babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Scene } from "babylonjs/scene";
  9538. import { ActionManager } from "babylonjs/Actions/actionManager";
  9539. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9540. import { Node } from "babylonjs/node";
  9541. /**
  9542. * Interface used to define Action
  9543. */
  9544. export interface IAction {
  9545. /**
  9546. * Trigger for the action
  9547. */
  9548. trigger: number;
  9549. /** Options of the trigger */
  9550. triggerOptions: any;
  9551. /**
  9552. * Gets the trigger parameters
  9553. * @returns the trigger parameters
  9554. */
  9555. getTriggerParameter(): any;
  9556. /**
  9557. * Internal only - executes current action event
  9558. * @hidden
  9559. */
  9560. _executeCurrent(evt?: ActionEvent): void;
  9561. /**
  9562. * Serialize placeholder for child classes
  9563. * @param parent of child
  9564. * @returns the serialized object
  9565. */
  9566. serialize(parent: any): any;
  9567. /**
  9568. * Internal only
  9569. * @hidden
  9570. */
  9571. _prepare(): void;
  9572. /**
  9573. * Internal only - manager for action
  9574. * @hidden
  9575. */
  9576. _actionManager: AbstractActionManager;
  9577. /**
  9578. * Adds action to chain of actions, may be a DoNothingAction
  9579. * @param action defines the next action to execute
  9580. * @returns The action passed in
  9581. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9582. */
  9583. then(action: IAction): IAction;
  9584. }
  9585. /**
  9586. * The action to be carried out following a trigger
  9587. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9588. */
  9589. export class Action implements IAction {
  9590. /** the trigger, with or without parameters, for the action */
  9591. triggerOptions: any;
  9592. /**
  9593. * Trigger for the action
  9594. */
  9595. trigger: number;
  9596. /**
  9597. * Internal only - manager for action
  9598. * @hidden
  9599. */
  9600. _actionManager: ActionManager;
  9601. private _nextActiveAction;
  9602. private _child;
  9603. private _condition?;
  9604. private _triggerParameter;
  9605. /**
  9606. * An event triggered prior to action being executed.
  9607. */
  9608. onBeforeExecuteObservable: Observable<Action>;
  9609. /**
  9610. * Creates a new Action
  9611. * @param triggerOptions the trigger, with or without parameters, for the action
  9612. * @param condition an optional determinant of action
  9613. */
  9614. constructor(
  9615. /** the trigger, with or without parameters, for the action */
  9616. triggerOptions: any, condition?: Condition);
  9617. /**
  9618. * Internal only
  9619. * @hidden
  9620. */
  9621. _prepare(): void;
  9622. /**
  9623. * Gets the trigger parameters
  9624. * @returns the trigger parameters
  9625. */
  9626. getTriggerParameter(): any;
  9627. /**
  9628. * Internal only - executes current action event
  9629. * @hidden
  9630. */
  9631. _executeCurrent(evt?: ActionEvent): void;
  9632. /**
  9633. * Execute placeholder for child classes
  9634. * @param evt optional action event
  9635. */
  9636. execute(evt?: ActionEvent): void;
  9637. /**
  9638. * Skips to next active action
  9639. */
  9640. skipToNextActiveAction(): void;
  9641. /**
  9642. * Adds action to chain of actions, may be a DoNothingAction
  9643. * @param action defines the next action to execute
  9644. * @returns The action passed in
  9645. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9646. */
  9647. then(action: Action): Action;
  9648. /**
  9649. * Internal only
  9650. * @hidden
  9651. */
  9652. _getProperty(propertyPath: string): string;
  9653. /**
  9654. * Internal only
  9655. * @hidden
  9656. */
  9657. _getEffectiveTarget(target: any, propertyPath: string): any;
  9658. /**
  9659. * Serialize placeholder for child classes
  9660. * @param parent of child
  9661. * @returns the serialized object
  9662. */
  9663. serialize(parent: any): any;
  9664. /**
  9665. * Internal only called by serialize
  9666. * @hidden
  9667. */
  9668. protected _serialize(serializedAction: any, parent?: any): any;
  9669. /**
  9670. * Internal only
  9671. * @hidden
  9672. */
  9673. static _SerializeValueAsString: (value: any) => string;
  9674. /**
  9675. * Internal only
  9676. * @hidden
  9677. */
  9678. static _GetTargetProperty: (target: Scene | Node) => {
  9679. name: string;
  9680. targetType: string;
  9681. value: string;
  9682. };
  9683. }
  9684. }
  9685. declare module "babylonjs/Actions/condition" {
  9686. import { ActionManager } from "babylonjs/Actions/actionManager";
  9687. /**
  9688. * A Condition applied to an Action
  9689. */
  9690. export class Condition {
  9691. /**
  9692. * Internal only - manager for action
  9693. * @hidden
  9694. */
  9695. _actionManager: ActionManager;
  9696. /**
  9697. * Internal only
  9698. * @hidden
  9699. */
  9700. _evaluationId: number;
  9701. /**
  9702. * Internal only
  9703. * @hidden
  9704. */
  9705. _currentResult: boolean;
  9706. /**
  9707. * Creates a new Condition
  9708. * @param actionManager the manager of the action the condition is applied to
  9709. */
  9710. constructor(actionManager: ActionManager);
  9711. /**
  9712. * Check if the current condition is valid
  9713. * @returns a boolean
  9714. */
  9715. isValid(): boolean;
  9716. /**
  9717. * Internal only
  9718. * @hidden
  9719. */
  9720. _getProperty(propertyPath: string): string;
  9721. /**
  9722. * Internal only
  9723. * @hidden
  9724. */
  9725. _getEffectiveTarget(target: any, propertyPath: string): any;
  9726. /**
  9727. * Serialize placeholder for child classes
  9728. * @returns the serialized object
  9729. */
  9730. serialize(): any;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. protected _serialize(serializedCondition: any): any;
  9736. }
  9737. /**
  9738. * Defines specific conditional operators as extensions of Condition
  9739. */
  9740. export class ValueCondition extends Condition {
  9741. /** path to specify the property of the target the conditional operator uses */
  9742. propertyPath: string;
  9743. /** the value compared by the conditional operator against the current value of the property */
  9744. value: any;
  9745. /** the conditional operator, default ValueCondition.IsEqual */
  9746. operator: number;
  9747. /**
  9748. * Internal only
  9749. * @hidden
  9750. */
  9751. private static _IsEqual;
  9752. /**
  9753. * Internal only
  9754. * @hidden
  9755. */
  9756. private static _IsDifferent;
  9757. /**
  9758. * Internal only
  9759. * @hidden
  9760. */
  9761. private static _IsGreater;
  9762. /**
  9763. * Internal only
  9764. * @hidden
  9765. */
  9766. private static _IsLesser;
  9767. /**
  9768. * returns the number for IsEqual
  9769. */
  9770. static get IsEqual(): number;
  9771. /**
  9772. * Returns the number for IsDifferent
  9773. */
  9774. static get IsDifferent(): number;
  9775. /**
  9776. * Returns the number for IsGreater
  9777. */
  9778. static get IsGreater(): number;
  9779. /**
  9780. * Returns the number for IsLesser
  9781. */
  9782. static get IsLesser(): number;
  9783. /**
  9784. * Internal only The action manager for the condition
  9785. * @hidden
  9786. */
  9787. _actionManager: ActionManager;
  9788. /**
  9789. * Internal only
  9790. * @hidden
  9791. */
  9792. private _target;
  9793. /**
  9794. * Internal only
  9795. * @hidden
  9796. */
  9797. private _effectiveTarget;
  9798. /**
  9799. * Internal only
  9800. * @hidden
  9801. */
  9802. private _property;
  9803. /**
  9804. * Creates a new ValueCondition
  9805. * @param actionManager manager for the action the condition applies to
  9806. * @param target for the action
  9807. * @param propertyPath path to specify the property of the target the conditional operator uses
  9808. * @param value the value compared by the conditional operator against the current value of the property
  9809. * @param operator the conditional operator, default ValueCondition.IsEqual
  9810. */
  9811. constructor(actionManager: ActionManager, target: any,
  9812. /** path to specify the property of the target the conditional operator uses */
  9813. propertyPath: string,
  9814. /** the value compared by the conditional operator against the current value of the property */
  9815. value: any,
  9816. /** the conditional operator, default ValueCondition.IsEqual */
  9817. operator?: number);
  9818. /**
  9819. * Compares the given value with the property value for the specified conditional operator
  9820. * @returns the result of the comparison
  9821. */
  9822. isValid(): boolean;
  9823. /**
  9824. * Serialize the ValueCondition into a JSON compatible object
  9825. * @returns serialization object
  9826. */
  9827. serialize(): any;
  9828. /**
  9829. * Gets the name of the conditional operator for the ValueCondition
  9830. * @param operator the conditional operator
  9831. * @returns the name
  9832. */
  9833. static GetOperatorName(operator: number): string;
  9834. }
  9835. /**
  9836. * Defines a predicate condition as an extension of Condition
  9837. */
  9838. export class PredicateCondition extends Condition {
  9839. /** defines the predicate function used to validate the condition */
  9840. predicate: () => boolean;
  9841. /**
  9842. * Internal only - manager for action
  9843. * @hidden
  9844. */
  9845. _actionManager: ActionManager;
  9846. /**
  9847. * Creates a new PredicateCondition
  9848. * @param actionManager manager for the action the condition applies to
  9849. * @param predicate defines the predicate function used to validate the condition
  9850. */
  9851. constructor(actionManager: ActionManager,
  9852. /** defines the predicate function used to validate the condition */
  9853. predicate: () => boolean);
  9854. /**
  9855. * @returns the validity of the predicate condition
  9856. */
  9857. isValid(): boolean;
  9858. }
  9859. /**
  9860. * Defines a state condition as an extension of Condition
  9861. */
  9862. export class StateCondition extends Condition {
  9863. /** Value to compare with target state */
  9864. value: string;
  9865. /**
  9866. * Internal only - manager for action
  9867. * @hidden
  9868. */
  9869. _actionManager: ActionManager;
  9870. /**
  9871. * Internal only
  9872. * @hidden
  9873. */
  9874. private _target;
  9875. /**
  9876. * Creates a new StateCondition
  9877. * @param actionManager manager for the action the condition applies to
  9878. * @param target of the condition
  9879. * @param value to compare with target state
  9880. */
  9881. constructor(actionManager: ActionManager, target: any,
  9882. /** Value to compare with target state */
  9883. value: string);
  9884. /**
  9885. * Gets a boolean indicating if the current condition is met
  9886. * @returns the validity of the state
  9887. */
  9888. isValid(): boolean;
  9889. /**
  9890. * Serialize the StateCondition into a JSON compatible object
  9891. * @returns serialization object
  9892. */
  9893. serialize(): any;
  9894. }
  9895. }
  9896. declare module "babylonjs/Actions/directActions" {
  9897. import { Action } from "babylonjs/Actions/action";
  9898. import { Condition } from "babylonjs/Actions/condition";
  9899. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9900. /**
  9901. * This defines an action responsible to toggle a boolean once triggered.
  9902. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9903. */
  9904. export class SwitchBooleanAction extends Action {
  9905. /**
  9906. * The path to the boolean property in the target object
  9907. */
  9908. propertyPath: string;
  9909. private _target;
  9910. private _effectiveTarget;
  9911. private _property;
  9912. /**
  9913. * Instantiate the action
  9914. * @param triggerOptions defines the trigger options
  9915. * @param target defines the object containing the boolean
  9916. * @param propertyPath defines the path to the boolean property in the target object
  9917. * @param condition defines the trigger related conditions
  9918. */
  9919. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9920. /** @hidden */
  9921. _prepare(): void;
  9922. /**
  9923. * Execute the action toggle the boolean value.
  9924. */
  9925. execute(): void;
  9926. /**
  9927. * Serializes the actions and its related information.
  9928. * @param parent defines the object to serialize in
  9929. * @returns the serialized object
  9930. */
  9931. serialize(parent: any): any;
  9932. }
  9933. /**
  9934. * This defines an action responsible to set a the state field of the target
  9935. * to a desired value once triggered.
  9936. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9937. */
  9938. export class SetStateAction extends Action {
  9939. /**
  9940. * The value to store in the state field.
  9941. */
  9942. value: string;
  9943. private _target;
  9944. /**
  9945. * Instantiate the action
  9946. * @param triggerOptions defines the trigger options
  9947. * @param target defines the object containing the state property
  9948. * @param value defines the value to store in the state field
  9949. * @param condition defines the trigger related conditions
  9950. */
  9951. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9952. /**
  9953. * Execute the action and store the value on the target state property.
  9954. */
  9955. execute(): void;
  9956. /**
  9957. * Serializes the actions and its related information.
  9958. * @param parent defines the object to serialize in
  9959. * @returns the serialized object
  9960. */
  9961. serialize(parent: any): any;
  9962. }
  9963. /**
  9964. * This defines an action responsible to set a property of the target
  9965. * to a desired value once triggered.
  9966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9967. */
  9968. export class SetValueAction extends Action {
  9969. /**
  9970. * The path of the property to set in the target.
  9971. */
  9972. propertyPath: string;
  9973. /**
  9974. * The value to set in the property
  9975. */
  9976. value: any;
  9977. private _target;
  9978. private _effectiveTarget;
  9979. private _property;
  9980. /**
  9981. * Instantiate the action
  9982. * @param triggerOptions defines the trigger options
  9983. * @param target defines the object containing the property
  9984. * @param propertyPath defines the path of the property to set in the target
  9985. * @param value defines the value to set in the property
  9986. * @param condition defines the trigger related conditions
  9987. */
  9988. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9989. /** @hidden */
  9990. _prepare(): void;
  9991. /**
  9992. * Execute the action and set the targetted property to the desired value.
  9993. */
  9994. execute(): void;
  9995. /**
  9996. * Serializes the actions and its related information.
  9997. * @param parent defines the object to serialize in
  9998. * @returns the serialized object
  9999. */
  10000. serialize(parent: any): any;
  10001. }
  10002. /**
  10003. * This defines an action responsible to increment the target value
  10004. * to a desired value once triggered.
  10005. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10006. */
  10007. export class IncrementValueAction extends Action {
  10008. /**
  10009. * The path of the property to increment in the target.
  10010. */
  10011. propertyPath: string;
  10012. /**
  10013. * The value we should increment the property by.
  10014. */
  10015. value: any;
  10016. private _target;
  10017. private _effectiveTarget;
  10018. private _property;
  10019. /**
  10020. * Instantiate the action
  10021. * @param triggerOptions defines the trigger options
  10022. * @param target defines the object containing the property
  10023. * @param propertyPath defines the path of the property to increment in the target
  10024. * @param value defines the value value we should increment the property by
  10025. * @param condition defines the trigger related conditions
  10026. */
  10027. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10028. /** @hidden */
  10029. _prepare(): void;
  10030. /**
  10031. * Execute the action and increment the target of the value amount.
  10032. */
  10033. execute(): void;
  10034. /**
  10035. * Serializes the actions and its related information.
  10036. * @param parent defines the object to serialize in
  10037. * @returns the serialized object
  10038. */
  10039. serialize(parent: any): any;
  10040. }
  10041. /**
  10042. * This defines an action responsible to start an animation once triggered.
  10043. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10044. */
  10045. export class PlayAnimationAction extends Action {
  10046. /**
  10047. * Where the animation should start (animation frame)
  10048. */
  10049. from: number;
  10050. /**
  10051. * Where the animation should stop (animation frame)
  10052. */
  10053. to: number;
  10054. /**
  10055. * Define if the animation should loop or stop after the first play.
  10056. */
  10057. loop?: boolean;
  10058. private _target;
  10059. /**
  10060. * Instantiate the action
  10061. * @param triggerOptions defines the trigger options
  10062. * @param target defines the target animation or animation name
  10063. * @param from defines from where the animation should start (animation frame)
  10064. * @param end defines where the animation should stop (animation frame)
  10065. * @param loop defines if the animation should loop or stop after the first play
  10066. * @param condition defines the trigger related conditions
  10067. */
  10068. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10069. /** @hidden */
  10070. _prepare(): void;
  10071. /**
  10072. * Execute the action and play the animation.
  10073. */
  10074. execute(): void;
  10075. /**
  10076. * Serializes the actions and its related information.
  10077. * @param parent defines the object to serialize in
  10078. * @returns the serialized object
  10079. */
  10080. serialize(parent: any): any;
  10081. }
  10082. /**
  10083. * This defines an action responsible to stop an animation once triggered.
  10084. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10085. */
  10086. export class StopAnimationAction extends Action {
  10087. private _target;
  10088. /**
  10089. * Instantiate the action
  10090. * @param triggerOptions defines the trigger options
  10091. * @param target defines the target animation or animation name
  10092. * @param condition defines the trigger related conditions
  10093. */
  10094. constructor(triggerOptions: any, target: any, condition?: Condition);
  10095. /** @hidden */
  10096. _prepare(): void;
  10097. /**
  10098. * Execute the action and stop the animation.
  10099. */
  10100. execute(): void;
  10101. /**
  10102. * Serializes the actions and its related information.
  10103. * @param parent defines the object to serialize in
  10104. * @returns the serialized object
  10105. */
  10106. serialize(parent: any): any;
  10107. }
  10108. /**
  10109. * This defines an action responsible that does nothing once triggered.
  10110. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10111. */
  10112. export class DoNothingAction extends Action {
  10113. /**
  10114. * Instantiate the action
  10115. * @param triggerOptions defines the trigger options
  10116. * @param condition defines the trigger related conditions
  10117. */
  10118. constructor(triggerOptions?: any, condition?: Condition);
  10119. /**
  10120. * Execute the action and do nothing.
  10121. */
  10122. execute(): void;
  10123. /**
  10124. * Serializes the actions and its related information.
  10125. * @param parent defines the object to serialize in
  10126. * @returns the serialized object
  10127. */
  10128. serialize(parent: any): any;
  10129. }
  10130. /**
  10131. * This defines an action responsible to trigger several actions once triggered.
  10132. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10133. */
  10134. export class CombineAction extends Action {
  10135. /**
  10136. * The list of aggregated animations to run.
  10137. */
  10138. children: Action[];
  10139. /**
  10140. * Instantiate the action
  10141. * @param triggerOptions defines the trigger options
  10142. * @param children defines the list of aggregated animations to run
  10143. * @param condition defines the trigger related conditions
  10144. */
  10145. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10146. /** @hidden */
  10147. _prepare(): void;
  10148. /**
  10149. * Execute the action and executes all the aggregated actions.
  10150. */
  10151. execute(evt: ActionEvent): void;
  10152. /**
  10153. * Serializes the actions and its related information.
  10154. * @param parent defines the object to serialize in
  10155. * @returns the serialized object
  10156. */
  10157. serialize(parent: any): any;
  10158. }
  10159. /**
  10160. * This defines an action responsible to run code (external event) once triggered.
  10161. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10162. */
  10163. export class ExecuteCodeAction extends Action {
  10164. /**
  10165. * The callback function to run.
  10166. */
  10167. func: (evt: ActionEvent) => void;
  10168. /**
  10169. * Instantiate the action
  10170. * @param triggerOptions defines the trigger options
  10171. * @param func defines the callback function to run
  10172. * @param condition defines the trigger related conditions
  10173. */
  10174. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10175. /**
  10176. * Execute the action and run the attached code.
  10177. */
  10178. execute(evt: ActionEvent): void;
  10179. }
  10180. /**
  10181. * This defines an action responsible to set the parent property of the target once triggered.
  10182. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10183. */
  10184. export class SetParentAction extends Action {
  10185. private _parent;
  10186. private _target;
  10187. /**
  10188. * Instantiate the action
  10189. * @param triggerOptions defines the trigger options
  10190. * @param target defines the target containing the parent property
  10191. * @param parent defines from where the animation should start (animation frame)
  10192. * @param condition defines the trigger related conditions
  10193. */
  10194. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10195. /** @hidden */
  10196. _prepare(): void;
  10197. /**
  10198. * Execute the action and set the parent property.
  10199. */
  10200. execute(): void;
  10201. /**
  10202. * Serializes the actions and its related information.
  10203. * @param parent defines the object to serialize in
  10204. * @returns the serialized object
  10205. */
  10206. serialize(parent: any): any;
  10207. }
  10208. }
  10209. declare module "babylonjs/Actions/actionManager" {
  10210. import { Nullable } from "babylonjs/types";
  10211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10212. import { Scene } from "babylonjs/scene";
  10213. import { IAction } from "babylonjs/Actions/action";
  10214. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10215. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10216. /**
  10217. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10218. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10219. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10220. */
  10221. export class ActionManager extends AbstractActionManager {
  10222. /**
  10223. * Nothing
  10224. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10225. */
  10226. static readonly NothingTrigger: number;
  10227. /**
  10228. * On pick
  10229. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10230. */
  10231. static readonly OnPickTrigger: number;
  10232. /**
  10233. * On left pick
  10234. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10235. */
  10236. static readonly OnLeftPickTrigger: number;
  10237. /**
  10238. * On right pick
  10239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10240. */
  10241. static readonly OnRightPickTrigger: number;
  10242. /**
  10243. * On center pick
  10244. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10245. */
  10246. static readonly OnCenterPickTrigger: number;
  10247. /**
  10248. * On pick down
  10249. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10250. */
  10251. static readonly OnPickDownTrigger: number;
  10252. /**
  10253. * On double pick
  10254. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10255. */
  10256. static readonly OnDoublePickTrigger: number;
  10257. /**
  10258. * On pick up
  10259. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10260. */
  10261. static readonly OnPickUpTrigger: number;
  10262. /**
  10263. * On pick out.
  10264. * This trigger will only be raised if you also declared a OnPickDown
  10265. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10266. */
  10267. static readonly OnPickOutTrigger: number;
  10268. /**
  10269. * On long press
  10270. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10271. */
  10272. static readonly OnLongPressTrigger: number;
  10273. /**
  10274. * On pointer over
  10275. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10276. */
  10277. static readonly OnPointerOverTrigger: number;
  10278. /**
  10279. * On pointer out
  10280. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10281. */
  10282. static readonly OnPointerOutTrigger: number;
  10283. /**
  10284. * On every frame
  10285. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10286. */
  10287. static readonly OnEveryFrameTrigger: number;
  10288. /**
  10289. * On intersection enter
  10290. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10291. */
  10292. static readonly OnIntersectionEnterTrigger: number;
  10293. /**
  10294. * On intersection exit
  10295. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10296. */
  10297. static readonly OnIntersectionExitTrigger: number;
  10298. /**
  10299. * On key down
  10300. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10301. */
  10302. static readonly OnKeyDownTrigger: number;
  10303. /**
  10304. * On key up
  10305. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10306. */
  10307. static readonly OnKeyUpTrigger: number;
  10308. private _scene;
  10309. /**
  10310. * Creates a new action manager
  10311. * @param scene defines the hosting scene
  10312. */
  10313. constructor(scene: Scene);
  10314. /**
  10315. * Releases all associated resources
  10316. */
  10317. dispose(): void;
  10318. /**
  10319. * Gets hosting scene
  10320. * @returns the hosting scene
  10321. */
  10322. getScene(): Scene;
  10323. /**
  10324. * Does this action manager handles actions of any of the given triggers
  10325. * @param triggers defines the triggers to be tested
  10326. * @return a boolean indicating whether one (or more) of the triggers is handled
  10327. */
  10328. hasSpecificTriggers(triggers: number[]): boolean;
  10329. /**
  10330. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10331. * speed.
  10332. * @param triggerA defines the trigger to be tested
  10333. * @param triggerB defines the trigger to be tested
  10334. * @return a boolean indicating whether one (or more) of the triggers is handled
  10335. */
  10336. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10337. /**
  10338. * Does this action manager handles actions of a given trigger
  10339. * @param trigger defines the trigger to be tested
  10340. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10341. * @return whether the trigger is handled
  10342. */
  10343. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10344. /**
  10345. * Does this action manager has pointer triggers
  10346. */
  10347. get hasPointerTriggers(): boolean;
  10348. /**
  10349. * Does this action manager has pick triggers
  10350. */
  10351. get hasPickTriggers(): boolean;
  10352. /**
  10353. * Registers an action to this action manager
  10354. * @param action defines the action to be registered
  10355. * @return the action amended (prepared) after registration
  10356. */
  10357. registerAction(action: IAction): Nullable<IAction>;
  10358. /**
  10359. * Unregisters an action to this action manager
  10360. * @param action defines the action to be unregistered
  10361. * @return a boolean indicating whether the action has been unregistered
  10362. */
  10363. unregisterAction(action: IAction): Boolean;
  10364. /**
  10365. * Process a specific trigger
  10366. * @param trigger defines the trigger to process
  10367. * @param evt defines the event details to be processed
  10368. */
  10369. processTrigger(trigger: number, evt?: IActionEvent): void;
  10370. /** @hidden */
  10371. _getEffectiveTarget(target: any, propertyPath: string): any;
  10372. /** @hidden */
  10373. _getProperty(propertyPath: string): string;
  10374. /**
  10375. * Serialize this manager to a JSON object
  10376. * @param name defines the property name to store this manager
  10377. * @returns a JSON representation of this manager
  10378. */
  10379. serialize(name: string): any;
  10380. /**
  10381. * Creates a new ActionManager from a JSON data
  10382. * @param parsedActions defines the JSON data to read from
  10383. * @param object defines the hosting mesh
  10384. * @param scene defines the hosting scene
  10385. */
  10386. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10387. /**
  10388. * Get a trigger name by index
  10389. * @param trigger defines the trigger index
  10390. * @returns a trigger name
  10391. */
  10392. static GetTriggerName(trigger: number): string;
  10393. }
  10394. }
  10395. declare module "babylonjs/Sprites/sprite" {
  10396. import { Vector3 } from "babylonjs/Maths/math.vector";
  10397. import { Nullable } from "babylonjs/types";
  10398. import { ActionManager } from "babylonjs/Actions/actionManager";
  10399. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10400. import { Color4 } from "babylonjs/Maths/math.color";
  10401. import { Observable } from "babylonjs/Misc/observable";
  10402. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10403. import { Animation } from "babylonjs/Animations/animation";
  10404. /**
  10405. * Class used to represent a sprite
  10406. * @see https://doc.babylonjs.com/babylon101/sprites
  10407. */
  10408. export class Sprite implements IAnimatable {
  10409. /** defines the name */
  10410. name: string;
  10411. /** Gets or sets the current world position */
  10412. position: Vector3;
  10413. /** Gets or sets the main color */
  10414. color: Color4;
  10415. /** Gets or sets the width */
  10416. width: number;
  10417. /** Gets or sets the height */
  10418. height: number;
  10419. /** Gets or sets rotation angle */
  10420. angle: number;
  10421. /** Gets or sets the cell index in the sprite sheet */
  10422. cellIndex: number;
  10423. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10424. cellRef: string;
  10425. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10426. invertU: boolean;
  10427. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10428. invertV: boolean;
  10429. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10430. disposeWhenFinishedAnimating: boolean;
  10431. /** Gets the list of attached animations */
  10432. animations: Nullable<Array<Animation>>;
  10433. /** Gets or sets a boolean indicating if the sprite can be picked */
  10434. isPickable: boolean;
  10435. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10436. useAlphaForPicking: boolean;
  10437. /** @hidden */
  10438. _xOffset: number;
  10439. /** @hidden */
  10440. _yOffset: number;
  10441. /** @hidden */
  10442. _xSize: number;
  10443. /** @hidden */
  10444. _ySize: number;
  10445. /**
  10446. * Gets or sets the associated action manager
  10447. */
  10448. actionManager: Nullable<ActionManager>;
  10449. /**
  10450. * An event triggered when the control has been disposed
  10451. */
  10452. onDisposeObservable: Observable<Sprite>;
  10453. private _animationStarted;
  10454. private _loopAnimation;
  10455. private _fromIndex;
  10456. private _toIndex;
  10457. private _delay;
  10458. private _direction;
  10459. private _manager;
  10460. private _time;
  10461. private _onAnimationEnd;
  10462. /**
  10463. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10464. */
  10465. isVisible: boolean;
  10466. /**
  10467. * Gets or sets the sprite size
  10468. */
  10469. get size(): number;
  10470. set size(value: number);
  10471. /**
  10472. * Returns a boolean indicating if the animation is started
  10473. */
  10474. get animationStarted(): boolean;
  10475. /**
  10476. * Gets or sets the unique id of the sprite
  10477. */
  10478. uniqueId: number;
  10479. /**
  10480. * Gets the manager of this sprite
  10481. */
  10482. get manager(): ISpriteManager;
  10483. /**
  10484. * Creates a new Sprite
  10485. * @param name defines the name
  10486. * @param manager defines the manager
  10487. */
  10488. constructor(
  10489. /** defines the name */
  10490. name: string, manager: ISpriteManager);
  10491. /**
  10492. * Returns the string "Sprite"
  10493. * @returns "Sprite"
  10494. */
  10495. getClassName(): string;
  10496. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10497. get fromIndex(): number;
  10498. set fromIndex(value: number);
  10499. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10500. get toIndex(): number;
  10501. set toIndex(value: number);
  10502. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10503. get loopAnimation(): boolean;
  10504. set loopAnimation(value: boolean);
  10505. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10506. get delay(): number;
  10507. set delay(value: number);
  10508. /**
  10509. * Starts an animation
  10510. * @param from defines the initial key
  10511. * @param to defines the end key
  10512. * @param loop defines if the animation must loop
  10513. * @param delay defines the start delay (in ms)
  10514. * @param onAnimationEnd defines a callback to call when animation ends
  10515. */
  10516. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10517. /** Stops current animation (if any) */
  10518. stopAnimation(): void;
  10519. /** @hidden */
  10520. _animate(deltaTime: number): void;
  10521. /** Release associated resources */
  10522. dispose(): void;
  10523. /**
  10524. * Serializes the sprite to a JSON object
  10525. * @returns the JSON object
  10526. */
  10527. serialize(): any;
  10528. /**
  10529. * Parses a JSON object to create a new sprite
  10530. * @param parsedSprite The JSON object to parse
  10531. * @param manager defines the hosting manager
  10532. * @returns the new sprite
  10533. */
  10534. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10535. }
  10536. }
  10537. declare module "babylonjs/Collisions/pickingInfo" {
  10538. import { Nullable } from "babylonjs/types";
  10539. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10540. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10541. import { Sprite } from "babylonjs/Sprites/sprite";
  10542. import { Ray } from "babylonjs/Culling/ray";
  10543. /**
  10544. * Information about the result of picking within a scene
  10545. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10546. */
  10547. export class PickingInfo {
  10548. /** @hidden */
  10549. _pickingUnavailable: boolean;
  10550. /**
  10551. * If the pick collided with an object
  10552. */
  10553. hit: boolean;
  10554. /**
  10555. * Distance away where the pick collided
  10556. */
  10557. distance: number;
  10558. /**
  10559. * The location of pick collision
  10560. */
  10561. pickedPoint: Nullable<Vector3>;
  10562. /**
  10563. * The mesh corresponding the the pick collision
  10564. */
  10565. pickedMesh: Nullable<AbstractMesh>;
  10566. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10567. bu: number;
  10568. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10569. bv: number;
  10570. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10571. faceId: number;
  10572. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10573. subMeshFaceId: number;
  10574. /** Id of the the submesh that was picked */
  10575. subMeshId: number;
  10576. /** If a sprite was picked, this will be the sprite the pick collided with */
  10577. pickedSprite: Nullable<Sprite>;
  10578. /**
  10579. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10580. */
  10581. originMesh: Nullable<AbstractMesh>;
  10582. /**
  10583. * The ray that was used to perform the picking.
  10584. */
  10585. ray: Nullable<Ray>;
  10586. /**
  10587. * Gets the normal correspodning to the face the pick collided with
  10588. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10589. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10590. * @returns The normal correspodning to the face the pick collided with
  10591. */
  10592. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10593. /**
  10594. * Gets the texture coordinates of where the pick occured
  10595. * @returns the vector containing the coordnates of the texture
  10596. */
  10597. getTextureCoordinates(): Nullable<Vector2>;
  10598. }
  10599. }
  10600. declare module "babylonjs/Culling/ray" {
  10601. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10602. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10603. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10604. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10605. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10606. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10607. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10608. import { Plane } from "babylonjs/Maths/math.plane";
  10609. /**
  10610. * Class representing a ray with position and direction
  10611. */
  10612. export class Ray {
  10613. /** origin point */
  10614. origin: Vector3;
  10615. /** direction */
  10616. direction: Vector3;
  10617. /** length of the ray */
  10618. length: number;
  10619. private static readonly TmpVector3;
  10620. private _tmpRay;
  10621. /**
  10622. * Creates a new ray
  10623. * @param origin origin point
  10624. * @param direction direction
  10625. * @param length length of the ray
  10626. */
  10627. constructor(
  10628. /** origin point */
  10629. origin: Vector3,
  10630. /** direction */
  10631. direction: Vector3,
  10632. /** length of the ray */
  10633. length?: number);
  10634. /**
  10635. * Checks if the ray intersects a box
  10636. * This does not account for the ray lenght by design to improve perfs.
  10637. * @param minimum bound of the box
  10638. * @param maximum bound of the box
  10639. * @param intersectionTreshold extra extend to be added to the box in all direction
  10640. * @returns if the box was hit
  10641. */
  10642. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10643. /**
  10644. * Checks if the ray intersects a box
  10645. * This does not account for the ray lenght by design to improve perfs.
  10646. * @param box the bounding box to check
  10647. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10648. * @returns if the box was hit
  10649. */
  10650. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10651. /**
  10652. * If the ray hits a sphere
  10653. * @param sphere the bounding sphere to check
  10654. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10655. * @returns true if it hits the sphere
  10656. */
  10657. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10658. /**
  10659. * If the ray hits a triange
  10660. * @param vertex0 triangle vertex
  10661. * @param vertex1 triangle vertex
  10662. * @param vertex2 triangle vertex
  10663. * @returns intersection information if hit
  10664. */
  10665. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10666. /**
  10667. * Checks if ray intersects a plane
  10668. * @param plane the plane to check
  10669. * @returns the distance away it was hit
  10670. */
  10671. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10672. /**
  10673. * Calculate the intercept of a ray on a given axis
  10674. * @param axis to check 'x' | 'y' | 'z'
  10675. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10676. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10677. */
  10678. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10679. /**
  10680. * Checks if ray intersects a mesh
  10681. * @param mesh the mesh to check
  10682. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10683. * @returns picking info of the intersecton
  10684. */
  10685. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10686. /**
  10687. * Checks if ray intersects a mesh
  10688. * @param meshes the meshes to check
  10689. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10690. * @param results array to store result in
  10691. * @returns Array of picking infos
  10692. */
  10693. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10694. private _comparePickingInfo;
  10695. private static smallnum;
  10696. private static rayl;
  10697. /**
  10698. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10699. * @param sega the first point of the segment to test the intersection against
  10700. * @param segb the second point of the segment to test the intersection against
  10701. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10702. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10703. */
  10704. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10705. /**
  10706. * Update the ray from viewport position
  10707. * @param x position
  10708. * @param y y position
  10709. * @param viewportWidth viewport width
  10710. * @param viewportHeight viewport height
  10711. * @param world world matrix
  10712. * @param view view matrix
  10713. * @param projection projection matrix
  10714. * @returns this ray updated
  10715. */
  10716. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10717. /**
  10718. * Creates a ray with origin and direction of 0,0,0
  10719. * @returns the new ray
  10720. */
  10721. static Zero(): Ray;
  10722. /**
  10723. * Creates a new ray from screen space and viewport
  10724. * @param x position
  10725. * @param y y position
  10726. * @param viewportWidth viewport width
  10727. * @param viewportHeight viewport height
  10728. * @param world world matrix
  10729. * @param view view matrix
  10730. * @param projection projection matrix
  10731. * @returns new ray
  10732. */
  10733. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10734. /**
  10735. * 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
  10736. * transformed to the given world matrix.
  10737. * @param origin The origin point
  10738. * @param end The end point
  10739. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10740. * @returns the new ray
  10741. */
  10742. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10743. /**
  10744. * Transforms a ray by a matrix
  10745. * @param ray ray to transform
  10746. * @param matrix matrix to apply
  10747. * @returns the resulting new ray
  10748. */
  10749. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10750. /**
  10751. * Transforms a ray by a matrix
  10752. * @param ray ray to transform
  10753. * @param matrix matrix to apply
  10754. * @param result ray to store result in
  10755. */
  10756. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10757. /**
  10758. * Unproject a ray from screen space to object space
  10759. * @param sourceX defines the screen space x coordinate to use
  10760. * @param sourceY defines the screen space y coordinate to use
  10761. * @param viewportWidth defines the current width of the viewport
  10762. * @param viewportHeight defines the current height of the viewport
  10763. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10764. * @param view defines the view matrix to use
  10765. * @param projection defines the projection matrix to use
  10766. */
  10767. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10768. }
  10769. /**
  10770. * Type used to define predicate used to select faces when a mesh intersection is detected
  10771. */
  10772. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10773. module "babylonjs/scene" {
  10774. interface Scene {
  10775. /** @hidden */
  10776. _tempPickingRay: Nullable<Ray>;
  10777. /** @hidden */
  10778. _cachedRayForTransform: Ray;
  10779. /** @hidden */
  10780. _pickWithRayInverseMatrix: Matrix;
  10781. /** @hidden */
  10782. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10783. /** @hidden */
  10784. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10785. }
  10786. }
  10787. }
  10788. declare module "babylonjs/sceneComponent" {
  10789. import { Scene } from "babylonjs/scene";
  10790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10791. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10792. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10793. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10794. import { Nullable } from "babylonjs/types";
  10795. import { Camera } from "babylonjs/Cameras/camera";
  10796. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10797. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10798. import { AbstractScene } from "babylonjs/abstractScene";
  10799. import { Mesh } from "babylonjs/Meshes/mesh";
  10800. /**
  10801. * Groups all the scene component constants in one place to ease maintenance.
  10802. * @hidden
  10803. */
  10804. export class SceneComponentConstants {
  10805. static readonly NAME_EFFECTLAYER: string;
  10806. static readonly NAME_LAYER: string;
  10807. static readonly NAME_LENSFLARESYSTEM: string;
  10808. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10809. static readonly NAME_PARTICLESYSTEM: string;
  10810. static readonly NAME_GAMEPAD: string;
  10811. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10812. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10813. static readonly NAME_PREPASSRENDERER: string;
  10814. static readonly NAME_DEPTHRENDERER: string;
  10815. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10816. static readonly NAME_SPRITE: string;
  10817. static readonly NAME_OUTLINERENDERER: string;
  10818. static readonly NAME_PROCEDURALTEXTURE: string;
  10819. static readonly NAME_SHADOWGENERATOR: string;
  10820. static readonly NAME_OCTREE: string;
  10821. static readonly NAME_PHYSICSENGINE: string;
  10822. static readonly NAME_AUDIO: string;
  10823. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10824. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10825. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10826. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10827. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10828. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10829. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10830. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10831. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10832. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10833. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10834. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10835. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10836. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10837. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10838. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10839. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10840. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10841. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10842. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10843. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10844. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10845. static readonly STEP_AFTERRENDER_AUDIO: number;
  10846. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10847. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10848. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10849. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10850. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10851. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10852. static readonly STEP_POINTERMOVE_SPRITE: number;
  10853. static readonly STEP_POINTERDOWN_SPRITE: number;
  10854. static readonly STEP_POINTERUP_SPRITE: number;
  10855. }
  10856. /**
  10857. * This represents a scene component.
  10858. *
  10859. * This is used to decouple the dependency the scene is having on the different workloads like
  10860. * layers, post processes...
  10861. */
  10862. export interface ISceneComponent {
  10863. /**
  10864. * The name of the component. Each component must have a unique name.
  10865. */
  10866. name: string;
  10867. /**
  10868. * The scene the component belongs to.
  10869. */
  10870. scene: Scene;
  10871. /**
  10872. * Register the component to one instance of a scene.
  10873. */
  10874. register(): void;
  10875. /**
  10876. * Rebuilds the elements related to this component in case of
  10877. * context lost for instance.
  10878. */
  10879. rebuild(): void;
  10880. /**
  10881. * Disposes the component and the associated ressources.
  10882. */
  10883. dispose(): void;
  10884. }
  10885. /**
  10886. * This represents a SERIALIZABLE scene component.
  10887. *
  10888. * This extends Scene Component to add Serialization methods on top.
  10889. */
  10890. export interface ISceneSerializableComponent extends ISceneComponent {
  10891. /**
  10892. * Adds all the elements from the container to the scene
  10893. * @param container the container holding the elements
  10894. */
  10895. addFromContainer(container: AbstractScene): void;
  10896. /**
  10897. * Removes all the elements in the container from the scene
  10898. * @param container contains the elements to remove
  10899. * @param dispose if the removed element should be disposed (default: false)
  10900. */
  10901. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10902. /**
  10903. * Serializes the component data to the specified json object
  10904. * @param serializationObject The object to serialize to
  10905. */
  10906. serialize(serializationObject: any): void;
  10907. }
  10908. /**
  10909. * Strong typing of a Mesh related stage step action
  10910. */
  10911. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10912. /**
  10913. * Strong typing of a Evaluate Sub Mesh related stage step action
  10914. */
  10915. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10916. /**
  10917. * Strong typing of a Active Mesh related stage step action
  10918. */
  10919. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10920. /**
  10921. * Strong typing of a Camera related stage step action
  10922. */
  10923. export type CameraStageAction = (camera: Camera) => void;
  10924. /**
  10925. * Strong typing of a Camera Frame buffer related stage step action
  10926. */
  10927. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10928. /**
  10929. * Strong typing of a Render Target related stage step action
  10930. */
  10931. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10932. /**
  10933. * Strong typing of a RenderingGroup related stage step action
  10934. */
  10935. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10936. /**
  10937. * Strong typing of a Mesh Render related stage step action
  10938. */
  10939. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10940. /**
  10941. * Strong typing of a simple stage step action
  10942. */
  10943. export type SimpleStageAction = () => void;
  10944. /**
  10945. * Strong typing of a render target action.
  10946. */
  10947. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10948. /**
  10949. * Strong typing of a pointer move action.
  10950. */
  10951. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10952. /**
  10953. * Strong typing of a pointer up/down action.
  10954. */
  10955. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10956. /**
  10957. * Representation of a stage in the scene (Basically a list of ordered steps)
  10958. * @hidden
  10959. */
  10960. export class Stage<T extends Function> extends Array<{
  10961. index: number;
  10962. component: ISceneComponent;
  10963. action: T;
  10964. }> {
  10965. /**
  10966. * Hide ctor from the rest of the world.
  10967. * @param items The items to add.
  10968. */
  10969. private constructor();
  10970. /**
  10971. * Creates a new Stage.
  10972. * @returns A new instance of a Stage
  10973. */
  10974. static Create<T extends Function>(): Stage<T>;
  10975. /**
  10976. * Registers a step in an ordered way in the targeted stage.
  10977. * @param index Defines the position to register the step in
  10978. * @param component Defines the component attached to the step
  10979. * @param action Defines the action to launch during the step
  10980. */
  10981. registerStep(index: number, component: ISceneComponent, action: T): void;
  10982. /**
  10983. * Clears all the steps from the stage.
  10984. */
  10985. clear(): void;
  10986. }
  10987. }
  10988. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10989. import { Nullable } from "babylonjs/types";
  10990. import { Observable } from "babylonjs/Misc/observable";
  10991. import { Scene } from "babylonjs/scene";
  10992. import { Sprite } from "babylonjs/Sprites/sprite";
  10993. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10994. import { Ray } from "babylonjs/Culling/ray";
  10995. import { Camera } from "babylonjs/Cameras/camera";
  10996. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10997. import { ISceneComponent } from "babylonjs/sceneComponent";
  10998. module "babylonjs/scene" {
  10999. interface Scene {
  11000. /** @hidden */
  11001. _pointerOverSprite: Nullable<Sprite>;
  11002. /** @hidden */
  11003. _pickedDownSprite: Nullable<Sprite>;
  11004. /** @hidden */
  11005. _tempSpritePickingRay: Nullable<Ray>;
  11006. /**
  11007. * All of the sprite managers added to this scene
  11008. * @see https://doc.babylonjs.com/babylon101/sprites
  11009. */
  11010. spriteManagers: Array<ISpriteManager>;
  11011. /**
  11012. * An event triggered when sprites rendering is about to start
  11013. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11014. */
  11015. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11016. /**
  11017. * An event triggered when sprites rendering is done
  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. onAfterSpritesRenderingObservable: Observable<Scene>;
  11021. /** @hidden */
  11022. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11023. /** Launch a ray to try to pick a sprite in the scene
  11024. * @param x position on screen
  11025. * @param y position on screen
  11026. * @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
  11027. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11028. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11029. * @returns a PickingInfo
  11030. */
  11031. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11032. /** Use the given ray to pick a sprite in the scene
  11033. * @param ray The ray (in world space) to use to pick meshes
  11034. * @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
  11035. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11036. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11037. * @returns a PickingInfo
  11038. */
  11039. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11040. /** @hidden */
  11041. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11042. /** Launch a ray to try to pick sprites in the scene
  11043. * @param x position on screen
  11044. * @param y position on screen
  11045. * @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
  11046. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11047. * @returns a PickingInfo array
  11048. */
  11049. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11050. /** Use the given ray to pick sprites in the scene
  11051. * @param ray The ray (in world space) to use to pick meshes
  11052. * @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
  11053. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11054. * @returns a PickingInfo array
  11055. */
  11056. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11057. /**
  11058. * Force the sprite under the pointer
  11059. * @param sprite defines the sprite to use
  11060. */
  11061. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11062. /**
  11063. * Gets the sprite under the pointer
  11064. * @returns a Sprite or null if no sprite is under the pointer
  11065. */
  11066. getPointerOverSprite(): Nullable<Sprite>;
  11067. }
  11068. }
  11069. /**
  11070. * Defines the sprite scene component responsible to manage sprites
  11071. * in a given scene.
  11072. */
  11073. export class SpriteSceneComponent implements ISceneComponent {
  11074. /**
  11075. * The component name helpfull to identify the component in the list of scene components.
  11076. */
  11077. readonly name: string;
  11078. /**
  11079. * The scene the component belongs to.
  11080. */
  11081. scene: Scene;
  11082. /** @hidden */
  11083. private _spritePredicate;
  11084. /**
  11085. * Creates a new instance of the component for the given scene
  11086. * @param scene Defines the scene to register the component in
  11087. */
  11088. constructor(scene: Scene);
  11089. /**
  11090. * Registers the component in a given scene
  11091. */
  11092. register(): void;
  11093. /**
  11094. * Rebuilds the elements related to this component in case of
  11095. * context lost for instance.
  11096. */
  11097. rebuild(): void;
  11098. /**
  11099. * Disposes the component and the associated ressources.
  11100. */
  11101. dispose(): void;
  11102. private _pickSpriteButKeepRay;
  11103. private _pointerMove;
  11104. private _pointerDown;
  11105. private _pointerUp;
  11106. }
  11107. }
  11108. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11109. /** @hidden */
  11110. export var fogFragmentDeclaration: {
  11111. name: string;
  11112. shader: string;
  11113. };
  11114. }
  11115. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11116. /** @hidden */
  11117. export var fogFragment: {
  11118. name: string;
  11119. shader: string;
  11120. };
  11121. }
  11122. declare module "babylonjs/Shaders/sprites.fragment" {
  11123. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11124. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11125. /** @hidden */
  11126. export var spritesPixelShader: {
  11127. name: string;
  11128. shader: string;
  11129. };
  11130. }
  11131. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11132. /** @hidden */
  11133. export var fogVertexDeclaration: {
  11134. name: string;
  11135. shader: string;
  11136. };
  11137. }
  11138. declare module "babylonjs/Shaders/sprites.vertex" {
  11139. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11140. /** @hidden */
  11141. export var spritesVertexShader: {
  11142. name: string;
  11143. shader: string;
  11144. };
  11145. }
  11146. declare module "babylonjs/Sprites/spriteManager" {
  11147. import { IDisposable, Scene } from "babylonjs/scene";
  11148. import { Nullable } from "babylonjs/types";
  11149. import { Observable } from "babylonjs/Misc/observable";
  11150. import { Sprite } from "babylonjs/Sprites/sprite";
  11151. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11152. import { Camera } from "babylonjs/Cameras/camera";
  11153. import { Texture } from "babylonjs/Materials/Textures/texture";
  11154. import "babylonjs/Shaders/sprites.fragment";
  11155. import "babylonjs/Shaders/sprites.vertex";
  11156. import { Ray } from "babylonjs/Culling/ray";
  11157. /**
  11158. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11159. */
  11160. export interface ISpriteManager extends IDisposable {
  11161. /**
  11162. * Gets manager's name
  11163. */
  11164. name: string;
  11165. /**
  11166. * Restricts the camera to viewing objects with the same layerMask.
  11167. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11168. */
  11169. layerMask: number;
  11170. /**
  11171. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11172. */
  11173. isPickable: boolean;
  11174. /**
  11175. * Gets the hosting scene
  11176. */
  11177. scene: Scene;
  11178. /**
  11179. * Specifies the rendering group id for this mesh (0 by default)
  11180. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11181. */
  11182. renderingGroupId: number;
  11183. /**
  11184. * Defines the list of sprites managed by the manager.
  11185. */
  11186. sprites: Array<Sprite>;
  11187. /**
  11188. * Gets or sets the spritesheet texture
  11189. */
  11190. texture: Texture;
  11191. /** Defines the default width of a cell in the spritesheet */
  11192. cellWidth: number;
  11193. /** Defines the default height of a cell in the spritesheet */
  11194. cellHeight: number;
  11195. /**
  11196. * Tests the intersection of a sprite with a specific ray.
  11197. * @param ray The ray we are sending to test the collision
  11198. * @param camera The camera space we are sending rays in
  11199. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11200. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11201. * @returns picking info or null.
  11202. */
  11203. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11204. /**
  11205. * Intersects the sprites with a ray
  11206. * @param ray defines the ray to intersect with
  11207. * @param camera defines the current active camera
  11208. * @param predicate defines a predicate used to select candidate sprites
  11209. * @returns null if no hit or a PickingInfo array
  11210. */
  11211. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11212. /**
  11213. * Renders the list of sprites on screen.
  11214. */
  11215. render(): void;
  11216. }
  11217. /**
  11218. * Class used to manage multiple sprites on the same spritesheet
  11219. * @see https://doc.babylonjs.com/babylon101/sprites
  11220. */
  11221. export class SpriteManager implements ISpriteManager {
  11222. /** defines the manager's name */
  11223. name: string;
  11224. /** Define the Url to load snippets */
  11225. static SnippetUrl: string;
  11226. /** Snippet ID if the manager was created from the snippet server */
  11227. snippetId: string;
  11228. /** Gets the list of sprites */
  11229. sprites: Sprite[];
  11230. /** Gets or sets the rendering group id (0 by default) */
  11231. renderingGroupId: number;
  11232. /** Gets or sets camera layer mask */
  11233. layerMask: number;
  11234. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11235. fogEnabled: boolean;
  11236. /** Gets or sets a boolean indicating if the sprites are pickable */
  11237. isPickable: boolean;
  11238. /** Defines the default width of a cell in the spritesheet */
  11239. cellWidth: number;
  11240. /** Defines the default height of a cell in the spritesheet */
  11241. cellHeight: number;
  11242. /** Associative array from JSON sprite data file */
  11243. private _cellData;
  11244. /** Array of sprite names from JSON sprite data file */
  11245. private _spriteMap;
  11246. /** True when packed cell data from JSON file is ready*/
  11247. private _packedAndReady;
  11248. private _textureContent;
  11249. /**
  11250. * An event triggered when the manager is disposed.
  11251. */
  11252. onDisposeObservable: Observable<SpriteManager>;
  11253. private _onDisposeObserver;
  11254. /**
  11255. * Callback called when the manager is disposed
  11256. */
  11257. set onDispose(callback: () => void);
  11258. private _capacity;
  11259. private _fromPacked;
  11260. private _spriteTexture;
  11261. private _epsilon;
  11262. private _scene;
  11263. private _vertexData;
  11264. private _buffer;
  11265. private _vertexBuffers;
  11266. private _indexBuffer;
  11267. private _effectBase;
  11268. private _effectFog;
  11269. /**
  11270. * Gets or sets the unique id of the sprite
  11271. */
  11272. uniqueId: number;
  11273. /**
  11274. * Gets the array of sprites
  11275. */
  11276. get children(): Sprite[];
  11277. /**
  11278. * Gets the hosting scene
  11279. */
  11280. get scene(): Scene;
  11281. /**
  11282. * Gets the capacity of the manager
  11283. */
  11284. get capacity(): number;
  11285. /**
  11286. * Gets or sets the spritesheet texture
  11287. */
  11288. get texture(): Texture;
  11289. set texture(value: Texture);
  11290. private _blendMode;
  11291. /**
  11292. * Blend mode use to render the particle, it can be any of
  11293. * the static Constants.ALPHA_x properties provided in this class.
  11294. * Default value is Constants.ALPHA_COMBINE
  11295. */
  11296. get blendMode(): number;
  11297. set blendMode(blendMode: number);
  11298. /** Disables writing to the depth buffer when rendering the sprites.
  11299. * It can be handy to disable depth writing when using textures without alpha channel
  11300. * and setting some specific blend modes.
  11301. */
  11302. disableDepthWrite: boolean;
  11303. /**
  11304. * Creates a new sprite manager
  11305. * @param name defines the manager's name
  11306. * @param imgUrl defines the sprite sheet url
  11307. * @param capacity defines the maximum allowed number of sprites
  11308. * @param cellSize defines the size of a sprite cell
  11309. * @param scene defines the hosting scene
  11310. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11311. * @param samplingMode defines the smapling mode to use with spritesheet
  11312. * @param fromPacked set to false; do not alter
  11313. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11314. */
  11315. constructor(
  11316. /** defines the manager's name */
  11317. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11318. /**
  11319. * Returns the string "SpriteManager"
  11320. * @returns "SpriteManager"
  11321. */
  11322. getClassName(): string;
  11323. private _makePacked;
  11324. private _appendSpriteVertex;
  11325. private _checkTextureAlpha;
  11326. /**
  11327. * Intersects the sprites with a ray
  11328. * @param ray defines the ray to intersect with
  11329. * @param camera defines the current active camera
  11330. * @param predicate defines a predicate used to select candidate sprites
  11331. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11332. * @returns null if no hit or a PickingInfo
  11333. */
  11334. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11335. /**
  11336. * Intersects the sprites with a ray
  11337. * @param ray defines the ray to intersect with
  11338. * @param camera defines the current active camera
  11339. * @param predicate defines a predicate used to select candidate sprites
  11340. * @returns null if no hit or a PickingInfo array
  11341. */
  11342. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11343. /**
  11344. * Render all child sprites
  11345. */
  11346. render(): void;
  11347. /**
  11348. * Release associated resources
  11349. */
  11350. dispose(): void;
  11351. /**
  11352. * Serializes the sprite manager to a JSON object
  11353. * @param serializeTexture defines if the texture must be serialized as well
  11354. * @returns the JSON object
  11355. */
  11356. serialize(serializeTexture?: boolean): any;
  11357. /**
  11358. * Parses a JSON object to create a new sprite manager.
  11359. * @param parsedManager The JSON object to parse
  11360. * @param scene The scene to create the sprite managerin
  11361. * @param rootUrl The root url to use to load external dependencies like texture
  11362. * @returns the new sprite manager
  11363. */
  11364. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11365. /**
  11366. * Creates a sprite manager from a snippet saved in a remote file
  11367. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11368. * @param url defines the url to load from
  11369. * @param scene defines the hosting scene
  11370. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11371. * @returns a promise that will resolve to the new sprite manager
  11372. */
  11373. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11374. /**
  11375. * Creates a sprite manager from a snippet saved by the sprite editor
  11376. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  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 CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. }
  11383. }
  11384. declare module "babylonjs/Misc/gradients" {
  11385. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11386. /** Interface used by value gradients (color, factor, ...) */
  11387. export interface IValueGradient {
  11388. /**
  11389. * Gets or sets the gradient value (between 0 and 1)
  11390. */
  11391. gradient: number;
  11392. }
  11393. /** Class used to store color4 gradient */
  11394. export class ColorGradient implements IValueGradient {
  11395. /**
  11396. * Gets or sets the gradient value (between 0 and 1)
  11397. */
  11398. gradient: number;
  11399. /**
  11400. * Gets or sets first associated color
  11401. */
  11402. color1: Color4;
  11403. /**
  11404. * Gets or sets second associated color
  11405. */
  11406. color2?: Color4 | undefined;
  11407. /**
  11408. * Creates a new color4 gradient
  11409. * @param gradient gets or sets the gradient value (between 0 and 1)
  11410. * @param color1 gets or sets first associated color
  11411. * @param color2 gets or sets first second color
  11412. */
  11413. constructor(
  11414. /**
  11415. * Gets or sets the gradient value (between 0 and 1)
  11416. */
  11417. gradient: number,
  11418. /**
  11419. * Gets or sets first associated color
  11420. */
  11421. color1: Color4,
  11422. /**
  11423. * Gets or sets second associated color
  11424. */
  11425. color2?: Color4 | undefined);
  11426. /**
  11427. * Will get a color picked randomly between color1 and color2.
  11428. * If color2 is undefined then color1 will be used
  11429. * @param result defines the target Color4 to store the result in
  11430. */
  11431. getColorToRef(result: Color4): void;
  11432. }
  11433. /** Class used to store color 3 gradient */
  11434. export class Color3Gradient implements IValueGradient {
  11435. /**
  11436. * Gets or sets the gradient value (between 0 and 1)
  11437. */
  11438. gradient: number;
  11439. /**
  11440. * Gets or sets the associated color
  11441. */
  11442. color: Color3;
  11443. /**
  11444. * Creates a new color3 gradient
  11445. * @param gradient gets or sets the gradient value (between 0 and 1)
  11446. * @param color gets or sets associated color
  11447. */
  11448. constructor(
  11449. /**
  11450. * Gets or sets the gradient value (between 0 and 1)
  11451. */
  11452. gradient: number,
  11453. /**
  11454. * Gets or sets the associated color
  11455. */
  11456. color: Color3);
  11457. }
  11458. /** Class used to store factor gradient */
  11459. export class FactorGradient implements IValueGradient {
  11460. /**
  11461. * Gets or sets the gradient value (between 0 and 1)
  11462. */
  11463. gradient: number;
  11464. /**
  11465. * Gets or sets first associated factor
  11466. */
  11467. factor1: number;
  11468. /**
  11469. * Gets or sets second associated factor
  11470. */
  11471. factor2?: number | undefined;
  11472. /**
  11473. * Creates a new factor gradient
  11474. * @param gradient gets or sets the gradient value (between 0 and 1)
  11475. * @param factor1 gets or sets first associated factor
  11476. * @param factor2 gets or sets second associated factor
  11477. */
  11478. constructor(
  11479. /**
  11480. * Gets or sets the gradient value (between 0 and 1)
  11481. */
  11482. gradient: number,
  11483. /**
  11484. * Gets or sets first associated factor
  11485. */
  11486. factor1: number,
  11487. /**
  11488. * Gets or sets second associated factor
  11489. */
  11490. factor2?: number | undefined);
  11491. /**
  11492. * Will get a number picked randomly between factor1 and factor2.
  11493. * If factor2 is undefined then factor1 will be used
  11494. * @returns the picked number
  11495. */
  11496. getFactor(): number;
  11497. }
  11498. /**
  11499. * Helper used to simplify some generic gradient tasks
  11500. */
  11501. export class GradientHelper {
  11502. /**
  11503. * Gets the current gradient from an array of IValueGradient
  11504. * @param ratio defines the current ratio to get
  11505. * @param gradients defines the array of IValueGradient
  11506. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11507. */
  11508. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11509. }
  11510. }
  11511. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11512. import { Nullable } from "babylonjs/types";
  11513. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11514. import { Scene } from "babylonjs/scene";
  11515. module "babylonjs/Engines/thinEngine" {
  11516. interface ThinEngine {
  11517. /**
  11518. * Creates a raw texture
  11519. * @param data defines the data to store in the texture
  11520. * @param width defines the width of the texture
  11521. * @param height defines the height of the texture
  11522. * @param format defines the format of the data
  11523. * @param generateMipMaps defines if the engine should generate the mip levels
  11524. * @param invertY defines if data must be stored with Y axis inverted
  11525. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11526. * @param compression defines the compression used (null by default)
  11527. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11528. * @returns the raw texture inside an InternalTexture
  11529. */
  11530. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11531. /**
  11532. * Update a raw texture
  11533. * @param texture defines the texture to update
  11534. * @param data defines the data to store in the texture
  11535. * @param format defines the format of the data
  11536. * @param invertY defines if data must be stored with Y axis inverted
  11537. */
  11538. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  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. * @param compression defines the compression used (null by default)
  11546. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11547. */
  11548. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11549. /**
  11550. * Creates a new raw cube texture
  11551. * @param data defines the array of data to use to create each face
  11552. * @param size defines the size of the textures
  11553. * @param format defines the format of the data
  11554. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11555. * @param generateMipMaps defines if the engine should generate the mip levels
  11556. * @param invertY defines if data must be stored with Y axis inverted
  11557. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11558. * @param compression defines the compression used (null by default)
  11559. * @returns the cube texture as an InternalTexture
  11560. */
  11561. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11562. /**
  11563. * Update a raw cube texture
  11564. * @param texture defines the texture to udpdate
  11565. * @param data defines the data to store
  11566. * @param format defines the data format
  11567. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11568. * @param invertY defines if data must be stored with Y axis inverted
  11569. */
  11570. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11571. /**
  11572. * Update a raw cube texture
  11573. * @param texture defines the texture to udpdate
  11574. * @param data defines the data to store
  11575. * @param format defines the data format
  11576. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11577. * @param invertY defines if data must be stored with Y axis inverted
  11578. * @param compression defines the compression used (null by default)
  11579. */
  11580. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11581. /**
  11582. * Update a raw cube texture
  11583. * @param texture defines the texture to udpdate
  11584. * @param data defines the data to store
  11585. * @param format defines the data format
  11586. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11587. * @param invertY defines if data must be stored with Y axis inverted
  11588. * @param compression defines the compression used (null by default)
  11589. * @param level defines which level of the texture to update
  11590. */
  11591. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11592. /**
  11593. * Creates a new raw cube texture from a specified url
  11594. * @param url defines the url where the data is located
  11595. * @param scene defines the current scene
  11596. * @param size defines the size of the textures
  11597. * @param format defines the format of the data
  11598. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11599. * @param noMipmap defines if the engine should avoid generating the mip levels
  11600. * @param callback defines a callback used to extract texture data from loaded data
  11601. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11602. * @param onLoad defines a callback called when texture is loaded
  11603. * @param onError defines a callback called if there is an error
  11604. * @returns the cube texture as an InternalTexture
  11605. */
  11606. 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;
  11607. /**
  11608. * Creates a new raw cube texture from a specified url
  11609. * @param url defines the url where the data is located
  11610. * @param scene defines the current scene
  11611. * @param size defines the size of the textures
  11612. * @param format defines the format of the data
  11613. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11614. * @param noMipmap defines if the engine should avoid generating the mip levels
  11615. * @param callback defines a callback used to extract texture data from loaded data
  11616. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11617. * @param onLoad defines a callback called when texture is loaded
  11618. * @param onError defines a callback called if there is an error
  11619. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11620. * @param invertY defines if data must be stored with Y axis inverted
  11621. * @returns the cube texture as an InternalTexture
  11622. */
  11623. 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;
  11624. /**
  11625. * Creates a new raw 3D texture
  11626. * @param data defines the data used to create the texture
  11627. * @param width defines the width of the texture
  11628. * @param height defines the height of the texture
  11629. * @param depth defines the depth of the texture
  11630. * @param format defines the format of the texture
  11631. * @param generateMipMaps defines if the engine must generate mip levels
  11632. * @param invertY defines if data must be stored with Y axis inverted
  11633. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11634. * @param compression defines the compressed used (can be null)
  11635. * @param textureType defines the compressed used (can be null)
  11636. * @returns a new raw 3D texture (stored in an InternalTexture)
  11637. */
  11638. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11639. /**
  11640. * Update a raw 3D texture
  11641. * @param texture defines the texture to update
  11642. * @param data defines the data to store
  11643. * @param format defines the data format
  11644. * @param invertY defines if data must be stored with Y axis inverted
  11645. */
  11646. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  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. * @param compression defines the used compression (can be null)
  11654. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11655. */
  11656. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11657. /**
  11658. * Creates a new raw 2D array texture
  11659. * @param data defines the data used to create the texture
  11660. * @param width defines the width of the texture
  11661. * @param height defines the height of the texture
  11662. * @param depth defines the number of layers of the texture
  11663. * @param format defines the format of the texture
  11664. * @param generateMipMaps defines if the engine must generate mip levels
  11665. * @param invertY defines if data must be stored with Y axis inverted
  11666. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11667. * @param compression defines the compressed used (can be null)
  11668. * @param textureType defines the compressed used (can be null)
  11669. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11670. */
  11671. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11672. /**
  11673. * Update a raw 2D array texture
  11674. * @param texture defines the texture to update
  11675. * @param data defines the data to store
  11676. * @param format defines the data format
  11677. * @param invertY defines if data must be stored with Y axis inverted
  11678. */
  11679. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  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. * @param compression defines the used compression (can be null)
  11687. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11688. */
  11689. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11690. }
  11691. }
  11692. }
  11693. declare module "babylonjs/Materials/Textures/rawTexture" {
  11694. import { Scene } from "babylonjs/scene";
  11695. import { Texture } from "babylonjs/Materials/Textures/texture";
  11696. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11697. /**
  11698. * Raw texture can help creating a texture directly from an array of data.
  11699. * This can be super useful if you either get the data from an uncompressed source or
  11700. * if you wish to create your texture pixel by pixel.
  11701. */
  11702. export class RawTexture extends Texture {
  11703. /**
  11704. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11705. */
  11706. format: number;
  11707. /**
  11708. * Instantiates a new RawTexture.
  11709. * Raw texture can help creating a texture directly from an array of data.
  11710. * This can be super useful if you either get the data from an uncompressed source or
  11711. * if you wish to create your texture pixel by pixel.
  11712. * @param data define the array of data to use to create the texture
  11713. * @param width define the width of the texture
  11714. * @param height define the height of the texture
  11715. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11716. * @param scene define the scene the texture belongs to
  11717. * @param generateMipMaps define whether mip maps should be generated or not
  11718. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11719. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11720. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11721. */
  11722. constructor(data: ArrayBufferView, width: number, height: number,
  11723. /**
  11724. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11725. */
  11726. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11727. /**
  11728. * Updates the texture underlying data.
  11729. * @param data Define the new data of the texture
  11730. */
  11731. update(data: ArrayBufferView): void;
  11732. /**
  11733. * Creates a luminance texture from some data.
  11734. * @param data Define the texture data
  11735. * @param width Define the width of the texture
  11736. * @param height Define the height of the texture
  11737. * @param scene Define the scene the texture belongs to
  11738. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11739. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11740. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11741. * @returns the luminance texture
  11742. */
  11743. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11744. /**
  11745. * Creates a luminance alpha texture from some data.
  11746. * @param data Define the texture data
  11747. * @param width Define the width of the texture
  11748. * @param height Define the height of the texture
  11749. * @param scene Define the scene the texture belongs to
  11750. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11751. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11752. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11753. * @returns the luminance alpha texture
  11754. */
  11755. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11756. /**
  11757. * Creates an alpha texture from some data.
  11758. * @param data Define the texture data
  11759. * @param width Define the width of the texture
  11760. * @param height Define the height of the texture
  11761. * @param scene Define the scene the texture belongs to
  11762. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11763. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11764. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11765. * @returns the alpha texture
  11766. */
  11767. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11768. /**
  11769. * Creates a RGB texture from some data.
  11770. * @param data Define the texture data
  11771. * @param width Define the width of the texture
  11772. * @param height Define the height of the texture
  11773. * @param scene Define the scene the texture belongs to
  11774. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11775. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11776. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11777. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11778. * @returns the RGB alpha texture
  11779. */
  11780. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11781. /**
  11782. * Creates a RGBA texture from some data.
  11783. * @param data Define the texture data
  11784. * @param width Define the width of the texture
  11785. * @param height Define the height of the texture
  11786. * @param scene Define the scene the texture belongs to
  11787. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11788. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11789. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11790. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11791. * @returns the RGBA texture
  11792. */
  11793. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11794. /**
  11795. * Creates a R texture from some data.
  11796. * @param data Define the texture data
  11797. * @param width Define the width of the texture
  11798. * @param height Define the height of the texture
  11799. * @param scene Define the scene the texture belongs to
  11800. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11801. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11802. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11803. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11804. * @returns the R texture
  11805. */
  11806. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11807. }
  11808. }
  11809. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11810. import { Scene } from "babylonjs/scene";
  11811. import { ISceneComponent } from "babylonjs/sceneComponent";
  11812. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11813. module "babylonjs/abstractScene" {
  11814. interface AbstractScene {
  11815. /**
  11816. * The list of procedural textures added to the scene
  11817. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11818. */
  11819. proceduralTextures: Array<ProceduralTexture>;
  11820. }
  11821. }
  11822. /**
  11823. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11824. * in a given scene.
  11825. */
  11826. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11827. /**
  11828. * The component name helpfull to identify the component in the list of scene components.
  11829. */
  11830. readonly name: string;
  11831. /**
  11832. * The scene the component belongs to.
  11833. */
  11834. scene: Scene;
  11835. /**
  11836. * Creates a new instance of the component for the given scene
  11837. * @param scene Defines the scene to register the component in
  11838. */
  11839. constructor(scene: Scene);
  11840. /**
  11841. * Registers the component in a given scene
  11842. */
  11843. register(): void;
  11844. /**
  11845. * Rebuilds the elements related to this component in case of
  11846. * context lost for instance.
  11847. */
  11848. rebuild(): void;
  11849. /**
  11850. * Disposes the component and the associated ressources.
  11851. */
  11852. dispose(): void;
  11853. private _beforeClear;
  11854. }
  11855. }
  11856. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11857. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11858. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11859. module "babylonjs/Engines/thinEngine" {
  11860. interface ThinEngine {
  11861. /**
  11862. * Creates a new render target cube texture
  11863. * @param size defines the size of the texture
  11864. * @param options defines the options used to create the texture
  11865. * @returns a new render target cube texture stored in an InternalTexture
  11866. */
  11867. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11868. }
  11869. }
  11870. }
  11871. declare module "babylonjs/Shaders/procedural.vertex" {
  11872. /** @hidden */
  11873. export var proceduralVertexShader: {
  11874. name: string;
  11875. shader: string;
  11876. };
  11877. }
  11878. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11879. import { Observable } from "babylonjs/Misc/observable";
  11880. import { Nullable } from "babylonjs/types";
  11881. import { Scene } from "babylonjs/scene";
  11882. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11883. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11884. import { Effect } from "babylonjs/Materials/effect";
  11885. import { Texture } from "babylonjs/Materials/Textures/texture";
  11886. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11887. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11888. import "babylonjs/Shaders/procedural.vertex";
  11889. /**
  11890. * 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.
  11891. * This is the base class of any Procedural texture and contains most of the shareable code.
  11892. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11893. */
  11894. export class ProceduralTexture extends Texture {
  11895. isCube: boolean;
  11896. /**
  11897. * Define if the texture is enabled or not (disabled texture will not render)
  11898. */
  11899. isEnabled: boolean;
  11900. /**
  11901. * Define if the texture must be cleared before rendering (default is true)
  11902. */
  11903. autoClear: boolean;
  11904. /**
  11905. * Callback called when the texture is generated
  11906. */
  11907. onGenerated: () => void;
  11908. /**
  11909. * Event raised when the texture is generated
  11910. */
  11911. onGeneratedObservable: Observable<ProceduralTexture>;
  11912. /** @hidden */
  11913. _generateMipMaps: boolean;
  11914. /** @hidden **/
  11915. _effect: Effect;
  11916. /** @hidden */
  11917. _textures: {
  11918. [key: string]: Texture;
  11919. };
  11920. /** @hidden */
  11921. protected _fallbackTexture: Nullable<Texture>;
  11922. private _size;
  11923. private _currentRefreshId;
  11924. private _frameId;
  11925. private _refreshRate;
  11926. private _vertexBuffers;
  11927. private _indexBuffer;
  11928. private _uniforms;
  11929. private _samplers;
  11930. private _fragment;
  11931. private _floats;
  11932. private _ints;
  11933. private _floatsArrays;
  11934. private _colors3;
  11935. private _colors4;
  11936. private _vectors2;
  11937. private _vectors3;
  11938. private _matrices;
  11939. private _fallbackTextureUsed;
  11940. private _fullEngine;
  11941. private _cachedDefines;
  11942. private _contentUpdateId;
  11943. private _contentData;
  11944. /**
  11945. * Instantiates a new procedural texture.
  11946. * 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.
  11947. * This is the base class of any Procedural texture and contains most of the shareable code.
  11948. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11949. * @param name Define the name of the texture
  11950. * @param size Define the size of the texture to create
  11951. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11952. * @param scene Define the scene the texture belongs to
  11953. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11954. * @param generateMipMaps Define if the texture should creates mip maps or not
  11955. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11956. */
  11957. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11958. /**
  11959. * The effect that is created when initializing the post process.
  11960. * @returns The created effect corresponding the the postprocess.
  11961. */
  11962. getEffect(): Effect;
  11963. /**
  11964. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11965. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11966. */
  11967. getContent(): Nullable<ArrayBufferView>;
  11968. private _createIndexBuffer;
  11969. /** @hidden */
  11970. _rebuild(): void;
  11971. /**
  11972. * Resets the texture in order to recreate its associated resources.
  11973. * This can be called in case of context loss
  11974. */
  11975. reset(): void;
  11976. protected _getDefines(): string;
  11977. /**
  11978. * Is the texture ready to be used ? (rendered at least once)
  11979. * @returns true if ready, otherwise, false.
  11980. */
  11981. isReady(): boolean;
  11982. /**
  11983. * Resets the refresh counter of the texture and start bak from scratch.
  11984. * Could be useful to regenerate the texture if it is setup to render only once.
  11985. */
  11986. resetRefreshCounter(): void;
  11987. /**
  11988. * Set the fragment shader to use in order to render the texture.
  11989. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  11990. */
  11991. setFragment(fragment: any): void;
  11992. /**
  11993. * Define the refresh rate of the texture or the rendering frequency.
  11994. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  11995. */
  11996. get refreshRate(): number;
  11997. set refreshRate(value: number);
  11998. /** @hidden */
  11999. _shouldRender(): boolean;
  12000. /**
  12001. * Get the size the texture is rendering at.
  12002. * @returns the size (texture is always squared)
  12003. */
  12004. getRenderSize(): number;
  12005. /**
  12006. * Resize the texture to new value.
  12007. * @param size Define the new size the texture should have
  12008. * @param generateMipMaps Define whether the new texture should create mip maps
  12009. */
  12010. resize(size: number, generateMipMaps: boolean): void;
  12011. private _checkUniform;
  12012. /**
  12013. * Set a texture in the shader program used to render.
  12014. * @param name Define the name of the uniform samplers as defined in the shader
  12015. * @param texture Define the texture to bind to this sampler
  12016. * @return the texture itself allowing "fluent" like uniform updates
  12017. */
  12018. setTexture(name: string, texture: Texture): ProceduralTexture;
  12019. /**
  12020. * Set a float in the shader.
  12021. * @param name Define the name of the uniform as defined in the shader
  12022. * @param value Define the value to give to the uniform
  12023. * @return the texture itself allowing "fluent" like uniform updates
  12024. */
  12025. setFloat(name: string, value: number): ProceduralTexture;
  12026. /**
  12027. * Set a int in the shader.
  12028. * @param name Define the name of the uniform as defined in the shader
  12029. * @param value Define the value to give to the uniform
  12030. * @return the texture itself allowing "fluent" like uniform updates
  12031. */
  12032. setInt(name: string, value: number): ProceduralTexture;
  12033. /**
  12034. * Set an array of floats in the shader.
  12035. * @param name Define the name of the uniform as defined in the shader
  12036. * @param value Define the value to give to the uniform
  12037. * @return the texture itself allowing "fluent" like uniform updates
  12038. */
  12039. setFloats(name: string, value: number[]): ProceduralTexture;
  12040. /**
  12041. * Set a vec3 in the shader from a Color3.
  12042. * @param name Define the name of the uniform as defined in the shader
  12043. * @param value Define the value to give to the uniform
  12044. * @return the texture itself allowing "fluent" like uniform updates
  12045. */
  12046. setColor3(name: string, value: Color3): ProceduralTexture;
  12047. /**
  12048. * Set a vec4 in the shader from a Color4.
  12049. * @param name Define the name of the uniform as defined in the shader
  12050. * @param value Define the value to give to the uniform
  12051. * @return the texture itself allowing "fluent" like uniform updates
  12052. */
  12053. setColor4(name: string, value: Color4): ProceduralTexture;
  12054. /**
  12055. * Set a vec2 in the shader from a Vector2.
  12056. * @param name Define the name of the uniform as defined in the shader
  12057. * @param value Define the value to give to the uniform
  12058. * @return the texture itself allowing "fluent" like uniform updates
  12059. */
  12060. setVector2(name: string, value: Vector2): ProceduralTexture;
  12061. /**
  12062. * Set a vec3 in the shader from a Vector3.
  12063. * @param name Define the name of the uniform as defined in the shader
  12064. * @param value Define the value to give to the uniform
  12065. * @return the texture itself allowing "fluent" like uniform updates
  12066. */
  12067. setVector3(name: string, value: Vector3): ProceduralTexture;
  12068. /**
  12069. * Set a mat4 in the shader from a MAtrix.
  12070. * @param name Define the name of the uniform as defined in the shader
  12071. * @param value Define the value to give to the uniform
  12072. * @return the texture itself allowing "fluent" like uniform updates
  12073. */
  12074. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12075. /**
  12076. * Render the texture to its associated render target.
  12077. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12078. */
  12079. render(useCameraPostProcess?: boolean): void;
  12080. /**
  12081. * Clone the texture.
  12082. * @returns the cloned texture
  12083. */
  12084. clone(): ProceduralTexture;
  12085. /**
  12086. * Dispose the texture and release its asoociated resources.
  12087. */
  12088. dispose(): void;
  12089. }
  12090. }
  12091. declare module "babylonjs/Particles/baseParticleSystem" {
  12092. import { Nullable } from "babylonjs/types";
  12093. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12094. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12095. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12096. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12097. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12098. import { Scene } from "babylonjs/scene";
  12099. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12100. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12101. import { Texture } from "babylonjs/Materials/Textures/texture";
  12102. import { Color4 } from "babylonjs/Maths/math.color";
  12103. import { Animation } from "babylonjs/Animations/animation";
  12104. /**
  12105. * This represents the base class for particle system in Babylon.
  12106. * 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.
  12107. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12108. * @example https://doc.babylonjs.com/babylon101/particles
  12109. */
  12110. export class BaseParticleSystem {
  12111. /**
  12112. * Source color is added to the destination color without alpha affecting the result
  12113. */
  12114. static BLENDMODE_ONEONE: number;
  12115. /**
  12116. * Blend current color and particle color using particle’s alpha
  12117. */
  12118. static BLENDMODE_STANDARD: number;
  12119. /**
  12120. * Add current color and particle color multiplied by particle’s alpha
  12121. */
  12122. static BLENDMODE_ADD: number;
  12123. /**
  12124. * Multiply current color with particle color
  12125. */
  12126. static BLENDMODE_MULTIPLY: number;
  12127. /**
  12128. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12129. */
  12130. static BLENDMODE_MULTIPLYADD: number;
  12131. /**
  12132. * List of animations used by the particle system.
  12133. */
  12134. animations: Animation[];
  12135. /**
  12136. * Gets or sets the unique id of the particle system
  12137. */
  12138. uniqueId: number;
  12139. /**
  12140. * The id of the Particle system.
  12141. */
  12142. id: string;
  12143. /**
  12144. * The friendly name of the Particle system.
  12145. */
  12146. name: string;
  12147. /**
  12148. * Snippet ID if the particle system was created from the snippet server
  12149. */
  12150. snippetId: string;
  12151. /**
  12152. * The rendering group used by the Particle system to chose when to render.
  12153. */
  12154. renderingGroupId: number;
  12155. /**
  12156. * The emitter represents the Mesh or position we are attaching the particle system to.
  12157. */
  12158. emitter: Nullable<AbstractMesh | Vector3>;
  12159. /**
  12160. * The maximum number of particles to emit per frame
  12161. */
  12162. emitRate: number;
  12163. /**
  12164. * If you want to launch only a few particles at once, that can be done, as well.
  12165. */
  12166. manualEmitCount: number;
  12167. /**
  12168. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12169. */
  12170. updateSpeed: number;
  12171. /**
  12172. * The amount of time the particle system is running (depends of the overall update speed).
  12173. */
  12174. targetStopDuration: number;
  12175. /**
  12176. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12177. */
  12178. disposeOnStop: boolean;
  12179. /**
  12180. * Minimum power of emitting particles.
  12181. */
  12182. minEmitPower: number;
  12183. /**
  12184. * Maximum power of emitting particles.
  12185. */
  12186. maxEmitPower: number;
  12187. /**
  12188. * Minimum life time of emitting particles.
  12189. */
  12190. minLifeTime: number;
  12191. /**
  12192. * Maximum life time of emitting particles.
  12193. */
  12194. maxLifeTime: number;
  12195. /**
  12196. * Minimum Size of emitting particles.
  12197. */
  12198. minSize: number;
  12199. /**
  12200. * Maximum Size of emitting particles.
  12201. */
  12202. maxSize: number;
  12203. /**
  12204. * Minimum scale of emitting particles on X axis.
  12205. */
  12206. minScaleX: number;
  12207. /**
  12208. * Maximum scale of emitting particles on X axis.
  12209. */
  12210. maxScaleX: number;
  12211. /**
  12212. * Minimum scale of emitting particles on Y axis.
  12213. */
  12214. minScaleY: number;
  12215. /**
  12216. * Maximum scale of emitting particles on Y axis.
  12217. */
  12218. maxScaleY: number;
  12219. /**
  12220. * Gets or sets the minimal initial rotation in radians.
  12221. */
  12222. minInitialRotation: number;
  12223. /**
  12224. * Gets or sets the maximal initial rotation in radians.
  12225. */
  12226. maxInitialRotation: number;
  12227. /**
  12228. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12229. */
  12230. minAngularSpeed: number;
  12231. /**
  12232. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12233. */
  12234. maxAngularSpeed: number;
  12235. /**
  12236. * The texture used to render each particle. (this can be a spritesheet)
  12237. */
  12238. particleTexture: Nullable<Texture>;
  12239. /**
  12240. * The layer mask we are rendering the particles through.
  12241. */
  12242. layerMask: number;
  12243. /**
  12244. * This can help using your own shader to render the particle system.
  12245. * The according effect will be created
  12246. */
  12247. customShader: any;
  12248. /**
  12249. * By default particle system starts as soon as they are created. This prevents the
  12250. * automatic start to happen and let you decide when to start emitting particles.
  12251. */
  12252. preventAutoStart: boolean;
  12253. private _noiseTexture;
  12254. /**
  12255. * Gets or sets a texture used to add random noise to particle positions
  12256. */
  12257. get noiseTexture(): Nullable<ProceduralTexture>;
  12258. set noiseTexture(value: Nullable<ProceduralTexture>);
  12259. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12260. noiseStrength: Vector3;
  12261. /**
  12262. * Callback triggered when the particle animation is ending.
  12263. */
  12264. onAnimationEnd: Nullable<() => void>;
  12265. /**
  12266. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12267. */
  12268. blendMode: number;
  12269. /**
  12270. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12271. * to override the particles.
  12272. */
  12273. forceDepthWrite: boolean;
  12274. /** 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 */
  12275. preWarmCycles: number;
  12276. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12277. preWarmStepOffset: number;
  12278. /**
  12279. * 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)
  12280. */
  12281. spriteCellChangeSpeed: number;
  12282. /**
  12283. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12284. */
  12285. startSpriteCellID: number;
  12286. /**
  12287. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12288. */
  12289. endSpriteCellID: number;
  12290. /**
  12291. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12292. */
  12293. spriteCellWidth: number;
  12294. /**
  12295. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12296. */
  12297. spriteCellHeight: number;
  12298. /**
  12299. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12300. */
  12301. spriteRandomStartCell: boolean;
  12302. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12303. translationPivot: Vector2;
  12304. /** @hidden */
  12305. protected _isAnimationSheetEnabled: boolean;
  12306. /**
  12307. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12308. */
  12309. beginAnimationOnStart: boolean;
  12310. /**
  12311. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12312. */
  12313. beginAnimationFrom: number;
  12314. /**
  12315. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12316. */
  12317. beginAnimationTo: number;
  12318. /**
  12319. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12320. */
  12321. beginAnimationLoop: boolean;
  12322. /**
  12323. * Gets or sets a world offset applied to all particles
  12324. */
  12325. worldOffset: Vector3;
  12326. /**
  12327. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12328. */
  12329. get isAnimationSheetEnabled(): boolean;
  12330. set isAnimationSheetEnabled(value: boolean);
  12331. /**
  12332. * Get hosting scene
  12333. * @returns the scene
  12334. */
  12335. getScene(): Scene;
  12336. /**
  12337. * You can use gravity if you want to give an orientation to your particles.
  12338. */
  12339. gravity: Vector3;
  12340. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12341. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12342. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12343. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12344. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12345. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12346. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12347. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12348. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12349. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12350. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12351. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12352. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12353. /**
  12354. * Defines the delay in milliseconds before starting the system (0 by default)
  12355. */
  12356. startDelay: number;
  12357. /**
  12358. * Gets the current list of drag gradients.
  12359. * You must use addDragGradient and removeDragGradient to udpate this list
  12360. * @returns the list of drag gradients
  12361. */
  12362. getDragGradients(): Nullable<Array<FactorGradient>>;
  12363. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12364. limitVelocityDamping: number;
  12365. /**
  12366. * Gets the current list of limit velocity gradients.
  12367. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12368. * @returns the list of limit velocity gradients
  12369. */
  12370. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12371. /**
  12372. * Gets the current list of color gradients.
  12373. * You must use addColorGradient and removeColorGradient to udpate this list
  12374. * @returns the list of color gradients
  12375. */
  12376. getColorGradients(): Nullable<Array<ColorGradient>>;
  12377. /**
  12378. * Gets the current list of size gradients.
  12379. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12380. * @returns the list of size gradients
  12381. */
  12382. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12383. /**
  12384. * Gets the current list of color remap gradients.
  12385. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12386. * @returns the list of color remap gradients
  12387. */
  12388. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12389. /**
  12390. * Gets the current list of alpha remap gradients.
  12391. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12392. * @returns the list of alpha remap gradients
  12393. */
  12394. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12395. /**
  12396. * Gets the current list of life time gradients.
  12397. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12398. * @returns the list of life time gradients
  12399. */
  12400. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12401. /**
  12402. * Gets the current list of angular speed gradients.
  12403. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12404. * @returns the list of angular speed gradients
  12405. */
  12406. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12407. /**
  12408. * Gets the current list of velocity gradients.
  12409. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12410. * @returns the list of velocity gradients
  12411. */
  12412. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12413. /**
  12414. * Gets the current list of start size gradients.
  12415. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12416. * @returns the list of start size gradients
  12417. */
  12418. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12419. /**
  12420. * Gets the current list of emit rate gradients.
  12421. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12422. * @returns the list of emit rate gradients
  12423. */
  12424. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12425. /**
  12426. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12427. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12428. */
  12429. get direction1(): Vector3;
  12430. set direction1(value: Vector3);
  12431. /**
  12432. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12433. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12434. */
  12435. get direction2(): Vector3;
  12436. set direction2(value: Vector3);
  12437. /**
  12438. * 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.
  12439. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12440. */
  12441. get minEmitBox(): Vector3;
  12442. set minEmitBox(value: Vector3);
  12443. /**
  12444. * 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.
  12445. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12446. */
  12447. get maxEmitBox(): Vector3;
  12448. set maxEmitBox(value: Vector3);
  12449. /**
  12450. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12451. */
  12452. color1: Color4;
  12453. /**
  12454. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12455. */
  12456. color2: Color4;
  12457. /**
  12458. * Color the particle will have at the end of its lifetime
  12459. */
  12460. colorDead: Color4;
  12461. /**
  12462. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12463. */
  12464. textureMask: Color4;
  12465. /**
  12466. * The particle emitter type defines the emitter used by the particle system.
  12467. * It can be for example box, sphere, or cone...
  12468. */
  12469. particleEmitterType: IParticleEmitterType;
  12470. /** @hidden */
  12471. _isSubEmitter: boolean;
  12472. /**
  12473. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12474. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12475. */
  12476. billboardMode: number;
  12477. protected _isBillboardBased: boolean;
  12478. /**
  12479. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12480. */
  12481. get isBillboardBased(): boolean;
  12482. set isBillboardBased(value: boolean);
  12483. /**
  12484. * The scene the particle system belongs to.
  12485. */
  12486. protected _scene: Scene;
  12487. /**
  12488. * Local cache of defines for image processing.
  12489. */
  12490. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12491. /**
  12492. * Default configuration related to image processing available in the standard Material.
  12493. */
  12494. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  12495. /**
  12496. * Gets the image processing configuration used either in this material.
  12497. */
  12498. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  12499. /**
  12500. * Sets the Default image processing configuration used either in the this material.
  12501. *
  12502. * If sets to null, the scene one is in use.
  12503. */
  12504. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  12505. /**
  12506. * Attaches a new image processing configuration to the Standard Material.
  12507. * @param configuration
  12508. */
  12509. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12510. /** @hidden */
  12511. protected _reset(): void;
  12512. /** @hidden */
  12513. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12514. /**
  12515. * Instantiates a particle system.
  12516. * 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.
  12517. * @param name The name of the particle system
  12518. */
  12519. constructor(name: string);
  12520. /**
  12521. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12522. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12523. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12524. * @returns the emitter
  12525. */
  12526. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12527. /**
  12528. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12529. * @param radius The radius of the hemisphere to emit from
  12530. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12531. * @returns the emitter
  12532. */
  12533. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12534. /**
  12535. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12536. * @param radius The radius of the sphere to emit from
  12537. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12538. * @returns the emitter
  12539. */
  12540. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12541. /**
  12542. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12543. * @param radius The radius of the sphere to emit from
  12544. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12545. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12546. * @returns the emitter
  12547. */
  12548. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12549. /**
  12550. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12551. * @param radius The radius of the emission cylinder
  12552. * @param height The height of the emission cylinder
  12553. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12554. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12555. * @returns the emitter
  12556. */
  12557. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12558. /**
  12559. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12560. * @param radius The radius of the cylinder to emit from
  12561. * @param height The height of the emission cylinder
  12562. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12563. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12564. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12565. * @returns the emitter
  12566. */
  12567. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12568. /**
  12569. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12570. * @param radius The radius of the cone to emit from
  12571. * @param angle The base angle of the cone
  12572. * @returns the emitter
  12573. */
  12574. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12575. /**
  12576. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12577. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12578. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12579. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12580. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12581. * @returns the emitter
  12582. */
  12583. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12584. }
  12585. }
  12586. declare module "babylonjs/Particles/subEmitter" {
  12587. import { Scene } from "babylonjs/scene";
  12588. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12589. /**
  12590. * Type of sub emitter
  12591. */
  12592. export enum SubEmitterType {
  12593. /**
  12594. * Attached to the particle over it's lifetime
  12595. */
  12596. ATTACHED = 0,
  12597. /**
  12598. * Created when the particle dies
  12599. */
  12600. END = 1
  12601. }
  12602. /**
  12603. * Sub emitter class used to emit particles from an existing particle
  12604. */
  12605. export class SubEmitter {
  12606. /**
  12607. * the particle system to be used by the sub emitter
  12608. */
  12609. particleSystem: ParticleSystem;
  12610. /**
  12611. * Type of the submitter (Default: END)
  12612. */
  12613. type: SubEmitterType;
  12614. /**
  12615. * 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)
  12616. * Note: This only is supported when using an emitter of type Mesh
  12617. */
  12618. inheritDirection: boolean;
  12619. /**
  12620. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12621. */
  12622. inheritedVelocityAmount: number;
  12623. /**
  12624. * Creates a sub emitter
  12625. * @param particleSystem the particle system to be used by the sub emitter
  12626. */
  12627. constructor(
  12628. /**
  12629. * the particle system to be used by the sub emitter
  12630. */
  12631. particleSystem: ParticleSystem);
  12632. /**
  12633. * Clones the sub emitter
  12634. * @returns the cloned sub emitter
  12635. */
  12636. clone(): SubEmitter;
  12637. /**
  12638. * Serialize current object to a JSON object
  12639. * @returns the serialized object
  12640. */
  12641. serialize(): any;
  12642. /** @hidden */
  12643. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  12644. /**
  12645. * Creates a new SubEmitter from a serialized JSON version
  12646. * @param serializationObject defines the JSON object to read from
  12647. * @param scene defines the hosting scene
  12648. * @param rootUrl defines the rootUrl for data loading
  12649. * @returns a new SubEmitter
  12650. */
  12651. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  12652. /** Release associated resources */
  12653. dispose(): void;
  12654. }
  12655. }
  12656. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12657. /** @hidden */
  12658. export var imageProcessingDeclaration: {
  12659. name: string;
  12660. shader: string;
  12661. };
  12662. }
  12663. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12664. /** @hidden */
  12665. export var imageProcessingFunctions: {
  12666. name: string;
  12667. shader: string;
  12668. };
  12669. }
  12670. declare module "babylonjs/Shaders/particles.fragment" {
  12671. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12672. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12673. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12674. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12675. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12676. /** @hidden */
  12677. export var particlesPixelShader: {
  12678. name: string;
  12679. shader: string;
  12680. };
  12681. }
  12682. declare module "babylonjs/Shaders/particles.vertex" {
  12683. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12684. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12685. /** @hidden */
  12686. export var particlesVertexShader: {
  12687. name: string;
  12688. shader: string;
  12689. };
  12690. }
  12691. declare module "babylonjs/Particles/particleSystem" {
  12692. import { Nullable } from "babylonjs/types";
  12693. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12694. import { Observable } from "babylonjs/Misc/observable";
  12695. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12696. import { Effect } from "babylonjs/Materials/effect";
  12697. import { Scene, IDisposable } from "babylonjs/scene";
  12698. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12699. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12700. import { Particle } from "babylonjs/Particles/particle";
  12701. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12702. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12703. import "babylonjs/Shaders/particles.fragment";
  12704. import "babylonjs/Shaders/particles.vertex";
  12705. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12706. /**
  12707. * This represents a particle system in Babylon.
  12708. * 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.
  12709. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12710. * @example https://doc.babylonjs.com/babylon101/particles
  12711. */
  12712. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12713. /**
  12714. * Billboard mode will only apply to Y axis
  12715. */
  12716. static readonly BILLBOARDMODE_Y: number;
  12717. /**
  12718. * Billboard mode will apply to all axes
  12719. */
  12720. static readonly BILLBOARDMODE_ALL: number;
  12721. /**
  12722. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12723. */
  12724. static readonly BILLBOARDMODE_STRETCHED: number;
  12725. /**
  12726. * This function can be defined to provide custom update for active particles.
  12727. * This function will be called instead of regular update (age, position, color, etc.).
  12728. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12729. */
  12730. updateFunction: (particles: Particle[]) => void;
  12731. private _emitterWorldMatrix;
  12732. /**
  12733. * This function can be defined to specify initial direction for every new particle.
  12734. * It by default use the emitterType defined function
  12735. */
  12736. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12737. /**
  12738. * This function can be defined to specify initial position for every new particle.
  12739. * It by default use the emitterType defined function
  12740. */
  12741. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12742. /**
  12743. * @hidden
  12744. */
  12745. _inheritedVelocityOffset: Vector3;
  12746. /**
  12747. * An event triggered when the system is disposed
  12748. */
  12749. onDisposeObservable: Observable<IParticleSystem>;
  12750. private _onDisposeObserver;
  12751. /**
  12752. * Sets a callback that will be triggered when the system is disposed
  12753. */
  12754. set onDispose(callback: () => void);
  12755. private _particles;
  12756. private _epsilon;
  12757. private _capacity;
  12758. private _stockParticles;
  12759. private _newPartsExcess;
  12760. private _vertexData;
  12761. private _vertexBuffer;
  12762. private _vertexBuffers;
  12763. private _spriteBuffer;
  12764. private _indexBuffer;
  12765. private _effect;
  12766. private _customEffect;
  12767. private _cachedDefines;
  12768. private _scaledColorStep;
  12769. private _colorDiff;
  12770. private _scaledDirection;
  12771. private _scaledGravity;
  12772. private _currentRenderId;
  12773. private _alive;
  12774. private _useInstancing;
  12775. private _started;
  12776. private _stopped;
  12777. private _actualFrame;
  12778. private _scaledUpdateSpeed;
  12779. private _vertexBufferSize;
  12780. /** @hidden */
  12781. _currentEmitRateGradient: Nullable<FactorGradient>;
  12782. /** @hidden */
  12783. _currentEmitRate1: number;
  12784. /** @hidden */
  12785. _currentEmitRate2: number;
  12786. /** @hidden */
  12787. _currentStartSizeGradient: Nullable<FactorGradient>;
  12788. /** @hidden */
  12789. _currentStartSize1: number;
  12790. /** @hidden */
  12791. _currentStartSize2: number;
  12792. private readonly _rawTextureWidth;
  12793. private _rampGradientsTexture;
  12794. private _useRampGradients;
  12795. /** Gets or sets a boolean indicating that ramp gradients must be used
  12796. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12797. */
  12798. get useRampGradients(): boolean;
  12799. set useRampGradients(value: boolean);
  12800. /**
  12801. * 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.
  12802. * 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: [])
  12803. */
  12804. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12805. private _subEmitters;
  12806. /**
  12807. * @hidden
  12808. * If the particle systems emitter should be disposed when the particle system is disposed
  12809. */
  12810. _disposeEmitterOnDispose: boolean;
  12811. /**
  12812. * The current active Sub-systems, this property is used by the root particle system only.
  12813. */
  12814. activeSubSystems: Array<ParticleSystem>;
  12815. /**
  12816. * Specifies if the particles are updated in emitter local space or world space
  12817. */
  12818. isLocal: boolean;
  12819. private _rootParticleSystem;
  12820. /**
  12821. * Gets the current list of active particles
  12822. */
  12823. get particles(): Particle[];
  12824. /**
  12825. * Gets the number of particles active at the same time.
  12826. * @returns The number of active particles.
  12827. */
  12828. getActiveCount(): number;
  12829. /**
  12830. * Returns the string "ParticleSystem"
  12831. * @returns a string containing the class name
  12832. */
  12833. getClassName(): string;
  12834. /**
  12835. * Gets a boolean indicating that the system is stopping
  12836. * @returns true if the system is currently stopping
  12837. */
  12838. isStopping(): boolean;
  12839. /**
  12840. * Gets the custom effect used to render the particles
  12841. * @param blendMode Blend mode for which the effect should be retrieved
  12842. * @returns The effect
  12843. */
  12844. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12845. /**
  12846. * Sets the custom effect used to render the particles
  12847. * @param effect The effect to set
  12848. * @param blendMode Blend mode for which the effect should be set
  12849. */
  12850. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12851. /** @hidden */
  12852. private _onBeforeDrawParticlesObservable;
  12853. /**
  12854. * Observable that will be called just before the particles are drawn
  12855. */
  12856. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12857. /**
  12858. * Gets the name of the particle vertex shader
  12859. */
  12860. get vertexShaderName(): string;
  12861. /**
  12862. * Instantiates a particle system.
  12863. * 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.
  12864. * @param name The name of the particle system
  12865. * @param capacity The max number of particles alive at the same time
  12866. * @param scene The scene the particle system belongs to
  12867. * @param customEffect a custom effect used to change the way particles are rendered by default
  12868. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  12869. * @param epsilon Offset used to render the particles
  12870. */
  12871. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  12872. private _addFactorGradient;
  12873. private _removeFactorGradient;
  12874. /**
  12875. * Adds a new life time gradient
  12876. * @param gradient defines the gradient to use (between 0 and 1)
  12877. * @param factor defines the life time factor to affect to the specified gradient
  12878. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12879. * @returns the current particle system
  12880. */
  12881. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12882. /**
  12883. * Remove a specific life time gradient
  12884. * @param gradient defines the gradient to remove
  12885. * @returns the current particle system
  12886. */
  12887. removeLifeTimeGradient(gradient: number): IParticleSystem;
  12888. /**
  12889. * Adds a new size gradient
  12890. * @param gradient defines the gradient to use (between 0 and 1)
  12891. * @param factor defines the size factor to affect to the specified gradient
  12892. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12893. * @returns the current particle system
  12894. */
  12895. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12896. /**
  12897. * Remove a specific size gradient
  12898. * @param gradient defines the gradient to remove
  12899. * @returns the current particle system
  12900. */
  12901. removeSizeGradient(gradient: number): IParticleSystem;
  12902. /**
  12903. * Adds a new color remap gradient
  12904. * @param gradient defines the gradient to use (between 0 and 1)
  12905. * @param min defines the color remap minimal range
  12906. * @param max defines the color remap maximal range
  12907. * @returns the current particle system
  12908. */
  12909. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12910. /**
  12911. * Remove a specific color remap gradient
  12912. * @param gradient defines the gradient to remove
  12913. * @returns the current particle system
  12914. */
  12915. removeColorRemapGradient(gradient: number): IParticleSystem;
  12916. /**
  12917. * Adds a new alpha remap gradient
  12918. * @param gradient defines the gradient to use (between 0 and 1)
  12919. * @param min defines the alpha remap minimal range
  12920. * @param max defines the alpha remap maximal range
  12921. * @returns the current particle system
  12922. */
  12923. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12924. /**
  12925. * Remove a specific alpha remap gradient
  12926. * @param gradient defines the gradient to remove
  12927. * @returns the current particle system
  12928. */
  12929. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  12930. /**
  12931. * Adds a new angular speed gradient
  12932. * @param gradient defines the gradient to use (between 0 and 1)
  12933. * @param factor defines the angular speed to affect to the specified gradient
  12934. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12935. * @returns the current particle system
  12936. */
  12937. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12938. /**
  12939. * Remove a specific angular speed gradient
  12940. * @param gradient defines the gradient to remove
  12941. * @returns the current particle system
  12942. */
  12943. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  12944. /**
  12945. * Adds a new velocity gradient
  12946. * @param gradient defines the gradient to use (between 0 and 1)
  12947. * @param factor defines the velocity to affect to the specified gradient
  12948. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12949. * @returns the current particle system
  12950. */
  12951. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12952. /**
  12953. * Remove a specific velocity gradient
  12954. * @param gradient defines the gradient to remove
  12955. * @returns the current particle system
  12956. */
  12957. removeVelocityGradient(gradient: number): IParticleSystem;
  12958. /**
  12959. * Adds a new limit velocity gradient
  12960. * @param gradient defines the gradient to use (between 0 and 1)
  12961. * @param factor defines the limit velocity value to affect to the specified gradient
  12962. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12963. * @returns the current particle system
  12964. */
  12965. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12966. /**
  12967. * Remove a specific limit velocity gradient
  12968. * @param gradient defines the gradient to remove
  12969. * @returns the current particle system
  12970. */
  12971. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  12972. /**
  12973. * Adds a new drag gradient
  12974. * @param gradient defines the gradient to use (between 0 and 1)
  12975. * @param factor defines the drag value to affect to the specified gradient
  12976. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12977. * @returns the current particle system
  12978. */
  12979. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12980. /**
  12981. * Remove a specific drag gradient
  12982. * @param gradient defines the gradient to remove
  12983. * @returns the current particle system
  12984. */
  12985. removeDragGradient(gradient: number): IParticleSystem;
  12986. /**
  12987. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  12988. * @param gradient defines the gradient to use (between 0 and 1)
  12989. * @param factor defines the emit rate value to affect to the specified gradient
  12990. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12991. * @returns the current particle system
  12992. */
  12993. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12994. /**
  12995. * Remove a specific emit rate gradient
  12996. * @param gradient defines the gradient to remove
  12997. * @returns the current particle system
  12998. */
  12999. removeEmitRateGradient(gradient: number): IParticleSystem;
  13000. /**
  13001. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13002. * @param gradient defines the gradient to use (between 0 and 1)
  13003. * @param factor defines the start size value to affect to the specified gradient
  13004. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13005. * @returns the current particle system
  13006. */
  13007. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13008. /**
  13009. * Remove a specific start size gradient
  13010. * @param gradient defines the gradient to remove
  13011. * @returns the current particle system
  13012. */
  13013. removeStartSizeGradient(gradient: number): IParticleSystem;
  13014. private _createRampGradientTexture;
  13015. /**
  13016. * Gets the current list of ramp gradients.
  13017. * You must use addRampGradient and removeRampGradient to udpate this list
  13018. * @returns the list of ramp gradients
  13019. */
  13020. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13021. /** Force the system to rebuild all gradients that need to be resync */
  13022. forceRefreshGradients(): void;
  13023. private _syncRampGradientTexture;
  13024. /**
  13025. * Adds a new ramp gradient used to remap particle colors
  13026. * @param gradient defines the gradient to use (between 0 and 1)
  13027. * @param color defines the color to affect to the specified gradient
  13028. * @returns the current particle system
  13029. */
  13030. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13031. /**
  13032. * Remove a specific ramp gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeRampGradient(gradient: number): ParticleSystem;
  13037. /**
  13038. * Adds a new color gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param color1 defines the color to affect to the specified gradient
  13041. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13042. * @returns this particle system
  13043. */
  13044. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13045. /**
  13046. * Remove a specific color gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns this particle system
  13049. */
  13050. removeColorGradient(gradient: number): IParticleSystem;
  13051. private _fetchR;
  13052. protected _reset(): void;
  13053. private _resetEffect;
  13054. private _createVertexBuffers;
  13055. private _createIndexBuffer;
  13056. /**
  13057. * Gets the maximum number of particles active at the same time.
  13058. * @returns The max number of active particles.
  13059. */
  13060. getCapacity(): number;
  13061. /**
  13062. * Gets whether there are still active particles in the system.
  13063. * @returns True if it is alive, otherwise false.
  13064. */
  13065. isAlive(): boolean;
  13066. /**
  13067. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13068. * @returns True if it has been started, otherwise false.
  13069. */
  13070. isStarted(): boolean;
  13071. private _prepareSubEmitterInternalArray;
  13072. /**
  13073. * Starts the particle system and begins to emit
  13074. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13075. */
  13076. start(delay?: number): void;
  13077. /**
  13078. * Stops the particle system.
  13079. * @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.
  13080. */
  13081. stop(stopSubEmitters?: boolean): void;
  13082. /**
  13083. * Remove all active particles
  13084. */
  13085. reset(): void;
  13086. /**
  13087. * @hidden (for internal use only)
  13088. */
  13089. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13090. /**
  13091. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13092. * Its lifetime will start back at 0.
  13093. */
  13094. recycleParticle: (particle: Particle) => void;
  13095. private _stopSubEmitters;
  13096. private _createParticle;
  13097. private _removeFromRoot;
  13098. private _emitFromParticle;
  13099. private _update;
  13100. /** @hidden */
  13101. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13102. /** @hidden */
  13103. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13104. /**
  13105. * Fill the defines array according to the current settings of the particle system
  13106. * @param defines Array to be updated
  13107. * @param blendMode blend mode to take into account when updating the array
  13108. */
  13109. fillDefines(defines: Array<string>, blendMode: number): void;
  13110. /**
  13111. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13112. * @param uniforms Uniforms array to fill
  13113. * @param attributes Attributes array to fill
  13114. * @param samplers Samplers array to fill
  13115. */
  13116. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13117. /** @hidden */
  13118. private _getEffect;
  13119. /**
  13120. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13121. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13122. */
  13123. animate(preWarmOnly?: boolean): void;
  13124. private _appendParticleVertices;
  13125. /**
  13126. * Rebuilds the particle system.
  13127. */
  13128. rebuild(): void;
  13129. /**
  13130. * Is this system ready to be used/rendered
  13131. * @return true if the system is ready
  13132. */
  13133. isReady(): boolean;
  13134. private _render;
  13135. /**
  13136. * Renders the particle system in its current state.
  13137. * @returns the current number of particles
  13138. */
  13139. render(): number;
  13140. /**
  13141. * Disposes the particle system and free the associated resources
  13142. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13143. */
  13144. dispose(disposeTexture?: boolean): void;
  13145. /**
  13146. * Clones the particle system.
  13147. * @param name The name of the cloned object
  13148. * @param newEmitter The new emitter to use
  13149. * @returns the cloned particle system
  13150. */
  13151. clone(name: string, newEmitter: any): ParticleSystem;
  13152. /**
  13153. * Serializes the particle system to a JSON object
  13154. * @param serializeTexture defines if the texture must be serialized as well
  13155. * @returns the JSON object
  13156. */
  13157. serialize(serializeTexture?: boolean): any;
  13158. /** @hidden */
  13159. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13160. /** @hidden */
  13161. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  13162. /**
  13163. * Parses a JSON object to create a particle system.
  13164. * @param parsedParticleSystem The JSON object to parse
  13165. * @param scene The scene to create the particle system in
  13166. * @param rootUrl The root url to use to load external dependencies like texture
  13167. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13168. * @returns the Parsed particle system
  13169. */
  13170. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13171. }
  13172. }
  13173. declare module "babylonjs/Particles/particle" {
  13174. import { Nullable } from "babylonjs/types";
  13175. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13176. import { Color4 } from "babylonjs/Maths/math.color";
  13177. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13178. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13179. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13180. /**
  13181. * A particle represents one of the element emitted by a particle system.
  13182. * This is mainly define by its coordinates, direction, velocity and age.
  13183. */
  13184. export class Particle {
  13185. /**
  13186. * The particle system the particle belongs to.
  13187. */
  13188. particleSystem: ParticleSystem;
  13189. private static _Count;
  13190. /**
  13191. * Unique ID of the particle
  13192. */
  13193. id: number;
  13194. /**
  13195. * The world position of the particle in the scene.
  13196. */
  13197. position: Vector3;
  13198. /**
  13199. * The world direction of the particle in the scene.
  13200. */
  13201. direction: Vector3;
  13202. /**
  13203. * The color of the particle.
  13204. */
  13205. color: Color4;
  13206. /**
  13207. * The color change of the particle per step.
  13208. */
  13209. colorStep: Color4;
  13210. /**
  13211. * Defines how long will the life of the particle be.
  13212. */
  13213. lifeTime: number;
  13214. /**
  13215. * The current age of the particle.
  13216. */
  13217. age: number;
  13218. /**
  13219. * The current size of the particle.
  13220. */
  13221. size: number;
  13222. /**
  13223. * The current scale of the particle.
  13224. */
  13225. scale: Vector2;
  13226. /**
  13227. * The current angle of the particle.
  13228. */
  13229. angle: number;
  13230. /**
  13231. * Defines how fast is the angle changing.
  13232. */
  13233. angularSpeed: number;
  13234. /**
  13235. * Defines the cell index used by the particle to be rendered from a sprite.
  13236. */
  13237. cellIndex: number;
  13238. /**
  13239. * The information required to support color remapping
  13240. */
  13241. remapData: Vector4;
  13242. /** @hidden */
  13243. _randomCellOffset?: number;
  13244. /** @hidden */
  13245. _initialDirection: Nullable<Vector3>;
  13246. /** @hidden */
  13247. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13248. /** @hidden */
  13249. _initialStartSpriteCellID: number;
  13250. /** @hidden */
  13251. _initialEndSpriteCellID: number;
  13252. /** @hidden */
  13253. _currentColorGradient: Nullable<ColorGradient>;
  13254. /** @hidden */
  13255. _currentColor1: Color4;
  13256. /** @hidden */
  13257. _currentColor2: Color4;
  13258. /** @hidden */
  13259. _currentSizeGradient: Nullable<FactorGradient>;
  13260. /** @hidden */
  13261. _currentSize1: number;
  13262. /** @hidden */
  13263. _currentSize2: number;
  13264. /** @hidden */
  13265. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13266. /** @hidden */
  13267. _currentAngularSpeed1: number;
  13268. /** @hidden */
  13269. _currentAngularSpeed2: number;
  13270. /** @hidden */
  13271. _currentVelocityGradient: Nullable<FactorGradient>;
  13272. /** @hidden */
  13273. _currentVelocity1: number;
  13274. /** @hidden */
  13275. _currentVelocity2: number;
  13276. /** @hidden */
  13277. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13278. /** @hidden */
  13279. _currentLimitVelocity1: number;
  13280. /** @hidden */
  13281. _currentLimitVelocity2: number;
  13282. /** @hidden */
  13283. _currentDragGradient: Nullable<FactorGradient>;
  13284. /** @hidden */
  13285. _currentDrag1: number;
  13286. /** @hidden */
  13287. _currentDrag2: number;
  13288. /** @hidden */
  13289. _randomNoiseCoordinates1: Vector3;
  13290. /** @hidden */
  13291. _randomNoiseCoordinates2: Vector3;
  13292. /** @hidden */
  13293. _localPosition?: Vector3;
  13294. /**
  13295. * Creates a new instance Particle
  13296. * @param particleSystem the particle system the particle belongs to
  13297. */
  13298. constructor(
  13299. /**
  13300. * The particle system the particle belongs to.
  13301. */
  13302. particleSystem: ParticleSystem);
  13303. private updateCellInfoFromSystem;
  13304. /**
  13305. * Defines how the sprite cell index is updated for the particle
  13306. */
  13307. updateCellIndex(): void;
  13308. /** @hidden */
  13309. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13310. /** @hidden */
  13311. _inheritParticleInfoToSubEmitters(): void;
  13312. /** @hidden */
  13313. _reset(): void;
  13314. /**
  13315. * Copy the properties of particle to another one.
  13316. * @param other the particle to copy the information to.
  13317. */
  13318. copyTo(other: Particle): void;
  13319. }
  13320. }
  13321. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13322. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13323. import { Effect } from "babylonjs/Materials/effect";
  13324. import { Particle } from "babylonjs/Particles/particle";
  13325. import { Scene } from "babylonjs/scene";
  13326. /**
  13327. * Particle emitter represents a volume emitting particles.
  13328. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13329. */
  13330. export interface IParticleEmitterType {
  13331. /**
  13332. * Called by the particle System when the direction is computed for the created particle.
  13333. * @param worldMatrix is the world matrix of the particle system
  13334. * @param directionToUpdate is the direction vector to update with the result
  13335. * @param particle is the particle we are computed the direction for
  13336. * @param isLocal defines if the direction should be set in local space
  13337. */
  13338. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13339. /**
  13340. * Called by the particle System when the position is computed for the created particle.
  13341. * @param worldMatrix is the world matrix of the particle system
  13342. * @param positionToUpdate is the position vector to update with the result
  13343. * @param particle is the particle we are computed the position for
  13344. * @param isLocal defines if the position should be set in local space
  13345. */
  13346. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13347. /**
  13348. * Clones the current emitter and returns a copy of it
  13349. * @returns the new emitter
  13350. */
  13351. clone(): IParticleEmitterType;
  13352. /**
  13353. * Called by the GPUParticleSystem to setup the update shader
  13354. * @param effect defines the update shader
  13355. */
  13356. applyToShader(effect: Effect): void;
  13357. /**
  13358. * Returns a string to use to update the GPU particles update shader
  13359. * @returns the effect defines string
  13360. */
  13361. getEffectDefines(): string;
  13362. /**
  13363. * Returns a string representing the class name
  13364. * @returns a string containing the class name
  13365. */
  13366. getClassName(): string;
  13367. /**
  13368. * Serializes the particle system to a JSON object.
  13369. * @returns the JSON object
  13370. */
  13371. serialize(): any;
  13372. /**
  13373. * Parse properties from a JSON object
  13374. * @param serializationObject defines the JSON object
  13375. * @param scene defines the hosting scene
  13376. */
  13377. parse(serializationObject: any, scene: Scene): void;
  13378. }
  13379. }
  13380. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13381. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13382. import { Effect } from "babylonjs/Materials/effect";
  13383. import { Particle } from "babylonjs/Particles/particle";
  13384. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13385. /**
  13386. * Particle emitter emitting particles from the inside of a box.
  13387. * It emits the particles randomly between 2 given directions.
  13388. */
  13389. export class BoxParticleEmitter implements IParticleEmitterType {
  13390. /**
  13391. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13392. */
  13393. direction1: Vector3;
  13394. /**
  13395. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13396. */
  13397. direction2: Vector3;
  13398. /**
  13399. * 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.
  13400. */
  13401. minEmitBox: Vector3;
  13402. /**
  13403. * 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.
  13404. */
  13405. maxEmitBox: Vector3;
  13406. /**
  13407. * Creates a new instance BoxParticleEmitter
  13408. */
  13409. constructor();
  13410. /**
  13411. * Called by the particle System when the direction is computed for the created particle.
  13412. * @param worldMatrix is the world matrix of the particle system
  13413. * @param directionToUpdate is the direction vector to update with the result
  13414. * @param particle is the particle we are computed the direction for
  13415. * @param isLocal defines if the direction should be set in local space
  13416. */
  13417. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13418. /**
  13419. * Called by the particle System when the position is computed for the created particle.
  13420. * @param worldMatrix is the world matrix of the particle system
  13421. * @param positionToUpdate is the position vector to update with the result
  13422. * @param particle is the particle we are computed the position for
  13423. * @param isLocal defines if the position should be set in local space
  13424. */
  13425. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13426. /**
  13427. * Clones the current emitter and returns a copy of it
  13428. * @returns the new emitter
  13429. */
  13430. clone(): BoxParticleEmitter;
  13431. /**
  13432. * Called by the GPUParticleSystem to setup the update shader
  13433. * @param effect defines the update shader
  13434. */
  13435. applyToShader(effect: Effect): void;
  13436. /**
  13437. * Returns a string to use to update the GPU particles update shader
  13438. * @returns a string containng the defines string
  13439. */
  13440. getEffectDefines(): string;
  13441. /**
  13442. * Returns the string "BoxParticleEmitter"
  13443. * @returns a string containing the class name
  13444. */
  13445. getClassName(): string;
  13446. /**
  13447. * Serializes the particle system to a JSON object.
  13448. * @returns the JSON object
  13449. */
  13450. serialize(): any;
  13451. /**
  13452. * Parse properties from a JSON object
  13453. * @param serializationObject defines the JSON object
  13454. */
  13455. parse(serializationObject: any): void;
  13456. }
  13457. }
  13458. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13459. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13460. import { Effect } from "babylonjs/Materials/effect";
  13461. import { Particle } from "babylonjs/Particles/particle";
  13462. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13463. /**
  13464. * Particle emitter emitting particles from the inside of a cone.
  13465. * It emits the particles alongside the cone volume from the base to the particle.
  13466. * The emission direction might be randomized.
  13467. */
  13468. export class ConeParticleEmitter implements IParticleEmitterType {
  13469. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13470. directionRandomizer: number;
  13471. private _radius;
  13472. private _angle;
  13473. private _height;
  13474. /**
  13475. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13476. */
  13477. radiusRange: number;
  13478. /**
  13479. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13480. */
  13481. heightRange: number;
  13482. /**
  13483. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13484. */
  13485. emitFromSpawnPointOnly: boolean;
  13486. /**
  13487. * Gets or sets the radius of the emission cone
  13488. */
  13489. get radius(): number;
  13490. set radius(value: number);
  13491. /**
  13492. * Gets or sets the angle of the emission cone
  13493. */
  13494. get angle(): number;
  13495. set angle(value: number);
  13496. private _buildHeight;
  13497. /**
  13498. * Creates a new instance ConeParticleEmitter
  13499. * @param radius the radius of the emission cone (1 by default)
  13500. * @param angle the cone base angle (PI by default)
  13501. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13502. */
  13503. constructor(radius?: number, angle?: number,
  13504. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13505. directionRandomizer?: number);
  13506. /**
  13507. * Called by the particle System when the direction is computed for the created particle.
  13508. * @param worldMatrix is the world matrix of the particle system
  13509. * @param directionToUpdate is the direction vector to update with the result
  13510. * @param particle is the particle we are computed the direction for
  13511. * @param isLocal defines if the direction should be set in local space
  13512. */
  13513. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13514. /**
  13515. * Called by the particle System when the position is computed for the created particle.
  13516. * @param worldMatrix is the world matrix of the particle system
  13517. * @param positionToUpdate is the position vector to update with the result
  13518. * @param particle is the particle we are computed the position for
  13519. * @param isLocal defines if the position should be set in local space
  13520. */
  13521. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13522. /**
  13523. * Clones the current emitter and returns a copy of it
  13524. * @returns the new emitter
  13525. */
  13526. clone(): ConeParticleEmitter;
  13527. /**
  13528. * Called by the GPUParticleSystem to setup the update shader
  13529. * @param effect defines the update shader
  13530. */
  13531. applyToShader(effect: Effect): void;
  13532. /**
  13533. * Returns a string to use to update the GPU particles update shader
  13534. * @returns a string containng the defines string
  13535. */
  13536. getEffectDefines(): string;
  13537. /**
  13538. * Returns the string "ConeParticleEmitter"
  13539. * @returns a string containing the class name
  13540. */
  13541. getClassName(): string;
  13542. /**
  13543. * Serializes the particle system to a JSON object.
  13544. * @returns the JSON object
  13545. */
  13546. serialize(): any;
  13547. /**
  13548. * Parse properties from a JSON object
  13549. * @param serializationObject defines the JSON object
  13550. */
  13551. parse(serializationObject: any): void;
  13552. }
  13553. }
  13554. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13555. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13556. import { Effect } from "babylonjs/Materials/effect";
  13557. import { Particle } from "babylonjs/Particles/particle";
  13558. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13559. /**
  13560. * Particle emitter emitting particles from the inside of a cylinder.
  13561. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13562. */
  13563. export class CylinderParticleEmitter implements IParticleEmitterType {
  13564. /**
  13565. * The radius of the emission cylinder.
  13566. */
  13567. radius: number;
  13568. /**
  13569. * The height of the emission cylinder.
  13570. */
  13571. height: number;
  13572. /**
  13573. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13574. */
  13575. radiusRange: number;
  13576. /**
  13577. * How much to randomize the particle direction [0-1].
  13578. */
  13579. directionRandomizer: number;
  13580. /**
  13581. * Creates a new instance CylinderParticleEmitter
  13582. * @param radius the radius of the emission cylinder (1 by default)
  13583. * @param height the height of the emission cylinder (1 by default)
  13584. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13585. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13586. */
  13587. constructor(
  13588. /**
  13589. * The radius of the emission cylinder.
  13590. */
  13591. radius?: number,
  13592. /**
  13593. * The height of the emission cylinder.
  13594. */
  13595. height?: number,
  13596. /**
  13597. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13598. */
  13599. radiusRange?: number,
  13600. /**
  13601. * How much to randomize the particle direction [0-1].
  13602. */
  13603. directionRandomizer?: number);
  13604. /**
  13605. * Called by the particle System when the direction is computed for the created particle.
  13606. * @param worldMatrix is the world matrix of the particle system
  13607. * @param directionToUpdate is the direction vector to update with the result
  13608. * @param particle is the particle we are computed the direction for
  13609. * @param isLocal defines if the direction should be set in local space
  13610. */
  13611. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13612. /**
  13613. * Called by the particle System when the position is computed for the created particle.
  13614. * @param worldMatrix is the world matrix of the particle system
  13615. * @param positionToUpdate is the position vector to update with the result
  13616. * @param particle is the particle we are computed the position for
  13617. * @param isLocal defines if the position should be set in local space
  13618. */
  13619. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13620. /**
  13621. * Clones the current emitter and returns a copy of it
  13622. * @returns the new emitter
  13623. */
  13624. clone(): CylinderParticleEmitter;
  13625. /**
  13626. * Called by the GPUParticleSystem to setup the update shader
  13627. * @param effect defines the update shader
  13628. */
  13629. applyToShader(effect: Effect): void;
  13630. /**
  13631. * Returns a string to use to update the GPU particles update shader
  13632. * @returns a string containng the defines string
  13633. */
  13634. getEffectDefines(): string;
  13635. /**
  13636. * Returns the string "CylinderParticleEmitter"
  13637. * @returns a string containing the class name
  13638. */
  13639. getClassName(): string;
  13640. /**
  13641. * Serializes the particle system to a JSON object.
  13642. * @returns the JSON object
  13643. */
  13644. serialize(): any;
  13645. /**
  13646. * Parse properties from a JSON object
  13647. * @param serializationObject defines the JSON object
  13648. */
  13649. parse(serializationObject: any): void;
  13650. }
  13651. /**
  13652. * Particle emitter emitting particles from the inside of a cylinder.
  13653. * It emits the particles randomly between two vectors.
  13654. */
  13655. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13656. /**
  13657. * The min limit of the emission direction.
  13658. */
  13659. direction1: Vector3;
  13660. /**
  13661. * The max limit of the emission direction.
  13662. */
  13663. direction2: Vector3;
  13664. /**
  13665. * Creates a new instance CylinderDirectedParticleEmitter
  13666. * @param radius the radius of the emission cylinder (1 by default)
  13667. * @param height the height of the emission cylinder (1 by default)
  13668. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13669. * @param direction1 the min limit of the emission direction (up vector by default)
  13670. * @param direction2 the max limit of the emission direction (up vector by default)
  13671. */
  13672. constructor(radius?: number, height?: number, radiusRange?: number,
  13673. /**
  13674. * The min limit of the emission direction.
  13675. */
  13676. direction1?: Vector3,
  13677. /**
  13678. * The max limit of the emission direction.
  13679. */
  13680. direction2?: Vector3);
  13681. /**
  13682. * Called by the particle System when the direction is computed for the created particle.
  13683. * @param worldMatrix is the world matrix of the particle system
  13684. * @param directionToUpdate is the direction vector to update with the result
  13685. * @param particle is the particle we are computed the direction for
  13686. */
  13687. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13688. /**
  13689. * Clones the current emitter and returns a copy of it
  13690. * @returns the new emitter
  13691. */
  13692. clone(): CylinderDirectedParticleEmitter;
  13693. /**
  13694. * Called by the GPUParticleSystem to setup the update shader
  13695. * @param effect defines the update shader
  13696. */
  13697. applyToShader(effect: Effect): void;
  13698. /**
  13699. * Returns a string to use to update the GPU particles update shader
  13700. * @returns a string containng the defines string
  13701. */
  13702. getEffectDefines(): string;
  13703. /**
  13704. * Returns the string "CylinderDirectedParticleEmitter"
  13705. * @returns a string containing the class name
  13706. */
  13707. getClassName(): string;
  13708. /**
  13709. * Serializes the particle system to a JSON object.
  13710. * @returns the JSON object
  13711. */
  13712. serialize(): any;
  13713. /**
  13714. * Parse properties from a JSON object
  13715. * @param serializationObject defines the JSON object
  13716. */
  13717. parse(serializationObject: any): void;
  13718. }
  13719. }
  13720. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13721. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13722. import { Effect } from "babylonjs/Materials/effect";
  13723. import { Particle } from "babylonjs/Particles/particle";
  13724. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13725. /**
  13726. * Particle emitter emitting particles from the inside of a hemisphere.
  13727. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13728. */
  13729. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13730. /**
  13731. * The radius of the emission hemisphere.
  13732. */
  13733. radius: number;
  13734. /**
  13735. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13736. */
  13737. radiusRange: number;
  13738. /**
  13739. * How much to randomize the particle direction [0-1].
  13740. */
  13741. directionRandomizer: number;
  13742. /**
  13743. * Creates a new instance HemisphericParticleEmitter
  13744. * @param radius the radius of the emission hemisphere (1 by default)
  13745. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13746. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13747. */
  13748. constructor(
  13749. /**
  13750. * The radius of the emission hemisphere.
  13751. */
  13752. radius?: number,
  13753. /**
  13754. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13755. */
  13756. radiusRange?: number,
  13757. /**
  13758. * How much to randomize the particle direction [0-1].
  13759. */
  13760. directionRandomizer?: number);
  13761. /**
  13762. * Called by the particle System when the direction is computed for the created particle.
  13763. * @param worldMatrix is the world matrix of the particle system
  13764. * @param directionToUpdate is the direction vector to update with the result
  13765. * @param particle is the particle we are computed the direction for
  13766. * @param isLocal defines if the direction should be set in local space
  13767. */
  13768. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13769. /**
  13770. * Called by the particle System when the position is computed for the created particle.
  13771. * @param worldMatrix is the world matrix of the particle system
  13772. * @param positionToUpdate is the position vector to update with the result
  13773. * @param particle is the particle we are computed the position for
  13774. * @param isLocal defines if the position should be set in local space
  13775. */
  13776. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13777. /**
  13778. * Clones the current emitter and returns a copy of it
  13779. * @returns the new emitter
  13780. */
  13781. clone(): HemisphericParticleEmitter;
  13782. /**
  13783. * Called by the GPUParticleSystem to setup the update shader
  13784. * @param effect defines the update shader
  13785. */
  13786. applyToShader(effect: Effect): void;
  13787. /**
  13788. * Returns a string to use to update the GPU particles update shader
  13789. * @returns a string containng the defines string
  13790. */
  13791. getEffectDefines(): string;
  13792. /**
  13793. * Returns the string "HemisphericParticleEmitter"
  13794. * @returns a string containing the class name
  13795. */
  13796. getClassName(): string;
  13797. /**
  13798. * Serializes the particle system to a JSON object.
  13799. * @returns the JSON object
  13800. */
  13801. serialize(): any;
  13802. /**
  13803. * Parse properties from a JSON object
  13804. * @param serializationObject defines the JSON object
  13805. */
  13806. parse(serializationObject: any): void;
  13807. }
  13808. }
  13809. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13810. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13811. import { Effect } from "babylonjs/Materials/effect";
  13812. import { Particle } from "babylonjs/Particles/particle";
  13813. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13814. /**
  13815. * Particle emitter emitting particles from a point.
  13816. * It emits the particles randomly between 2 given directions.
  13817. */
  13818. export class PointParticleEmitter implements IParticleEmitterType {
  13819. /**
  13820. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13821. */
  13822. direction1: Vector3;
  13823. /**
  13824. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13825. */
  13826. direction2: Vector3;
  13827. /**
  13828. * Creates a new instance PointParticleEmitter
  13829. */
  13830. constructor();
  13831. /**
  13832. * Called by the particle System when the direction is computed for the created particle.
  13833. * @param worldMatrix is the world matrix of the particle system
  13834. * @param directionToUpdate is the direction vector to update with the result
  13835. * @param particle is the particle we are computed the direction for
  13836. * @param isLocal defines if the direction should be set in local space
  13837. */
  13838. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13839. /**
  13840. * Called by the particle System when the position is computed for the created particle.
  13841. * @param worldMatrix is the world matrix of the particle system
  13842. * @param positionToUpdate is the position vector to update with the result
  13843. * @param particle is the particle we are computed the position for
  13844. * @param isLocal defines if the position should be set in local space
  13845. */
  13846. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13847. /**
  13848. * Clones the current emitter and returns a copy of it
  13849. * @returns the new emitter
  13850. */
  13851. clone(): PointParticleEmitter;
  13852. /**
  13853. * Called by the GPUParticleSystem to setup the update shader
  13854. * @param effect defines the update shader
  13855. */
  13856. applyToShader(effect: Effect): void;
  13857. /**
  13858. * Returns a string to use to update the GPU particles update shader
  13859. * @returns a string containng the defines string
  13860. */
  13861. getEffectDefines(): string;
  13862. /**
  13863. * Returns the string "PointParticleEmitter"
  13864. * @returns a string containing the class name
  13865. */
  13866. getClassName(): string;
  13867. /**
  13868. * Serializes the particle system to a JSON object.
  13869. * @returns the JSON object
  13870. */
  13871. serialize(): any;
  13872. /**
  13873. * Parse properties from a JSON object
  13874. * @param serializationObject defines the JSON object
  13875. */
  13876. parse(serializationObject: any): void;
  13877. }
  13878. }
  13879. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  13880. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13881. import { Effect } from "babylonjs/Materials/effect";
  13882. import { Particle } from "babylonjs/Particles/particle";
  13883. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13884. /**
  13885. * Particle emitter emitting particles from the inside of a sphere.
  13886. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  13887. */
  13888. export class SphereParticleEmitter implements IParticleEmitterType {
  13889. /**
  13890. * The radius of the emission sphere.
  13891. */
  13892. radius: number;
  13893. /**
  13894. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13895. */
  13896. radiusRange: number;
  13897. /**
  13898. * How much to randomize the particle direction [0-1].
  13899. */
  13900. directionRandomizer: number;
  13901. /**
  13902. * Creates a new instance SphereParticleEmitter
  13903. * @param radius the radius of the emission sphere (1 by default)
  13904. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13905. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13906. */
  13907. constructor(
  13908. /**
  13909. * The radius of the emission sphere.
  13910. */
  13911. radius?: number,
  13912. /**
  13913. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13914. */
  13915. radiusRange?: number,
  13916. /**
  13917. * How much to randomize the particle direction [0-1].
  13918. */
  13919. directionRandomizer?: number);
  13920. /**
  13921. * Called by the particle System when the direction is computed for the created particle.
  13922. * @param worldMatrix is the world matrix of the particle system
  13923. * @param directionToUpdate is the direction vector to update with the result
  13924. * @param particle is the particle we are computed the direction for
  13925. * @param isLocal defines if the direction should be set in local space
  13926. */
  13927. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13928. /**
  13929. * Called by the particle System when the position is computed for the created particle.
  13930. * @param worldMatrix is the world matrix of the particle system
  13931. * @param positionToUpdate is the position vector to update with the result
  13932. * @param particle is the particle we are computed the position for
  13933. * @param isLocal defines if the position should be set in local space
  13934. */
  13935. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13936. /**
  13937. * Clones the current emitter and returns a copy of it
  13938. * @returns the new emitter
  13939. */
  13940. clone(): SphereParticleEmitter;
  13941. /**
  13942. * Called by the GPUParticleSystem to setup the update shader
  13943. * @param effect defines the update shader
  13944. */
  13945. applyToShader(effect: Effect): void;
  13946. /**
  13947. * Returns a string to use to update the GPU particles update shader
  13948. * @returns a string containng the defines string
  13949. */
  13950. getEffectDefines(): string;
  13951. /**
  13952. * Returns the string "SphereParticleEmitter"
  13953. * @returns a string containing the class name
  13954. */
  13955. getClassName(): string;
  13956. /**
  13957. * Serializes the particle system to a JSON object.
  13958. * @returns the JSON object
  13959. */
  13960. serialize(): any;
  13961. /**
  13962. * Parse properties from a JSON object
  13963. * @param serializationObject defines the JSON object
  13964. */
  13965. parse(serializationObject: any): void;
  13966. }
  13967. /**
  13968. * Particle emitter emitting particles from the inside of a sphere.
  13969. * It emits the particles randomly between two vectors.
  13970. */
  13971. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  13972. /**
  13973. * The min limit of the emission direction.
  13974. */
  13975. direction1: Vector3;
  13976. /**
  13977. * The max limit of the emission direction.
  13978. */
  13979. direction2: Vector3;
  13980. /**
  13981. * Creates a new instance SphereDirectedParticleEmitter
  13982. * @param radius the radius of the emission sphere (1 by default)
  13983. * @param direction1 the min limit of the emission direction (up vector by default)
  13984. * @param direction2 the max limit of the emission direction (up vector by default)
  13985. */
  13986. constructor(radius?: number,
  13987. /**
  13988. * The min limit of the emission direction.
  13989. */
  13990. direction1?: Vector3,
  13991. /**
  13992. * The max limit of the emission direction.
  13993. */
  13994. direction2?: Vector3);
  13995. /**
  13996. * Called by the particle System when the direction is computed for the created particle.
  13997. * @param worldMatrix is the world matrix of the particle system
  13998. * @param directionToUpdate is the direction vector to update with the result
  13999. * @param particle is the particle we are computed the direction for
  14000. */
  14001. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14002. /**
  14003. * Clones the current emitter and returns a copy of it
  14004. * @returns the new emitter
  14005. */
  14006. clone(): SphereDirectedParticleEmitter;
  14007. /**
  14008. * Called by the GPUParticleSystem to setup the update shader
  14009. * @param effect defines the update shader
  14010. */
  14011. applyToShader(effect: Effect): void;
  14012. /**
  14013. * Returns a string to use to update the GPU particles update shader
  14014. * @returns a string containng the defines string
  14015. */
  14016. getEffectDefines(): string;
  14017. /**
  14018. * Returns the string "SphereDirectedParticleEmitter"
  14019. * @returns a string containing the class name
  14020. */
  14021. getClassName(): string;
  14022. /**
  14023. * Serializes the particle system to a JSON object.
  14024. * @returns the JSON object
  14025. */
  14026. serialize(): any;
  14027. /**
  14028. * Parse properties from a JSON object
  14029. * @param serializationObject defines the JSON object
  14030. */
  14031. parse(serializationObject: any): void;
  14032. }
  14033. }
  14034. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14035. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14036. import { Effect } from "babylonjs/Materials/effect";
  14037. import { Particle } from "babylonjs/Particles/particle";
  14038. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14039. import { Nullable } from "babylonjs/types";
  14040. /**
  14041. * Particle emitter emitting particles from a custom list of positions.
  14042. */
  14043. export class CustomParticleEmitter implements IParticleEmitterType {
  14044. /**
  14045. * Gets or sets the position generator that will create the inital position of each particle.
  14046. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14047. */
  14048. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14049. /**
  14050. * Gets or sets the destination generator that will create the final destination of each particle.
  14051. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14052. */
  14053. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14054. /**
  14055. * Creates a new instance CustomParticleEmitter
  14056. */
  14057. constructor();
  14058. /**
  14059. * Called by the particle System when the direction is computed for the created particle.
  14060. * @param worldMatrix is the world matrix of the particle system
  14061. * @param directionToUpdate is the direction vector to update with the result
  14062. * @param particle is the particle we are computed the direction for
  14063. * @param isLocal defines if the direction should be set in local space
  14064. */
  14065. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14066. /**
  14067. * Called by the particle System when the position is computed for the created particle.
  14068. * @param worldMatrix is the world matrix of the particle system
  14069. * @param positionToUpdate is the position vector to update with the result
  14070. * @param particle is the particle we are computed the position for
  14071. * @param isLocal defines if the position should be set in local space
  14072. */
  14073. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14074. /**
  14075. * Clones the current emitter and returns a copy of it
  14076. * @returns the new emitter
  14077. */
  14078. clone(): CustomParticleEmitter;
  14079. /**
  14080. * Called by the GPUParticleSystem to setup the update shader
  14081. * @param effect defines the update shader
  14082. */
  14083. applyToShader(effect: Effect): void;
  14084. /**
  14085. * Returns a string to use to update the GPU particles update shader
  14086. * @returns a string containng the defines string
  14087. */
  14088. getEffectDefines(): string;
  14089. /**
  14090. * Returns the string "PointParticleEmitter"
  14091. * @returns a string containing the class name
  14092. */
  14093. getClassName(): string;
  14094. /**
  14095. * Serializes the particle system to a JSON object.
  14096. * @returns the JSON object
  14097. */
  14098. serialize(): any;
  14099. /**
  14100. * Parse properties from a JSON object
  14101. * @param serializationObject defines the JSON object
  14102. */
  14103. parse(serializationObject: any): void;
  14104. }
  14105. }
  14106. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14107. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14108. import { Effect } from "babylonjs/Materials/effect";
  14109. import { Particle } from "babylonjs/Particles/particle";
  14110. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14111. import { Nullable } from "babylonjs/types";
  14112. import { Scene } from "babylonjs/scene";
  14113. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14114. /**
  14115. * Particle emitter emitting particles from the inside of a box.
  14116. * It emits the particles randomly between 2 given directions.
  14117. */
  14118. export class MeshParticleEmitter implements IParticleEmitterType {
  14119. private _indices;
  14120. private _positions;
  14121. private _normals;
  14122. private _storedNormal;
  14123. private _mesh;
  14124. /**
  14125. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14126. */
  14127. direction1: Vector3;
  14128. /**
  14129. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14130. */
  14131. direction2: Vector3;
  14132. /**
  14133. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14134. */
  14135. useMeshNormalsForDirection: boolean;
  14136. /** Defines the mesh to use as source */
  14137. get mesh(): Nullable<AbstractMesh>;
  14138. set mesh(value: Nullable<AbstractMesh>);
  14139. /**
  14140. * Creates a new instance MeshParticleEmitter
  14141. * @param mesh defines the mesh to use as source
  14142. */
  14143. constructor(mesh?: Nullable<AbstractMesh>);
  14144. /**
  14145. * Called by the particle System when the direction is computed for the created particle.
  14146. * @param worldMatrix is the world matrix of the particle system
  14147. * @param directionToUpdate is the direction vector to update with the result
  14148. * @param particle is the particle we are computed the direction for
  14149. * @param isLocal defines if the direction should be set in local space
  14150. */
  14151. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14152. /**
  14153. * Called by the particle System when the position is computed for the created particle.
  14154. * @param worldMatrix is the world matrix of the particle system
  14155. * @param positionToUpdate is the position vector to update with the result
  14156. * @param particle is the particle we are computed the position for
  14157. * @param isLocal defines if the position should be set in local space
  14158. */
  14159. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14160. /**
  14161. * Clones the current emitter and returns a copy of it
  14162. * @returns the new emitter
  14163. */
  14164. clone(): MeshParticleEmitter;
  14165. /**
  14166. * Called by the GPUParticleSystem to setup the update shader
  14167. * @param effect defines the update shader
  14168. */
  14169. applyToShader(effect: Effect): void;
  14170. /**
  14171. * Returns a string to use to update the GPU particles update shader
  14172. * @returns a string containng the defines string
  14173. */
  14174. getEffectDefines(): string;
  14175. /**
  14176. * Returns the string "BoxParticleEmitter"
  14177. * @returns a string containing the class name
  14178. */
  14179. getClassName(): string;
  14180. /**
  14181. * Serializes the particle system to a JSON object.
  14182. * @returns the JSON object
  14183. */
  14184. serialize(): any;
  14185. /**
  14186. * Parse properties from a JSON object
  14187. * @param serializationObject defines the JSON object
  14188. * @param scene defines the hosting scene
  14189. */
  14190. parse(serializationObject: any, scene: Scene): void;
  14191. }
  14192. }
  14193. declare module "babylonjs/Particles/EmitterTypes/index" {
  14194. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14195. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14196. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14197. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14198. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14199. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14200. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14201. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14202. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14203. }
  14204. declare module "babylonjs/Particles/IParticleSystem" {
  14205. import { Nullable } from "babylonjs/types";
  14206. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  14207. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14208. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14209. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14210. import { Texture } from "babylonjs/Materials/Textures/texture";
  14211. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14212. import { Scene } from "babylonjs/scene";
  14213. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14214. import { Effect } from "babylonjs/Materials/effect";
  14215. import { Observable } from "babylonjs/Misc/observable";
  14216. import { Animation } from "babylonjs/Animations/animation";
  14217. /**
  14218. * Interface representing a particle system in Babylon.js.
  14219. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14220. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14221. */
  14222. export interface IParticleSystem {
  14223. /**
  14224. * List of animations used by the particle system.
  14225. */
  14226. animations: Animation[];
  14227. /**
  14228. * The id of the Particle system.
  14229. */
  14230. id: string;
  14231. /**
  14232. * The name of the Particle system.
  14233. */
  14234. name: string;
  14235. /**
  14236. * The emitter represents the Mesh or position we are attaching the particle system to.
  14237. */
  14238. emitter: Nullable<AbstractMesh | Vector3>;
  14239. /**
  14240. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14241. */
  14242. isBillboardBased: boolean;
  14243. /**
  14244. * The rendering group used by the Particle system to chose when to render.
  14245. */
  14246. renderingGroupId: number;
  14247. /**
  14248. * The layer mask we are rendering the particles through.
  14249. */
  14250. layerMask: number;
  14251. /**
  14252. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14253. */
  14254. updateSpeed: number;
  14255. /**
  14256. * The amount of time the particle system is running (depends of the overall update speed).
  14257. */
  14258. targetStopDuration: number;
  14259. /**
  14260. * The texture used to render each particle. (this can be a spritesheet)
  14261. */
  14262. particleTexture: Nullable<Texture>;
  14263. /**
  14264. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14265. */
  14266. blendMode: number;
  14267. /**
  14268. * Minimum life time of emitting particles.
  14269. */
  14270. minLifeTime: number;
  14271. /**
  14272. * Maximum life time of emitting particles.
  14273. */
  14274. maxLifeTime: number;
  14275. /**
  14276. * Minimum Size of emitting particles.
  14277. */
  14278. minSize: number;
  14279. /**
  14280. * Maximum Size of emitting particles.
  14281. */
  14282. maxSize: number;
  14283. /**
  14284. * Minimum scale of emitting particles on X axis.
  14285. */
  14286. minScaleX: number;
  14287. /**
  14288. * Maximum scale of emitting particles on X axis.
  14289. */
  14290. maxScaleX: number;
  14291. /**
  14292. * Minimum scale of emitting particles on Y axis.
  14293. */
  14294. minScaleY: number;
  14295. /**
  14296. * Maximum scale of emitting particles on Y axis.
  14297. */
  14298. maxScaleY: number;
  14299. /**
  14300. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14301. */
  14302. color1: Color4;
  14303. /**
  14304. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14305. */
  14306. color2: Color4;
  14307. /**
  14308. * Color the particle will have at the end of its lifetime.
  14309. */
  14310. colorDead: Color4;
  14311. /**
  14312. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14313. */
  14314. emitRate: number;
  14315. /**
  14316. * You can use gravity if you want to give an orientation to your particles.
  14317. */
  14318. gravity: Vector3;
  14319. /**
  14320. * Minimum power of emitting particles.
  14321. */
  14322. minEmitPower: number;
  14323. /**
  14324. * Maximum power of emitting particles.
  14325. */
  14326. maxEmitPower: number;
  14327. /**
  14328. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14329. */
  14330. minAngularSpeed: number;
  14331. /**
  14332. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14333. */
  14334. maxAngularSpeed: number;
  14335. /**
  14336. * Gets or sets the minimal initial rotation in radians.
  14337. */
  14338. minInitialRotation: number;
  14339. /**
  14340. * Gets or sets the maximal initial rotation in radians.
  14341. */
  14342. maxInitialRotation: number;
  14343. /**
  14344. * The particle emitter type defines the emitter used by the particle system.
  14345. * It can be for example box, sphere, or cone...
  14346. */
  14347. particleEmitterType: Nullable<IParticleEmitterType>;
  14348. /**
  14349. * Defines the delay in milliseconds before starting the system (0 by default)
  14350. */
  14351. startDelay: number;
  14352. /**
  14353. * 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
  14354. */
  14355. preWarmCycles: number;
  14356. /**
  14357. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14358. */
  14359. preWarmStepOffset: number;
  14360. /**
  14361. * 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)
  14362. */
  14363. spriteCellChangeSpeed: number;
  14364. /**
  14365. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14366. */
  14367. startSpriteCellID: number;
  14368. /**
  14369. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14370. */
  14371. endSpriteCellID: number;
  14372. /**
  14373. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14374. */
  14375. spriteCellWidth: number;
  14376. /**
  14377. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14378. */
  14379. spriteCellHeight: number;
  14380. /**
  14381. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14382. */
  14383. spriteRandomStartCell: boolean;
  14384. /**
  14385. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14386. */
  14387. isAnimationSheetEnabled: boolean;
  14388. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14389. translationPivot: Vector2;
  14390. /**
  14391. * Gets or sets a texture used to add random noise to particle positions
  14392. */
  14393. noiseTexture: Nullable<BaseTexture>;
  14394. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14395. noiseStrength: Vector3;
  14396. /**
  14397. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14398. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14399. */
  14400. billboardMode: number;
  14401. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14402. limitVelocityDamping: number;
  14403. /**
  14404. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14405. */
  14406. beginAnimationOnStart: boolean;
  14407. /**
  14408. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14409. */
  14410. beginAnimationFrom: number;
  14411. /**
  14412. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14413. */
  14414. beginAnimationTo: number;
  14415. /**
  14416. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14417. */
  14418. beginAnimationLoop: boolean;
  14419. /**
  14420. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14421. */
  14422. disposeOnStop: boolean;
  14423. /**
  14424. * Specifies if the particles are updated in emitter local space or world space
  14425. */
  14426. isLocal: boolean;
  14427. /** Snippet ID if the particle system was created from the snippet server */
  14428. snippetId: string;
  14429. /**
  14430. * Gets the maximum number of particles active at the same time.
  14431. * @returns The max number of active particles.
  14432. */
  14433. getCapacity(): number;
  14434. /**
  14435. * Gets the number of particles active at the same time.
  14436. * @returns The number of active particles.
  14437. */
  14438. getActiveCount(): number;
  14439. /**
  14440. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14441. * @returns True if it has been started, otherwise false.
  14442. */
  14443. isStarted(): boolean;
  14444. /**
  14445. * Animates the particle system for this frame.
  14446. */
  14447. animate(): void;
  14448. /**
  14449. * Renders the particle system in its current state.
  14450. * @returns the current number of particles
  14451. */
  14452. render(): number;
  14453. /**
  14454. * Dispose the particle system and frees its associated resources.
  14455. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14456. */
  14457. dispose(disposeTexture?: boolean): void;
  14458. /**
  14459. * An event triggered when the system is disposed
  14460. */
  14461. onDisposeObservable: Observable<IParticleSystem>;
  14462. /**
  14463. * Clones the particle system.
  14464. * @param name The name of the cloned object
  14465. * @param newEmitter The new emitter to use
  14466. * @returns the cloned particle system
  14467. */
  14468. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14469. /**
  14470. * Serializes the particle system to a JSON object
  14471. * @param serializeTexture defines if the texture must be serialized as well
  14472. * @returns the JSON object
  14473. */
  14474. serialize(serializeTexture: boolean): any;
  14475. /**
  14476. * Rebuild the particle system
  14477. */
  14478. rebuild(): void;
  14479. /** Force the system to rebuild all gradients that need to be resync */
  14480. forceRefreshGradients(): void;
  14481. /**
  14482. * Starts the particle system and begins to emit
  14483. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14484. */
  14485. start(delay?: number): void;
  14486. /**
  14487. * Stops the particle system.
  14488. */
  14489. stop(): void;
  14490. /**
  14491. * Remove all active particles
  14492. */
  14493. reset(): void;
  14494. /**
  14495. * Gets a boolean indicating that the system is stopping
  14496. * @returns true if the system is currently stopping
  14497. */
  14498. isStopping(): boolean;
  14499. /**
  14500. * Is this system ready to be used/rendered
  14501. * @return true if the system is ready
  14502. */
  14503. isReady(): boolean;
  14504. /**
  14505. * Returns the string "ParticleSystem"
  14506. * @returns a string containing the class name
  14507. */
  14508. getClassName(): string;
  14509. /**
  14510. * Gets the custom effect used to render the particles
  14511. * @param blendMode Blend mode for which the effect should be retrieved
  14512. * @returns The effect
  14513. */
  14514. getCustomEffect(blendMode: number): Nullable<Effect>;
  14515. /**
  14516. * Sets the custom effect used to render the particles
  14517. * @param effect The effect to set
  14518. * @param blendMode Blend mode for which the effect should be set
  14519. */
  14520. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14521. /**
  14522. * Fill the defines array according to the current settings of the particle system
  14523. * @param defines Array to be updated
  14524. * @param blendMode blend mode to take into account when updating the array
  14525. */
  14526. fillDefines(defines: Array<string>, blendMode: number): void;
  14527. /**
  14528. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14529. * @param uniforms Uniforms array to fill
  14530. * @param attributes Attributes array to fill
  14531. * @param samplers Samplers array to fill
  14532. */
  14533. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14534. /**
  14535. * Observable that will be called just before the particles are drawn
  14536. */
  14537. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14538. /**
  14539. * Gets the name of the particle vertex shader
  14540. */
  14541. vertexShaderName: string;
  14542. /**
  14543. * Adds a new color gradient
  14544. * @param gradient defines the gradient to use (between 0 and 1)
  14545. * @param color1 defines the color to affect to the specified gradient
  14546. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14547. * @returns the current particle system
  14548. */
  14549. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14550. /**
  14551. * Remove a specific color gradient
  14552. * @param gradient defines the gradient to remove
  14553. * @returns the current particle system
  14554. */
  14555. removeColorGradient(gradient: number): IParticleSystem;
  14556. /**
  14557. * Adds a new size gradient
  14558. * @param gradient defines the gradient to use (between 0 and 1)
  14559. * @param factor defines the size factor to affect to the specified gradient
  14560. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14561. * @returns the current particle system
  14562. */
  14563. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14564. /**
  14565. * Remove a specific size gradient
  14566. * @param gradient defines the gradient to remove
  14567. * @returns the current particle system
  14568. */
  14569. removeSizeGradient(gradient: number): IParticleSystem;
  14570. /**
  14571. * Gets the current list of color gradients.
  14572. * You must use addColorGradient and removeColorGradient to udpate this list
  14573. * @returns the list of color gradients
  14574. */
  14575. getColorGradients(): Nullable<Array<ColorGradient>>;
  14576. /**
  14577. * Gets the current list of size gradients.
  14578. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14579. * @returns the list of size gradients
  14580. */
  14581. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14582. /**
  14583. * Gets the current list of angular speed gradients.
  14584. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14585. * @returns the list of angular speed gradients
  14586. */
  14587. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14588. /**
  14589. * Adds a new angular speed gradient
  14590. * @param gradient defines the gradient to use (between 0 and 1)
  14591. * @param factor defines the angular speed to affect to the specified gradient
  14592. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14593. * @returns the current particle system
  14594. */
  14595. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14596. /**
  14597. * Remove a specific angular speed gradient
  14598. * @param gradient defines the gradient to remove
  14599. * @returns the current particle system
  14600. */
  14601. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14602. /**
  14603. * Gets the current list of velocity gradients.
  14604. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14605. * @returns the list of velocity gradients
  14606. */
  14607. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14608. /**
  14609. * Adds a new velocity gradient
  14610. * @param gradient defines the gradient to use (between 0 and 1)
  14611. * @param factor defines the velocity to affect to the specified gradient
  14612. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14613. * @returns the current particle system
  14614. */
  14615. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14616. /**
  14617. * Remove a specific velocity gradient
  14618. * @param gradient defines the gradient to remove
  14619. * @returns the current particle system
  14620. */
  14621. removeVelocityGradient(gradient: number): IParticleSystem;
  14622. /**
  14623. * Gets the current list of limit velocity gradients.
  14624. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14625. * @returns the list of limit velocity gradients
  14626. */
  14627. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14628. /**
  14629. * Adds a new limit velocity gradient
  14630. * @param gradient defines the gradient to use (between 0 and 1)
  14631. * @param factor defines the limit velocity to affect to the specified gradient
  14632. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14633. * @returns the current particle system
  14634. */
  14635. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14636. /**
  14637. * Remove a specific limit velocity gradient
  14638. * @param gradient defines the gradient to remove
  14639. * @returns the current particle system
  14640. */
  14641. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14642. /**
  14643. * Adds a new drag gradient
  14644. * @param gradient defines the gradient to use (between 0 and 1)
  14645. * @param factor defines the drag to affect to the specified gradient
  14646. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14647. * @returns the current particle system
  14648. */
  14649. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14650. /**
  14651. * Remove a specific drag gradient
  14652. * @param gradient defines the gradient to remove
  14653. * @returns the current particle system
  14654. */
  14655. removeDragGradient(gradient: number): IParticleSystem;
  14656. /**
  14657. * Gets the current list of drag gradients.
  14658. * You must use addDragGradient and removeDragGradient to udpate this list
  14659. * @returns the list of drag gradients
  14660. */
  14661. getDragGradients(): Nullable<Array<FactorGradient>>;
  14662. /**
  14663. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14664. * @param gradient defines the gradient to use (between 0 and 1)
  14665. * @param factor defines the emit rate to affect to the specified gradient
  14666. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14667. * @returns the current particle system
  14668. */
  14669. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14670. /**
  14671. * Remove a specific emit rate gradient
  14672. * @param gradient defines the gradient to remove
  14673. * @returns the current particle system
  14674. */
  14675. removeEmitRateGradient(gradient: number): IParticleSystem;
  14676. /**
  14677. * Gets the current list of emit rate gradients.
  14678. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14679. * @returns the list of emit rate gradients
  14680. */
  14681. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14682. /**
  14683. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14684. * @param gradient defines the gradient to use (between 0 and 1)
  14685. * @param factor defines the start size to affect to the specified gradient
  14686. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14687. * @returns the current particle system
  14688. */
  14689. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14690. /**
  14691. * Remove a specific start size gradient
  14692. * @param gradient defines the gradient to remove
  14693. * @returns the current particle system
  14694. */
  14695. removeStartSizeGradient(gradient: number): IParticleSystem;
  14696. /**
  14697. * Gets the current list of start size gradients.
  14698. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14699. * @returns the list of start size gradients
  14700. */
  14701. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14702. /**
  14703. * Adds a new life time gradient
  14704. * @param gradient defines the gradient to use (between 0 and 1)
  14705. * @param factor defines the life time factor to affect to the specified gradient
  14706. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14707. * @returns the current particle system
  14708. */
  14709. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14710. /**
  14711. * Remove a specific life time gradient
  14712. * @param gradient defines the gradient to remove
  14713. * @returns the current particle system
  14714. */
  14715. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14716. /**
  14717. * Gets the current list of life time gradients.
  14718. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14719. * @returns the list of life time gradients
  14720. */
  14721. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14722. /**
  14723. * Gets the current list of color gradients.
  14724. * You must use addColorGradient and removeColorGradient to udpate this list
  14725. * @returns the list of color gradients
  14726. */
  14727. getColorGradients(): Nullable<Array<ColorGradient>>;
  14728. /**
  14729. * Adds a new ramp gradient used to remap particle colors
  14730. * @param gradient defines the gradient to use (between 0 and 1)
  14731. * @param color defines the color to affect to the specified gradient
  14732. * @returns the current particle system
  14733. */
  14734. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14735. /**
  14736. * Gets the current list of ramp gradients.
  14737. * You must use addRampGradient and removeRampGradient to udpate this list
  14738. * @returns the list of ramp gradients
  14739. */
  14740. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14741. /** Gets or sets a boolean indicating that ramp gradients must be used
  14742. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14743. */
  14744. useRampGradients: boolean;
  14745. /**
  14746. * Adds a new color remap gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param min defines the color remap minimal range
  14749. * @param max defines the color remap maximal range
  14750. * @returns the current particle system
  14751. */
  14752. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14753. /**
  14754. * Gets the current list of color remap gradients.
  14755. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14756. * @returns the list of color remap gradients
  14757. */
  14758. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14759. /**
  14760. * Adds a new alpha remap gradient
  14761. * @param gradient defines the gradient to use (between 0 and 1)
  14762. * @param min defines the alpha remap minimal range
  14763. * @param max defines the alpha remap maximal range
  14764. * @returns the current particle system
  14765. */
  14766. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14767. /**
  14768. * Gets the current list of alpha remap gradients.
  14769. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14770. * @returns the list of alpha remap gradients
  14771. */
  14772. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14773. /**
  14774. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14775. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14776. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14777. * @returns the emitter
  14778. */
  14779. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14780. /**
  14781. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14782. * @param radius The radius of the hemisphere to emit from
  14783. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14784. * @returns the emitter
  14785. */
  14786. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14787. /**
  14788. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14789. * @param radius The radius of the sphere to emit from
  14790. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14791. * @returns the emitter
  14792. */
  14793. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14794. /**
  14795. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14796. * @param radius The radius of the sphere to emit from
  14797. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14798. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14799. * @returns the emitter
  14800. */
  14801. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14802. /**
  14803. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14804. * @param radius The radius of the emission cylinder
  14805. * @param height The height of the emission cylinder
  14806. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14807. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14808. * @returns the emitter
  14809. */
  14810. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14811. /**
  14812. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14813. * @param radius The radius of the cylinder to emit from
  14814. * @param height The height of the emission cylinder
  14815. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14816. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14817. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14818. * @returns the emitter
  14819. */
  14820. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14821. /**
  14822. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14823. * @param radius The radius of the cone to emit from
  14824. * @param angle The base angle of the cone
  14825. * @returns the emitter
  14826. */
  14827. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14828. /**
  14829. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14830. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14831. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14832. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14833. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14834. * @returns the emitter
  14835. */
  14836. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14837. /**
  14838. * Get hosting scene
  14839. * @returns the scene
  14840. */
  14841. getScene(): Scene;
  14842. }
  14843. }
  14844. declare module "babylonjs/Meshes/transformNode" {
  14845. import { DeepImmutable } from "babylonjs/types";
  14846. import { Observable } from "babylonjs/Misc/observable";
  14847. import { Nullable } from "babylonjs/types";
  14848. import { Camera } from "babylonjs/Cameras/camera";
  14849. import { Scene } from "babylonjs/scene";
  14850. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14851. import { Node } from "babylonjs/node";
  14852. import { Bone } from "babylonjs/Bones/bone";
  14853. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14854. import { Space } from "babylonjs/Maths/math.axis";
  14855. /**
  14856. * 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.
  14857. * @see https://doc.babylonjs.com/how_to/transformnode
  14858. */
  14859. export class TransformNode extends Node {
  14860. /**
  14861. * Object will not rotate to face the camera
  14862. */
  14863. static BILLBOARDMODE_NONE: number;
  14864. /**
  14865. * Object will rotate to face the camera but only on the x axis
  14866. */
  14867. static BILLBOARDMODE_X: number;
  14868. /**
  14869. * Object will rotate to face the camera but only on the y axis
  14870. */
  14871. static BILLBOARDMODE_Y: number;
  14872. /**
  14873. * Object will rotate to face the camera but only on the z axis
  14874. */
  14875. static BILLBOARDMODE_Z: number;
  14876. /**
  14877. * Object will rotate to face the camera
  14878. */
  14879. static BILLBOARDMODE_ALL: number;
  14880. /**
  14881. * Object will rotate to face the camera's position instead of orientation
  14882. */
  14883. static BILLBOARDMODE_USE_POSITION: number;
  14884. private static _TmpRotation;
  14885. private static _TmpScaling;
  14886. private static _TmpTranslation;
  14887. private _forward;
  14888. private _forwardInverted;
  14889. private _up;
  14890. private _right;
  14891. private _rightInverted;
  14892. private _position;
  14893. private _rotation;
  14894. private _rotationQuaternion;
  14895. protected _scaling: Vector3;
  14896. protected _isDirty: boolean;
  14897. private _transformToBoneReferal;
  14898. private _isAbsoluteSynced;
  14899. private _billboardMode;
  14900. /**
  14901. * Gets or sets the billboard mode. Default is 0.
  14902. *
  14903. * | Value | Type | Description |
  14904. * | --- | --- | --- |
  14905. * | 0 | BILLBOARDMODE_NONE | |
  14906. * | 1 | BILLBOARDMODE_X | |
  14907. * | 2 | BILLBOARDMODE_Y | |
  14908. * | 4 | BILLBOARDMODE_Z | |
  14909. * | 7 | BILLBOARDMODE_ALL | |
  14910. *
  14911. */
  14912. get billboardMode(): number;
  14913. set billboardMode(value: number);
  14914. private _preserveParentRotationForBillboard;
  14915. /**
  14916. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14917. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14918. */
  14919. get preserveParentRotationForBillboard(): boolean;
  14920. set preserveParentRotationForBillboard(value: boolean);
  14921. /**
  14922. * 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
  14923. */
  14924. scalingDeterminant: number;
  14925. private _infiniteDistance;
  14926. /**
  14927. * Gets or sets the distance of the object to max, often used by skybox
  14928. */
  14929. get infiniteDistance(): boolean;
  14930. set infiniteDistance(value: boolean);
  14931. /**
  14932. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14933. * By default the system will update normals to compensate
  14934. */
  14935. ignoreNonUniformScaling: boolean;
  14936. /**
  14937. * 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
  14938. */
  14939. reIntegrateRotationIntoRotationQuaternion: boolean;
  14940. /** @hidden */
  14941. _poseMatrix: Nullable<Matrix>;
  14942. /** @hidden */
  14943. _localMatrix: Matrix;
  14944. private _usePivotMatrix;
  14945. private _absolutePosition;
  14946. private _absoluteScaling;
  14947. private _absoluteRotationQuaternion;
  14948. private _pivotMatrix;
  14949. private _pivotMatrixInverse;
  14950. protected _postMultiplyPivotMatrix: boolean;
  14951. protected _isWorldMatrixFrozen: boolean;
  14952. /** @hidden */
  14953. _indexInSceneTransformNodesArray: number;
  14954. /**
  14955. * An event triggered after the world matrix is updated
  14956. */
  14957. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14958. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14959. /**
  14960. * Gets a string identifying the name of the class
  14961. * @returns "TransformNode" string
  14962. */
  14963. getClassName(): string;
  14964. /**
  14965. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14966. */
  14967. get position(): Vector3;
  14968. set position(newPosition: Vector3);
  14969. /**
  14970. * 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)).
  14971. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14972. */
  14973. get rotation(): Vector3;
  14974. set rotation(newRotation: Vector3);
  14975. /**
  14976. * 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)).
  14977. */
  14978. get scaling(): Vector3;
  14979. set scaling(newScaling: Vector3);
  14980. /**
  14981. * 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).
  14982. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14983. */
  14984. get rotationQuaternion(): Nullable<Quaternion>;
  14985. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  14986. /**
  14987. * The forward direction of that transform in world space.
  14988. */
  14989. get forward(): Vector3;
  14990. /**
  14991. * The up direction of that transform in world space.
  14992. */
  14993. get up(): Vector3;
  14994. /**
  14995. * The right direction of that transform in world space.
  14996. */
  14997. get right(): Vector3;
  14998. /**
  14999. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15000. * @param matrix the matrix to copy the pose from
  15001. * @returns this TransformNode.
  15002. */
  15003. updatePoseMatrix(matrix: Matrix): TransformNode;
  15004. /**
  15005. * Returns the mesh Pose matrix.
  15006. * @returns the pose matrix
  15007. */
  15008. getPoseMatrix(): Matrix;
  15009. /** @hidden */
  15010. _isSynchronized(): boolean;
  15011. /** @hidden */
  15012. _initCache(): void;
  15013. /**
  15014. * Flag the transform node as dirty (Forcing it to update everything)
  15015. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15016. * @returns this transform node
  15017. */
  15018. markAsDirty(property: string): TransformNode;
  15019. /**
  15020. * Returns the current mesh absolute position.
  15021. * Returns a Vector3.
  15022. */
  15023. get absolutePosition(): Vector3;
  15024. /**
  15025. * Returns the current mesh absolute scaling.
  15026. * Returns a Vector3.
  15027. */
  15028. get absoluteScaling(): Vector3;
  15029. /**
  15030. * Returns the current mesh absolute rotation.
  15031. * Returns a Quaternion.
  15032. */
  15033. get absoluteRotationQuaternion(): Quaternion;
  15034. /**
  15035. * Sets a new matrix to apply before all other transformation
  15036. * @param matrix defines the transform matrix
  15037. * @returns the current TransformNode
  15038. */
  15039. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15040. /**
  15041. * Sets a new pivot matrix to the current node
  15042. * @param matrix defines the new pivot matrix to use
  15043. * @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
  15044. * @returns the current TransformNode
  15045. */
  15046. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15047. /**
  15048. * Returns the mesh pivot matrix.
  15049. * Default : Identity.
  15050. * @returns the matrix
  15051. */
  15052. getPivotMatrix(): Matrix;
  15053. /**
  15054. * Instantiate (when possible) or clone that node with its hierarchy
  15055. * @param newParent defines the new parent to use for the instance (or clone)
  15056. * @param options defines options to configure how copy is done
  15057. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15058. * @returns an instance (or a clone) of the current node with its hiearchy
  15059. */
  15060. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15061. doNotInstantiate: boolean;
  15062. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15063. /**
  15064. * Prevents the World matrix to be computed any longer
  15065. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15066. * @returns the TransformNode.
  15067. */
  15068. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15069. /**
  15070. * Allows back the World matrix computation.
  15071. * @returns the TransformNode.
  15072. */
  15073. unfreezeWorldMatrix(): this;
  15074. /**
  15075. * True if the World matrix has been frozen.
  15076. */
  15077. get isWorldMatrixFrozen(): boolean;
  15078. /**
  15079. * Retuns the mesh absolute position in the World.
  15080. * @returns a Vector3.
  15081. */
  15082. getAbsolutePosition(): Vector3;
  15083. /**
  15084. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15085. * @param absolutePosition the absolute position to set
  15086. * @returns the TransformNode.
  15087. */
  15088. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15089. /**
  15090. * Sets the mesh position in its local space.
  15091. * @param vector3 the position to set in localspace
  15092. * @returns the TransformNode.
  15093. */
  15094. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15095. /**
  15096. * Returns the mesh position in the local space from the current World matrix values.
  15097. * @returns a new Vector3.
  15098. */
  15099. getPositionExpressedInLocalSpace(): Vector3;
  15100. /**
  15101. * Translates the mesh along the passed Vector3 in its local space.
  15102. * @param vector3 the distance to translate in localspace
  15103. * @returns the TransformNode.
  15104. */
  15105. locallyTranslate(vector3: Vector3): TransformNode;
  15106. private static _lookAtVectorCache;
  15107. /**
  15108. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15109. * @param targetPoint the position (must be in same space as current mesh) to look at
  15110. * @param yawCor optional yaw (y-axis) correction in radians
  15111. * @param pitchCor optional pitch (x-axis) correction in radians
  15112. * @param rollCor optional roll (z-axis) correction in radians
  15113. * @param space the choosen space of the target
  15114. * @returns the TransformNode.
  15115. */
  15116. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15117. /**
  15118. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15119. * This Vector3 is expressed in the World space.
  15120. * @param localAxis axis to rotate
  15121. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15122. */
  15123. getDirection(localAxis: Vector3): Vector3;
  15124. /**
  15125. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15126. * localAxis is expressed in the mesh local space.
  15127. * result is computed in the Wordl space from the mesh World matrix.
  15128. * @param localAxis axis to rotate
  15129. * @param result the resulting transformnode
  15130. * @returns this TransformNode.
  15131. */
  15132. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15133. /**
  15134. * Sets this transform node rotation to the given local axis.
  15135. * @param localAxis the axis in local space
  15136. * @param yawCor optional yaw (y-axis) correction in radians
  15137. * @param pitchCor optional pitch (x-axis) correction in radians
  15138. * @param rollCor optional roll (z-axis) correction in radians
  15139. * @returns this TransformNode
  15140. */
  15141. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15142. /**
  15143. * Sets a new pivot point to the current node
  15144. * @param point defines the new pivot point to use
  15145. * @param space defines if the point is in world or local space (local by default)
  15146. * @returns the current TransformNode
  15147. */
  15148. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15149. /**
  15150. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15151. * @returns the pivot point
  15152. */
  15153. getPivotPoint(): Vector3;
  15154. /**
  15155. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15156. * @param result the vector3 to store the result
  15157. * @returns this TransformNode.
  15158. */
  15159. getPivotPointToRef(result: Vector3): TransformNode;
  15160. /**
  15161. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15162. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15163. */
  15164. getAbsolutePivotPoint(): Vector3;
  15165. /**
  15166. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15167. * @param result vector3 to store the result
  15168. * @returns this TransformNode.
  15169. */
  15170. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15171. /**
  15172. * Defines the passed node as the parent of the current node.
  15173. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15174. * @see https://doc.babylonjs.com/how_to/parenting
  15175. * @param node the node ot set as the parent
  15176. * @returns this TransformNode.
  15177. */
  15178. setParent(node: Nullable<Node>): TransformNode;
  15179. private _nonUniformScaling;
  15180. /**
  15181. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15182. */
  15183. get nonUniformScaling(): boolean;
  15184. /** @hidden */
  15185. _updateNonUniformScalingState(value: boolean): boolean;
  15186. /**
  15187. * Attach the current TransformNode to another TransformNode associated with a bone
  15188. * @param bone Bone affecting the TransformNode
  15189. * @param affectedTransformNode TransformNode associated with the bone
  15190. * @returns this object
  15191. */
  15192. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15193. /**
  15194. * Detach the transform node if its associated with a bone
  15195. * @returns this object
  15196. */
  15197. detachFromBone(): TransformNode;
  15198. private static _rotationAxisCache;
  15199. /**
  15200. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15201. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15202. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15203. * The passed axis is also normalized.
  15204. * @param axis the axis to rotate around
  15205. * @param amount the amount to rotate in radians
  15206. * @param space Space to rotate in (Default: local)
  15207. * @returns the TransformNode.
  15208. */
  15209. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15210. /**
  15211. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15212. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15213. * The passed axis is also normalized. .
  15214. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15215. * @param point the point to rotate around
  15216. * @param axis the axis to rotate around
  15217. * @param amount the amount to rotate in radians
  15218. * @returns the TransformNode
  15219. */
  15220. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15221. /**
  15222. * Translates the mesh along the axis vector for the passed distance in the given space.
  15223. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15224. * @param axis the axis to translate in
  15225. * @param distance the distance to translate
  15226. * @param space Space to rotate in (Default: local)
  15227. * @returns the TransformNode.
  15228. */
  15229. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15230. /**
  15231. * Adds a rotation step to the mesh current rotation.
  15232. * x, y, z are Euler angles expressed in radians.
  15233. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15234. * This means this rotation is made in the mesh local space only.
  15235. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15236. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15237. * ```javascript
  15238. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15239. * ```
  15240. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15241. * 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.
  15242. * @param x Rotation to add
  15243. * @param y Rotation to add
  15244. * @param z Rotation to add
  15245. * @returns the TransformNode.
  15246. */
  15247. addRotation(x: number, y: number, z: number): TransformNode;
  15248. /**
  15249. * @hidden
  15250. */
  15251. protected _getEffectiveParent(): Nullable<Node>;
  15252. /**
  15253. * Computes the world matrix of the node
  15254. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15255. * @returns the world matrix
  15256. */
  15257. computeWorldMatrix(force?: boolean): Matrix;
  15258. /**
  15259. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15260. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15261. */
  15262. resetLocalMatrix(independentOfChildren?: boolean): void;
  15263. protected _afterComputeWorldMatrix(): void;
  15264. /**
  15265. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15266. * @param func callback function to add
  15267. *
  15268. * @returns the TransformNode.
  15269. */
  15270. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15271. /**
  15272. * Removes a registered callback function.
  15273. * @param func callback function to remove
  15274. * @returns the TransformNode.
  15275. */
  15276. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15277. /**
  15278. * Gets the position of the current mesh in camera space
  15279. * @param camera defines the camera to use
  15280. * @returns a position
  15281. */
  15282. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15283. /**
  15284. * Returns the distance from the mesh to the active camera
  15285. * @param camera defines the camera to use
  15286. * @returns the distance
  15287. */
  15288. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15289. /**
  15290. * Clone the current transform node
  15291. * @param name Name of the new clone
  15292. * @param newParent New parent for the clone
  15293. * @param doNotCloneChildren Do not clone children hierarchy
  15294. * @returns the new transform node
  15295. */
  15296. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15297. /**
  15298. * Serializes the objects information.
  15299. * @param currentSerializationObject defines the object to serialize in
  15300. * @returns the serialized object
  15301. */
  15302. serialize(currentSerializationObject?: any): any;
  15303. /**
  15304. * Returns a new TransformNode object parsed from the source provided.
  15305. * @param parsedTransformNode is the source.
  15306. * @param scene the scne the object belongs to
  15307. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15308. * @returns a new TransformNode object parsed from the source provided.
  15309. */
  15310. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15311. /**
  15312. * Get all child-transformNodes of this node
  15313. * @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
  15314. * @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
  15315. * @returns an array of TransformNode
  15316. */
  15317. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15318. /**
  15319. * Releases resources associated with this transform node.
  15320. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15321. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15322. */
  15323. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15324. /**
  15325. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15326. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15327. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15328. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15329. * @returns the current mesh
  15330. */
  15331. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15332. private _syncAbsoluteScalingAndRotation;
  15333. }
  15334. }
  15335. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15336. /**
  15337. * Class used to override all child animations of a given target
  15338. */
  15339. export class AnimationPropertiesOverride {
  15340. /**
  15341. * Gets or sets a value indicating if animation blending must be used
  15342. */
  15343. enableBlending: boolean;
  15344. /**
  15345. * Gets or sets the blending speed to use when enableBlending is true
  15346. */
  15347. blendingSpeed: number;
  15348. /**
  15349. * Gets or sets the default loop mode to use
  15350. */
  15351. loopMode: number;
  15352. }
  15353. }
  15354. declare module "babylonjs/Bones/bone" {
  15355. import { Skeleton } from "babylonjs/Bones/skeleton";
  15356. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15357. import { Nullable } from "babylonjs/types";
  15358. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15359. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15360. import { Node } from "babylonjs/node";
  15361. import { Space } from "babylonjs/Maths/math.axis";
  15362. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15363. /**
  15364. * Class used to store bone information
  15365. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15366. */
  15367. export class Bone extends Node {
  15368. /**
  15369. * defines the bone name
  15370. */
  15371. name: string;
  15372. private static _tmpVecs;
  15373. private static _tmpQuat;
  15374. private static _tmpMats;
  15375. /**
  15376. * Gets the list of child bones
  15377. */
  15378. children: Bone[];
  15379. /** Gets the animations associated with this bone */
  15380. animations: import("babylonjs/Animations/animation").Animation[];
  15381. /**
  15382. * Gets or sets bone length
  15383. */
  15384. length: number;
  15385. /**
  15386. * @hidden Internal only
  15387. * Set this value to map this bone to a different index in the transform matrices
  15388. * Set this value to -1 to exclude the bone from the transform matrices
  15389. */
  15390. _index: Nullable<number>;
  15391. private _skeleton;
  15392. private _localMatrix;
  15393. private _restPose;
  15394. private _baseMatrix;
  15395. private _absoluteTransform;
  15396. private _invertedAbsoluteTransform;
  15397. private _parent;
  15398. private _scalingDeterminant;
  15399. private _worldTransform;
  15400. private _localScaling;
  15401. private _localRotation;
  15402. private _localPosition;
  15403. private _needToDecompose;
  15404. private _needToCompose;
  15405. /** @hidden */
  15406. _linkedTransformNode: Nullable<TransformNode>;
  15407. /** @hidden */
  15408. _waitingTransformNodeId: Nullable<string>;
  15409. /** @hidden */
  15410. get _matrix(): Matrix;
  15411. /** @hidden */
  15412. set _matrix(value: Matrix);
  15413. /**
  15414. * Create a new bone
  15415. * @param name defines the bone name
  15416. * @param skeleton defines the parent skeleton
  15417. * @param parentBone defines the parent (can be null if the bone is the root)
  15418. * @param localMatrix defines the local matrix
  15419. * @param restPose defines the rest pose matrix
  15420. * @param baseMatrix defines the base matrix
  15421. * @param index defines index of the bone in the hiearchy
  15422. */
  15423. constructor(
  15424. /**
  15425. * defines the bone name
  15426. */
  15427. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15428. /**
  15429. * Gets the current object class name.
  15430. * @return the class name
  15431. */
  15432. getClassName(): string;
  15433. /**
  15434. * Gets the parent skeleton
  15435. * @returns a skeleton
  15436. */
  15437. getSkeleton(): Skeleton;
  15438. /**
  15439. * Gets parent bone
  15440. * @returns a bone or null if the bone is the root of the bone hierarchy
  15441. */
  15442. getParent(): Nullable<Bone>;
  15443. /**
  15444. * Returns an array containing the root bones
  15445. * @returns an array containing the root bones
  15446. */
  15447. getChildren(): Array<Bone>;
  15448. /**
  15449. * Gets the node index in matrix array generated for rendering
  15450. * @returns the node index
  15451. */
  15452. getIndex(): number;
  15453. /**
  15454. * Sets the parent bone
  15455. * @param parent defines the parent (can be null if the bone is the root)
  15456. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15457. */
  15458. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15459. /**
  15460. * Gets the local matrix
  15461. * @returns a matrix
  15462. */
  15463. getLocalMatrix(): Matrix;
  15464. /**
  15465. * Gets the base matrix (initial matrix which remains unchanged)
  15466. * @returns a matrix
  15467. */
  15468. getBaseMatrix(): Matrix;
  15469. /**
  15470. * Gets the rest pose matrix
  15471. * @returns a matrix
  15472. */
  15473. getRestPose(): Matrix;
  15474. /**
  15475. * Sets the rest pose matrix
  15476. * @param matrix the local-space rest pose to set for this bone
  15477. */
  15478. setRestPose(matrix: Matrix): void;
  15479. /**
  15480. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15481. */
  15482. getWorldMatrix(): Matrix;
  15483. /**
  15484. * Sets the local matrix to rest pose matrix
  15485. */
  15486. returnToRest(): void;
  15487. /**
  15488. * Gets the inverse of the absolute transform matrix.
  15489. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15490. * @returns a matrix
  15491. */
  15492. getInvertedAbsoluteTransform(): Matrix;
  15493. /**
  15494. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15495. * @returns a matrix
  15496. */
  15497. getAbsoluteTransform(): Matrix;
  15498. /**
  15499. * Links with the given transform node.
  15500. * The local matrix of this bone is copied from the transform node every frame.
  15501. * @param transformNode defines the transform node to link to
  15502. */
  15503. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15504. /**
  15505. * Gets the node used to drive the bone's transformation
  15506. * @returns a transform node or null
  15507. */
  15508. getTransformNode(): Nullable<TransformNode>;
  15509. /** Gets or sets current position (in local space) */
  15510. get position(): Vector3;
  15511. set position(newPosition: Vector3);
  15512. /** Gets or sets current rotation (in local space) */
  15513. get rotation(): Vector3;
  15514. set rotation(newRotation: Vector3);
  15515. /** Gets or sets current rotation quaternion (in local space) */
  15516. get rotationQuaternion(): Quaternion;
  15517. set rotationQuaternion(newRotation: Quaternion);
  15518. /** Gets or sets current scaling (in local space) */
  15519. get scaling(): Vector3;
  15520. set scaling(newScaling: Vector3);
  15521. /**
  15522. * Gets the animation properties override
  15523. */
  15524. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15525. private _decompose;
  15526. private _compose;
  15527. /**
  15528. * Update the base and local matrices
  15529. * @param matrix defines the new base or local matrix
  15530. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15531. * @param updateLocalMatrix defines if the local matrix should be updated
  15532. */
  15533. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15534. /** @hidden */
  15535. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15536. /**
  15537. * Flag the bone as dirty (Forcing it to update everything)
  15538. */
  15539. markAsDirty(): void;
  15540. /** @hidden */
  15541. _markAsDirtyAndCompose(): void;
  15542. private _markAsDirtyAndDecompose;
  15543. /**
  15544. * Translate the bone in local or world space
  15545. * @param vec The amount to translate the bone
  15546. * @param space The space that the translation is in
  15547. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15548. */
  15549. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15550. /**
  15551. * Set the postion of the bone in local or world space
  15552. * @param position The position to set the bone
  15553. * @param space The space that the position is in
  15554. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15555. */
  15556. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15557. /**
  15558. * Set the absolute position of the bone (world space)
  15559. * @param position The position to set the bone
  15560. * @param mesh The mesh that this bone is attached to
  15561. */
  15562. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15563. /**
  15564. * Scale the bone on the x, y and z axes (in local space)
  15565. * @param x The amount to scale the bone on the x axis
  15566. * @param y The amount to scale the bone on the y axis
  15567. * @param z The amount to scale the bone on the z axis
  15568. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15569. */
  15570. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15571. /**
  15572. * Set the bone scaling in local space
  15573. * @param scale defines the scaling vector
  15574. */
  15575. setScale(scale: Vector3): void;
  15576. /**
  15577. * Gets the current scaling in local space
  15578. * @returns the current scaling vector
  15579. */
  15580. getScale(): Vector3;
  15581. /**
  15582. * Gets the current scaling in local space and stores it in a target vector
  15583. * @param result defines the target vector
  15584. */
  15585. getScaleToRef(result: Vector3): void;
  15586. /**
  15587. * Set the yaw, pitch, and roll of the bone in local or world space
  15588. * @param yaw The rotation of the bone on the y axis
  15589. * @param pitch The rotation of the bone on the x axis
  15590. * @param roll The rotation of the bone on the z axis
  15591. * @param space The space that the axes of rotation are in
  15592. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15593. */
  15594. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15595. /**
  15596. * Add a rotation to the bone on an axis in local or world space
  15597. * @param axis The axis to rotate the bone on
  15598. * @param amount The amount to rotate the bone
  15599. * @param space The space that the axis is in
  15600. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15601. */
  15602. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15603. /**
  15604. * Set the rotation of the bone to a particular axis angle in local or world space
  15605. * @param axis The axis to rotate the bone on
  15606. * @param angle The angle that the bone should be rotated to
  15607. * @param space The space that the axis is in
  15608. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15609. */
  15610. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15611. /**
  15612. * Set the euler rotation of the bone in local of world space
  15613. * @param rotation The euler rotation that the bone should be set to
  15614. * @param space The space that the rotation is in
  15615. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15616. */
  15617. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15618. /**
  15619. * Set the quaternion rotation of the bone in local of world space
  15620. * @param quat The quaternion rotation that the bone should be set to
  15621. * @param space The space that the rotation is in
  15622. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15623. */
  15624. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15625. /**
  15626. * Set the rotation matrix of the bone in local of world space
  15627. * @param rotMat The rotation matrix that the bone should be set to
  15628. * @param space The space that the rotation is in
  15629. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15630. */
  15631. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15632. private _rotateWithMatrix;
  15633. private _getNegativeRotationToRef;
  15634. /**
  15635. * Get the position of the bone in local or world space
  15636. * @param space The space that the returned position is in
  15637. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15638. * @returns The position of the bone
  15639. */
  15640. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15641. /**
  15642. * Copy the position of the bone to a vector3 in local or world space
  15643. * @param space The space that the returned position is in
  15644. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15645. * @param result The vector3 to copy the position to
  15646. */
  15647. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15648. /**
  15649. * Get the absolute position of the bone (world space)
  15650. * @param mesh The mesh that this bone is attached to
  15651. * @returns The absolute position of the bone
  15652. */
  15653. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15654. /**
  15655. * Copy the absolute position of the bone (world space) to the result param
  15656. * @param mesh The mesh that this bone is attached to
  15657. * @param result The vector3 to copy the absolute position to
  15658. */
  15659. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15660. /**
  15661. * Compute the absolute transforms of this bone and its children
  15662. */
  15663. computeAbsoluteTransforms(): void;
  15664. /**
  15665. * Get the world direction from an axis that is in the local space of the bone
  15666. * @param localAxis The local direction that is used to compute the world direction
  15667. * @param mesh The mesh that this bone is attached to
  15668. * @returns The world direction
  15669. */
  15670. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15671. /**
  15672. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15673. * @param localAxis The local direction that is used to compute the world direction
  15674. * @param mesh The mesh that this bone is attached to
  15675. * @param result The vector3 that the world direction will be copied to
  15676. */
  15677. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15678. /**
  15679. * Get the euler rotation of the bone in local or world space
  15680. * @param space The space that the rotation should be in
  15681. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15682. * @returns The euler rotation
  15683. */
  15684. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15685. /**
  15686. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15687. * @param space The space that the rotation should be in
  15688. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15689. * @param result The vector3 that the rotation should be copied to
  15690. */
  15691. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15692. /**
  15693. * Get the quaternion rotation of the bone in either local or world space
  15694. * @param space The space that the rotation should be in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. * @returns The quaternion rotation
  15697. */
  15698. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15699. /**
  15700. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15701. * @param space The space that the rotation should be in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. * @param result The quaternion that the rotation should be copied to
  15704. */
  15705. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15706. /**
  15707. * Get the rotation matrix of the bone in local or world space
  15708. * @param space The space that the rotation should be in
  15709. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15710. * @returns The rotation matrix
  15711. */
  15712. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15713. /**
  15714. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15715. * @param space The space that the rotation should be in
  15716. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15717. * @param result The quaternion that the rotation should be copied to
  15718. */
  15719. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15720. /**
  15721. * Get the world position of a point that is in the local space of the bone
  15722. * @param position The local position
  15723. * @param mesh The mesh that this bone is attached to
  15724. * @returns The world position
  15725. */
  15726. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15727. /**
  15728. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15729. * @param position The local position
  15730. * @param mesh The mesh that this bone is attached to
  15731. * @param result The vector3 that the world position should be copied to
  15732. */
  15733. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15734. /**
  15735. * Get the local position of a point that is in world space
  15736. * @param position The world position
  15737. * @param mesh The mesh that this bone is attached to
  15738. * @returns The local position
  15739. */
  15740. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15741. /**
  15742. * Get the local position of a point that is in world space and copy it to the result param
  15743. * @param position The world position
  15744. * @param mesh The mesh that this bone is attached to
  15745. * @param result The vector3 that the local position should be copied to
  15746. */
  15747. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15748. }
  15749. }
  15750. declare module "babylonjs/Animations/runtimeAnimation" {
  15751. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15752. import { Animatable } from "babylonjs/Animations/animatable";
  15753. import { Scene } from "babylonjs/scene";
  15754. /**
  15755. * Defines a runtime animation
  15756. */
  15757. export class RuntimeAnimation {
  15758. private _events;
  15759. /**
  15760. * The current frame of the runtime animation
  15761. */
  15762. private _currentFrame;
  15763. /**
  15764. * The animation used by the runtime animation
  15765. */
  15766. private _animation;
  15767. /**
  15768. * The target of the runtime animation
  15769. */
  15770. private _target;
  15771. /**
  15772. * The initiating animatable
  15773. */
  15774. private _host;
  15775. /**
  15776. * The original value of the runtime animation
  15777. */
  15778. private _originalValue;
  15779. /**
  15780. * The original blend value of the runtime animation
  15781. */
  15782. private _originalBlendValue;
  15783. /**
  15784. * The offsets cache of the runtime animation
  15785. */
  15786. private _offsetsCache;
  15787. /**
  15788. * The high limits cache of the runtime animation
  15789. */
  15790. private _highLimitsCache;
  15791. /**
  15792. * Specifies if the runtime animation has been stopped
  15793. */
  15794. private _stopped;
  15795. /**
  15796. * The blending factor of the runtime animation
  15797. */
  15798. private _blendingFactor;
  15799. /**
  15800. * The BabylonJS scene
  15801. */
  15802. private _scene;
  15803. /**
  15804. * The current value of the runtime animation
  15805. */
  15806. private _currentValue;
  15807. /** @hidden */
  15808. _animationState: _IAnimationState;
  15809. /**
  15810. * The active target of the runtime animation
  15811. */
  15812. private _activeTargets;
  15813. private _currentActiveTarget;
  15814. private _directTarget;
  15815. /**
  15816. * The target path of the runtime animation
  15817. */
  15818. private _targetPath;
  15819. /**
  15820. * The weight of the runtime animation
  15821. */
  15822. private _weight;
  15823. /**
  15824. * The ratio offset of the runtime animation
  15825. */
  15826. private _ratioOffset;
  15827. /**
  15828. * The previous delay of the runtime animation
  15829. */
  15830. private _previousDelay;
  15831. /**
  15832. * The previous ratio of the runtime animation
  15833. */
  15834. private _previousRatio;
  15835. private _enableBlending;
  15836. private _keys;
  15837. private _minFrame;
  15838. private _maxFrame;
  15839. private _minValue;
  15840. private _maxValue;
  15841. private _targetIsArray;
  15842. /**
  15843. * Gets the current frame of the runtime animation
  15844. */
  15845. get currentFrame(): number;
  15846. /**
  15847. * Gets the weight of the runtime animation
  15848. */
  15849. get weight(): number;
  15850. /**
  15851. * Gets the current value of the runtime animation
  15852. */
  15853. get currentValue(): any;
  15854. /**
  15855. * Gets the target path of the runtime animation
  15856. */
  15857. get targetPath(): string;
  15858. /**
  15859. * Gets the actual target of the runtime animation
  15860. */
  15861. get target(): any;
  15862. /**
  15863. * Gets the additive state of the runtime animation
  15864. */
  15865. get isAdditive(): boolean;
  15866. /** @hidden */
  15867. _onLoop: () => void;
  15868. /**
  15869. * Create a new RuntimeAnimation object
  15870. * @param target defines the target of the animation
  15871. * @param animation defines the source animation object
  15872. * @param scene defines the hosting scene
  15873. * @param host defines the initiating Animatable
  15874. */
  15875. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  15876. private _preparePath;
  15877. /**
  15878. * Gets the animation from the runtime animation
  15879. */
  15880. get animation(): Animation;
  15881. /**
  15882. * Resets the runtime animation to the beginning
  15883. * @param restoreOriginal defines whether to restore the target property to the original value
  15884. */
  15885. reset(restoreOriginal?: boolean): void;
  15886. /**
  15887. * Specifies if the runtime animation is stopped
  15888. * @returns Boolean specifying if the runtime animation is stopped
  15889. */
  15890. isStopped(): boolean;
  15891. /**
  15892. * Disposes of the runtime animation
  15893. */
  15894. dispose(): void;
  15895. /**
  15896. * Apply the interpolated value to the target
  15897. * @param currentValue defines the value computed by the animation
  15898. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  15899. */
  15900. setValue(currentValue: any, weight: number): void;
  15901. private _getOriginalValues;
  15902. private _setValue;
  15903. /**
  15904. * Gets the loop pmode of the runtime animation
  15905. * @returns Loop Mode
  15906. */
  15907. private _getCorrectLoopMode;
  15908. /**
  15909. * Move the current animation to a given frame
  15910. * @param frame defines the frame to move to
  15911. */
  15912. goToFrame(frame: number): void;
  15913. /**
  15914. * @hidden Internal use only
  15915. */
  15916. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  15917. /**
  15918. * Execute the current animation
  15919. * @param delay defines the delay to add to the current frame
  15920. * @param from defines the lower bound of the animation range
  15921. * @param to defines the upper bound of the animation range
  15922. * @param loop defines if the current animation must loop
  15923. * @param speedRatio defines the current speed ratio
  15924. * @param weight defines the weight of the animation (default is -1 so no weight)
  15925. * @param onLoop optional callback called when animation loops
  15926. * @returns a boolean indicating if the animation is running
  15927. */
  15928. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  15929. }
  15930. }
  15931. declare module "babylonjs/Animations/animatable" {
  15932. import { Animation } from "babylonjs/Animations/animation";
  15933. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  15934. import { Nullable } from "babylonjs/types";
  15935. import { Observable } from "babylonjs/Misc/observable";
  15936. import { Scene } from "babylonjs/scene";
  15937. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  15938. import { Node } from "babylonjs/node";
  15939. /**
  15940. * Class used to store an actual running animation
  15941. */
  15942. export class Animatable {
  15943. /** defines the target object */
  15944. target: any;
  15945. /** defines the starting frame number (default is 0) */
  15946. fromFrame: number;
  15947. /** defines the ending frame number (default is 100) */
  15948. toFrame: number;
  15949. /** defines if the animation must loop (default is false) */
  15950. loopAnimation: boolean;
  15951. /** defines a callback to call when animation ends if it is not looping */
  15952. onAnimationEnd?: (() => void) | null | undefined;
  15953. /** defines a callback to call when animation loops */
  15954. onAnimationLoop?: (() => void) | null | undefined;
  15955. /** defines whether the animation should be evaluated additively */
  15956. isAdditive: boolean;
  15957. private _localDelayOffset;
  15958. private _pausedDelay;
  15959. private _runtimeAnimations;
  15960. private _paused;
  15961. private _scene;
  15962. private _speedRatio;
  15963. private _weight;
  15964. private _syncRoot;
  15965. /**
  15966. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  15967. * This will only apply for non looping animation (default is true)
  15968. */
  15969. disposeOnEnd: boolean;
  15970. /**
  15971. * Gets a boolean indicating if the animation has started
  15972. */
  15973. animationStarted: boolean;
  15974. /**
  15975. * Observer raised when the animation ends
  15976. */
  15977. onAnimationEndObservable: Observable<Animatable>;
  15978. /**
  15979. * Observer raised when the animation loops
  15980. */
  15981. onAnimationLoopObservable: Observable<Animatable>;
  15982. /**
  15983. * Gets the root Animatable used to synchronize and normalize animations
  15984. */
  15985. get syncRoot(): Nullable<Animatable>;
  15986. /**
  15987. * Gets the current frame of the first RuntimeAnimation
  15988. * Used to synchronize Animatables
  15989. */
  15990. get masterFrame(): number;
  15991. /**
  15992. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  15993. */
  15994. get weight(): number;
  15995. set weight(value: number);
  15996. /**
  15997. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  15998. */
  15999. get speedRatio(): number;
  16000. set speedRatio(value: number);
  16001. /**
  16002. * Creates a new Animatable
  16003. * @param scene defines the hosting scene
  16004. * @param target defines the target object
  16005. * @param fromFrame defines the starting frame number (default is 0)
  16006. * @param toFrame defines the ending frame number (default is 100)
  16007. * @param loopAnimation defines if the animation must loop (default is false)
  16008. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16009. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16010. * @param animations defines a group of animation to add to the new Animatable
  16011. * @param onAnimationLoop defines a callback to call when animation loops
  16012. * @param isAdditive defines whether the animation should be evaluated additively
  16013. */
  16014. constructor(scene: Scene,
  16015. /** defines the target object */
  16016. target: any,
  16017. /** defines the starting frame number (default is 0) */
  16018. fromFrame?: number,
  16019. /** defines the ending frame number (default is 100) */
  16020. toFrame?: number,
  16021. /** defines if the animation must loop (default is false) */
  16022. loopAnimation?: boolean, speedRatio?: number,
  16023. /** defines a callback to call when animation ends if it is not looping */
  16024. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16025. /** defines a callback to call when animation loops */
  16026. onAnimationLoop?: (() => void) | null | undefined,
  16027. /** defines whether the animation should be evaluated additively */
  16028. isAdditive?: boolean);
  16029. /**
  16030. * Synchronize and normalize current Animatable with a source Animatable
  16031. * This is useful when using animation weights and when animations are not of the same length
  16032. * @param root defines the root Animatable to synchronize with
  16033. * @returns the current Animatable
  16034. */
  16035. syncWith(root: Animatable): Animatable;
  16036. /**
  16037. * Gets the list of runtime animations
  16038. * @returns an array of RuntimeAnimation
  16039. */
  16040. getAnimations(): RuntimeAnimation[];
  16041. /**
  16042. * Adds more animations to the current animatable
  16043. * @param target defines the target of the animations
  16044. * @param animations defines the new animations to add
  16045. */
  16046. appendAnimations(target: any, animations: Animation[]): void;
  16047. /**
  16048. * Gets the source animation for a specific property
  16049. * @param property defines the propertyu to look for
  16050. * @returns null or the source animation for the given property
  16051. */
  16052. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16053. /**
  16054. * Gets the runtime animation for a specific property
  16055. * @param property defines the propertyu to look for
  16056. * @returns null or the runtime animation for the given property
  16057. */
  16058. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16059. /**
  16060. * Resets the animatable to its original state
  16061. */
  16062. reset(): void;
  16063. /**
  16064. * Allows the animatable to blend with current running animations
  16065. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16066. * @param blendingSpeed defines the blending speed to use
  16067. */
  16068. enableBlending(blendingSpeed: number): void;
  16069. /**
  16070. * Disable animation blending
  16071. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16072. */
  16073. disableBlending(): void;
  16074. /**
  16075. * Jump directly to a given frame
  16076. * @param frame defines the frame to jump to
  16077. */
  16078. goToFrame(frame: number): void;
  16079. /**
  16080. * Pause the animation
  16081. */
  16082. pause(): void;
  16083. /**
  16084. * Restart the animation
  16085. */
  16086. restart(): void;
  16087. private _raiseOnAnimationEnd;
  16088. /**
  16089. * Stop and delete the current animation
  16090. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16091. * @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)
  16092. */
  16093. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16094. /**
  16095. * Wait asynchronously for the animation to end
  16096. * @returns a promise which will be fullfilled when the animation ends
  16097. */
  16098. waitAsync(): Promise<Animatable>;
  16099. /** @hidden */
  16100. _animate(delay: number): boolean;
  16101. }
  16102. module "babylonjs/scene" {
  16103. interface Scene {
  16104. /** @hidden */
  16105. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16106. /** @hidden */
  16107. _processLateAnimationBindingsForMatrices(holder: {
  16108. totalWeight: number;
  16109. totalAdditiveWeight: number;
  16110. animations: RuntimeAnimation[];
  16111. additiveAnimations: RuntimeAnimation[];
  16112. originalValue: Matrix;
  16113. }): any;
  16114. /** @hidden */
  16115. _processLateAnimationBindingsForQuaternions(holder: {
  16116. totalWeight: number;
  16117. totalAdditiveWeight: number;
  16118. animations: RuntimeAnimation[];
  16119. additiveAnimations: RuntimeAnimation[];
  16120. originalValue: Quaternion;
  16121. }, refQuaternion: Quaternion): Quaternion;
  16122. /** @hidden */
  16123. _processLateAnimationBindings(): void;
  16124. /**
  16125. * Will start the animation sequence of a given target
  16126. * @param target defines the target
  16127. * @param from defines from which frame should animation start
  16128. * @param to defines until which frame should animation run.
  16129. * @param weight defines the weight to apply to the animation (1.0 by default)
  16130. * @param loop defines if the animation loops
  16131. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16132. * @param onAnimationEnd defines the function to be executed when the animation ends
  16133. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16134. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16135. * @param onAnimationLoop defines the callback to call when an animation loops
  16136. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16137. * @returns the animatable object created for this animation
  16138. */
  16139. 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;
  16140. /**
  16141. * Will start the animation sequence of a given target
  16142. * @param target defines the target
  16143. * @param from defines from which frame should animation start
  16144. * @param to defines until which frame should animation run.
  16145. * @param loop defines if the animation loops
  16146. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16147. * @param onAnimationEnd defines the function to be executed when the animation ends
  16148. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16149. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16150. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16151. * @param onAnimationLoop defines the callback to call when an animation loops
  16152. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16153. * @returns the animatable object created for this animation
  16154. */
  16155. 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;
  16156. /**
  16157. * Will start the animation sequence of a given target and its hierarchy
  16158. * @param target defines the target
  16159. * @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.
  16160. * @param from defines from which frame should animation start
  16161. * @param to defines until which frame should animation run.
  16162. * @param loop defines if the animation loops
  16163. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16164. * @param onAnimationEnd defines the function to be executed when the animation ends
  16165. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16166. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16167. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16168. * @param onAnimationLoop defines the callback to call when an animation loops
  16169. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16170. * @returns the list of created animatables
  16171. */
  16172. 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[];
  16173. /**
  16174. * Begin a new animation on a given node
  16175. * @param target defines the target where the animation will take place
  16176. * @param animations defines the list of animations to start
  16177. * @param from defines the initial value
  16178. * @param to defines the final value
  16179. * @param loop defines if you want animation to loop (off by default)
  16180. * @param speedRatio defines the speed ratio to apply to all animations
  16181. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16182. * @param onAnimationLoop defines the callback to call when an animation loops
  16183. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16184. * @returns the list of created animatables
  16185. */
  16186. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16187. /**
  16188. * Begin a new animation on a given node and its hierarchy
  16189. * @param target defines the root node where the animation will take place
  16190. * @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.
  16191. * @param animations defines the list of animations to start
  16192. * @param from defines the initial value
  16193. * @param to defines the final value
  16194. * @param loop defines if you want animation to loop (off by default)
  16195. * @param speedRatio defines the speed ratio to apply to all animations
  16196. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16197. * @param onAnimationLoop defines the callback to call when an animation loops
  16198. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16199. * @returns the list of animatables created for all nodes
  16200. */
  16201. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16202. /**
  16203. * Gets the animatable associated with a specific target
  16204. * @param target defines the target of the animatable
  16205. * @returns the required animatable if found
  16206. */
  16207. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16208. /**
  16209. * Gets all animatables associated with a given target
  16210. * @param target defines the target to look animatables for
  16211. * @returns an array of Animatables
  16212. */
  16213. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16214. /**
  16215. * Stops and removes all animations that have been applied to the scene
  16216. */
  16217. stopAllAnimations(): void;
  16218. /**
  16219. * Gets the current delta time used by animation engine
  16220. */
  16221. deltaTime: number;
  16222. }
  16223. }
  16224. module "babylonjs/Bones/bone" {
  16225. interface Bone {
  16226. /**
  16227. * Copy an animation range from another bone
  16228. * @param source defines the source bone
  16229. * @param rangeName defines the range name to copy
  16230. * @param frameOffset defines the frame offset
  16231. * @param rescaleAsRequired defines if rescaling must be applied if required
  16232. * @param skelDimensionsRatio defines the scaling ratio
  16233. * @returns true if operation was successful
  16234. */
  16235. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16236. }
  16237. }
  16238. }
  16239. declare module "babylonjs/Bones/skeleton" {
  16240. import { Bone } from "babylonjs/Bones/bone";
  16241. import { Observable } from "babylonjs/Misc/observable";
  16242. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16243. import { Scene } from "babylonjs/scene";
  16244. import { Nullable } from "babylonjs/types";
  16245. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16246. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16247. import { Animatable } from "babylonjs/Animations/animatable";
  16248. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16249. import { Animation } from "babylonjs/Animations/animation";
  16250. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16251. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16252. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16253. /**
  16254. * Class used to handle skinning animations
  16255. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16256. */
  16257. export class Skeleton implements IAnimatable {
  16258. /** defines the skeleton name */
  16259. name: string;
  16260. /** defines the skeleton Id */
  16261. id: string;
  16262. /**
  16263. * Defines the list of child bones
  16264. */
  16265. bones: Bone[];
  16266. /**
  16267. * Defines an estimate of the dimension of the skeleton at rest
  16268. */
  16269. dimensionsAtRest: Vector3;
  16270. /**
  16271. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16272. */
  16273. needInitialSkinMatrix: boolean;
  16274. /**
  16275. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16276. */
  16277. overrideMesh: Nullable<AbstractMesh>;
  16278. /**
  16279. * Gets the list of animations attached to this skeleton
  16280. */
  16281. animations: Array<Animation>;
  16282. private _scene;
  16283. private _isDirty;
  16284. private _transformMatrices;
  16285. private _transformMatrixTexture;
  16286. private _meshesWithPoseMatrix;
  16287. private _animatables;
  16288. private _identity;
  16289. private _synchronizedWithMesh;
  16290. private _ranges;
  16291. private _lastAbsoluteTransformsUpdateId;
  16292. private _canUseTextureForBones;
  16293. private _uniqueId;
  16294. /** @hidden */
  16295. _numBonesWithLinkedTransformNode: number;
  16296. /** @hidden */
  16297. _hasWaitingData: Nullable<boolean>;
  16298. /**
  16299. * Specifies if the skeleton should be serialized
  16300. */
  16301. doNotSerialize: boolean;
  16302. private _useTextureToStoreBoneMatrices;
  16303. /**
  16304. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16305. * Please note that this option is not available if the hardware does not support it
  16306. */
  16307. get useTextureToStoreBoneMatrices(): boolean;
  16308. set useTextureToStoreBoneMatrices(value: boolean);
  16309. private _animationPropertiesOverride;
  16310. /**
  16311. * Gets or sets the animation properties override
  16312. */
  16313. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16314. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16315. /**
  16316. * List of inspectable custom properties (used by the Inspector)
  16317. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16318. */
  16319. inspectableCustomProperties: IInspectable[];
  16320. /**
  16321. * An observable triggered before computing the skeleton's matrices
  16322. */
  16323. onBeforeComputeObservable: Observable<Skeleton>;
  16324. /**
  16325. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16326. */
  16327. get isUsingTextureForMatrices(): boolean;
  16328. /**
  16329. * Gets the unique ID of this skeleton
  16330. */
  16331. get uniqueId(): number;
  16332. /**
  16333. * Creates a new skeleton
  16334. * @param name defines the skeleton name
  16335. * @param id defines the skeleton Id
  16336. * @param scene defines the hosting scene
  16337. */
  16338. constructor(
  16339. /** defines the skeleton name */
  16340. name: string,
  16341. /** defines the skeleton Id */
  16342. id: string, scene: Scene);
  16343. /**
  16344. * Gets the current object class name.
  16345. * @return the class name
  16346. */
  16347. getClassName(): string;
  16348. /**
  16349. * Returns an array containing the root bones
  16350. * @returns an array containing the root bones
  16351. */
  16352. getChildren(): Array<Bone>;
  16353. /**
  16354. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16355. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16356. * @returns a Float32Array containing matrices data
  16357. */
  16358. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16359. /**
  16360. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16361. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16362. * @returns a raw texture containing the data
  16363. */
  16364. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16365. /**
  16366. * Gets the current hosting scene
  16367. * @returns a scene object
  16368. */
  16369. getScene(): Scene;
  16370. /**
  16371. * Gets a string representing the current skeleton data
  16372. * @param fullDetails defines a boolean indicating if we want a verbose version
  16373. * @returns a string representing the current skeleton data
  16374. */
  16375. toString(fullDetails?: boolean): string;
  16376. /**
  16377. * Get bone's index searching by name
  16378. * @param name defines bone's name to search for
  16379. * @return the indice of the bone. Returns -1 if not found
  16380. */
  16381. getBoneIndexByName(name: string): number;
  16382. /**
  16383. * Creater a new animation range
  16384. * @param name defines the name of the range
  16385. * @param from defines the start key
  16386. * @param to defines the end key
  16387. */
  16388. createAnimationRange(name: string, from: number, to: number): void;
  16389. /**
  16390. * Delete a specific animation range
  16391. * @param name defines the name of the range
  16392. * @param deleteFrames defines if frames must be removed as well
  16393. */
  16394. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16395. /**
  16396. * Gets a specific animation range
  16397. * @param name defines the name of the range to look for
  16398. * @returns the requested animation range or null if not found
  16399. */
  16400. getAnimationRange(name: string): Nullable<AnimationRange>;
  16401. /**
  16402. * Gets the list of all animation ranges defined on this skeleton
  16403. * @returns an array
  16404. */
  16405. getAnimationRanges(): Nullable<AnimationRange>[];
  16406. /**
  16407. * Copy animation range from a source skeleton.
  16408. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16409. * @param source defines the source skeleton
  16410. * @param name defines the name of the range to copy
  16411. * @param rescaleAsRequired defines if rescaling must be applied if required
  16412. * @returns true if operation was successful
  16413. */
  16414. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16415. /**
  16416. * Forces the skeleton to go to rest pose
  16417. */
  16418. returnToRest(): void;
  16419. private _getHighestAnimationFrame;
  16420. /**
  16421. * Begin a specific animation range
  16422. * @param name defines the name of the range to start
  16423. * @param loop defines if looping must be turned on (false by default)
  16424. * @param speedRatio defines the speed ratio to apply (1 by default)
  16425. * @param onAnimationEnd defines a callback which will be called when animation will end
  16426. * @returns a new animatable
  16427. */
  16428. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16429. /**
  16430. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16431. * @param skeleton defines the Skeleton containing the animation range to convert
  16432. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16433. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16434. * @returns the original skeleton
  16435. */
  16436. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16437. /** @hidden */
  16438. _markAsDirty(): void;
  16439. /** @hidden */
  16440. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16441. /** @hidden */
  16442. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16443. private _computeTransformMatrices;
  16444. /**
  16445. * Build all resources required to render a skeleton
  16446. */
  16447. prepare(): void;
  16448. /**
  16449. * Gets the list of animatables currently running for this skeleton
  16450. * @returns an array of animatables
  16451. */
  16452. getAnimatables(): IAnimatable[];
  16453. /**
  16454. * Clone the current skeleton
  16455. * @param name defines the name of the new skeleton
  16456. * @param id defines the id of the new skeleton
  16457. * @returns the new skeleton
  16458. */
  16459. clone(name: string, id?: string): Skeleton;
  16460. /**
  16461. * Enable animation blending for this skeleton
  16462. * @param blendingSpeed defines the blending speed to apply
  16463. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16464. */
  16465. enableBlending(blendingSpeed?: number): void;
  16466. /**
  16467. * Releases all resources associated with the current skeleton
  16468. */
  16469. dispose(): void;
  16470. /**
  16471. * Serialize the skeleton in a JSON object
  16472. * @returns a JSON object
  16473. */
  16474. serialize(): any;
  16475. /**
  16476. * Creates a new skeleton from serialized data
  16477. * @param parsedSkeleton defines the serialized data
  16478. * @param scene defines the hosting scene
  16479. * @returns a new skeleton
  16480. */
  16481. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16482. /**
  16483. * Compute all node absolute transforms
  16484. * @param forceUpdate defines if computation must be done even if cache is up to date
  16485. */
  16486. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16487. /**
  16488. * Gets the root pose matrix
  16489. * @returns a matrix
  16490. */
  16491. getPoseMatrix(): Nullable<Matrix>;
  16492. /**
  16493. * Sorts bones per internal index
  16494. */
  16495. sortBones(): void;
  16496. private _sortBones;
  16497. }
  16498. }
  16499. declare module "babylonjs/Meshes/instancedMesh" {
  16500. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16501. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16502. import { Camera } from "babylonjs/Cameras/camera";
  16503. import { Node } from "babylonjs/node";
  16504. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16505. import { Mesh } from "babylonjs/Meshes/mesh";
  16506. import { Material } from "babylonjs/Materials/material";
  16507. import { Skeleton } from "babylonjs/Bones/skeleton";
  16508. import { Light } from "babylonjs/Lights/light";
  16509. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16510. /**
  16511. * Creates an instance based on a source mesh.
  16512. */
  16513. export class InstancedMesh extends AbstractMesh {
  16514. private _sourceMesh;
  16515. private _currentLOD;
  16516. /** @hidden */
  16517. _indexInSourceMeshInstanceArray: number;
  16518. constructor(name: string, source: Mesh);
  16519. /**
  16520. * Returns the string "InstancedMesh".
  16521. */
  16522. getClassName(): string;
  16523. /** Gets the list of lights affecting that mesh */
  16524. get lightSources(): Light[];
  16525. _resyncLightSources(): void;
  16526. _resyncLightSource(light: Light): void;
  16527. _removeLightSource(light: Light, dispose: boolean): void;
  16528. /**
  16529. * If the source mesh receives shadows
  16530. */
  16531. get receiveShadows(): boolean;
  16532. /**
  16533. * The material of the source mesh
  16534. */
  16535. get material(): Nullable<Material>;
  16536. /**
  16537. * Visibility of the source mesh
  16538. */
  16539. get visibility(): number;
  16540. /**
  16541. * Skeleton of the source mesh
  16542. */
  16543. get skeleton(): Nullable<Skeleton>;
  16544. /**
  16545. * Rendering ground id of the source mesh
  16546. */
  16547. get renderingGroupId(): number;
  16548. set renderingGroupId(value: number);
  16549. /**
  16550. * Returns the total number of vertices (integer).
  16551. */
  16552. getTotalVertices(): number;
  16553. /**
  16554. * Returns a positive integer : the total number of indices in this mesh geometry.
  16555. * @returns the numner of indices or zero if the mesh has no geometry.
  16556. */
  16557. getTotalIndices(): number;
  16558. /**
  16559. * The source mesh of the instance
  16560. */
  16561. get sourceMesh(): Mesh;
  16562. /**
  16563. * Creates a new InstancedMesh object from the mesh model.
  16564. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16565. * @param name defines the name of the new instance
  16566. * @returns a new InstancedMesh
  16567. */
  16568. createInstance(name: string): InstancedMesh;
  16569. /**
  16570. * Is this node ready to be used/rendered
  16571. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16572. * @return {boolean} is it ready
  16573. */
  16574. isReady(completeCheck?: boolean): boolean;
  16575. /**
  16576. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16577. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16578. * @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.
  16579. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16580. */
  16581. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16582. /**
  16583. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16584. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16585. * The `data` are either a numeric array either a Float32Array.
  16586. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16587. * 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).
  16588. * Note that a new underlying VertexBuffer object is created each call.
  16589. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16590. *
  16591. * Possible `kind` values :
  16592. * - VertexBuffer.PositionKind
  16593. * - VertexBuffer.UVKind
  16594. * - VertexBuffer.UV2Kind
  16595. * - VertexBuffer.UV3Kind
  16596. * - VertexBuffer.UV4Kind
  16597. * - VertexBuffer.UV5Kind
  16598. * - VertexBuffer.UV6Kind
  16599. * - VertexBuffer.ColorKind
  16600. * - VertexBuffer.MatricesIndicesKind
  16601. * - VertexBuffer.MatricesIndicesExtraKind
  16602. * - VertexBuffer.MatricesWeightsKind
  16603. * - VertexBuffer.MatricesWeightsExtraKind
  16604. *
  16605. * Returns the Mesh.
  16606. */
  16607. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16608. /**
  16609. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16610. * If the mesh has no geometry, it is simply returned as it is.
  16611. * The `data` are either a numeric array either a Float32Array.
  16612. * No new underlying VertexBuffer object is created.
  16613. * 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.
  16614. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16615. *
  16616. * Possible `kind` values :
  16617. * - VertexBuffer.PositionKind
  16618. * - VertexBuffer.UVKind
  16619. * - VertexBuffer.UV2Kind
  16620. * - VertexBuffer.UV3Kind
  16621. * - VertexBuffer.UV4Kind
  16622. * - VertexBuffer.UV5Kind
  16623. * - VertexBuffer.UV6Kind
  16624. * - VertexBuffer.ColorKind
  16625. * - VertexBuffer.MatricesIndicesKind
  16626. * - VertexBuffer.MatricesIndicesExtraKind
  16627. * - VertexBuffer.MatricesWeightsKind
  16628. * - VertexBuffer.MatricesWeightsExtraKind
  16629. *
  16630. * Returns the Mesh.
  16631. */
  16632. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16633. /**
  16634. * Sets the mesh indices.
  16635. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16636. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16637. * This method creates a new index buffer each call.
  16638. * Returns the Mesh.
  16639. */
  16640. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16641. /**
  16642. * Boolean : True if the mesh owns the requested kind of data.
  16643. */
  16644. isVerticesDataPresent(kind: string): boolean;
  16645. /**
  16646. * Returns an array of indices (IndicesArray).
  16647. */
  16648. getIndices(): Nullable<IndicesArray>;
  16649. get _positions(): Nullable<Vector3[]>;
  16650. /**
  16651. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16652. * This means the mesh underlying bounding box and sphere are recomputed.
  16653. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16654. * @returns the current mesh
  16655. */
  16656. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16657. /** @hidden */
  16658. _preActivate(): InstancedMesh;
  16659. /** @hidden */
  16660. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16661. /** @hidden */
  16662. _postActivate(): void;
  16663. getWorldMatrix(): Matrix;
  16664. get isAnInstance(): boolean;
  16665. /**
  16666. * Returns the current associated LOD AbstractMesh.
  16667. */
  16668. getLOD(camera: Camera): AbstractMesh;
  16669. /** @hidden */
  16670. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16671. /** @hidden */
  16672. _syncSubMeshes(): InstancedMesh;
  16673. /** @hidden */
  16674. _generatePointsArray(): boolean;
  16675. /**
  16676. * Creates a new InstancedMesh from the current mesh.
  16677. * - name (string) : the cloned mesh name
  16678. * - newParent (optional Node) : the optional Node to parent the clone to.
  16679. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16680. *
  16681. * Returns the clone.
  16682. */
  16683. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16684. /**
  16685. * Disposes the InstancedMesh.
  16686. * Returns nothing.
  16687. */
  16688. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16689. }
  16690. module "babylonjs/Meshes/mesh" {
  16691. interface Mesh {
  16692. /**
  16693. * Register a custom buffer that will be instanced
  16694. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16695. * @param kind defines the buffer kind
  16696. * @param stride defines the stride in floats
  16697. */
  16698. registerInstancedBuffer(kind: string, stride: number): void;
  16699. /**
  16700. * true to use the edge renderer for all instances of this mesh
  16701. */
  16702. edgesShareWithInstances: boolean;
  16703. /** @hidden */
  16704. _userInstancedBuffersStorage: {
  16705. data: {
  16706. [key: string]: Float32Array;
  16707. };
  16708. sizes: {
  16709. [key: string]: number;
  16710. };
  16711. vertexBuffers: {
  16712. [key: string]: Nullable<VertexBuffer>;
  16713. };
  16714. strides: {
  16715. [key: string]: number;
  16716. };
  16717. };
  16718. }
  16719. }
  16720. module "babylonjs/Meshes/abstractMesh" {
  16721. interface AbstractMesh {
  16722. /**
  16723. * Object used to store instanced buffers defined by user
  16724. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16725. */
  16726. instancedBuffers: {
  16727. [key: string]: any;
  16728. };
  16729. }
  16730. }
  16731. }
  16732. declare module "babylonjs/Materials/shaderMaterial" {
  16733. import { Nullable } from "babylonjs/types";
  16734. import { Scene } from "babylonjs/scene";
  16735. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16737. import { Mesh } from "babylonjs/Meshes/mesh";
  16738. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16739. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16740. import { Effect } from "babylonjs/Materials/effect";
  16741. import { Material } from "babylonjs/Materials/material";
  16742. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16743. /**
  16744. * Defines the options associated with the creation of a shader material.
  16745. */
  16746. export interface IShaderMaterialOptions {
  16747. /**
  16748. * Does the material work in alpha blend mode
  16749. */
  16750. needAlphaBlending: boolean;
  16751. /**
  16752. * Does the material work in alpha test mode
  16753. */
  16754. needAlphaTesting: boolean;
  16755. /**
  16756. * The list of attribute names used in the shader
  16757. */
  16758. attributes: string[];
  16759. /**
  16760. * The list of unifrom names used in the shader
  16761. */
  16762. uniforms: string[];
  16763. /**
  16764. * The list of UBO names used in the shader
  16765. */
  16766. uniformBuffers: string[];
  16767. /**
  16768. * The list of sampler names used in the shader
  16769. */
  16770. samplers: string[];
  16771. /**
  16772. * The list of defines used in the shader
  16773. */
  16774. defines: string[];
  16775. }
  16776. /**
  16777. * 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.
  16778. *
  16779. * This returned material effects how the mesh will look based on the code in the shaders.
  16780. *
  16781. * @see https://doc.babylonjs.com/how_to/shader_material
  16782. */
  16783. export class ShaderMaterial extends Material {
  16784. private _shaderPath;
  16785. private _options;
  16786. private _textures;
  16787. private _textureArrays;
  16788. private _floats;
  16789. private _ints;
  16790. private _floatsArrays;
  16791. private _colors3;
  16792. private _colors3Arrays;
  16793. private _colors4;
  16794. private _colors4Arrays;
  16795. private _vectors2;
  16796. private _vectors3;
  16797. private _vectors4;
  16798. private _matrices;
  16799. private _matrixArrays;
  16800. private _matrices3x3;
  16801. private _matrices2x2;
  16802. private _vectors2Arrays;
  16803. private _vectors3Arrays;
  16804. private _vectors4Arrays;
  16805. private _cachedWorldViewMatrix;
  16806. private _cachedWorldViewProjectionMatrix;
  16807. private _renderId;
  16808. private _multiview;
  16809. private _cachedDefines;
  16810. /** Define the Url to load snippets */
  16811. static SnippetUrl: string;
  16812. /** Snippet ID if the material was created from the snippet server */
  16813. snippetId: string;
  16814. /**
  16815. * Instantiate a new shader material.
  16816. * 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.
  16817. * This returned material effects how the mesh will look based on the code in the shaders.
  16818. * @see https://doc.babylonjs.com/how_to/shader_material
  16819. * @param name Define the name of the material in the scene
  16820. * @param scene Define the scene the material belongs to
  16821. * @param shaderPath Defines the route to the shader code in one of three ways:
  16822. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16823. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16824. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16825. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16826. * @param options Define the options used to create the shader
  16827. */
  16828. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16829. /**
  16830. * Gets the shader path used to define the shader code
  16831. * It can be modified to trigger a new compilation
  16832. */
  16833. get shaderPath(): any;
  16834. /**
  16835. * Sets the shader path used to define the shader code
  16836. * It can be modified to trigger a new compilation
  16837. */
  16838. set shaderPath(shaderPath: any);
  16839. /**
  16840. * Gets the options used to compile the shader.
  16841. * They can be modified to trigger a new compilation
  16842. */
  16843. get options(): IShaderMaterialOptions;
  16844. /**
  16845. * Gets the current class name of the material e.g. "ShaderMaterial"
  16846. * Mainly use in serialization.
  16847. * @returns the class name
  16848. */
  16849. getClassName(): string;
  16850. /**
  16851. * Specifies if the material will require alpha blending
  16852. * @returns a boolean specifying if alpha blending is needed
  16853. */
  16854. needAlphaBlending(): boolean;
  16855. /**
  16856. * Specifies if this material should be rendered in alpha test mode
  16857. * @returns a boolean specifying if an alpha test is needed.
  16858. */
  16859. needAlphaTesting(): boolean;
  16860. private _checkUniform;
  16861. /**
  16862. * Set a texture in the shader.
  16863. * @param name Define the name of the uniform samplers as defined in the shader
  16864. * @param texture Define the texture to bind to this sampler
  16865. * @return the material itself allowing "fluent" like uniform updates
  16866. */
  16867. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  16868. /**
  16869. * Set a texture array in the shader.
  16870. * @param name Define the name of the uniform sampler array as defined in the shader
  16871. * @param textures Define the list of textures to bind to this sampler
  16872. * @return the material itself allowing "fluent" like uniform updates
  16873. */
  16874. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  16875. /**
  16876. * Set a float in the shader.
  16877. * @param name Define the name of the uniform as defined in the shader
  16878. * @param value Define the value to give to the uniform
  16879. * @return the material itself allowing "fluent" like uniform updates
  16880. */
  16881. setFloat(name: string, value: number): ShaderMaterial;
  16882. /**
  16883. * Set a int in the shader.
  16884. * @param name Define the name of the uniform as defined in the shader
  16885. * @param value Define the value to give to the uniform
  16886. * @return the material itself allowing "fluent" like uniform updates
  16887. */
  16888. setInt(name: string, value: number): ShaderMaterial;
  16889. /**
  16890. * Set an array of floats in the shader.
  16891. * @param name Define the name of the uniform as defined in the shader
  16892. * @param value Define the value to give to the uniform
  16893. * @return the material itself allowing "fluent" like uniform updates
  16894. */
  16895. setFloats(name: string, value: number[]): ShaderMaterial;
  16896. /**
  16897. * Set a vec3 in the shader from a Color3.
  16898. * @param name Define the name of the uniform as defined in the shader
  16899. * @param value Define the value to give to the uniform
  16900. * @return the material itself allowing "fluent" like uniform updates
  16901. */
  16902. setColor3(name: string, value: Color3): ShaderMaterial;
  16903. /**
  16904. * Set a vec3 array in the shader from a Color3 array.
  16905. * @param name Define the name of the uniform as defined in the shader
  16906. * @param value Define the value to give to the uniform
  16907. * @return the material itself allowing "fluent" like uniform updates
  16908. */
  16909. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  16910. /**
  16911. * Set a vec4 in the shader from a Color4.
  16912. * @param name Define the name of the uniform as defined in the shader
  16913. * @param value Define the value to give to the uniform
  16914. * @return the material itself allowing "fluent" like uniform updates
  16915. */
  16916. setColor4(name: string, value: Color4): ShaderMaterial;
  16917. /**
  16918. * Set a vec4 array in the shader from a Color4 array.
  16919. * @param name Define the name of the uniform as defined in the shader
  16920. * @param value Define the value to give to the uniform
  16921. * @return the material itself allowing "fluent" like uniform updates
  16922. */
  16923. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  16924. /**
  16925. * Set a vec2 in the shader from a Vector2.
  16926. * @param name Define the name of the uniform as defined in the shader
  16927. * @param value Define the value to give to the uniform
  16928. * @return the material itself allowing "fluent" like uniform updates
  16929. */
  16930. setVector2(name: string, value: Vector2): ShaderMaterial;
  16931. /**
  16932. * Set a vec3 in the shader from a Vector3.
  16933. * @param name Define the name of the uniform as defined in the shader
  16934. * @param value Define the value to give to the uniform
  16935. * @return the material itself allowing "fluent" like uniform updates
  16936. */
  16937. setVector3(name: string, value: Vector3): ShaderMaterial;
  16938. /**
  16939. * Set a vec4 in the shader from a Vector4.
  16940. * @param name Define the name of the uniform as defined in the shader
  16941. * @param value Define the value to give to the uniform
  16942. * @return the material itself allowing "fluent" like uniform updates
  16943. */
  16944. setVector4(name: string, value: Vector4): ShaderMaterial;
  16945. /**
  16946. * Set a mat4 in the shader from a Matrix.
  16947. * @param name Define the name of the uniform as defined in the shader
  16948. * @param value Define the value to give to the uniform
  16949. * @return the material itself allowing "fluent" like uniform updates
  16950. */
  16951. setMatrix(name: string, value: Matrix): ShaderMaterial;
  16952. /**
  16953. * Set a float32Array in the shader from a matrix array.
  16954. * @param name Define the name of the uniform as defined in the shader
  16955. * @param value Define the value to give to the uniform
  16956. * @return the material itself allowing "fluent" like uniform updates
  16957. */
  16958. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  16959. /**
  16960. * Set a mat3 in the shader from a Float32Array.
  16961. * @param name Define the name of the uniform as defined in the shader
  16962. * @param value Define the value to give to the uniform
  16963. * @return the material itself allowing "fluent" like uniform updates
  16964. */
  16965. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  16966. /**
  16967. * Set a mat2 in the shader from a Float32Array.
  16968. * @param name Define the name of the uniform as defined in the shader
  16969. * @param value Define the value to give to the uniform
  16970. * @return the material itself allowing "fluent" like uniform updates
  16971. */
  16972. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  16973. /**
  16974. * Set a vec2 array in the shader from a number array.
  16975. * @param name Define the name of the uniform as defined in the shader
  16976. * @param value Define the value to give to the uniform
  16977. * @return the material itself allowing "fluent" like uniform updates
  16978. */
  16979. setArray2(name: string, value: number[]): ShaderMaterial;
  16980. /**
  16981. * Set a vec3 array in the shader from a number array.
  16982. * @param name Define the name of the uniform as defined in the shader
  16983. * @param value Define the value to give to the uniform
  16984. * @return the material itself allowing "fluent" like uniform updates
  16985. */
  16986. setArray3(name: string, value: number[]): ShaderMaterial;
  16987. /**
  16988. * Set a vec4 array in the shader from a number array.
  16989. * @param name Define the name of the uniform as defined in the shader
  16990. * @param value Define the value to give to the uniform
  16991. * @return the material itself allowing "fluent" like uniform updates
  16992. */
  16993. setArray4(name: string, value: number[]): ShaderMaterial;
  16994. private _checkCache;
  16995. /**
  16996. * Specifies that the submesh is ready to be used
  16997. * @param mesh defines the mesh to check
  16998. * @param subMesh defines which submesh to check
  16999. * @param useInstances specifies that instances should be used
  17000. * @returns a boolean indicating that the submesh is ready or not
  17001. */
  17002. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17003. /**
  17004. * Checks if the material is ready to render the requested mesh
  17005. * @param mesh Define the mesh to render
  17006. * @param useInstances Define whether or not the material is used with instances
  17007. * @returns true if ready, otherwise false
  17008. */
  17009. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17010. /**
  17011. * Binds the world matrix to the material
  17012. * @param world defines the world transformation matrix
  17013. * @param effectOverride - If provided, use this effect instead of internal effect
  17014. */
  17015. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17016. /**
  17017. * Binds the submesh to this material by preparing the effect and shader to draw
  17018. * @param world defines the world transformation matrix
  17019. * @param mesh defines the mesh containing the submesh
  17020. * @param subMesh defines the submesh to bind the material to
  17021. */
  17022. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17023. /**
  17024. * Binds the material to the mesh
  17025. * @param world defines the world transformation matrix
  17026. * @param mesh defines the mesh to bind the material to
  17027. * @param effectOverride - If provided, use this effect instead of internal effect
  17028. */
  17029. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17030. protected _afterBind(mesh?: Mesh): void;
  17031. /**
  17032. * Gets the active textures from the material
  17033. * @returns an array of textures
  17034. */
  17035. getActiveTextures(): BaseTexture[];
  17036. /**
  17037. * Specifies if the material uses a texture
  17038. * @param texture defines the texture to check against the material
  17039. * @returns a boolean specifying if the material uses the texture
  17040. */
  17041. hasTexture(texture: BaseTexture): boolean;
  17042. /**
  17043. * Makes a duplicate of the material, and gives it a new name
  17044. * @param name defines the new name for the duplicated material
  17045. * @returns the cloned material
  17046. */
  17047. clone(name: string): ShaderMaterial;
  17048. /**
  17049. * Disposes the material
  17050. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17051. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17052. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17053. */
  17054. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17055. /**
  17056. * Serializes this material in a JSON representation
  17057. * @returns the serialized material object
  17058. */
  17059. serialize(): any;
  17060. /**
  17061. * Creates a shader material from parsed shader material data
  17062. * @param source defines the JSON represnetation of the material
  17063. * @param scene defines the hosting scene
  17064. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17065. * @returns a new material
  17066. */
  17067. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17068. /**
  17069. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17070. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17071. * @param url defines the url to load from
  17072. * @param scene defines the hosting scene
  17073. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17074. * @returns a promise that will resolve to the new ShaderMaterial
  17075. */
  17076. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17077. /**
  17078. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17079. * @param snippetId defines the snippet to load
  17080. * @param scene defines the hosting scene
  17081. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17082. * @returns a promise that will resolve to the new ShaderMaterial
  17083. */
  17084. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17085. }
  17086. }
  17087. declare module "babylonjs/Shaders/color.fragment" {
  17088. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17089. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17090. /** @hidden */
  17091. export var colorPixelShader: {
  17092. name: string;
  17093. shader: string;
  17094. };
  17095. }
  17096. declare module "babylonjs/Shaders/color.vertex" {
  17097. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17098. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17099. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17100. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17101. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17102. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17103. /** @hidden */
  17104. export var colorVertexShader: {
  17105. name: string;
  17106. shader: string;
  17107. };
  17108. }
  17109. declare module "babylonjs/Meshes/linesMesh" {
  17110. import { Nullable } from "babylonjs/types";
  17111. import { Scene } from "babylonjs/scene";
  17112. import { Color3 } from "babylonjs/Maths/math.color";
  17113. import { Node } from "babylonjs/node";
  17114. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17115. import { Mesh } from "babylonjs/Meshes/mesh";
  17116. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17117. import { Effect } from "babylonjs/Materials/effect";
  17118. import { Material } from "babylonjs/Materials/material";
  17119. import "babylonjs/Shaders/color.fragment";
  17120. import "babylonjs/Shaders/color.vertex";
  17121. /**
  17122. * Line mesh
  17123. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17124. */
  17125. export class LinesMesh extends Mesh {
  17126. /**
  17127. * If vertex color should be applied to the mesh
  17128. */
  17129. readonly useVertexColor?: boolean | undefined;
  17130. /**
  17131. * If vertex alpha should be applied to the mesh
  17132. */
  17133. readonly useVertexAlpha?: boolean | undefined;
  17134. /**
  17135. * Color of the line (Default: White)
  17136. */
  17137. color: Color3;
  17138. /**
  17139. * Alpha of the line (Default: 1)
  17140. */
  17141. alpha: number;
  17142. /**
  17143. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17144. * This margin is expressed in world space coordinates, so its value may vary.
  17145. * Default value is 0.1
  17146. */
  17147. intersectionThreshold: number;
  17148. private _colorShader;
  17149. private color4;
  17150. /**
  17151. * Creates a new LinesMesh
  17152. * @param name defines the name
  17153. * @param scene defines the hosting scene
  17154. * @param parent defines the parent mesh if any
  17155. * @param source defines the optional source LinesMesh used to clone data from
  17156. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17157. * When false, achieved by calling a clone(), also passing False.
  17158. * This will make creation of children, recursive.
  17159. * @param useVertexColor defines if this LinesMesh supports vertex color
  17160. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17161. */
  17162. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17163. /**
  17164. * If vertex color should be applied to the mesh
  17165. */
  17166. useVertexColor?: boolean | undefined,
  17167. /**
  17168. * If vertex alpha should be applied to the mesh
  17169. */
  17170. useVertexAlpha?: boolean | undefined);
  17171. private _addClipPlaneDefine;
  17172. private _removeClipPlaneDefine;
  17173. isReady(): boolean;
  17174. /**
  17175. * Returns the string "LineMesh"
  17176. */
  17177. getClassName(): string;
  17178. /**
  17179. * @hidden
  17180. */
  17181. get material(): Material;
  17182. /**
  17183. * @hidden
  17184. */
  17185. set material(value: Material);
  17186. /**
  17187. * @hidden
  17188. */
  17189. get checkCollisions(): boolean;
  17190. /** @hidden */
  17191. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17192. /** @hidden */
  17193. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17194. /**
  17195. * Disposes of the line mesh
  17196. * @param doNotRecurse If children should be disposed
  17197. */
  17198. dispose(doNotRecurse?: boolean): void;
  17199. /**
  17200. * Returns a new LineMesh object cloned from the current one.
  17201. */
  17202. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17203. /**
  17204. * Creates a new InstancedLinesMesh object from the mesh model.
  17205. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17206. * @param name defines the name of the new instance
  17207. * @returns a new InstancedLinesMesh
  17208. */
  17209. createInstance(name: string): InstancedLinesMesh;
  17210. }
  17211. /**
  17212. * Creates an instance based on a source LinesMesh
  17213. */
  17214. export class InstancedLinesMesh extends InstancedMesh {
  17215. /**
  17216. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17217. * This margin is expressed in world space coordinates, so its value may vary.
  17218. * Initilized with the intersectionThreshold value of the source LinesMesh
  17219. */
  17220. intersectionThreshold: number;
  17221. constructor(name: string, source: LinesMesh);
  17222. /**
  17223. * Returns the string "InstancedLinesMesh".
  17224. */
  17225. getClassName(): string;
  17226. }
  17227. }
  17228. declare module "babylonjs/Shaders/line.fragment" {
  17229. /** @hidden */
  17230. export var linePixelShader: {
  17231. name: string;
  17232. shader: string;
  17233. };
  17234. }
  17235. declare module "babylonjs/Shaders/line.vertex" {
  17236. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17237. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17238. /** @hidden */
  17239. export var lineVertexShader: {
  17240. name: string;
  17241. shader: string;
  17242. };
  17243. }
  17244. declare module "babylonjs/Rendering/edgesRenderer" {
  17245. import { Nullable } from "babylonjs/types";
  17246. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17247. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17248. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17249. import { IDisposable } from "babylonjs/scene";
  17250. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17251. import "babylonjs/Shaders/line.fragment";
  17252. import "babylonjs/Shaders/line.vertex";
  17253. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17254. import { SmartArray } from "babylonjs/Misc/smartArray";
  17255. module "babylonjs/scene" {
  17256. interface Scene {
  17257. /** @hidden */
  17258. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17259. }
  17260. }
  17261. module "babylonjs/Meshes/abstractMesh" {
  17262. interface AbstractMesh {
  17263. /**
  17264. * Gets the edgesRenderer associated with the mesh
  17265. */
  17266. edgesRenderer: Nullable<EdgesRenderer>;
  17267. }
  17268. }
  17269. module "babylonjs/Meshes/linesMesh" {
  17270. interface LinesMesh {
  17271. /**
  17272. * Enables the edge rendering mode on the mesh.
  17273. * This mode makes the mesh edges visible
  17274. * @param epsilon defines the maximal distance between two angles to detect a face
  17275. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17276. * @returns the currentAbstractMesh
  17277. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17278. */
  17279. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17280. }
  17281. }
  17282. module "babylonjs/Meshes/linesMesh" {
  17283. interface InstancedLinesMesh {
  17284. /**
  17285. * Enables the edge rendering mode on the mesh.
  17286. * This mode makes the mesh edges visible
  17287. * @param epsilon defines the maximal distance between two angles to detect a face
  17288. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17289. * @returns the current InstancedLinesMesh
  17290. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17291. */
  17292. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17293. }
  17294. }
  17295. /**
  17296. * Defines the minimum contract an Edges renderer should follow.
  17297. */
  17298. export interface IEdgesRenderer extends IDisposable {
  17299. /**
  17300. * Gets or sets a boolean indicating if the edgesRenderer is active
  17301. */
  17302. isEnabled: boolean;
  17303. /**
  17304. * Renders the edges of the attached mesh,
  17305. */
  17306. render(): void;
  17307. /**
  17308. * Checks wether or not the edges renderer is ready to render.
  17309. * @return true if ready, otherwise false.
  17310. */
  17311. isReady(): boolean;
  17312. /**
  17313. * List of instances to render in case the source mesh has instances
  17314. */
  17315. customInstances: SmartArray<Matrix>;
  17316. }
  17317. /**
  17318. * Defines the additional options of the edges renderer
  17319. */
  17320. export interface IEdgesRendererOptions {
  17321. /**
  17322. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17323. * If not defined, the default value is true
  17324. */
  17325. useAlternateEdgeFinder?: boolean;
  17326. /**
  17327. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17328. * If not defined, the default value is true.
  17329. * 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)
  17330. * This option is used only if useAlternateEdgeFinder = true
  17331. */
  17332. useFastVertexMerger?: boolean;
  17333. /**
  17334. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17335. * The default value is 1e-6
  17336. * This option is used only if useAlternateEdgeFinder = true
  17337. */
  17338. epsilonVertexMerge?: number;
  17339. /**
  17340. * 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
  17341. * 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.
  17342. * This option is used only if useAlternateEdgeFinder = true
  17343. */
  17344. applyTessellation?: boolean;
  17345. /**
  17346. * 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
  17347. * The default value is 1e-6
  17348. * This option is used only if useAlternateEdgeFinder = true
  17349. */
  17350. epsilonVertexAligned?: number;
  17351. }
  17352. /**
  17353. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17354. */
  17355. export class EdgesRenderer implements IEdgesRenderer {
  17356. /**
  17357. * Define the size of the edges with an orthographic camera
  17358. */
  17359. edgesWidthScalerForOrthographic: number;
  17360. /**
  17361. * Define the size of the edges with a perspective camera
  17362. */
  17363. edgesWidthScalerForPerspective: number;
  17364. protected _source: AbstractMesh;
  17365. protected _linesPositions: number[];
  17366. protected _linesNormals: number[];
  17367. protected _linesIndices: number[];
  17368. protected _epsilon: number;
  17369. protected _indicesCount: number;
  17370. protected _lineShader: ShaderMaterial;
  17371. protected _ib: DataBuffer;
  17372. protected _buffers: {
  17373. [key: string]: Nullable<VertexBuffer>;
  17374. };
  17375. protected _buffersForInstances: {
  17376. [key: string]: Nullable<VertexBuffer>;
  17377. };
  17378. protected _checkVerticesInsteadOfIndices: boolean;
  17379. protected _options: Nullable<IEdgesRendererOptions>;
  17380. private _meshRebuildObserver;
  17381. private _meshDisposeObserver;
  17382. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17383. isEnabled: boolean;
  17384. /**
  17385. * List of instances to render in case the source mesh has instances
  17386. */
  17387. customInstances: SmartArray<Matrix>;
  17388. private static GetShader;
  17389. /**
  17390. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17391. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17392. * @param source Mesh used to create edges
  17393. * @param epsilon sum of angles in adjacency to check for edge
  17394. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17395. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17396. * @param options The options to apply when generating the edges
  17397. */
  17398. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17399. protected _prepareRessources(): void;
  17400. /** @hidden */
  17401. _rebuild(): void;
  17402. /**
  17403. * Releases the required resources for the edges renderer
  17404. */
  17405. dispose(): void;
  17406. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17407. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17408. /**
  17409. * Checks if the pair of p0 and p1 is en edge
  17410. * @param faceIndex
  17411. * @param edge
  17412. * @param faceNormals
  17413. * @param p0
  17414. * @param p1
  17415. * @private
  17416. */
  17417. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17418. /**
  17419. * push line into the position, normal and index buffer
  17420. * @protected
  17421. */
  17422. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17423. /**
  17424. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17425. */
  17426. private _tessellateTriangle;
  17427. private _generateEdgesLinesAlternate;
  17428. /**
  17429. * Generates lines edges from adjacencjes
  17430. * @private
  17431. */
  17432. _generateEdgesLines(): void;
  17433. /**
  17434. * Checks wether or not the edges renderer is ready to render.
  17435. * @return true if ready, otherwise false.
  17436. */
  17437. isReady(): boolean;
  17438. /**
  17439. * Renders the edges of the attached mesh,
  17440. */
  17441. render(): void;
  17442. }
  17443. /**
  17444. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17445. */
  17446. export class LineEdgesRenderer extends EdgesRenderer {
  17447. /**
  17448. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17449. * @param source LineMesh used to generate edges
  17450. * @param epsilon not important (specified angle for edge detection)
  17451. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17452. */
  17453. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17454. /**
  17455. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17456. */
  17457. _generateEdgesLines(): void;
  17458. }
  17459. }
  17460. declare module "babylonjs/Rendering/renderingGroup" {
  17461. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17462. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17463. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17464. import { Nullable } from "babylonjs/types";
  17465. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17466. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17467. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17468. import { Material } from "babylonjs/Materials/material";
  17469. import { Scene } from "babylonjs/scene";
  17470. /**
  17471. * This represents the object necessary to create a rendering group.
  17472. * This is exclusively used and created by the rendering manager.
  17473. * To modify the behavior, you use the available helpers in your scene or meshes.
  17474. * @hidden
  17475. */
  17476. export class RenderingGroup {
  17477. index: number;
  17478. private static _zeroVector;
  17479. private _scene;
  17480. private _opaqueSubMeshes;
  17481. private _transparentSubMeshes;
  17482. private _alphaTestSubMeshes;
  17483. private _depthOnlySubMeshes;
  17484. private _particleSystems;
  17485. private _spriteManagers;
  17486. private _opaqueSortCompareFn;
  17487. private _alphaTestSortCompareFn;
  17488. private _transparentSortCompareFn;
  17489. private _renderOpaque;
  17490. private _renderAlphaTest;
  17491. private _renderTransparent;
  17492. /** @hidden */
  17493. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17494. onBeforeTransparentRendering: () => void;
  17495. /**
  17496. * Set the opaque sort comparison function.
  17497. * If null the sub meshes will be render in the order they were created
  17498. */
  17499. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17500. /**
  17501. * Set the alpha test sort comparison function.
  17502. * If null the sub meshes will be render in the order they were created
  17503. */
  17504. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17505. /**
  17506. * Set the transparent sort comparison function.
  17507. * If null the sub meshes will be render in the order they were created
  17508. */
  17509. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17510. /**
  17511. * Creates a new rendering group.
  17512. * @param index The rendering group index
  17513. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17514. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17515. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17516. */
  17517. 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>);
  17518. /**
  17519. * Render all the sub meshes contained in the group.
  17520. * @param customRenderFunction Used to override the default render behaviour of the group.
  17521. * @returns true if rendered some submeshes.
  17522. */
  17523. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17524. /**
  17525. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17526. * @param subMeshes The submeshes to render
  17527. */
  17528. private renderOpaqueSorted;
  17529. /**
  17530. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17531. * @param subMeshes The submeshes to render
  17532. */
  17533. private renderAlphaTestSorted;
  17534. /**
  17535. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17536. * @param subMeshes The submeshes to render
  17537. */
  17538. private renderTransparentSorted;
  17539. /**
  17540. * Renders the submeshes in a specified order.
  17541. * @param subMeshes The submeshes to sort before render
  17542. * @param sortCompareFn The comparison function use to sort
  17543. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17544. * @param transparent Specifies to activate blending if true
  17545. */
  17546. private static renderSorted;
  17547. /**
  17548. * Renders the submeshes in the order they were dispatched (no sort applied).
  17549. * @param subMeshes The submeshes to render
  17550. */
  17551. private static renderUnsorted;
  17552. /**
  17553. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17554. * are rendered back to front if in the same alpha index.
  17555. *
  17556. * @param a The first submesh
  17557. * @param b The second submesh
  17558. * @returns The result of the comparison
  17559. */
  17560. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17561. /**
  17562. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17563. * are rendered back to front.
  17564. *
  17565. * @param a The first submesh
  17566. * @param b The second submesh
  17567. * @returns The result of the comparison
  17568. */
  17569. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17570. /**
  17571. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17572. * are rendered front to back (prevent overdraw).
  17573. *
  17574. * @param a The first submesh
  17575. * @param b The second submesh
  17576. * @returns The result of the comparison
  17577. */
  17578. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17579. /**
  17580. * Resets the different lists of submeshes to prepare a new frame.
  17581. */
  17582. prepare(): void;
  17583. dispose(): void;
  17584. /**
  17585. * Inserts the submesh in its correct queue depending on its material.
  17586. * @param subMesh The submesh to dispatch
  17587. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17588. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17589. */
  17590. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17591. dispatchSprites(spriteManager: ISpriteManager): void;
  17592. dispatchParticles(particleSystem: IParticleSystem): void;
  17593. private _renderParticles;
  17594. private _renderSprites;
  17595. }
  17596. }
  17597. declare module "babylonjs/Rendering/renderingManager" {
  17598. import { Nullable } from "babylonjs/types";
  17599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17600. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17601. import { SmartArray } from "babylonjs/Misc/smartArray";
  17602. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17603. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17604. import { Material } from "babylonjs/Materials/material";
  17605. import { Scene } from "babylonjs/scene";
  17606. import { Camera } from "babylonjs/Cameras/camera";
  17607. /**
  17608. * Interface describing the different options available in the rendering manager
  17609. * regarding Auto Clear between groups.
  17610. */
  17611. export interface IRenderingManagerAutoClearSetup {
  17612. /**
  17613. * Defines whether or not autoclear is enable.
  17614. */
  17615. autoClear: boolean;
  17616. /**
  17617. * Defines whether or not to autoclear the depth buffer.
  17618. */
  17619. depth: boolean;
  17620. /**
  17621. * Defines whether or not to autoclear the stencil buffer.
  17622. */
  17623. stencil: boolean;
  17624. }
  17625. /**
  17626. * This class is used by the onRenderingGroupObservable
  17627. */
  17628. export class RenderingGroupInfo {
  17629. /**
  17630. * The Scene that being rendered
  17631. */
  17632. scene: Scene;
  17633. /**
  17634. * The camera currently used for the rendering pass
  17635. */
  17636. camera: Nullable<Camera>;
  17637. /**
  17638. * The ID of the renderingGroup being processed
  17639. */
  17640. renderingGroupId: number;
  17641. }
  17642. /**
  17643. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17644. * It is enable to manage the different groups as well as the different necessary sort functions.
  17645. * This should not be used directly aside of the few static configurations
  17646. */
  17647. export class RenderingManager {
  17648. /**
  17649. * The max id used for rendering groups (not included)
  17650. */
  17651. static MAX_RENDERINGGROUPS: number;
  17652. /**
  17653. * The min id used for rendering groups (included)
  17654. */
  17655. static MIN_RENDERINGGROUPS: number;
  17656. /**
  17657. * Used to globally prevent autoclearing scenes.
  17658. */
  17659. static AUTOCLEAR: boolean;
  17660. /**
  17661. * @hidden
  17662. */
  17663. _useSceneAutoClearSetup: boolean;
  17664. private _scene;
  17665. private _renderingGroups;
  17666. private _depthStencilBufferAlreadyCleaned;
  17667. private _autoClearDepthStencil;
  17668. private _customOpaqueSortCompareFn;
  17669. private _customAlphaTestSortCompareFn;
  17670. private _customTransparentSortCompareFn;
  17671. private _renderingGroupInfo;
  17672. /**
  17673. * Instantiates a new rendering group for a particular scene
  17674. * @param scene Defines the scene the groups belongs to
  17675. */
  17676. constructor(scene: Scene);
  17677. private _clearDepthStencilBuffer;
  17678. /**
  17679. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17680. * @hidden
  17681. */
  17682. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17683. /**
  17684. * Resets the different information of the group to prepare a new frame
  17685. * @hidden
  17686. */
  17687. reset(): void;
  17688. /**
  17689. * Dispose and release the group and its associated resources.
  17690. * @hidden
  17691. */
  17692. dispose(): void;
  17693. /**
  17694. * Clear the info related to rendering groups preventing retention points during dispose.
  17695. */
  17696. freeRenderingGroups(): void;
  17697. private _prepareRenderingGroup;
  17698. /**
  17699. * Add a sprite manager to the rendering manager in order to render it this frame.
  17700. * @param spriteManager Define the sprite manager to render
  17701. */
  17702. dispatchSprites(spriteManager: ISpriteManager): void;
  17703. /**
  17704. * Add a particle system to the rendering manager in order to render it this frame.
  17705. * @param particleSystem Define the particle system to render
  17706. */
  17707. dispatchParticles(particleSystem: IParticleSystem): void;
  17708. /**
  17709. * Add a submesh to the manager in order to render it this frame
  17710. * @param subMesh The submesh to dispatch
  17711. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17712. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17713. */
  17714. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17715. /**
  17716. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17717. * This allowed control for front to back rendering or reversly depending of the special needs.
  17718. *
  17719. * @param renderingGroupId The rendering group id corresponding to its index
  17720. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17721. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17722. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17723. */
  17724. 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;
  17725. /**
  17726. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17727. *
  17728. * @param renderingGroupId The rendering group id corresponding to its index
  17729. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17730. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17731. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17732. */
  17733. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17734. /**
  17735. * Gets the current auto clear configuration for one rendering group of the rendering
  17736. * manager.
  17737. * @param index the rendering group index to get the information for
  17738. * @returns The auto clear setup for the requested rendering group
  17739. */
  17740. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17741. }
  17742. }
  17743. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17744. import { SmartArray } from "babylonjs/Misc/smartArray";
  17745. import { Nullable } from "babylonjs/types";
  17746. import { Scene } from "babylonjs/scene";
  17747. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17748. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17750. import { Mesh } from "babylonjs/Meshes/mesh";
  17751. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17752. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17753. import { Effect } from "babylonjs/Materials/effect";
  17754. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17755. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17756. import "babylonjs/Shaders/shadowMap.fragment";
  17757. import "babylonjs/Shaders/shadowMap.vertex";
  17758. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17759. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17760. import { Observable } from "babylonjs/Misc/observable";
  17761. /**
  17762. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17763. */
  17764. export interface ICustomShaderOptions {
  17765. /**
  17766. * Gets or sets the custom shader name to use
  17767. */
  17768. shaderName: string;
  17769. /**
  17770. * The list of attribute names used in the shader
  17771. */
  17772. attributes?: string[];
  17773. /**
  17774. * The list of unifrom names used in the shader
  17775. */
  17776. uniforms?: string[];
  17777. /**
  17778. * The list of sampler names used in the shader
  17779. */
  17780. samplers?: string[];
  17781. /**
  17782. * The list of defines used in the shader
  17783. */
  17784. defines?: string[];
  17785. }
  17786. /**
  17787. * Interface to implement to create a shadow generator compatible with BJS.
  17788. */
  17789. export interface IShadowGenerator {
  17790. /**
  17791. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17792. * @returns The render target texture if present otherwise, null
  17793. */
  17794. getShadowMap(): Nullable<RenderTargetTexture>;
  17795. /**
  17796. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17797. * @param subMesh The submesh we want to render in the shadow map
  17798. * @param useInstances Defines wether will draw in the map using instances
  17799. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17800. * @returns true if ready otherwise, false
  17801. */
  17802. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17803. /**
  17804. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17805. * @param defines Defines of the material we want to update
  17806. * @param lightIndex Index of the light in the enabled light list of the material
  17807. */
  17808. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17809. /**
  17810. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17811. * defined in the generator but impacting the effect).
  17812. * It implies the unifroms available on the materials are the standard BJS ones.
  17813. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17814. * @param effect The effect we are binfing the information for
  17815. */
  17816. bindShadowLight(lightIndex: string, effect: Effect): void;
  17817. /**
  17818. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17819. * (eq to shadow prjection matrix * light transform matrix)
  17820. * @returns The transform matrix used to create the shadow map
  17821. */
  17822. getTransformMatrix(): Matrix;
  17823. /**
  17824. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17825. * Cube and 2D textures for instance.
  17826. */
  17827. recreateShadowMap(): void;
  17828. /**
  17829. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17830. * @param onCompiled Callback triggered at the and of the effects compilation
  17831. * @param options Sets of optional options forcing the compilation with different modes
  17832. */
  17833. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17834. useInstances: boolean;
  17835. }>): void;
  17836. /**
  17837. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17838. * @param options Sets of optional options forcing the compilation with different modes
  17839. * @returns A promise that resolves when the compilation completes
  17840. */
  17841. forceCompilationAsync(options?: Partial<{
  17842. useInstances: boolean;
  17843. }>): Promise<void>;
  17844. /**
  17845. * Serializes the shadow generator setup to a json object.
  17846. * @returns The serialized JSON object
  17847. */
  17848. serialize(): any;
  17849. /**
  17850. * Disposes the Shadow map and related Textures and effects.
  17851. */
  17852. dispose(): void;
  17853. }
  17854. /**
  17855. * Default implementation IShadowGenerator.
  17856. * This is the main object responsible of generating shadows in the framework.
  17857. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  17858. */
  17859. export class ShadowGenerator implements IShadowGenerator {
  17860. /**
  17861. * Name of the shadow generator class
  17862. */
  17863. static CLASSNAME: string;
  17864. /**
  17865. * Shadow generator mode None: no filtering applied.
  17866. */
  17867. static readonly FILTER_NONE: number;
  17868. /**
  17869. * Shadow generator mode ESM: Exponential Shadow Mapping.
  17870. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17871. */
  17872. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  17873. /**
  17874. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  17875. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  17876. */
  17877. static readonly FILTER_POISSONSAMPLING: number;
  17878. /**
  17879. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  17880. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17881. */
  17882. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  17883. /**
  17884. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  17885. * edge artifacts on steep falloff.
  17886. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17887. */
  17888. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  17889. /**
  17890. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  17891. * edge artifacts on steep falloff.
  17892. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17893. */
  17894. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  17895. /**
  17896. * Shadow generator mode PCF: Percentage Closer Filtering
  17897. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17898. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  17899. */
  17900. static readonly FILTER_PCF: number;
  17901. /**
  17902. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  17903. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17904. * Contact Hardening
  17905. */
  17906. static readonly FILTER_PCSS: number;
  17907. /**
  17908. * Reserved for PCF and PCSS
  17909. * Highest Quality.
  17910. *
  17911. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  17912. *
  17913. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  17914. */
  17915. static readonly QUALITY_HIGH: number;
  17916. /**
  17917. * Reserved for PCF and PCSS
  17918. * Good tradeoff for quality/perf cross devices
  17919. *
  17920. * Execute PCF on a 3*3 kernel.
  17921. *
  17922. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  17923. */
  17924. static readonly QUALITY_MEDIUM: number;
  17925. /**
  17926. * Reserved for PCF and PCSS
  17927. * The lowest quality but the fastest.
  17928. *
  17929. * Execute PCF on a 1*1 kernel.
  17930. *
  17931. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  17932. */
  17933. static readonly QUALITY_LOW: number;
  17934. /** Gets or sets the custom shader name to use */
  17935. customShaderOptions: ICustomShaderOptions;
  17936. /**
  17937. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  17938. */
  17939. onBeforeShadowMapRenderObservable: Observable<Effect>;
  17940. /**
  17941. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  17942. */
  17943. onAfterShadowMapRenderObservable: Observable<Effect>;
  17944. /**
  17945. * Observable triggered before a mesh is rendered in the shadow map.
  17946. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  17947. */
  17948. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  17949. /**
  17950. * Observable triggered after a mesh is rendered in the shadow map.
  17951. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  17952. */
  17953. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  17954. protected _bias: number;
  17955. /**
  17956. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  17957. */
  17958. get bias(): number;
  17959. /**
  17960. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  17961. */
  17962. set bias(bias: number);
  17963. protected _normalBias: number;
  17964. /**
  17965. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17966. */
  17967. get normalBias(): number;
  17968. /**
  17969. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17970. */
  17971. set normalBias(normalBias: number);
  17972. protected _blurBoxOffset: number;
  17973. /**
  17974. * Gets the blur box offset: offset applied during the blur pass.
  17975. * Only useful if useKernelBlur = false
  17976. */
  17977. get blurBoxOffset(): number;
  17978. /**
  17979. * Sets the blur box offset: offset applied during the blur pass.
  17980. * Only useful if useKernelBlur = false
  17981. */
  17982. set blurBoxOffset(value: number);
  17983. protected _blurScale: number;
  17984. /**
  17985. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  17986. * 2 means half of the size.
  17987. */
  17988. get blurScale(): number;
  17989. /**
  17990. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  17991. * 2 means half of the size.
  17992. */
  17993. set blurScale(value: number);
  17994. protected _blurKernel: number;
  17995. /**
  17996. * Gets the blur kernel: kernel size of the blur pass.
  17997. * Only useful if useKernelBlur = true
  17998. */
  17999. get blurKernel(): number;
  18000. /**
  18001. * Sets the blur kernel: kernel size of the blur pass.
  18002. * Only useful if useKernelBlur = true
  18003. */
  18004. set blurKernel(value: number);
  18005. protected _useKernelBlur: boolean;
  18006. /**
  18007. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18008. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18009. */
  18010. get useKernelBlur(): boolean;
  18011. /**
  18012. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18013. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18014. */
  18015. set useKernelBlur(value: boolean);
  18016. protected _depthScale: number;
  18017. /**
  18018. * Gets the depth scale used in ESM mode.
  18019. */
  18020. get depthScale(): number;
  18021. /**
  18022. * Sets the depth scale used in ESM mode.
  18023. * This can override the scale stored on the light.
  18024. */
  18025. set depthScale(value: number);
  18026. protected _validateFilter(filter: number): number;
  18027. protected _filter: number;
  18028. /**
  18029. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18030. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18031. */
  18032. get filter(): number;
  18033. /**
  18034. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18035. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18036. */
  18037. set filter(value: number);
  18038. /**
  18039. * Gets if the current filter is set to Poisson Sampling.
  18040. */
  18041. get usePoissonSampling(): boolean;
  18042. /**
  18043. * Sets the current filter to Poisson Sampling.
  18044. */
  18045. set usePoissonSampling(value: boolean);
  18046. /**
  18047. * Gets if the current filter is set to ESM.
  18048. */
  18049. get useExponentialShadowMap(): boolean;
  18050. /**
  18051. * Sets the current filter is to ESM.
  18052. */
  18053. set useExponentialShadowMap(value: boolean);
  18054. /**
  18055. * Gets if the current filter is set to filtered ESM.
  18056. */
  18057. get useBlurExponentialShadowMap(): boolean;
  18058. /**
  18059. * Gets if the current filter is set to filtered ESM.
  18060. */
  18061. set useBlurExponentialShadowMap(value: boolean);
  18062. /**
  18063. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18064. * exponential to prevent steep falloff artifacts).
  18065. */
  18066. get useCloseExponentialShadowMap(): boolean;
  18067. /**
  18068. * Sets the current filter to "close ESM" (using the inverse of the
  18069. * exponential to prevent steep falloff artifacts).
  18070. */
  18071. set useCloseExponentialShadowMap(value: boolean);
  18072. /**
  18073. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18074. * exponential to prevent steep falloff artifacts).
  18075. */
  18076. get useBlurCloseExponentialShadowMap(): boolean;
  18077. /**
  18078. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18079. * exponential to prevent steep falloff artifacts).
  18080. */
  18081. set useBlurCloseExponentialShadowMap(value: boolean);
  18082. /**
  18083. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18084. */
  18085. get usePercentageCloserFiltering(): boolean;
  18086. /**
  18087. * Sets the current filter to "PCF" (percentage closer filtering).
  18088. */
  18089. set usePercentageCloserFiltering(value: boolean);
  18090. protected _filteringQuality: number;
  18091. /**
  18092. * Gets the PCF or PCSS Quality.
  18093. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18094. */
  18095. get filteringQuality(): number;
  18096. /**
  18097. * Sets the PCF or PCSS Quality.
  18098. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18099. */
  18100. set filteringQuality(filteringQuality: number);
  18101. /**
  18102. * Gets if the current filter is set to "PCSS" (contact hardening).
  18103. */
  18104. get useContactHardeningShadow(): boolean;
  18105. /**
  18106. * Sets the current filter to "PCSS" (contact hardening).
  18107. */
  18108. set useContactHardeningShadow(value: boolean);
  18109. protected _contactHardeningLightSizeUVRatio: number;
  18110. /**
  18111. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18112. * Using a ratio helps keeping shape stability independently of the map size.
  18113. *
  18114. * It does not account for the light projection as it was having too much
  18115. * instability during the light setup or during light position changes.
  18116. *
  18117. * Only valid if useContactHardeningShadow is true.
  18118. */
  18119. get contactHardeningLightSizeUVRatio(): number;
  18120. /**
  18121. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18122. * Using a ratio helps keeping shape stability independently of the map size.
  18123. *
  18124. * It does not account for the light projection as it was having too much
  18125. * instability during the light setup or during light position changes.
  18126. *
  18127. * Only valid if useContactHardeningShadow is true.
  18128. */
  18129. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18130. protected _darkness: number;
  18131. /** Gets or sets the actual darkness of a shadow */
  18132. get darkness(): number;
  18133. set darkness(value: number);
  18134. /**
  18135. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18136. * 0 means strongest and 1 would means no shadow.
  18137. * @returns the darkness.
  18138. */
  18139. getDarkness(): number;
  18140. /**
  18141. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18142. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18143. * @returns the shadow generator allowing fluent coding.
  18144. */
  18145. setDarkness(darkness: number): ShadowGenerator;
  18146. protected _transparencyShadow: boolean;
  18147. /** Gets or sets the ability to have transparent shadow */
  18148. get transparencyShadow(): boolean;
  18149. set transparencyShadow(value: boolean);
  18150. /**
  18151. * Sets the ability to have transparent shadow (boolean).
  18152. * @param transparent True if transparent else False
  18153. * @returns the shadow generator allowing fluent coding
  18154. */
  18155. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18156. /**
  18157. * Enables or disables shadows with varying strength based on the transparency
  18158. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18159. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18160. * mesh.visibility * alphaTexture.a
  18161. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18162. */
  18163. enableSoftTransparentShadow: boolean;
  18164. protected _shadowMap: Nullable<RenderTargetTexture>;
  18165. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18166. /**
  18167. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18168. * @returns The render target texture if present otherwise, null
  18169. */
  18170. getShadowMap(): Nullable<RenderTargetTexture>;
  18171. /**
  18172. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18173. * @returns The render target texture if the shadow map is present otherwise, null
  18174. */
  18175. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18176. /**
  18177. * Gets the class name of that object
  18178. * @returns "ShadowGenerator"
  18179. */
  18180. getClassName(): string;
  18181. /**
  18182. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18183. * @param mesh Mesh to add
  18184. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18185. * @returns the Shadow Generator itself
  18186. */
  18187. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18188. /**
  18189. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18190. * @param mesh Mesh to remove
  18191. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18192. * @returns the Shadow Generator itself
  18193. */
  18194. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18195. /**
  18196. * Controls the extent to which the shadows fade out at the edge of the frustum
  18197. */
  18198. frustumEdgeFalloff: number;
  18199. protected _light: IShadowLight;
  18200. /**
  18201. * Returns the associated light object.
  18202. * @returns the light generating the shadow
  18203. */
  18204. getLight(): IShadowLight;
  18205. /**
  18206. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18207. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18208. * It might on the other hand introduce peter panning.
  18209. */
  18210. forceBackFacesOnly: boolean;
  18211. protected _scene: Scene;
  18212. protected _lightDirection: Vector3;
  18213. protected _effect: Effect;
  18214. protected _viewMatrix: Matrix;
  18215. protected _projectionMatrix: Matrix;
  18216. protected _transformMatrix: Matrix;
  18217. protected _cachedPosition: Vector3;
  18218. protected _cachedDirection: Vector3;
  18219. protected _cachedDefines: string;
  18220. protected _currentRenderID: number;
  18221. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18222. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18223. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18224. protected _blurPostProcesses: PostProcess[];
  18225. protected _mapSize: number;
  18226. protected _currentFaceIndex: number;
  18227. protected _currentFaceIndexCache: number;
  18228. protected _textureType: number;
  18229. protected _defaultTextureMatrix: Matrix;
  18230. protected _storedUniqueId: Nullable<number>;
  18231. /** @hidden */
  18232. static _SceneComponentInitialization: (scene: Scene) => void;
  18233. /**
  18234. * Creates a ShadowGenerator object.
  18235. * A ShadowGenerator is the required tool to use the shadows.
  18236. * Each light casting shadows needs to use its own ShadowGenerator.
  18237. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18238. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18239. * @param light The light object generating the shadows.
  18240. * @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.
  18241. */
  18242. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18243. protected _initializeGenerator(): void;
  18244. protected _createTargetRenderTexture(): void;
  18245. protected _initializeShadowMap(): void;
  18246. protected _initializeBlurRTTAndPostProcesses(): void;
  18247. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18248. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18249. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18250. protected _applyFilterValues(): void;
  18251. /**
  18252. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18253. * @param onCompiled Callback triggered at the and of the effects compilation
  18254. * @param options Sets of optional options forcing the compilation with different modes
  18255. */
  18256. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18257. useInstances: boolean;
  18258. }>): void;
  18259. /**
  18260. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18261. * @param options Sets of optional options forcing the compilation with different modes
  18262. * @returns A promise that resolves when the compilation completes
  18263. */
  18264. forceCompilationAsync(options?: Partial<{
  18265. useInstances: boolean;
  18266. }>): Promise<void>;
  18267. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18268. private _prepareShadowDefines;
  18269. /**
  18270. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18271. * @param subMesh The submesh we want to render in the shadow map
  18272. * @param useInstances Defines wether will draw in the map using instances
  18273. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18274. * @returns true if ready otherwise, false
  18275. */
  18276. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18277. /**
  18278. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18279. * @param defines Defines of the material we want to update
  18280. * @param lightIndex Index of the light in the enabled light list of the material
  18281. */
  18282. prepareDefines(defines: any, lightIndex: number): void;
  18283. /**
  18284. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18285. * defined in the generator but impacting the effect).
  18286. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18287. * @param effect The effect we are binfing the information for
  18288. */
  18289. bindShadowLight(lightIndex: string, effect: Effect): void;
  18290. /**
  18291. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18292. * (eq to shadow prjection matrix * light transform matrix)
  18293. * @returns The transform matrix used to create the shadow map
  18294. */
  18295. getTransformMatrix(): Matrix;
  18296. /**
  18297. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18298. * Cube and 2D textures for instance.
  18299. */
  18300. recreateShadowMap(): void;
  18301. protected _disposeBlurPostProcesses(): void;
  18302. protected _disposeRTTandPostProcesses(): void;
  18303. /**
  18304. * Disposes the ShadowGenerator.
  18305. * Returns nothing.
  18306. */
  18307. dispose(): void;
  18308. /**
  18309. * Serializes the shadow generator setup to a json object.
  18310. * @returns The serialized JSON object
  18311. */
  18312. serialize(): any;
  18313. /**
  18314. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18315. * @param parsedShadowGenerator The JSON object to parse
  18316. * @param scene The scene to create the shadow map for
  18317. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18318. * @returns The parsed shadow generator
  18319. */
  18320. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18321. }
  18322. }
  18323. declare module "babylonjs/Lights/light" {
  18324. import { Nullable } from "babylonjs/types";
  18325. import { Scene } from "babylonjs/scene";
  18326. import { Vector3 } from "babylonjs/Maths/math.vector";
  18327. import { Color3 } from "babylonjs/Maths/math.color";
  18328. import { Node } from "babylonjs/node";
  18329. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18330. import { Effect } from "babylonjs/Materials/effect";
  18331. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18332. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18333. /**
  18334. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18335. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18336. * 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.
  18337. */
  18338. export abstract class Light extends Node {
  18339. /**
  18340. * Falloff Default: light is falling off following the material specification:
  18341. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18342. */
  18343. static readonly FALLOFF_DEFAULT: number;
  18344. /**
  18345. * Falloff Physical: light is falling off following the inverse squared distance law.
  18346. */
  18347. static readonly FALLOFF_PHYSICAL: number;
  18348. /**
  18349. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18350. * to enhance interoperability with other engines.
  18351. */
  18352. static readonly FALLOFF_GLTF: number;
  18353. /**
  18354. * Falloff Standard: light is falling off like in the standard material
  18355. * to enhance interoperability with other materials.
  18356. */
  18357. static readonly FALLOFF_STANDARD: number;
  18358. /**
  18359. * If every light affecting the material is in this lightmapMode,
  18360. * material.lightmapTexture adds or multiplies
  18361. * (depends on material.useLightmapAsShadowmap)
  18362. * after every other light calculations.
  18363. */
  18364. static readonly LIGHTMAP_DEFAULT: number;
  18365. /**
  18366. * material.lightmapTexture as only diffuse lighting from this light
  18367. * adds only specular lighting from this light
  18368. * adds dynamic shadows
  18369. */
  18370. static readonly LIGHTMAP_SPECULAR: number;
  18371. /**
  18372. * material.lightmapTexture as only lighting
  18373. * no light calculation from this light
  18374. * only adds dynamic shadows from this light
  18375. */
  18376. static readonly LIGHTMAP_SHADOWSONLY: number;
  18377. /**
  18378. * Each light type uses the default quantity according to its type:
  18379. * point/spot lights use luminous intensity
  18380. * directional lights use illuminance
  18381. */
  18382. static readonly INTENSITYMODE_AUTOMATIC: number;
  18383. /**
  18384. * lumen (lm)
  18385. */
  18386. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18387. /**
  18388. * candela (lm/sr)
  18389. */
  18390. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18391. /**
  18392. * lux (lm/m^2)
  18393. */
  18394. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18395. /**
  18396. * nit (cd/m^2)
  18397. */
  18398. static readonly INTENSITYMODE_LUMINANCE: number;
  18399. /**
  18400. * Light type const id of the point light.
  18401. */
  18402. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18403. /**
  18404. * Light type const id of the directional light.
  18405. */
  18406. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18407. /**
  18408. * Light type const id of the spot light.
  18409. */
  18410. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18411. /**
  18412. * Light type const id of the hemispheric light.
  18413. */
  18414. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18415. /**
  18416. * Diffuse gives the basic color to an object.
  18417. */
  18418. diffuse: Color3;
  18419. /**
  18420. * Specular produces a highlight color on an object.
  18421. * Note: This is note affecting PBR materials.
  18422. */
  18423. specular: Color3;
  18424. /**
  18425. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18426. * falling off base on range or angle.
  18427. * This can be set to any values in Light.FALLOFF_x.
  18428. *
  18429. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18430. * other types of materials.
  18431. */
  18432. falloffType: number;
  18433. /**
  18434. * Strength of the light.
  18435. * Note: By default it is define in the framework own unit.
  18436. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18437. */
  18438. intensity: number;
  18439. private _range;
  18440. protected _inverseSquaredRange: number;
  18441. /**
  18442. * Defines how far from the source the light is impacting in scene units.
  18443. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18444. */
  18445. get range(): number;
  18446. /**
  18447. * Defines how far from the source the light is impacting in scene units.
  18448. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18449. */
  18450. set range(value: number);
  18451. /**
  18452. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18453. * of light.
  18454. */
  18455. private _photometricScale;
  18456. private _intensityMode;
  18457. /**
  18458. * Gets the photometric scale used to interpret the intensity.
  18459. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18460. */
  18461. get intensityMode(): number;
  18462. /**
  18463. * Sets the photometric scale used to interpret the intensity.
  18464. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18465. */
  18466. set intensityMode(value: number);
  18467. private _radius;
  18468. /**
  18469. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18470. */
  18471. get radius(): number;
  18472. /**
  18473. * sets the light radius used by PBR Materials to simulate soft area lights.
  18474. */
  18475. set radius(value: number);
  18476. private _renderPriority;
  18477. /**
  18478. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18479. * exceeding the number allowed of the materials.
  18480. */
  18481. renderPriority: number;
  18482. private _shadowEnabled;
  18483. /**
  18484. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18485. * the current shadow generator.
  18486. */
  18487. get shadowEnabled(): boolean;
  18488. /**
  18489. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18490. * the current shadow generator.
  18491. */
  18492. set shadowEnabled(value: boolean);
  18493. private _includedOnlyMeshes;
  18494. /**
  18495. * Gets the only meshes impacted by this light.
  18496. */
  18497. get includedOnlyMeshes(): AbstractMesh[];
  18498. /**
  18499. * Sets the only meshes impacted by this light.
  18500. */
  18501. set includedOnlyMeshes(value: AbstractMesh[]);
  18502. private _excludedMeshes;
  18503. /**
  18504. * Gets the meshes not impacted by this light.
  18505. */
  18506. get excludedMeshes(): AbstractMesh[];
  18507. /**
  18508. * Sets the meshes not impacted by this light.
  18509. */
  18510. set excludedMeshes(value: AbstractMesh[]);
  18511. private _excludeWithLayerMask;
  18512. /**
  18513. * Gets the layer id use to find what meshes are not impacted by the light.
  18514. * Inactive if 0
  18515. */
  18516. get excludeWithLayerMask(): number;
  18517. /**
  18518. * Sets the layer id use to find what meshes are not impacted by the light.
  18519. * Inactive if 0
  18520. */
  18521. set excludeWithLayerMask(value: number);
  18522. private _includeOnlyWithLayerMask;
  18523. /**
  18524. * Gets the layer id use to find what meshes are impacted by the light.
  18525. * Inactive if 0
  18526. */
  18527. get includeOnlyWithLayerMask(): number;
  18528. /**
  18529. * Sets the layer id use to find what meshes are impacted by the light.
  18530. * Inactive if 0
  18531. */
  18532. set includeOnlyWithLayerMask(value: number);
  18533. private _lightmapMode;
  18534. /**
  18535. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18536. */
  18537. get lightmapMode(): number;
  18538. /**
  18539. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18540. */
  18541. set lightmapMode(value: number);
  18542. /**
  18543. * Shadow generator associted to the light.
  18544. * @hidden Internal use only.
  18545. */
  18546. _shadowGenerator: Nullable<IShadowGenerator>;
  18547. /**
  18548. * @hidden Internal use only.
  18549. */
  18550. _excludedMeshesIds: string[];
  18551. /**
  18552. * @hidden Internal use only.
  18553. */
  18554. _includedOnlyMeshesIds: string[];
  18555. /**
  18556. * The current light unifom buffer.
  18557. * @hidden Internal use only.
  18558. */
  18559. _uniformBuffer: UniformBuffer;
  18560. /** @hidden */
  18561. _renderId: number;
  18562. /**
  18563. * Creates a Light object in the scene.
  18564. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18565. * @param name The firendly name of the light
  18566. * @param scene The scene the light belongs too
  18567. */
  18568. constructor(name: string, scene: Scene);
  18569. protected abstract _buildUniformLayout(): void;
  18570. /**
  18571. * Sets the passed Effect "effect" with the Light information.
  18572. * @param effect The effect to update
  18573. * @param lightIndex The index of the light in the effect to update
  18574. * @returns The light
  18575. */
  18576. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18577. /**
  18578. * Sets the passed Effect "effect" with the Light textures.
  18579. * @param effect The effect to update
  18580. * @param lightIndex The index of the light in the effect to update
  18581. * @returns The light
  18582. */
  18583. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18584. /**
  18585. * Binds the lights information from the scene to the effect for the given mesh.
  18586. * @param lightIndex Light index
  18587. * @param scene The scene where the light belongs to
  18588. * @param effect The effect we are binding the data to
  18589. * @param useSpecular Defines if specular is supported
  18590. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18591. */
  18592. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18593. /**
  18594. * Sets the passed Effect "effect" with the Light information.
  18595. * @param effect The effect to update
  18596. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18597. * @returns The light
  18598. */
  18599. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18600. /**
  18601. * Returns the string "Light".
  18602. * @returns the class name
  18603. */
  18604. getClassName(): string;
  18605. /** @hidden */
  18606. readonly _isLight: boolean;
  18607. /**
  18608. * Converts the light information to a readable string for debug purpose.
  18609. * @param fullDetails Supports for multiple levels of logging within scene loading
  18610. * @returns the human readable light info
  18611. */
  18612. toString(fullDetails?: boolean): string;
  18613. /** @hidden */
  18614. protected _syncParentEnabledState(): void;
  18615. /**
  18616. * Set the enabled state of this node.
  18617. * @param value - the new enabled state
  18618. */
  18619. setEnabled(value: boolean): void;
  18620. /**
  18621. * Returns the Light associated shadow generator if any.
  18622. * @return the associated shadow generator.
  18623. */
  18624. getShadowGenerator(): Nullable<IShadowGenerator>;
  18625. /**
  18626. * Returns a Vector3, the absolute light position in the World.
  18627. * @returns the world space position of the light
  18628. */
  18629. getAbsolutePosition(): Vector3;
  18630. /**
  18631. * Specifies if the light will affect the passed mesh.
  18632. * @param mesh The mesh to test against the light
  18633. * @return true the mesh is affected otherwise, false.
  18634. */
  18635. canAffectMesh(mesh: AbstractMesh): boolean;
  18636. /**
  18637. * Sort function to order lights for rendering.
  18638. * @param a First Light object to compare to second.
  18639. * @param b Second Light object to compare first.
  18640. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18641. */
  18642. static CompareLightsPriority(a: Light, b: Light): number;
  18643. /**
  18644. * Releases resources associated with this node.
  18645. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18646. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18647. */
  18648. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18649. /**
  18650. * Returns the light type ID (integer).
  18651. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18652. */
  18653. getTypeID(): number;
  18654. /**
  18655. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18656. * @returns the scaled intensity in intensity mode unit
  18657. */
  18658. getScaledIntensity(): number;
  18659. /**
  18660. * Returns a new Light object, named "name", from the current one.
  18661. * @param name The name of the cloned light
  18662. * @param newParent The parent of this light, if it has one
  18663. * @returns the new created light
  18664. */
  18665. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18666. /**
  18667. * Serializes the current light into a Serialization object.
  18668. * @returns the serialized object.
  18669. */
  18670. serialize(): any;
  18671. /**
  18672. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18673. * This new light is named "name" and added to the passed scene.
  18674. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18675. * @param name The friendly name of the light
  18676. * @param scene The scene the new light will belong to
  18677. * @returns the constructor function
  18678. */
  18679. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18680. /**
  18681. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18682. * @param parsedLight The JSON representation of the light
  18683. * @param scene The scene to create the parsed light in
  18684. * @returns the created light after parsing
  18685. */
  18686. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18687. private _hookArrayForExcluded;
  18688. private _hookArrayForIncludedOnly;
  18689. private _resyncMeshes;
  18690. /**
  18691. * Forces the meshes to update their light related information in their rendering used effects
  18692. * @hidden Internal Use Only
  18693. */
  18694. _markMeshesAsLightDirty(): void;
  18695. /**
  18696. * Recomputes the cached photometric scale if needed.
  18697. */
  18698. private _computePhotometricScale;
  18699. /**
  18700. * Returns the Photometric Scale according to the light type and intensity mode.
  18701. */
  18702. private _getPhotometricScale;
  18703. /**
  18704. * Reorder the light in the scene according to their defined priority.
  18705. * @hidden Internal Use Only
  18706. */
  18707. _reorderLightsInScene(): void;
  18708. /**
  18709. * Prepares the list of defines specific to the light type.
  18710. * @param defines the list of defines
  18711. * @param lightIndex defines the index of the light for the effect
  18712. */
  18713. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18714. }
  18715. }
  18716. declare module "babylonjs/Cameras/targetCamera" {
  18717. import { Nullable } from "babylonjs/types";
  18718. import { Camera } from "babylonjs/Cameras/camera";
  18719. import { Scene } from "babylonjs/scene";
  18720. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18721. /**
  18722. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18723. * This is the base of the follow, arc rotate cameras and Free camera
  18724. * @see https://doc.babylonjs.com/features/cameras
  18725. */
  18726. export class TargetCamera extends Camera {
  18727. private static _RigCamTransformMatrix;
  18728. private static _TargetTransformMatrix;
  18729. private static _TargetFocalPoint;
  18730. private _tmpUpVector;
  18731. private _tmpTargetVector;
  18732. /**
  18733. * Define the current direction the camera is moving to
  18734. */
  18735. cameraDirection: Vector3;
  18736. /**
  18737. * Define the current rotation the camera is rotating to
  18738. */
  18739. cameraRotation: Vector2;
  18740. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18741. ignoreParentScaling: boolean;
  18742. /**
  18743. * When set, the up vector of the camera will be updated by the rotation of the camera
  18744. */
  18745. updateUpVectorFromRotation: boolean;
  18746. private _tmpQuaternion;
  18747. /**
  18748. * Define the current rotation of the camera
  18749. */
  18750. rotation: Vector3;
  18751. /**
  18752. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18753. */
  18754. rotationQuaternion: Quaternion;
  18755. /**
  18756. * Define the current speed of the camera
  18757. */
  18758. speed: number;
  18759. /**
  18760. * Add constraint to the camera to prevent it to move freely in all directions and
  18761. * around all axis.
  18762. */
  18763. noRotationConstraint: boolean;
  18764. /**
  18765. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18766. * panning
  18767. */
  18768. invertRotation: boolean;
  18769. /**
  18770. * Speed multiplier for inverse camera panning
  18771. */
  18772. inverseRotationSpeed: number;
  18773. /**
  18774. * Define the current target of the camera as an object or a position.
  18775. */
  18776. lockedTarget: any;
  18777. /** @hidden */
  18778. _currentTarget: Vector3;
  18779. /** @hidden */
  18780. _initialFocalDistance: number;
  18781. /** @hidden */
  18782. _viewMatrix: Matrix;
  18783. /** @hidden */
  18784. _camMatrix: Matrix;
  18785. /** @hidden */
  18786. _cameraTransformMatrix: Matrix;
  18787. /** @hidden */
  18788. _cameraRotationMatrix: Matrix;
  18789. /** @hidden */
  18790. _referencePoint: Vector3;
  18791. /** @hidden */
  18792. _transformedReferencePoint: Vector3;
  18793. /** @hidden */
  18794. _reset: () => void;
  18795. private _defaultUp;
  18796. /**
  18797. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18798. * This is the base of the follow, arc rotate cameras and Free camera
  18799. * @see https://doc.babylonjs.com/features/cameras
  18800. * @param name Defines the name of the camera in the scene
  18801. * @param position Defines the start position of the camera in the scene
  18802. * @param scene Defines the scene the camera belongs to
  18803. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18804. */
  18805. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18806. /**
  18807. * Gets the position in front of the camera at a given distance.
  18808. * @param distance The distance from the camera we want the position to be
  18809. * @returns the position
  18810. */
  18811. getFrontPosition(distance: number): Vector3;
  18812. /** @hidden */
  18813. _getLockedTargetPosition(): Nullable<Vector3>;
  18814. private _storedPosition;
  18815. private _storedRotation;
  18816. private _storedRotationQuaternion;
  18817. /**
  18818. * Store current camera state of the camera (fov, position, rotation, etc..)
  18819. * @returns the camera
  18820. */
  18821. storeState(): Camera;
  18822. /**
  18823. * Restored camera state. You must call storeState() first
  18824. * @returns whether it was successful or not
  18825. * @hidden
  18826. */
  18827. _restoreStateValues(): boolean;
  18828. /** @hidden */
  18829. _initCache(): void;
  18830. /** @hidden */
  18831. _updateCache(ignoreParentClass?: boolean): void;
  18832. /** @hidden */
  18833. _isSynchronizedViewMatrix(): boolean;
  18834. /** @hidden */
  18835. _computeLocalCameraSpeed(): number;
  18836. /**
  18837. * Defines the target the camera should look at.
  18838. * @param target Defines the new target as a Vector or a mesh
  18839. */
  18840. setTarget(target: Vector3): void;
  18841. /**
  18842. * Return the current target position of the camera. This value is expressed in local space.
  18843. * @returns the target position
  18844. */
  18845. getTarget(): Vector3;
  18846. /** @hidden */
  18847. _decideIfNeedsToMove(): boolean;
  18848. /** @hidden */
  18849. _updatePosition(): void;
  18850. /** @hidden */
  18851. _checkInputs(): void;
  18852. protected _updateCameraRotationMatrix(): void;
  18853. /**
  18854. * 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)
  18855. * @returns the current camera
  18856. */
  18857. private _rotateUpVectorWithCameraRotationMatrix;
  18858. private _cachedRotationZ;
  18859. private _cachedQuaternionRotationZ;
  18860. /** @hidden */
  18861. _getViewMatrix(): Matrix;
  18862. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  18863. /**
  18864. * @hidden
  18865. */
  18866. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  18867. /**
  18868. * @hidden
  18869. */
  18870. _updateRigCameras(): void;
  18871. private _getRigCamPositionAndTarget;
  18872. /**
  18873. * Gets the current object class name.
  18874. * @return the class name
  18875. */
  18876. getClassName(): string;
  18877. }
  18878. }
  18879. declare module "babylonjs/Events/keyboardEvents" {
  18880. /**
  18881. * Gather the list of keyboard event types as constants.
  18882. */
  18883. export class KeyboardEventTypes {
  18884. /**
  18885. * The keydown event is fired when a key becomes active (pressed).
  18886. */
  18887. static readonly KEYDOWN: number;
  18888. /**
  18889. * The keyup event is fired when a key has been released.
  18890. */
  18891. static readonly KEYUP: number;
  18892. }
  18893. /**
  18894. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18895. */
  18896. export class KeyboardInfo {
  18897. /**
  18898. * Defines the type of event (KeyboardEventTypes)
  18899. */
  18900. type: number;
  18901. /**
  18902. * Defines the related dom event
  18903. */
  18904. event: KeyboardEvent;
  18905. /**
  18906. * Instantiates a new keyboard info.
  18907. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18908. * @param type Defines the type of event (KeyboardEventTypes)
  18909. * @param event Defines the related dom event
  18910. */
  18911. constructor(
  18912. /**
  18913. * Defines the type of event (KeyboardEventTypes)
  18914. */
  18915. type: number,
  18916. /**
  18917. * Defines the related dom event
  18918. */
  18919. event: KeyboardEvent);
  18920. }
  18921. /**
  18922. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18923. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  18924. */
  18925. export class KeyboardInfoPre extends KeyboardInfo {
  18926. /**
  18927. * Defines the type of event (KeyboardEventTypes)
  18928. */
  18929. type: number;
  18930. /**
  18931. * Defines the related dom event
  18932. */
  18933. event: KeyboardEvent;
  18934. /**
  18935. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  18936. */
  18937. skipOnPointerObservable: boolean;
  18938. /**
  18939. * Instantiates a new keyboard pre info.
  18940. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18941. * @param type Defines the type of event (KeyboardEventTypes)
  18942. * @param event Defines the related dom event
  18943. */
  18944. constructor(
  18945. /**
  18946. * Defines the type of event (KeyboardEventTypes)
  18947. */
  18948. type: number,
  18949. /**
  18950. * Defines the related dom event
  18951. */
  18952. event: KeyboardEvent);
  18953. }
  18954. }
  18955. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  18956. import { Nullable } from "babylonjs/types";
  18957. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  18958. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  18959. /**
  18960. * Manage the keyboard inputs to control the movement of a free camera.
  18961. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  18962. */
  18963. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  18964. /**
  18965. * Defines the camera the input is attached to.
  18966. */
  18967. camera: FreeCamera;
  18968. /**
  18969. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  18970. */
  18971. keysUp: number[];
  18972. /**
  18973. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  18974. */
  18975. keysUpward: number[];
  18976. /**
  18977. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  18978. */
  18979. keysDown: number[];
  18980. /**
  18981. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  18982. */
  18983. keysDownward: number[];
  18984. /**
  18985. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  18986. */
  18987. keysLeft: number[];
  18988. /**
  18989. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  18990. */
  18991. keysRight: number[];
  18992. private _keys;
  18993. private _onCanvasBlurObserver;
  18994. private _onKeyboardObserver;
  18995. private _engine;
  18996. private _scene;
  18997. /**
  18998. * Attach the input controls to a specific dom element to get the input from.
  18999. * @param element Defines the element the controls should be listened from
  19000. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19001. */
  19002. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19003. /**
  19004. * Detach the current controls from the specified dom element.
  19005. * @param element Defines the element to stop listening the inputs from
  19006. */
  19007. detachControl(element: Nullable<HTMLElement>): void;
  19008. /**
  19009. * Update the current camera state depending on the inputs that have been used this frame.
  19010. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19011. */
  19012. checkInputs(): void;
  19013. /**
  19014. * Gets the class name of the current intput.
  19015. * @returns the class name
  19016. */
  19017. getClassName(): string;
  19018. /** @hidden */
  19019. _onLostFocus(): void;
  19020. /**
  19021. * Get the friendly name associated with the input class.
  19022. * @returns the input friendly name
  19023. */
  19024. getSimpleName(): string;
  19025. }
  19026. }
  19027. declare module "babylonjs/Events/pointerEvents" {
  19028. import { Nullable } from "babylonjs/types";
  19029. import { Vector2 } from "babylonjs/Maths/math.vector";
  19030. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19031. import { Ray } from "babylonjs/Culling/ray";
  19032. /**
  19033. * Gather the list of pointer event types as constants.
  19034. */
  19035. export class PointerEventTypes {
  19036. /**
  19037. * 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.
  19038. */
  19039. static readonly POINTERDOWN: number;
  19040. /**
  19041. * The pointerup event is fired when a pointer is no longer active.
  19042. */
  19043. static readonly POINTERUP: number;
  19044. /**
  19045. * The pointermove event is fired when a pointer changes coordinates.
  19046. */
  19047. static readonly POINTERMOVE: number;
  19048. /**
  19049. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19050. */
  19051. static readonly POINTERWHEEL: number;
  19052. /**
  19053. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19054. */
  19055. static readonly POINTERPICK: number;
  19056. /**
  19057. * The pointertap event is fired when a the object has been touched and released without drag.
  19058. */
  19059. static readonly POINTERTAP: number;
  19060. /**
  19061. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19062. */
  19063. static readonly POINTERDOUBLETAP: number;
  19064. }
  19065. /**
  19066. * Base class of pointer info types.
  19067. */
  19068. export class PointerInfoBase {
  19069. /**
  19070. * Defines the type of event (PointerEventTypes)
  19071. */
  19072. type: number;
  19073. /**
  19074. * Defines the related dom event
  19075. */
  19076. event: PointerEvent | MouseWheelEvent;
  19077. /**
  19078. * Instantiates the base class of pointers info.
  19079. * @param type Defines the type of event (PointerEventTypes)
  19080. * @param event Defines the related dom event
  19081. */
  19082. constructor(
  19083. /**
  19084. * Defines the type of event (PointerEventTypes)
  19085. */
  19086. type: number,
  19087. /**
  19088. * Defines the related dom event
  19089. */
  19090. event: PointerEvent | MouseWheelEvent);
  19091. }
  19092. /**
  19093. * This class is used to store pointer related info for the onPrePointerObservable event.
  19094. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19095. */
  19096. export class PointerInfoPre extends PointerInfoBase {
  19097. /**
  19098. * Ray from a pointer if availible (eg. 6dof controller)
  19099. */
  19100. ray: Nullable<Ray>;
  19101. /**
  19102. * Defines the local position of the pointer on the canvas.
  19103. */
  19104. localPosition: Vector2;
  19105. /**
  19106. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19107. */
  19108. skipOnPointerObservable: boolean;
  19109. /**
  19110. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19111. * @param type Defines the type of event (PointerEventTypes)
  19112. * @param event Defines the related dom event
  19113. * @param localX Defines the local x coordinates of the pointer when the event occured
  19114. * @param localY Defines the local y coordinates of the pointer when the event occured
  19115. */
  19116. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19117. }
  19118. /**
  19119. * This type contains all the data related to a pointer event in Babylon.js.
  19120. * 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.
  19121. */
  19122. export class PointerInfo extends PointerInfoBase {
  19123. /**
  19124. * Defines the picking info associated to the info (if any)\
  19125. */
  19126. pickInfo: Nullable<PickingInfo>;
  19127. /**
  19128. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19129. * @param type Defines the type of event (PointerEventTypes)
  19130. * @param event Defines the related dom event
  19131. * @param pickInfo Defines the picking info associated to the info (if any)\
  19132. */
  19133. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19134. /**
  19135. * Defines the picking info associated to the info (if any)\
  19136. */
  19137. pickInfo: Nullable<PickingInfo>);
  19138. }
  19139. /**
  19140. * Data relating to a touch event on the screen.
  19141. */
  19142. export interface PointerTouch {
  19143. /**
  19144. * X coordinate of touch.
  19145. */
  19146. x: number;
  19147. /**
  19148. * Y coordinate of touch.
  19149. */
  19150. y: number;
  19151. /**
  19152. * Id of touch. Unique for each finger.
  19153. */
  19154. pointerId: number;
  19155. /**
  19156. * Event type passed from DOM.
  19157. */
  19158. type: any;
  19159. }
  19160. }
  19161. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19162. import { Observable } from "babylonjs/Misc/observable";
  19163. import { Nullable } from "babylonjs/types";
  19164. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19165. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19166. /**
  19167. * Manage the mouse inputs to control the movement of a free camera.
  19168. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19169. */
  19170. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19171. /**
  19172. * Define if touch is enabled in the mouse input
  19173. */
  19174. touchEnabled: boolean;
  19175. /**
  19176. * Defines the camera the input is attached to.
  19177. */
  19178. camera: FreeCamera;
  19179. /**
  19180. * Defines the buttons associated with the input to handle camera move.
  19181. */
  19182. buttons: number[];
  19183. /**
  19184. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19185. */
  19186. angularSensibility: number;
  19187. private _pointerInput;
  19188. private _onMouseMove;
  19189. private _observer;
  19190. private previousPosition;
  19191. /**
  19192. * Observable for when a pointer move event occurs containing the move offset
  19193. */
  19194. onPointerMovedObservable: Observable<{
  19195. offsetX: number;
  19196. offsetY: number;
  19197. }>;
  19198. /**
  19199. * @hidden
  19200. * If the camera should be rotated automatically based on pointer movement
  19201. */
  19202. _allowCameraRotation: boolean;
  19203. /**
  19204. * Manage the mouse inputs to control the movement of a free camera.
  19205. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19206. * @param touchEnabled Defines if touch is enabled or not
  19207. */
  19208. constructor(
  19209. /**
  19210. * Define if touch is enabled in the mouse input
  19211. */
  19212. touchEnabled?: boolean);
  19213. /**
  19214. * Attach the input controls to a specific dom element to get the input from.
  19215. * @param element Defines the element the controls should be listened from
  19216. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19217. */
  19218. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19219. /**
  19220. * Called on JS contextmenu event.
  19221. * Override this method to provide functionality.
  19222. */
  19223. protected onContextMenu(evt: PointerEvent): void;
  19224. /**
  19225. * Detach the current controls from the specified dom element.
  19226. * @param element Defines the element to stop listening the inputs from
  19227. */
  19228. detachControl(element: Nullable<HTMLElement>): void;
  19229. /**
  19230. * Gets the class name of the current intput.
  19231. * @returns the class name
  19232. */
  19233. getClassName(): string;
  19234. /**
  19235. * Get the friendly name associated with the input class.
  19236. * @returns the input friendly name
  19237. */
  19238. getSimpleName(): string;
  19239. }
  19240. }
  19241. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19242. import { Nullable } from "babylonjs/types";
  19243. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19244. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19245. /**
  19246. * Manage the touch inputs to control the movement of a free camera.
  19247. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19248. */
  19249. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19250. /**
  19251. * Defines the camera the input is attached to.
  19252. */
  19253. camera: FreeCamera;
  19254. /**
  19255. * Defines the touch sensibility for rotation.
  19256. * The higher the faster.
  19257. */
  19258. touchAngularSensibility: number;
  19259. /**
  19260. * Defines the touch sensibility for move.
  19261. * The higher the faster.
  19262. */
  19263. touchMoveSensibility: number;
  19264. private _offsetX;
  19265. private _offsetY;
  19266. private _pointerPressed;
  19267. private _pointerInput;
  19268. private _observer;
  19269. private _onLostFocus;
  19270. /**
  19271. * Attach the input controls to a specific dom element to get the input from.
  19272. * @param element Defines the element the controls should be listened from
  19273. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19274. */
  19275. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19276. /**
  19277. * Detach the current controls from the specified dom element.
  19278. * @param element Defines the element to stop listening the inputs from
  19279. */
  19280. detachControl(element: Nullable<HTMLElement>): void;
  19281. /**
  19282. * Update the current camera state depending on the inputs that have been used this frame.
  19283. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19284. */
  19285. checkInputs(): void;
  19286. /**
  19287. * Gets the class name of the current intput.
  19288. * @returns the class name
  19289. */
  19290. getClassName(): string;
  19291. /**
  19292. * Get the friendly name associated with the input class.
  19293. * @returns the input friendly name
  19294. */
  19295. getSimpleName(): string;
  19296. }
  19297. }
  19298. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19299. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19300. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19301. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19302. import { Nullable } from "babylonjs/types";
  19303. /**
  19304. * Default Inputs manager for the FreeCamera.
  19305. * It groups all the default supported inputs for ease of use.
  19306. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19307. */
  19308. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19309. /**
  19310. * @hidden
  19311. */
  19312. _mouseInput: Nullable<FreeCameraMouseInput>;
  19313. /**
  19314. * Instantiates a new FreeCameraInputsManager.
  19315. * @param camera Defines the camera the inputs belong to
  19316. */
  19317. constructor(camera: FreeCamera);
  19318. /**
  19319. * Add keyboard input support to the input manager.
  19320. * @returns the current input manager
  19321. */
  19322. addKeyboard(): FreeCameraInputsManager;
  19323. /**
  19324. * Add mouse input support to the input manager.
  19325. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19326. * @returns the current input manager
  19327. */
  19328. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19329. /**
  19330. * Removes the mouse input support from the manager
  19331. * @returns the current input manager
  19332. */
  19333. removeMouse(): FreeCameraInputsManager;
  19334. /**
  19335. * Add touch input support to the input manager.
  19336. * @returns the current input manager
  19337. */
  19338. addTouch(): FreeCameraInputsManager;
  19339. /**
  19340. * Remove all attached input methods from a camera
  19341. */
  19342. clear(): void;
  19343. }
  19344. }
  19345. declare module "babylonjs/Cameras/freeCamera" {
  19346. import { Vector3 } from "babylonjs/Maths/math.vector";
  19347. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19348. import { Scene } from "babylonjs/scene";
  19349. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19350. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19351. /**
  19352. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19353. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19354. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19355. */
  19356. export class FreeCamera extends TargetCamera {
  19357. /**
  19358. * Define the collision ellipsoid of the camera.
  19359. * This is helpful to simulate a camera body like the player body around the camera
  19360. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19361. */
  19362. ellipsoid: Vector3;
  19363. /**
  19364. * Define an offset for the position of the ellipsoid around the camera.
  19365. * This can be helpful to determine the center of the body near the gravity center of the body
  19366. * instead of its head.
  19367. */
  19368. ellipsoidOffset: Vector3;
  19369. /**
  19370. * Enable or disable collisions of the camera with the rest of the scene objects.
  19371. */
  19372. checkCollisions: boolean;
  19373. /**
  19374. * Enable or disable gravity on the camera.
  19375. */
  19376. applyGravity: boolean;
  19377. /**
  19378. * Define the input manager associated to the camera.
  19379. */
  19380. inputs: FreeCameraInputsManager;
  19381. /**
  19382. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19383. * Higher values reduce sensitivity.
  19384. */
  19385. get angularSensibility(): number;
  19386. /**
  19387. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19388. * Higher values reduce sensitivity.
  19389. */
  19390. set angularSensibility(value: number);
  19391. /**
  19392. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19393. */
  19394. get keysUp(): number[];
  19395. set keysUp(value: number[]);
  19396. /**
  19397. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19398. */
  19399. get keysUpward(): number[];
  19400. set keysUpward(value: number[]);
  19401. /**
  19402. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19403. */
  19404. get keysDown(): number[];
  19405. set keysDown(value: number[]);
  19406. /**
  19407. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19408. */
  19409. get keysDownward(): number[];
  19410. set keysDownward(value: number[]);
  19411. /**
  19412. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19413. */
  19414. get keysLeft(): number[];
  19415. set keysLeft(value: number[]);
  19416. /**
  19417. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19418. */
  19419. get keysRight(): number[];
  19420. set keysRight(value: number[]);
  19421. /**
  19422. * Event raised when the camera collide with a mesh in the scene.
  19423. */
  19424. onCollide: (collidedMesh: AbstractMesh) => void;
  19425. private _collider;
  19426. private _needMoveForGravity;
  19427. private _oldPosition;
  19428. private _diffPosition;
  19429. private _newPosition;
  19430. /** @hidden */
  19431. _localDirection: Vector3;
  19432. /** @hidden */
  19433. _transformedDirection: Vector3;
  19434. /**
  19435. * Instantiates a Free Camera.
  19436. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19437. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19438. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19439. * @param name Define the name of the camera in the scene
  19440. * @param position Define the start position of the camera in the scene
  19441. * @param scene Define the scene the camera belongs to
  19442. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19443. */
  19444. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19445. /**
  19446. * Attached controls to the current camera.
  19447. * @param element Defines the element the controls should be listened from
  19448. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19449. */
  19450. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19451. /**
  19452. * Detach the current controls from the camera.
  19453. * The camera will stop reacting to inputs.
  19454. * @param element Defines the element to stop listening the inputs from
  19455. */
  19456. detachControl(element: HTMLElement): void;
  19457. private _collisionMask;
  19458. /**
  19459. * Define a collision mask to limit the list of object the camera can collide with
  19460. */
  19461. get collisionMask(): number;
  19462. set collisionMask(mask: number);
  19463. /** @hidden */
  19464. _collideWithWorld(displacement: Vector3): void;
  19465. private _onCollisionPositionChange;
  19466. /** @hidden */
  19467. _checkInputs(): void;
  19468. /** @hidden */
  19469. _decideIfNeedsToMove(): boolean;
  19470. /** @hidden */
  19471. _updatePosition(): void;
  19472. /**
  19473. * Destroy the camera and release the current resources hold by it.
  19474. */
  19475. dispose(): void;
  19476. /**
  19477. * Gets the current object class name.
  19478. * @return the class name
  19479. */
  19480. getClassName(): string;
  19481. }
  19482. }
  19483. declare module "babylonjs/Gamepads/gamepad" {
  19484. import { Observable } from "babylonjs/Misc/observable";
  19485. /**
  19486. * Represents a gamepad control stick position
  19487. */
  19488. export class StickValues {
  19489. /**
  19490. * The x component of the control stick
  19491. */
  19492. x: number;
  19493. /**
  19494. * The y component of the control stick
  19495. */
  19496. y: number;
  19497. /**
  19498. * Initializes the gamepad x and y control stick values
  19499. * @param x The x component of the gamepad control stick value
  19500. * @param y The y component of the gamepad control stick value
  19501. */
  19502. constructor(
  19503. /**
  19504. * The x component of the control stick
  19505. */
  19506. x: number,
  19507. /**
  19508. * The y component of the control stick
  19509. */
  19510. y: number);
  19511. }
  19512. /**
  19513. * An interface which manages callbacks for gamepad button changes
  19514. */
  19515. export interface GamepadButtonChanges {
  19516. /**
  19517. * Called when a gamepad has been changed
  19518. */
  19519. changed: boolean;
  19520. /**
  19521. * Called when a gamepad press event has been triggered
  19522. */
  19523. pressChanged: boolean;
  19524. /**
  19525. * Called when a touch event has been triggered
  19526. */
  19527. touchChanged: boolean;
  19528. /**
  19529. * Called when a value has changed
  19530. */
  19531. valueChanged: boolean;
  19532. }
  19533. /**
  19534. * Represents a gamepad
  19535. */
  19536. export class Gamepad {
  19537. /**
  19538. * The id of the gamepad
  19539. */
  19540. id: string;
  19541. /**
  19542. * The index of the gamepad
  19543. */
  19544. index: number;
  19545. /**
  19546. * The browser gamepad
  19547. */
  19548. browserGamepad: any;
  19549. /**
  19550. * Specifies what type of gamepad this represents
  19551. */
  19552. type: number;
  19553. private _leftStick;
  19554. private _rightStick;
  19555. /** @hidden */
  19556. _isConnected: boolean;
  19557. private _leftStickAxisX;
  19558. private _leftStickAxisY;
  19559. private _rightStickAxisX;
  19560. private _rightStickAxisY;
  19561. /**
  19562. * Triggered when the left control stick has been changed
  19563. */
  19564. private _onleftstickchanged;
  19565. /**
  19566. * Triggered when the right control stick has been changed
  19567. */
  19568. private _onrightstickchanged;
  19569. /**
  19570. * Represents a gamepad controller
  19571. */
  19572. static GAMEPAD: number;
  19573. /**
  19574. * Represents a generic controller
  19575. */
  19576. static GENERIC: number;
  19577. /**
  19578. * Represents an XBox controller
  19579. */
  19580. static XBOX: number;
  19581. /**
  19582. * Represents a pose-enabled controller
  19583. */
  19584. static POSE_ENABLED: number;
  19585. /**
  19586. * Represents an Dual Shock controller
  19587. */
  19588. static DUALSHOCK: number;
  19589. /**
  19590. * Specifies whether the left control stick should be Y-inverted
  19591. */
  19592. protected _invertLeftStickY: boolean;
  19593. /**
  19594. * Specifies if the gamepad has been connected
  19595. */
  19596. get isConnected(): boolean;
  19597. /**
  19598. * Initializes the gamepad
  19599. * @param id The id of the gamepad
  19600. * @param index The index of the gamepad
  19601. * @param browserGamepad The browser gamepad
  19602. * @param leftStickX The x component of the left joystick
  19603. * @param leftStickY The y component of the left joystick
  19604. * @param rightStickX The x component of the right joystick
  19605. * @param rightStickY The y component of the right joystick
  19606. */
  19607. constructor(
  19608. /**
  19609. * The id of the gamepad
  19610. */
  19611. id: string,
  19612. /**
  19613. * The index of the gamepad
  19614. */
  19615. index: number,
  19616. /**
  19617. * The browser gamepad
  19618. */
  19619. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19620. /**
  19621. * Callback triggered when the left joystick has changed
  19622. * @param callback
  19623. */
  19624. onleftstickchanged(callback: (values: StickValues) => void): void;
  19625. /**
  19626. * Callback triggered when the right joystick has changed
  19627. * @param callback
  19628. */
  19629. onrightstickchanged(callback: (values: StickValues) => void): void;
  19630. /**
  19631. * Gets the left joystick
  19632. */
  19633. get leftStick(): StickValues;
  19634. /**
  19635. * Sets the left joystick values
  19636. */
  19637. set leftStick(newValues: StickValues);
  19638. /**
  19639. * Gets the right joystick
  19640. */
  19641. get rightStick(): StickValues;
  19642. /**
  19643. * Sets the right joystick value
  19644. */
  19645. set rightStick(newValues: StickValues);
  19646. /**
  19647. * Updates the gamepad joystick positions
  19648. */
  19649. update(): void;
  19650. /**
  19651. * Disposes the gamepad
  19652. */
  19653. dispose(): void;
  19654. }
  19655. /**
  19656. * Represents a generic gamepad
  19657. */
  19658. export class GenericPad extends Gamepad {
  19659. private _buttons;
  19660. private _onbuttondown;
  19661. private _onbuttonup;
  19662. /**
  19663. * Observable triggered when a button has been pressed
  19664. */
  19665. onButtonDownObservable: Observable<number>;
  19666. /**
  19667. * Observable triggered when a button has been released
  19668. */
  19669. onButtonUpObservable: Observable<number>;
  19670. /**
  19671. * Callback triggered when a button has been pressed
  19672. * @param callback Called when a button has been pressed
  19673. */
  19674. onbuttondown(callback: (buttonPressed: number) => void): void;
  19675. /**
  19676. * Callback triggered when a button has been released
  19677. * @param callback Called when a button has been released
  19678. */
  19679. onbuttonup(callback: (buttonReleased: number) => void): void;
  19680. /**
  19681. * Initializes the generic gamepad
  19682. * @param id The id of the generic gamepad
  19683. * @param index The index of the generic gamepad
  19684. * @param browserGamepad The browser gamepad
  19685. */
  19686. constructor(id: string, index: number, browserGamepad: any);
  19687. private _setButtonValue;
  19688. /**
  19689. * Updates the generic gamepad
  19690. */
  19691. update(): void;
  19692. /**
  19693. * Disposes the generic gamepad
  19694. */
  19695. dispose(): void;
  19696. }
  19697. }
  19698. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19699. import { Observable } from "babylonjs/Misc/observable";
  19700. import { Nullable } from "babylonjs/types";
  19701. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19702. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19703. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19704. import { Ray } from "babylonjs/Culling/ray";
  19705. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19706. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19707. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19708. /**
  19709. * Defines the types of pose enabled controllers that are supported
  19710. */
  19711. export enum PoseEnabledControllerType {
  19712. /**
  19713. * HTC Vive
  19714. */
  19715. VIVE = 0,
  19716. /**
  19717. * Oculus Rift
  19718. */
  19719. OCULUS = 1,
  19720. /**
  19721. * Windows mixed reality
  19722. */
  19723. WINDOWS = 2,
  19724. /**
  19725. * Samsung gear VR
  19726. */
  19727. GEAR_VR = 3,
  19728. /**
  19729. * Google Daydream
  19730. */
  19731. DAYDREAM = 4,
  19732. /**
  19733. * Generic
  19734. */
  19735. GENERIC = 5
  19736. }
  19737. /**
  19738. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19739. */
  19740. export interface MutableGamepadButton {
  19741. /**
  19742. * Value of the button/trigger
  19743. */
  19744. value: number;
  19745. /**
  19746. * If the button/trigger is currently touched
  19747. */
  19748. touched: boolean;
  19749. /**
  19750. * If the button/trigger is currently pressed
  19751. */
  19752. pressed: boolean;
  19753. }
  19754. /**
  19755. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19756. * @hidden
  19757. */
  19758. export interface ExtendedGamepadButton extends GamepadButton {
  19759. /**
  19760. * If the button/trigger is currently pressed
  19761. */
  19762. readonly pressed: boolean;
  19763. /**
  19764. * If the button/trigger is currently touched
  19765. */
  19766. readonly touched: boolean;
  19767. /**
  19768. * Value of the button/trigger
  19769. */
  19770. readonly value: number;
  19771. }
  19772. /** @hidden */
  19773. export interface _GamePadFactory {
  19774. /**
  19775. * Returns whether or not the current gamepad can be created for this type of controller.
  19776. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19777. * @returns true if it can be created, otherwise false
  19778. */
  19779. canCreate(gamepadInfo: any): boolean;
  19780. /**
  19781. * Creates a new instance of the Gamepad.
  19782. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19783. * @returns the new gamepad instance
  19784. */
  19785. create(gamepadInfo: any): Gamepad;
  19786. }
  19787. /**
  19788. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19789. */
  19790. export class PoseEnabledControllerHelper {
  19791. /** @hidden */
  19792. static _ControllerFactories: _GamePadFactory[];
  19793. /** @hidden */
  19794. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19795. /**
  19796. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19797. * @param vrGamepad the gamepad to initialized
  19798. * @returns a vr controller of the type the gamepad identified as
  19799. */
  19800. static InitiateController(vrGamepad: any): Gamepad;
  19801. }
  19802. /**
  19803. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19804. */
  19805. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19806. /**
  19807. * If the controller is used in a webXR session
  19808. */
  19809. isXR: boolean;
  19810. private _deviceRoomPosition;
  19811. private _deviceRoomRotationQuaternion;
  19812. /**
  19813. * The device position in babylon space
  19814. */
  19815. devicePosition: Vector3;
  19816. /**
  19817. * The device rotation in babylon space
  19818. */
  19819. deviceRotationQuaternion: Quaternion;
  19820. /**
  19821. * The scale factor of the device in babylon space
  19822. */
  19823. deviceScaleFactor: number;
  19824. /**
  19825. * (Likely devicePosition should be used instead) The device position in its room space
  19826. */
  19827. position: Vector3;
  19828. /**
  19829. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  19830. */
  19831. rotationQuaternion: Quaternion;
  19832. /**
  19833. * The type of controller (Eg. Windows mixed reality)
  19834. */
  19835. controllerType: PoseEnabledControllerType;
  19836. protected _calculatedPosition: Vector3;
  19837. private _calculatedRotation;
  19838. /**
  19839. * The raw pose from the device
  19840. */
  19841. rawPose: DevicePose;
  19842. private _trackPosition;
  19843. private _maxRotationDistFromHeadset;
  19844. private _draggedRoomRotation;
  19845. /**
  19846. * @hidden
  19847. */
  19848. _disableTrackPosition(fixedPosition: Vector3): void;
  19849. /**
  19850. * Internal, the mesh attached to the controller
  19851. * @hidden
  19852. */
  19853. _mesh: Nullable<AbstractMesh>;
  19854. private _poseControlledCamera;
  19855. private _leftHandSystemQuaternion;
  19856. /**
  19857. * Internal, matrix used to convert room space to babylon space
  19858. * @hidden
  19859. */
  19860. _deviceToWorld: Matrix;
  19861. /**
  19862. * Node to be used when casting a ray from the controller
  19863. * @hidden
  19864. */
  19865. _pointingPoseNode: Nullable<TransformNode>;
  19866. /**
  19867. * Name of the child mesh that can be used to cast a ray from the controller
  19868. */
  19869. static readonly POINTING_POSE: string;
  19870. /**
  19871. * Creates a new PoseEnabledController from a gamepad
  19872. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  19873. */
  19874. constructor(browserGamepad: any);
  19875. private _workingMatrix;
  19876. /**
  19877. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  19878. */
  19879. update(): void;
  19880. /**
  19881. * Updates only the pose device and mesh without doing any button event checking
  19882. */
  19883. protected _updatePoseAndMesh(): void;
  19884. /**
  19885. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  19886. * @param poseData raw pose fromthe device
  19887. */
  19888. updateFromDevice(poseData: DevicePose): void;
  19889. /**
  19890. * @hidden
  19891. */
  19892. _meshAttachedObservable: Observable<AbstractMesh>;
  19893. /**
  19894. * Attaches a mesh to the controller
  19895. * @param mesh the mesh to be attached
  19896. */
  19897. attachToMesh(mesh: AbstractMesh): void;
  19898. /**
  19899. * Attaches the controllers mesh to a camera
  19900. * @param camera the camera the mesh should be attached to
  19901. */
  19902. attachToPoseControlledCamera(camera: TargetCamera): void;
  19903. /**
  19904. * Disposes of the controller
  19905. */
  19906. dispose(): void;
  19907. /**
  19908. * The mesh that is attached to the controller
  19909. */
  19910. get mesh(): Nullable<AbstractMesh>;
  19911. /**
  19912. * Gets the ray of the controller in the direction the controller is pointing
  19913. * @param length the length the resulting ray should be
  19914. * @returns a ray in the direction the controller is pointing
  19915. */
  19916. getForwardRay(length?: number): Ray;
  19917. }
  19918. }
  19919. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  19920. import { Observable } from "babylonjs/Misc/observable";
  19921. import { Scene } from "babylonjs/scene";
  19922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19923. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  19924. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  19925. import { Nullable } from "babylonjs/types";
  19926. /**
  19927. * Defines the WebVRController object that represents controllers tracked in 3D space
  19928. */
  19929. export abstract class WebVRController extends PoseEnabledController {
  19930. /**
  19931. * Internal, the default controller model for the controller
  19932. */
  19933. protected _defaultModel: Nullable<AbstractMesh>;
  19934. /**
  19935. * Fired when the trigger state has changed
  19936. */
  19937. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  19938. /**
  19939. * Fired when the main button state has changed
  19940. */
  19941. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19942. /**
  19943. * Fired when the secondary button state has changed
  19944. */
  19945. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19946. /**
  19947. * Fired when the pad state has changed
  19948. */
  19949. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  19950. /**
  19951. * Fired when controllers stick values have changed
  19952. */
  19953. onPadValuesChangedObservable: Observable<StickValues>;
  19954. /**
  19955. * Array of button availible on the controller
  19956. */
  19957. protected _buttons: Array<MutableGamepadButton>;
  19958. private _onButtonStateChange;
  19959. /**
  19960. * Fired when a controller button's state has changed
  19961. * @param callback the callback containing the button that was modified
  19962. */
  19963. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  19964. /**
  19965. * X and Y axis corresponding to the controllers joystick
  19966. */
  19967. pad: StickValues;
  19968. /**
  19969. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  19970. */
  19971. hand: string;
  19972. /**
  19973. * The default controller model for the controller
  19974. */
  19975. get defaultModel(): Nullable<AbstractMesh>;
  19976. /**
  19977. * Creates a new WebVRController from a gamepad
  19978. * @param vrGamepad the gamepad that the WebVRController should be created from
  19979. */
  19980. constructor(vrGamepad: any);
  19981. /**
  19982. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  19983. */
  19984. update(): void;
  19985. /**
  19986. * Function to be called when a button is modified
  19987. */
  19988. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  19989. /**
  19990. * Loads a mesh and attaches it to the controller
  19991. * @param scene the scene the mesh should be added to
  19992. * @param meshLoaded callback for when the mesh has been loaded
  19993. */
  19994. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  19995. private _setButtonValue;
  19996. private _changes;
  19997. private _checkChanges;
  19998. /**
  19999. * Disposes of th webVRCOntroller
  20000. */
  20001. dispose(): void;
  20002. }
  20003. }
  20004. declare module "babylonjs/Lights/hemisphericLight" {
  20005. import { Nullable } from "babylonjs/types";
  20006. import { Scene } from "babylonjs/scene";
  20007. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20008. import { Color3 } from "babylonjs/Maths/math.color";
  20009. import { Effect } from "babylonjs/Materials/effect";
  20010. import { Light } from "babylonjs/Lights/light";
  20011. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20012. /**
  20013. * The HemisphericLight simulates the ambient environment light,
  20014. * so the passed direction is the light reflection direction, not the incoming direction.
  20015. */
  20016. export class HemisphericLight extends Light {
  20017. /**
  20018. * The groundColor is the light in the opposite direction to the one specified during creation.
  20019. * 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.
  20020. */
  20021. groundColor: Color3;
  20022. /**
  20023. * The light reflection direction, not the incoming direction.
  20024. */
  20025. direction: Vector3;
  20026. /**
  20027. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20028. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20029. * The HemisphericLight can't cast shadows.
  20030. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20031. * @param name The friendly name of the light
  20032. * @param direction The direction of the light reflection
  20033. * @param scene The scene the light belongs to
  20034. */
  20035. constructor(name: string, direction: Vector3, scene: Scene);
  20036. protected _buildUniformLayout(): void;
  20037. /**
  20038. * Returns the string "HemisphericLight".
  20039. * @return The class name
  20040. */
  20041. getClassName(): string;
  20042. /**
  20043. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20044. * Returns the updated direction.
  20045. * @param target The target the direction should point to
  20046. * @return The computed direction
  20047. */
  20048. setDirectionToTarget(target: Vector3): Vector3;
  20049. /**
  20050. * Returns the shadow generator associated to the light.
  20051. * @returns Always null for hemispheric lights because it does not support shadows.
  20052. */
  20053. getShadowGenerator(): Nullable<IShadowGenerator>;
  20054. /**
  20055. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20056. * @param effect The effect to update
  20057. * @param lightIndex The index of the light in the effect to update
  20058. * @returns The hemispheric light
  20059. */
  20060. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20061. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20062. /**
  20063. * Computes the world matrix of the node
  20064. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20065. * @param useWasUpdatedFlag defines a reserved property
  20066. * @returns the world matrix
  20067. */
  20068. computeWorldMatrix(): Matrix;
  20069. /**
  20070. * Returns the integer 3.
  20071. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20072. */
  20073. getTypeID(): number;
  20074. /**
  20075. * Prepares the list of defines specific to the light type.
  20076. * @param defines the list of defines
  20077. * @param lightIndex defines the index of the light for the effect
  20078. */
  20079. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20080. }
  20081. }
  20082. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20083. /** @hidden */
  20084. export var vrMultiviewToSingleviewPixelShader: {
  20085. name: string;
  20086. shader: string;
  20087. };
  20088. }
  20089. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20090. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20091. import { Scene } from "babylonjs/scene";
  20092. /**
  20093. * Renders to multiple views with a single draw call
  20094. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20095. */
  20096. export class MultiviewRenderTarget extends RenderTargetTexture {
  20097. /**
  20098. * Creates a multiview render target
  20099. * @param scene scene used with the render target
  20100. * @param size the size of the render target (used for each view)
  20101. */
  20102. constructor(scene: Scene, size?: number | {
  20103. width: number;
  20104. height: number;
  20105. } | {
  20106. ratio: number;
  20107. });
  20108. /**
  20109. * @hidden
  20110. * @param faceIndex the face index, if its a cube texture
  20111. */
  20112. _bindFrameBuffer(faceIndex?: number): void;
  20113. /**
  20114. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20115. * @returns the view count
  20116. */
  20117. getViewCount(): number;
  20118. }
  20119. }
  20120. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20121. import { Camera } from "babylonjs/Cameras/camera";
  20122. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20123. import { Nullable } from "babylonjs/types";
  20124. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20125. import { Matrix } from "babylonjs/Maths/math.vector";
  20126. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20127. module "babylonjs/Engines/engine" {
  20128. interface Engine {
  20129. /**
  20130. * Creates a new multiview render target
  20131. * @param width defines the width of the texture
  20132. * @param height defines the height of the texture
  20133. * @returns the created multiview texture
  20134. */
  20135. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20136. /**
  20137. * Binds a multiview framebuffer to be drawn to
  20138. * @param multiviewTexture texture to bind
  20139. */
  20140. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20141. }
  20142. }
  20143. module "babylonjs/Cameras/camera" {
  20144. interface Camera {
  20145. /**
  20146. * @hidden
  20147. * 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)
  20148. */
  20149. _useMultiviewToSingleView: boolean;
  20150. /**
  20151. * @hidden
  20152. * 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)
  20153. */
  20154. _multiviewTexture: Nullable<RenderTargetTexture>;
  20155. /**
  20156. * @hidden
  20157. * ensures the multiview texture of the camera exists and has the specified width/height
  20158. * @param width height to set on the multiview texture
  20159. * @param height width to set on the multiview texture
  20160. */
  20161. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20162. }
  20163. }
  20164. module "babylonjs/scene" {
  20165. interface Scene {
  20166. /** @hidden */
  20167. _transformMatrixR: Matrix;
  20168. /** @hidden */
  20169. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20170. /** @hidden */
  20171. _createMultiviewUbo(): void;
  20172. /** @hidden */
  20173. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20174. /** @hidden */
  20175. _renderMultiviewToSingleView(camera: Camera): void;
  20176. }
  20177. }
  20178. }
  20179. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20180. import { Camera } from "babylonjs/Cameras/camera";
  20181. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20182. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20183. import "babylonjs/Engines/Extensions/engine.multiview";
  20184. /**
  20185. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20186. * This will not be used for webXR as it supports displaying texture arrays directly
  20187. */
  20188. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20189. /**
  20190. * Initializes a VRMultiviewToSingleview
  20191. * @param name name of the post process
  20192. * @param camera camera to be applied to
  20193. * @param scaleFactor scaling factor to the size of the output texture
  20194. */
  20195. constructor(name: string, camera: Camera, scaleFactor: number);
  20196. }
  20197. }
  20198. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20199. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20200. import { Nullable } from "babylonjs/types";
  20201. import { Size } from "babylonjs/Maths/math.size";
  20202. import { Observable } from "babylonjs/Misc/observable";
  20203. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20204. /**
  20205. * Interface used to define additional presentation attributes
  20206. */
  20207. export interface IVRPresentationAttributes {
  20208. /**
  20209. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20210. */
  20211. highRefreshRate: boolean;
  20212. /**
  20213. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20214. */
  20215. foveationLevel: number;
  20216. }
  20217. module "babylonjs/Engines/engine" {
  20218. interface Engine {
  20219. /** @hidden */
  20220. _vrDisplay: any;
  20221. /** @hidden */
  20222. _vrSupported: boolean;
  20223. /** @hidden */
  20224. _oldSize: Size;
  20225. /** @hidden */
  20226. _oldHardwareScaleFactor: number;
  20227. /** @hidden */
  20228. _vrExclusivePointerMode: boolean;
  20229. /** @hidden */
  20230. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20231. /** @hidden */
  20232. _onVRDisplayPointerRestricted: () => void;
  20233. /** @hidden */
  20234. _onVRDisplayPointerUnrestricted: () => void;
  20235. /** @hidden */
  20236. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20237. /** @hidden */
  20238. _onVrDisplayDisconnect: Nullable<() => void>;
  20239. /** @hidden */
  20240. _onVrDisplayPresentChange: Nullable<() => void>;
  20241. /**
  20242. * Observable signaled when VR display mode changes
  20243. */
  20244. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20245. /**
  20246. * Observable signaled when VR request present is complete
  20247. */
  20248. onVRRequestPresentComplete: Observable<boolean>;
  20249. /**
  20250. * Observable signaled when VR request present starts
  20251. */
  20252. onVRRequestPresentStart: Observable<Engine>;
  20253. /**
  20254. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20255. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20256. */
  20257. isInVRExclusivePointerMode: boolean;
  20258. /**
  20259. * Gets a boolean indicating if a webVR device was detected
  20260. * @returns true if a webVR device was detected
  20261. */
  20262. isVRDevicePresent(): boolean;
  20263. /**
  20264. * Gets the current webVR device
  20265. * @returns the current webVR device (or null)
  20266. */
  20267. getVRDevice(): any;
  20268. /**
  20269. * Initializes a webVR display and starts listening to display change events
  20270. * The onVRDisplayChangedObservable will be notified upon these changes
  20271. * @returns A promise containing a VRDisplay and if vr is supported
  20272. */
  20273. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20274. /** @hidden */
  20275. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20276. /**
  20277. * Gets or sets the presentation attributes used to configure VR rendering
  20278. */
  20279. vrPresentationAttributes?: IVRPresentationAttributes;
  20280. /**
  20281. * Call this function to switch to webVR mode
  20282. * Will do nothing if webVR is not supported or if there is no webVR device
  20283. * @param options the webvr options provided to the camera. mainly used for multiview
  20284. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20285. */
  20286. enableVR(options: WebVROptions): void;
  20287. /** @hidden */
  20288. _onVRFullScreenTriggered(): void;
  20289. }
  20290. }
  20291. }
  20292. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20293. import { Nullable } from "babylonjs/types";
  20294. import { Observable } from "babylonjs/Misc/observable";
  20295. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20296. import { Scene } from "babylonjs/scene";
  20297. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20298. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20299. import { Node } from "babylonjs/node";
  20300. import { Ray } from "babylonjs/Culling/ray";
  20301. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20302. import "babylonjs/Engines/Extensions/engine.webVR";
  20303. /**
  20304. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20305. * IMPORTANT!! The data is right-hand data.
  20306. * @export
  20307. * @interface DevicePose
  20308. */
  20309. export interface DevicePose {
  20310. /**
  20311. * The position of the device, values in array are [x,y,z].
  20312. */
  20313. readonly position: Nullable<Float32Array>;
  20314. /**
  20315. * The linearVelocity of the device, values in array are [x,y,z].
  20316. */
  20317. readonly linearVelocity: Nullable<Float32Array>;
  20318. /**
  20319. * The linearAcceleration of the device, values in array are [x,y,z].
  20320. */
  20321. readonly linearAcceleration: Nullable<Float32Array>;
  20322. /**
  20323. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20324. */
  20325. readonly orientation: Nullable<Float32Array>;
  20326. /**
  20327. * The angularVelocity of the device, values in array are [x,y,z].
  20328. */
  20329. readonly angularVelocity: Nullable<Float32Array>;
  20330. /**
  20331. * The angularAcceleration of the device, values in array are [x,y,z].
  20332. */
  20333. readonly angularAcceleration: Nullable<Float32Array>;
  20334. }
  20335. /**
  20336. * Interface representing a pose controlled object in Babylon.
  20337. * A pose controlled object has both regular pose values as well as pose values
  20338. * from an external device such as a VR head mounted display
  20339. */
  20340. export interface PoseControlled {
  20341. /**
  20342. * The position of the object in babylon space.
  20343. */
  20344. position: Vector3;
  20345. /**
  20346. * The rotation quaternion of the object in babylon space.
  20347. */
  20348. rotationQuaternion: Quaternion;
  20349. /**
  20350. * The position of the device in babylon space.
  20351. */
  20352. devicePosition?: Vector3;
  20353. /**
  20354. * The rotation quaternion of the device in babylon space.
  20355. */
  20356. deviceRotationQuaternion: Quaternion;
  20357. /**
  20358. * The raw pose coming from the device.
  20359. */
  20360. rawPose: Nullable<DevicePose>;
  20361. /**
  20362. * The scale of the device to be used when translating from device space to babylon space.
  20363. */
  20364. deviceScaleFactor: number;
  20365. /**
  20366. * Updates the poseControlled values based on the input device pose.
  20367. * @param poseData the pose data to update the object with
  20368. */
  20369. updateFromDevice(poseData: DevicePose): void;
  20370. }
  20371. /**
  20372. * Set of options to customize the webVRCamera
  20373. */
  20374. export interface WebVROptions {
  20375. /**
  20376. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20377. */
  20378. trackPosition?: boolean;
  20379. /**
  20380. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20381. */
  20382. positionScale?: number;
  20383. /**
  20384. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20385. */
  20386. displayName?: string;
  20387. /**
  20388. * Should the native controller meshes be initialized. (default: true)
  20389. */
  20390. controllerMeshes?: boolean;
  20391. /**
  20392. * Creating a default HemiLight only on controllers. (default: true)
  20393. */
  20394. defaultLightingOnControllers?: boolean;
  20395. /**
  20396. * If you don't want to use the default VR button of the helper. (default: false)
  20397. */
  20398. useCustomVRButton?: boolean;
  20399. /**
  20400. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20401. */
  20402. customVRButton?: HTMLButtonElement;
  20403. /**
  20404. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20405. */
  20406. rayLength?: number;
  20407. /**
  20408. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20409. */
  20410. defaultHeight?: number;
  20411. /**
  20412. * If multiview should be used if availible (default: false)
  20413. */
  20414. useMultiview?: boolean;
  20415. }
  20416. /**
  20417. * This represents a WebVR camera.
  20418. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20419. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20420. */
  20421. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20422. private webVROptions;
  20423. /**
  20424. * @hidden
  20425. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20426. */
  20427. _vrDevice: any;
  20428. /**
  20429. * The rawPose of the vrDevice.
  20430. */
  20431. rawPose: Nullable<DevicePose>;
  20432. private _onVREnabled;
  20433. private _specsVersion;
  20434. private _attached;
  20435. private _frameData;
  20436. protected _descendants: Array<Node>;
  20437. private _deviceRoomPosition;
  20438. /** @hidden */
  20439. _deviceRoomRotationQuaternion: Quaternion;
  20440. private _standingMatrix;
  20441. /**
  20442. * Represents device position in babylon space.
  20443. */
  20444. devicePosition: Vector3;
  20445. /**
  20446. * Represents device rotation in babylon space.
  20447. */
  20448. deviceRotationQuaternion: Quaternion;
  20449. /**
  20450. * The scale of the device to be used when translating from device space to babylon space.
  20451. */
  20452. deviceScaleFactor: number;
  20453. private _deviceToWorld;
  20454. private _worldToDevice;
  20455. /**
  20456. * References to the webVR controllers for the vrDevice.
  20457. */
  20458. controllers: Array<WebVRController>;
  20459. /**
  20460. * Emits an event when a controller is attached.
  20461. */
  20462. onControllersAttachedObservable: Observable<WebVRController[]>;
  20463. /**
  20464. * Emits an event when a controller's mesh has been loaded;
  20465. */
  20466. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20467. /**
  20468. * Emits an event when the HMD's pose has been updated.
  20469. */
  20470. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20471. private _poseSet;
  20472. /**
  20473. * If the rig cameras be used as parent instead of this camera.
  20474. */
  20475. rigParenting: boolean;
  20476. private _lightOnControllers;
  20477. private _defaultHeight?;
  20478. /**
  20479. * Instantiates a WebVRFreeCamera.
  20480. * @param name The name of the WebVRFreeCamera
  20481. * @param position The starting anchor position for the camera
  20482. * @param scene The scene the camera belongs to
  20483. * @param webVROptions a set of customizable options for the webVRCamera
  20484. */
  20485. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20486. /**
  20487. * Gets the device distance from the ground in meters.
  20488. * @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.
  20489. */
  20490. deviceDistanceToRoomGround(): number;
  20491. /**
  20492. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20493. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20494. */
  20495. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20496. /**
  20497. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20498. * @returns A promise with a boolean set to if the standing matrix is supported.
  20499. */
  20500. useStandingMatrixAsync(): Promise<boolean>;
  20501. /**
  20502. * Disposes the camera
  20503. */
  20504. dispose(): void;
  20505. /**
  20506. * Gets a vrController by name.
  20507. * @param name The name of the controller to retreive
  20508. * @returns the controller matching the name specified or null if not found
  20509. */
  20510. getControllerByName(name: string): Nullable<WebVRController>;
  20511. private _leftController;
  20512. /**
  20513. * The controller corresponding to the users left hand.
  20514. */
  20515. get leftController(): Nullable<WebVRController>;
  20516. private _rightController;
  20517. /**
  20518. * The controller corresponding to the users right hand.
  20519. */
  20520. get rightController(): Nullable<WebVRController>;
  20521. /**
  20522. * Casts a ray forward from the vrCamera's gaze.
  20523. * @param length Length of the ray (default: 100)
  20524. * @returns the ray corresponding to the gaze
  20525. */
  20526. getForwardRay(length?: number): Ray;
  20527. /**
  20528. * @hidden
  20529. * Updates the camera based on device's frame data
  20530. */
  20531. _checkInputs(): void;
  20532. /**
  20533. * Updates the poseControlled values based on the input device pose.
  20534. * @param poseData Pose coming from the device
  20535. */
  20536. updateFromDevice(poseData: DevicePose): void;
  20537. private _htmlElementAttached;
  20538. private _detachIfAttached;
  20539. /**
  20540. * WebVR's attach control will start broadcasting frames to the device.
  20541. * Note that in certain browsers (chrome for example) this function must be called
  20542. * within a user-interaction callback. Example:
  20543. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20544. *
  20545. * @param element html element to attach the vrDevice to
  20546. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20547. */
  20548. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20549. /**
  20550. * Detaches the camera from the html element and disables VR
  20551. *
  20552. * @param element html element to detach from
  20553. */
  20554. detachControl(element: HTMLElement): void;
  20555. /**
  20556. * @returns the name of this class
  20557. */
  20558. getClassName(): string;
  20559. /**
  20560. * Calls resetPose on the vrDisplay
  20561. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20562. */
  20563. resetToCurrentRotation(): void;
  20564. /**
  20565. * @hidden
  20566. * Updates the rig cameras (left and right eye)
  20567. */
  20568. _updateRigCameras(): void;
  20569. private _workingVector;
  20570. private _oneVector;
  20571. private _workingMatrix;
  20572. private updateCacheCalled;
  20573. private _correctPositionIfNotTrackPosition;
  20574. /**
  20575. * @hidden
  20576. * Updates the cached values of the camera
  20577. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20578. */
  20579. _updateCache(ignoreParentClass?: boolean): void;
  20580. /**
  20581. * @hidden
  20582. * Get current device position in babylon world
  20583. */
  20584. _computeDevicePosition(): void;
  20585. /**
  20586. * Updates the current device position and rotation in the babylon world
  20587. */
  20588. update(): void;
  20589. /**
  20590. * @hidden
  20591. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20592. * @returns an identity matrix
  20593. */
  20594. _getViewMatrix(): Matrix;
  20595. private _tmpMatrix;
  20596. /**
  20597. * This function is called by the two RIG cameras.
  20598. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20599. * @hidden
  20600. */
  20601. _getWebVRViewMatrix(): Matrix;
  20602. /** @hidden */
  20603. _getWebVRProjectionMatrix(): Matrix;
  20604. private _onGamepadConnectedObserver;
  20605. private _onGamepadDisconnectedObserver;
  20606. private _updateCacheWhenTrackingDisabledObserver;
  20607. /**
  20608. * Initializes the controllers and their meshes
  20609. */
  20610. initControllers(): void;
  20611. }
  20612. }
  20613. declare module "babylonjs/Materials/materialHelper" {
  20614. import { Nullable } from "babylonjs/types";
  20615. import { Scene } from "babylonjs/scene";
  20616. import { Engine } from "babylonjs/Engines/engine";
  20617. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20618. import { Light } from "babylonjs/Lights/light";
  20619. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20620. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20621. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20622. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20623. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20624. /**
  20625. * "Static Class" containing the most commonly used helper while dealing with material for
  20626. * rendering purpose.
  20627. *
  20628. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20629. *
  20630. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20631. */
  20632. export class MaterialHelper {
  20633. /**
  20634. * Bind the current view position to an effect.
  20635. * @param effect The effect to be bound
  20636. * @param scene The scene the eyes position is used from
  20637. * @param variableName name of the shader variable that will hold the eye position
  20638. */
  20639. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20640. /**
  20641. * Helps preparing the defines values about the UVs in used in the effect.
  20642. * UVs are shared as much as we can accross channels in the shaders.
  20643. * @param texture The texture we are preparing the UVs for
  20644. * @param defines The defines to update
  20645. * @param key The channel key "diffuse", "specular"... used in the shader
  20646. */
  20647. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20648. /**
  20649. * Binds a texture matrix value to its corrsponding uniform
  20650. * @param texture The texture to bind the matrix for
  20651. * @param uniformBuffer The uniform buffer receivin the data
  20652. * @param key The channel key "diffuse", "specular"... used in the shader
  20653. */
  20654. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20655. /**
  20656. * Gets the current status of the fog (should it be enabled?)
  20657. * @param mesh defines the mesh to evaluate for fog support
  20658. * @param scene defines the hosting scene
  20659. * @returns true if fog must be enabled
  20660. */
  20661. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20662. /**
  20663. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20664. * @param mesh defines the current mesh
  20665. * @param scene defines the current scene
  20666. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20667. * @param pointsCloud defines if point cloud rendering has to be turned on
  20668. * @param fogEnabled defines if fog has to be turned on
  20669. * @param alphaTest defines if alpha testing has to be turned on
  20670. * @param defines defines the current list of defines
  20671. */
  20672. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20673. /**
  20674. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20675. * @param scene defines the current scene
  20676. * @param engine defines the current engine
  20677. * @param defines specifies the list of active defines
  20678. * @param useInstances defines if instances have to be turned on
  20679. * @param useClipPlane defines if clip plane have to be turned on
  20680. * @param useInstances defines if instances have to be turned on
  20681. * @param useThinInstances defines if thin instances have to be turned on
  20682. */
  20683. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20684. /**
  20685. * Prepares the defines for bones
  20686. * @param mesh The mesh containing the geometry data we will draw
  20687. * @param defines The defines to update
  20688. */
  20689. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20690. /**
  20691. * Prepares the defines for morph targets
  20692. * @param mesh The mesh containing the geometry data we will draw
  20693. * @param defines The defines to update
  20694. */
  20695. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20696. /**
  20697. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20698. * @param mesh The mesh containing the geometry data we will draw
  20699. * @param defines The defines to update
  20700. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20701. * @param useBones Precise whether bones should be used or not (override mesh info)
  20702. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20703. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20704. * @returns false if defines are considered not dirty and have not been checked
  20705. */
  20706. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20707. /**
  20708. * Prepares the defines related to multiview
  20709. * @param scene The scene we are intending to draw
  20710. * @param defines The defines to update
  20711. */
  20712. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20713. /**
  20714. * Prepares the defines related to the prepass
  20715. * @param scene The scene we are intending to draw
  20716. * @param defines The defines to update
  20717. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20718. */
  20719. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20720. /**
  20721. * Prepares the defines related to the light information passed in parameter
  20722. * @param scene The scene we are intending to draw
  20723. * @param mesh The mesh the effect is compiling for
  20724. * @param light The light the effect is compiling for
  20725. * @param lightIndex The index of the light
  20726. * @param defines The defines to update
  20727. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20728. * @param state Defines the current state regarding what is needed (normals, etc...)
  20729. */
  20730. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20731. needNormals: boolean;
  20732. needRebuild: boolean;
  20733. shadowEnabled: boolean;
  20734. specularEnabled: boolean;
  20735. lightmapMode: boolean;
  20736. }): void;
  20737. /**
  20738. * Prepares the defines related to the light information passed in parameter
  20739. * @param scene The scene we are intending to draw
  20740. * @param mesh The mesh the effect is compiling for
  20741. * @param defines The defines to update
  20742. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20743. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20744. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20745. * @returns true if normals will be required for the rest of the effect
  20746. */
  20747. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20748. /**
  20749. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20750. * @param lightIndex defines the light index
  20751. * @param uniformsList The uniform list
  20752. * @param samplersList The sampler list
  20753. * @param projectedLightTexture defines if projected texture must be used
  20754. * @param uniformBuffersList defines an optional list of uniform buffers
  20755. */
  20756. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20757. /**
  20758. * Prepares the uniforms and samplers list to be used in the effect
  20759. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20760. * @param samplersList The sampler list
  20761. * @param defines The defines helping in the list generation
  20762. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20763. */
  20764. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20765. /**
  20766. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20767. * @param defines The defines to update while falling back
  20768. * @param fallbacks The authorized effect fallbacks
  20769. * @param maxSimultaneousLights The maximum number of lights allowed
  20770. * @param rank the current rank of the Effect
  20771. * @returns The newly affected rank
  20772. */
  20773. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20774. private static _TmpMorphInfluencers;
  20775. /**
  20776. * Prepares the list of attributes required for morph targets according to the effect defines.
  20777. * @param attribs The current list of supported attribs
  20778. * @param mesh The mesh to prepare the morph targets attributes for
  20779. * @param influencers The number of influencers
  20780. */
  20781. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20782. /**
  20783. * Prepares the list of attributes required for morph targets according to the effect defines.
  20784. * @param attribs The current list of supported attribs
  20785. * @param mesh The mesh to prepare the morph targets attributes for
  20786. * @param defines The current Defines of the effect
  20787. */
  20788. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20789. /**
  20790. * Prepares the list of attributes required for bones according to the effect defines.
  20791. * @param attribs The current list of supported attribs
  20792. * @param mesh The mesh to prepare the bones attributes for
  20793. * @param defines The current Defines of the effect
  20794. * @param fallbacks The current efffect fallback strategy
  20795. */
  20796. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20797. /**
  20798. * Check and prepare the list of attributes required for instances according to the effect defines.
  20799. * @param attribs The current list of supported attribs
  20800. * @param defines The current MaterialDefines of the effect
  20801. */
  20802. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20803. /**
  20804. * Add the list of attributes required for instances to the attribs array.
  20805. * @param attribs The current list of supported attribs
  20806. */
  20807. static PushAttributesForInstances(attribs: string[]): void;
  20808. /**
  20809. * Binds the light information to the effect.
  20810. * @param light The light containing the generator
  20811. * @param effect The effect we are binding the data to
  20812. * @param lightIndex The light index in the effect used to render
  20813. */
  20814. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20815. /**
  20816. * Binds the lights information from the scene to the effect for the given mesh.
  20817. * @param light Light to bind
  20818. * @param lightIndex Light index
  20819. * @param scene The scene where the light belongs to
  20820. * @param effect The effect we are binding the data to
  20821. * @param useSpecular Defines if specular is supported
  20822. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20823. */
  20824. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  20825. /**
  20826. * Binds the lights information from the scene to the effect for the given mesh.
  20827. * @param scene The scene the lights belongs to
  20828. * @param mesh The mesh we are binding the information to render
  20829. * @param effect The effect we are binding the data to
  20830. * @param defines The generated defines for the effect
  20831. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  20832. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20833. */
  20834. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  20835. private static _tempFogColor;
  20836. /**
  20837. * Binds the fog information from the scene to the effect for the given mesh.
  20838. * @param scene The scene the lights belongs to
  20839. * @param mesh The mesh we are binding the information to render
  20840. * @param effect The effect we are binding the data to
  20841. * @param linearSpace Defines if the fog effect is applied in linear space
  20842. */
  20843. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  20844. /**
  20845. * Binds the bones information from the mesh to the effect.
  20846. * @param mesh The mesh we are binding the information to render
  20847. * @param effect The effect we are binding the data to
  20848. */
  20849. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  20850. /**
  20851. * Binds the morph targets information from the mesh to the effect.
  20852. * @param abstractMesh The mesh we are binding the information to render
  20853. * @param effect The effect we are binding the data to
  20854. */
  20855. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  20856. /**
  20857. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  20858. * @param defines The generated defines used in the effect
  20859. * @param effect The effect we are binding the data to
  20860. * @param scene The scene we are willing to render with logarithmic scale for
  20861. */
  20862. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  20863. /**
  20864. * Binds the clip plane information from the scene to the effect.
  20865. * @param scene The scene the clip plane information are extracted from
  20866. * @param effect The effect we are binding the data to
  20867. */
  20868. static BindClipPlane(effect: Effect, scene: Scene): void;
  20869. }
  20870. }
  20871. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  20872. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  20873. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  20874. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  20875. import { Nullable } from "babylonjs/types";
  20876. import { Effect } from "babylonjs/Materials/effect";
  20877. import { Matrix } from "babylonjs/Maths/math.vector";
  20878. import { Scene } from "babylonjs/scene";
  20879. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  20880. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  20881. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  20882. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  20883. import { Observable } from "babylonjs/Misc/observable";
  20884. /**
  20885. * Block used to expose an input value
  20886. */
  20887. export class InputBlock extends NodeMaterialBlock {
  20888. private _mode;
  20889. private _associatedVariableName;
  20890. private _storedValue;
  20891. private _valueCallback;
  20892. private _type;
  20893. private _animationType;
  20894. /** Gets or set a value used to limit the range of float values */
  20895. min: number;
  20896. /** Gets or set a value used to limit the range of float values */
  20897. max: number;
  20898. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  20899. isBoolean: boolean;
  20900. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  20901. matrixMode: number;
  20902. /** @hidden */
  20903. _systemValue: Nullable<NodeMaterialSystemValues>;
  20904. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  20905. visibleInInspector: boolean;
  20906. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  20907. isConstant: boolean;
  20908. /** Gets or sets the group to use to display this block in the Inspector */
  20909. groupInInspector: string;
  20910. /** Gets an observable raised when the value is changed */
  20911. onValueChangedObservable: Observable<InputBlock>;
  20912. /**
  20913. * Gets or sets the connection point type (default is float)
  20914. */
  20915. get type(): NodeMaterialBlockConnectionPointTypes;
  20916. /**
  20917. * Creates a new InputBlock
  20918. * @param name defines the block name
  20919. * @param target defines the target of that block (Vertex by default)
  20920. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  20921. */
  20922. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  20923. /**
  20924. * Validates if a name is a reserve word.
  20925. * @param newName the new name to be given to the node.
  20926. * @returns false if the name is a reserve word, else true.
  20927. */
  20928. validateBlockName(newName: string): boolean;
  20929. /**
  20930. * Gets the output component
  20931. */
  20932. get output(): NodeMaterialConnectionPoint;
  20933. /**
  20934. * Set the source of this connection point to a vertex attribute
  20935. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  20936. * @returns the current connection point
  20937. */
  20938. setAsAttribute(attributeName?: string): InputBlock;
  20939. /**
  20940. * Set the source of this connection point to a system value
  20941. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  20942. * @returns the current connection point
  20943. */
  20944. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  20945. /**
  20946. * Gets or sets the value of that point.
  20947. * Please note that this value will be ignored if valueCallback is defined
  20948. */
  20949. get value(): any;
  20950. set value(value: any);
  20951. /**
  20952. * Gets or sets a callback used to get the value of that point.
  20953. * Please note that setting this value will force the connection point to ignore the value property
  20954. */
  20955. get valueCallback(): () => any;
  20956. set valueCallback(value: () => any);
  20957. /**
  20958. * Gets or sets the associated variable name in the shader
  20959. */
  20960. get associatedVariableName(): string;
  20961. set associatedVariableName(value: string);
  20962. /** Gets or sets the type of animation applied to the input */
  20963. get animationType(): AnimatedInputBlockTypes;
  20964. set animationType(value: AnimatedInputBlockTypes);
  20965. /**
  20966. * Gets a boolean indicating that this connection point not defined yet
  20967. */
  20968. get isUndefined(): boolean;
  20969. /**
  20970. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  20971. * In this case the connection point name must be the name of the uniform to use.
  20972. * Can only be set on inputs
  20973. */
  20974. get isUniform(): boolean;
  20975. set isUniform(value: boolean);
  20976. /**
  20977. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  20978. * In this case the connection point name must be the name of the attribute to use
  20979. * Can only be set on inputs
  20980. */
  20981. get isAttribute(): boolean;
  20982. set isAttribute(value: boolean);
  20983. /**
  20984. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  20985. * Can only be set on exit points
  20986. */
  20987. get isVarying(): boolean;
  20988. set isVarying(value: boolean);
  20989. /**
  20990. * Gets a boolean indicating that the current connection point is a system value
  20991. */
  20992. get isSystemValue(): boolean;
  20993. /**
  20994. * Gets or sets the current well known value or null if not defined as a system value
  20995. */
  20996. get systemValue(): Nullable<NodeMaterialSystemValues>;
  20997. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  20998. /**
  20999. * Gets the current class name
  21000. * @returns the class name
  21001. */
  21002. getClassName(): string;
  21003. /**
  21004. * Animate the input if animationType !== None
  21005. * @param scene defines the rendering scene
  21006. */
  21007. animate(scene: Scene): void;
  21008. private _emitDefine;
  21009. initialize(state: NodeMaterialBuildState): void;
  21010. /**
  21011. * Set the input block to its default value (based on its type)
  21012. */
  21013. setDefaultValue(): void;
  21014. private _emitConstant;
  21015. /** @hidden */
  21016. get _noContextSwitch(): boolean;
  21017. private _emit;
  21018. /** @hidden */
  21019. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21020. /** @hidden */
  21021. _transmit(effect: Effect, scene: Scene): void;
  21022. protected _buildBlock(state: NodeMaterialBuildState): void;
  21023. protected _dumpPropertiesCode(): string;
  21024. dispose(): void;
  21025. serialize(): any;
  21026. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21027. }
  21028. }
  21029. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21030. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21031. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21032. import { Nullable } from "babylonjs/types";
  21033. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21034. import { Observable } from "babylonjs/Misc/observable";
  21035. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21036. /**
  21037. * Enum used to define the compatibility state between two connection points
  21038. */
  21039. export enum NodeMaterialConnectionPointCompatibilityStates {
  21040. /** Points are compatibles */
  21041. Compatible = 0,
  21042. /** Points are incompatible because of their types */
  21043. TypeIncompatible = 1,
  21044. /** Points are incompatible because of their targets (vertex vs fragment) */
  21045. TargetIncompatible = 2
  21046. }
  21047. /**
  21048. * Defines the direction of a connection point
  21049. */
  21050. export enum NodeMaterialConnectionPointDirection {
  21051. /** Input */
  21052. Input = 0,
  21053. /** Output */
  21054. Output = 1
  21055. }
  21056. /**
  21057. * Defines a connection point for a block
  21058. */
  21059. export class NodeMaterialConnectionPoint {
  21060. /** @hidden */
  21061. _ownerBlock: NodeMaterialBlock;
  21062. /** @hidden */
  21063. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21064. private _endpoints;
  21065. private _associatedVariableName;
  21066. private _direction;
  21067. /** @hidden */
  21068. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21069. /** @hidden */
  21070. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21071. private _type;
  21072. /** @hidden */
  21073. _enforceAssociatedVariableName: boolean;
  21074. /** Gets the direction of the point */
  21075. get direction(): NodeMaterialConnectionPointDirection;
  21076. /** Indicates that this connection point needs dual validation before being connected to another point */
  21077. needDualDirectionValidation: boolean;
  21078. /**
  21079. * Gets or sets the additional types supported by this connection point
  21080. */
  21081. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21082. /**
  21083. * Gets or sets the additional types excluded by this connection point
  21084. */
  21085. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21086. /**
  21087. * Observable triggered when this point is connected
  21088. */
  21089. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21090. /**
  21091. * Gets or sets the associated variable name in the shader
  21092. */
  21093. get associatedVariableName(): string;
  21094. set associatedVariableName(value: string);
  21095. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21096. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21097. /**
  21098. * Gets or sets the connection point type (default is float)
  21099. */
  21100. get type(): NodeMaterialBlockConnectionPointTypes;
  21101. set type(value: NodeMaterialBlockConnectionPointTypes);
  21102. /**
  21103. * Gets or sets the connection point name
  21104. */
  21105. name: string;
  21106. /**
  21107. * Gets or sets the connection point name
  21108. */
  21109. displayName: string;
  21110. /**
  21111. * Gets or sets a boolean indicating that this connection point can be omitted
  21112. */
  21113. isOptional: boolean;
  21114. /**
  21115. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21116. */
  21117. isExposedOnFrame: boolean;
  21118. /**
  21119. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21120. */
  21121. define: string;
  21122. /** @hidden */
  21123. _prioritizeVertex: boolean;
  21124. private _target;
  21125. /** Gets or sets the target of that connection point */
  21126. get target(): NodeMaterialBlockTargets;
  21127. set target(value: NodeMaterialBlockTargets);
  21128. /**
  21129. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21130. */
  21131. get isConnected(): boolean;
  21132. /**
  21133. * Gets a boolean indicating that the current point is connected to an input block
  21134. */
  21135. get isConnectedToInputBlock(): boolean;
  21136. /**
  21137. * Gets a the connected input block (if any)
  21138. */
  21139. get connectInputBlock(): Nullable<InputBlock>;
  21140. /** Get the other side of the connection (if any) */
  21141. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21142. /** Get the block that owns this connection point */
  21143. get ownerBlock(): NodeMaterialBlock;
  21144. /** Get the block connected on the other side of this connection (if any) */
  21145. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21146. /** Get the block connected on the endpoints of this connection (if any) */
  21147. get connectedBlocks(): Array<NodeMaterialBlock>;
  21148. /** Gets the list of connected endpoints */
  21149. get endpoints(): NodeMaterialConnectionPoint[];
  21150. /** Gets a boolean indicating if that output point is connected to at least one input */
  21151. get hasEndpoints(): boolean;
  21152. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21153. get isConnectedInVertexShader(): boolean;
  21154. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21155. get isConnectedInFragmentShader(): boolean;
  21156. /**
  21157. * Creates a block suitable to be used as an input for this input point.
  21158. * If null is returned, a block based on the point type will be created.
  21159. * @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
  21160. */
  21161. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21162. /**
  21163. * Creates a new connection point
  21164. * @param name defines the connection point name
  21165. * @param ownerBlock defines the block hosting this connection point
  21166. * @param direction defines the direction of the connection point
  21167. */
  21168. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21169. /**
  21170. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21171. * @returns the class name
  21172. */
  21173. getClassName(): string;
  21174. /**
  21175. * Gets a boolean indicating if the current point can be connected to another point
  21176. * @param connectionPoint defines the other connection point
  21177. * @returns a boolean
  21178. */
  21179. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21180. /**
  21181. * Gets a number indicating if the current point can be connected to another point
  21182. * @param connectionPoint defines the other connection point
  21183. * @returns a number defining the compatibility state
  21184. */
  21185. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21186. /**
  21187. * Connect this point to another connection point
  21188. * @param connectionPoint defines the other connection point
  21189. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21190. * @returns the current connection point
  21191. */
  21192. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21193. /**
  21194. * Disconnect this point from one of his endpoint
  21195. * @param endpoint defines the other connection point
  21196. * @returns the current connection point
  21197. */
  21198. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21199. /**
  21200. * Serializes this point in a JSON representation
  21201. * @param isInput defines if the connection point is an input (default is true)
  21202. * @returns the serialized point object
  21203. */
  21204. serialize(isInput?: boolean): any;
  21205. /**
  21206. * Release resources
  21207. */
  21208. dispose(): void;
  21209. }
  21210. }
  21211. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21212. /**
  21213. * Enum used to define the material modes
  21214. */
  21215. export enum NodeMaterialModes {
  21216. /** Regular material */
  21217. Material = 0,
  21218. /** For post process */
  21219. PostProcess = 1,
  21220. /** For particle system */
  21221. Particle = 2
  21222. }
  21223. }
  21224. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21225. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21226. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21227. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21228. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21229. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21230. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21231. import { Effect } from "babylonjs/Materials/effect";
  21232. import { Mesh } from "babylonjs/Meshes/mesh";
  21233. import { Nullable } from "babylonjs/types";
  21234. import { Texture } from "babylonjs/Materials/Textures/texture";
  21235. import { Scene } from "babylonjs/scene";
  21236. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21237. /**
  21238. * Block used to read a texture from a sampler
  21239. */
  21240. export class TextureBlock extends NodeMaterialBlock {
  21241. private _defineName;
  21242. private _linearDefineName;
  21243. private _gammaDefineName;
  21244. private _tempTextureRead;
  21245. private _samplerName;
  21246. private _transformedUVName;
  21247. private _textureTransformName;
  21248. private _textureInfoName;
  21249. private _mainUVName;
  21250. private _mainUVDefineName;
  21251. private _fragmentOnly;
  21252. /**
  21253. * Gets or sets the texture associated with the node
  21254. */
  21255. texture: Nullable<Texture>;
  21256. /**
  21257. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21258. */
  21259. convertToGammaSpace: boolean;
  21260. /**
  21261. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21262. */
  21263. convertToLinearSpace: boolean;
  21264. /**
  21265. * Create a new TextureBlock
  21266. * @param name defines the block name
  21267. */
  21268. constructor(name: string, fragmentOnly?: boolean);
  21269. /**
  21270. * Gets the current class name
  21271. * @returns the class name
  21272. */
  21273. getClassName(): string;
  21274. /**
  21275. * Gets the uv input component
  21276. */
  21277. get uv(): NodeMaterialConnectionPoint;
  21278. /**
  21279. * Gets the rgba output component
  21280. */
  21281. get rgba(): NodeMaterialConnectionPoint;
  21282. /**
  21283. * Gets the rgb output component
  21284. */
  21285. get rgb(): NodeMaterialConnectionPoint;
  21286. /**
  21287. * Gets the r output component
  21288. */
  21289. get r(): NodeMaterialConnectionPoint;
  21290. /**
  21291. * Gets the g output component
  21292. */
  21293. get g(): NodeMaterialConnectionPoint;
  21294. /**
  21295. * Gets the b output component
  21296. */
  21297. get b(): NodeMaterialConnectionPoint;
  21298. /**
  21299. * Gets the a output component
  21300. */
  21301. get a(): NodeMaterialConnectionPoint;
  21302. get target(): NodeMaterialBlockTargets;
  21303. autoConfigure(material: NodeMaterial): void;
  21304. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21305. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21306. isReady(): boolean;
  21307. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21308. private get _isMixed();
  21309. private _injectVertexCode;
  21310. private _writeTextureRead;
  21311. private _writeOutput;
  21312. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21313. protected _dumpPropertiesCode(): string;
  21314. serialize(): any;
  21315. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21316. }
  21317. }
  21318. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21319. /** @hidden */
  21320. export var reflectionFunction: {
  21321. name: string;
  21322. shader: string;
  21323. };
  21324. }
  21325. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21329. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21331. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21332. import { Effect } from "babylonjs/Materials/effect";
  21333. import { Mesh } from "babylonjs/Meshes/mesh";
  21334. import { Nullable } from "babylonjs/types";
  21335. import { Scene } from "babylonjs/scene";
  21336. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21337. /**
  21338. * Base block used to read a reflection texture from a sampler
  21339. */
  21340. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21341. /** @hidden */
  21342. _define3DName: string;
  21343. /** @hidden */
  21344. _defineCubicName: string;
  21345. /** @hidden */
  21346. _defineExplicitName: string;
  21347. /** @hidden */
  21348. _defineProjectionName: string;
  21349. /** @hidden */
  21350. _defineLocalCubicName: string;
  21351. /** @hidden */
  21352. _defineSphericalName: string;
  21353. /** @hidden */
  21354. _definePlanarName: string;
  21355. /** @hidden */
  21356. _defineEquirectangularName: string;
  21357. /** @hidden */
  21358. _defineMirroredEquirectangularFixedName: string;
  21359. /** @hidden */
  21360. _defineEquirectangularFixedName: string;
  21361. /** @hidden */
  21362. _defineSkyboxName: string;
  21363. /** @hidden */
  21364. _defineOppositeZ: string;
  21365. /** @hidden */
  21366. _cubeSamplerName: string;
  21367. /** @hidden */
  21368. _2DSamplerName: string;
  21369. protected _positionUVWName: string;
  21370. protected _directionWName: string;
  21371. protected _reflectionVectorName: string;
  21372. /** @hidden */
  21373. _reflectionCoordsName: string;
  21374. /** @hidden */
  21375. _reflectionMatrixName: string;
  21376. protected _reflectionColorName: string;
  21377. /**
  21378. * Gets or sets the texture associated with the node
  21379. */
  21380. texture: Nullable<BaseTexture>;
  21381. /**
  21382. * Create a new ReflectionTextureBaseBlock
  21383. * @param name defines the block name
  21384. */
  21385. constructor(name: string);
  21386. /**
  21387. * Gets the current class name
  21388. * @returns the class name
  21389. */
  21390. getClassName(): string;
  21391. /**
  21392. * Gets the world position input component
  21393. */
  21394. abstract get position(): NodeMaterialConnectionPoint;
  21395. /**
  21396. * Gets the world position input component
  21397. */
  21398. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21399. /**
  21400. * Gets the world normal input component
  21401. */
  21402. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21403. /**
  21404. * Gets the world input component
  21405. */
  21406. abstract get world(): NodeMaterialConnectionPoint;
  21407. /**
  21408. * Gets the camera (or eye) position component
  21409. */
  21410. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21411. /**
  21412. * Gets the view input component
  21413. */
  21414. abstract get view(): NodeMaterialConnectionPoint;
  21415. protected _getTexture(): Nullable<BaseTexture>;
  21416. autoConfigure(material: NodeMaterial): void;
  21417. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21418. isReady(): boolean;
  21419. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21420. /**
  21421. * Gets the code to inject in the vertex shader
  21422. * @param state current state of the node material building
  21423. * @returns the shader code
  21424. */
  21425. handleVertexSide(state: NodeMaterialBuildState): string;
  21426. /**
  21427. * Handles the inits for the fragment code path
  21428. * @param state node material build state
  21429. */
  21430. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21431. /**
  21432. * Generates the reflection coords code for the fragment code path
  21433. * @param worldNormalVarName name of the world normal variable
  21434. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21435. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21436. * @returns the shader code
  21437. */
  21438. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21439. /**
  21440. * Generates the reflection color code for the fragment code path
  21441. * @param lodVarName name of the lod variable
  21442. * @param swizzleLookupTexture swizzle to use for the final color variable
  21443. * @returns the shader code
  21444. */
  21445. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21446. /**
  21447. * Generates the code corresponding to the connected output points
  21448. * @param state node material build state
  21449. * @param varName name of the variable to output
  21450. * @returns the shader code
  21451. */
  21452. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21453. protected _buildBlock(state: NodeMaterialBuildState): this;
  21454. protected _dumpPropertiesCode(): string;
  21455. serialize(): any;
  21456. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21457. }
  21458. }
  21459. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21460. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21461. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21462. import { Nullable } from "babylonjs/types";
  21463. /**
  21464. * Defines a connection point to be used for points with a custom object type
  21465. */
  21466. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21467. private _blockType;
  21468. private _blockName;
  21469. private _nameForCheking?;
  21470. /**
  21471. * Creates a new connection point
  21472. * @param name defines the connection point name
  21473. * @param ownerBlock defines the block hosting this connection point
  21474. * @param direction defines the direction of the connection point
  21475. */
  21476. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21477. /**
  21478. * Gets a number indicating if the current point can be connected to another point
  21479. * @param connectionPoint defines the other connection point
  21480. * @returns a number defining the compatibility state
  21481. */
  21482. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21483. /**
  21484. * Creates a block suitable to be used as an input for this input point.
  21485. * If null is returned, a block based on the point type will be created.
  21486. * @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
  21487. */
  21488. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21489. }
  21490. }
  21491. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21492. /**
  21493. * Enum defining the type of properties that can be edited in the property pages in the NME
  21494. */
  21495. export enum PropertyTypeForEdition {
  21496. /** property is a boolean */
  21497. Boolean = 0,
  21498. /** property is a float */
  21499. Float = 1,
  21500. /** property is a Vector2 */
  21501. Vector2 = 2,
  21502. /** property is a list of values */
  21503. List = 3
  21504. }
  21505. /**
  21506. * Interface that defines an option in a variable of type list
  21507. */
  21508. export interface IEditablePropertyListOption {
  21509. /** label of the option */
  21510. "label": string;
  21511. /** value of the option */
  21512. "value": number;
  21513. }
  21514. /**
  21515. * Interface that defines the options available for an editable property
  21516. */
  21517. export interface IEditablePropertyOption {
  21518. /** min value */
  21519. "min"?: number;
  21520. /** max value */
  21521. "max"?: number;
  21522. /** notifiers: indicates which actions to take when the property is changed */
  21523. "notifiers"?: {
  21524. /** the material should be rebuilt */
  21525. "rebuild"?: boolean;
  21526. /** the preview should be updated */
  21527. "update"?: boolean;
  21528. };
  21529. /** list of the options for a variable of type list */
  21530. "options"?: IEditablePropertyListOption[];
  21531. }
  21532. /**
  21533. * Interface that describes an editable property
  21534. */
  21535. export interface IPropertyDescriptionForEdition {
  21536. /** name of the property */
  21537. "propertyName": string;
  21538. /** display name of the property */
  21539. "displayName": string;
  21540. /** type of the property */
  21541. "type": PropertyTypeForEdition;
  21542. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21543. "groupName": string;
  21544. /** options for the property */
  21545. "options": IEditablePropertyOption;
  21546. }
  21547. /**
  21548. * Decorator that flags a property in a node material block as being editable
  21549. */
  21550. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21551. }
  21552. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21553. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21554. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21555. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21556. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21557. import { Nullable } from "babylonjs/types";
  21558. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21559. import { Mesh } from "babylonjs/Meshes/mesh";
  21560. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21561. import { Effect } from "babylonjs/Materials/effect";
  21562. import { Scene } from "babylonjs/scene";
  21563. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21564. /**
  21565. * Block used to implement the refraction part of the sub surface module of the PBR material
  21566. */
  21567. export class RefractionBlock extends NodeMaterialBlock {
  21568. /** @hidden */
  21569. _define3DName: string;
  21570. /** @hidden */
  21571. _refractionMatrixName: string;
  21572. /** @hidden */
  21573. _defineLODRefractionAlpha: string;
  21574. /** @hidden */
  21575. _defineLinearSpecularRefraction: string;
  21576. /** @hidden */
  21577. _defineOppositeZ: string;
  21578. /** @hidden */
  21579. _cubeSamplerName: string;
  21580. /** @hidden */
  21581. _2DSamplerName: string;
  21582. /** @hidden */
  21583. _vRefractionMicrosurfaceInfosName: string;
  21584. /** @hidden */
  21585. _vRefractionInfosName: string;
  21586. private _scene;
  21587. /**
  21588. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21589. * Materials half opaque for instance using refraction could benefit from this control.
  21590. */
  21591. linkRefractionWithTransparency: boolean;
  21592. /**
  21593. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21594. */
  21595. invertRefractionY: boolean;
  21596. /**
  21597. * Gets or sets the texture associated with the node
  21598. */
  21599. texture: Nullable<BaseTexture>;
  21600. /**
  21601. * Create a new RefractionBlock
  21602. * @param name defines the block name
  21603. */
  21604. constructor(name: string);
  21605. /**
  21606. * Gets the current class name
  21607. * @returns the class name
  21608. */
  21609. getClassName(): string;
  21610. /**
  21611. * Gets the intensity input component
  21612. */
  21613. get intensity(): NodeMaterialConnectionPoint;
  21614. /**
  21615. * Gets the index of refraction input component
  21616. */
  21617. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21618. /**
  21619. * Gets the tint at distance input component
  21620. */
  21621. get tintAtDistance(): NodeMaterialConnectionPoint;
  21622. /**
  21623. * Gets the view input component
  21624. */
  21625. get view(): NodeMaterialConnectionPoint;
  21626. /**
  21627. * Gets the refraction object output component
  21628. */
  21629. get refraction(): NodeMaterialConnectionPoint;
  21630. /**
  21631. * Returns true if the block has a texture
  21632. */
  21633. get hasTexture(): boolean;
  21634. protected _getTexture(): Nullable<BaseTexture>;
  21635. autoConfigure(material: NodeMaterial): void;
  21636. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21637. isReady(): boolean;
  21638. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21639. /**
  21640. * Gets the main code of the block (fragment side)
  21641. * @param state current state of the node material building
  21642. * @returns the shader code
  21643. */
  21644. getCode(state: NodeMaterialBuildState): string;
  21645. protected _buildBlock(state: NodeMaterialBuildState): this;
  21646. protected _dumpPropertiesCode(): string;
  21647. serialize(): any;
  21648. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21649. }
  21650. }
  21651. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21652. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21653. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21654. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21655. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21656. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21657. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21658. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21659. import { Nullable } from "babylonjs/types";
  21660. import { Scene } from "babylonjs/scene";
  21661. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21662. /**
  21663. * Base block used as input for post process
  21664. */
  21665. export class CurrentScreenBlock extends NodeMaterialBlock {
  21666. private _samplerName;
  21667. private _linearDefineName;
  21668. private _gammaDefineName;
  21669. private _mainUVName;
  21670. private _tempTextureRead;
  21671. /**
  21672. * Gets or sets the texture associated with the node
  21673. */
  21674. texture: Nullable<BaseTexture>;
  21675. /**
  21676. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21677. */
  21678. convertToGammaSpace: boolean;
  21679. /**
  21680. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21681. */
  21682. convertToLinearSpace: boolean;
  21683. /**
  21684. * Create a new CurrentScreenBlock
  21685. * @param name defines the block name
  21686. */
  21687. constructor(name: string);
  21688. /**
  21689. * Gets the current class name
  21690. * @returns the class name
  21691. */
  21692. getClassName(): string;
  21693. /**
  21694. * Gets the uv input component
  21695. */
  21696. get uv(): NodeMaterialConnectionPoint;
  21697. /**
  21698. * Gets the rgba output component
  21699. */
  21700. get rgba(): NodeMaterialConnectionPoint;
  21701. /**
  21702. * Gets the rgb output component
  21703. */
  21704. get rgb(): NodeMaterialConnectionPoint;
  21705. /**
  21706. * Gets the r output component
  21707. */
  21708. get r(): NodeMaterialConnectionPoint;
  21709. /**
  21710. * Gets the g output component
  21711. */
  21712. get g(): NodeMaterialConnectionPoint;
  21713. /**
  21714. * Gets the b output component
  21715. */
  21716. get b(): NodeMaterialConnectionPoint;
  21717. /**
  21718. * Gets the a output component
  21719. */
  21720. get a(): NodeMaterialConnectionPoint;
  21721. /**
  21722. * Initialize the block and prepare the context for build
  21723. * @param state defines the state that will be used for the build
  21724. */
  21725. initialize(state: NodeMaterialBuildState): void;
  21726. get target(): NodeMaterialBlockTargets;
  21727. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21728. isReady(): boolean;
  21729. private _injectVertexCode;
  21730. private _writeTextureRead;
  21731. private _writeOutput;
  21732. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21733. serialize(): any;
  21734. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21735. }
  21736. }
  21737. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21738. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21739. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21740. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21742. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21743. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21744. import { Nullable } from "babylonjs/types";
  21745. import { Scene } from "babylonjs/scene";
  21746. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21747. /**
  21748. * Base block used for the particle texture
  21749. */
  21750. export class ParticleTextureBlock extends NodeMaterialBlock {
  21751. private _samplerName;
  21752. private _linearDefineName;
  21753. private _gammaDefineName;
  21754. private _tempTextureRead;
  21755. /**
  21756. * Gets or sets the texture associated with the node
  21757. */
  21758. texture: Nullable<BaseTexture>;
  21759. /**
  21760. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21761. */
  21762. convertToGammaSpace: boolean;
  21763. /**
  21764. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21765. */
  21766. convertToLinearSpace: boolean;
  21767. /**
  21768. * Create a new ParticleTextureBlock
  21769. * @param name defines the block name
  21770. */
  21771. constructor(name: string);
  21772. /**
  21773. * Gets the current class name
  21774. * @returns the class name
  21775. */
  21776. getClassName(): string;
  21777. /**
  21778. * Gets the uv input component
  21779. */
  21780. get uv(): NodeMaterialConnectionPoint;
  21781. /**
  21782. * Gets the rgba output component
  21783. */
  21784. get rgba(): NodeMaterialConnectionPoint;
  21785. /**
  21786. * Gets the rgb output component
  21787. */
  21788. get rgb(): NodeMaterialConnectionPoint;
  21789. /**
  21790. * Gets the r output component
  21791. */
  21792. get r(): NodeMaterialConnectionPoint;
  21793. /**
  21794. * Gets the g output component
  21795. */
  21796. get g(): NodeMaterialConnectionPoint;
  21797. /**
  21798. * Gets the b output component
  21799. */
  21800. get b(): NodeMaterialConnectionPoint;
  21801. /**
  21802. * Gets the a output component
  21803. */
  21804. get a(): NodeMaterialConnectionPoint;
  21805. /**
  21806. * Initialize the block and prepare the context for build
  21807. * @param state defines the state that will be used for the build
  21808. */
  21809. initialize(state: NodeMaterialBuildState): void;
  21810. autoConfigure(material: NodeMaterial): void;
  21811. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21812. isReady(): boolean;
  21813. private _writeOutput;
  21814. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21815. serialize(): any;
  21816. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21817. }
  21818. }
  21819. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21820. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21821. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21822. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21823. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  21824. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  21825. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  21826. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  21827. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  21828. import { Scene } from "babylonjs/scene";
  21829. /**
  21830. * Class used to store shared data between 2 NodeMaterialBuildState
  21831. */
  21832. export class NodeMaterialBuildStateSharedData {
  21833. /**
  21834. * Gets the list of emitted varyings
  21835. */
  21836. temps: string[];
  21837. /**
  21838. * Gets the list of emitted varyings
  21839. */
  21840. varyings: string[];
  21841. /**
  21842. * Gets the varying declaration string
  21843. */
  21844. varyingDeclaration: string;
  21845. /**
  21846. * Input blocks
  21847. */
  21848. inputBlocks: InputBlock[];
  21849. /**
  21850. * Input blocks
  21851. */
  21852. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  21853. /**
  21854. * Bindable blocks (Blocks that need to set data to the effect)
  21855. */
  21856. bindableBlocks: NodeMaterialBlock[];
  21857. /**
  21858. * List of blocks that can provide a compilation fallback
  21859. */
  21860. blocksWithFallbacks: NodeMaterialBlock[];
  21861. /**
  21862. * List of blocks that can provide a define update
  21863. */
  21864. blocksWithDefines: NodeMaterialBlock[];
  21865. /**
  21866. * List of blocks that can provide a repeatable content
  21867. */
  21868. repeatableContentBlocks: NodeMaterialBlock[];
  21869. /**
  21870. * List of blocks that can provide a dynamic list of uniforms
  21871. */
  21872. dynamicUniformBlocks: NodeMaterialBlock[];
  21873. /**
  21874. * List of blocks that can block the isReady function for the material
  21875. */
  21876. blockingBlocks: NodeMaterialBlock[];
  21877. /**
  21878. * Gets the list of animated inputs
  21879. */
  21880. animatedInputs: InputBlock[];
  21881. /**
  21882. * Build Id used to avoid multiple recompilations
  21883. */
  21884. buildId: number;
  21885. /** List of emitted variables */
  21886. variableNames: {
  21887. [key: string]: number;
  21888. };
  21889. /** List of emitted defines */
  21890. defineNames: {
  21891. [key: string]: number;
  21892. };
  21893. /** Should emit comments? */
  21894. emitComments: boolean;
  21895. /** Emit build activity */
  21896. verbose: boolean;
  21897. /** Gets or sets the hosting scene */
  21898. scene: Scene;
  21899. /**
  21900. * Gets the compilation hints emitted at compilation time
  21901. */
  21902. hints: {
  21903. needWorldViewMatrix: boolean;
  21904. needWorldViewProjectionMatrix: boolean;
  21905. needAlphaBlending: boolean;
  21906. needAlphaTesting: boolean;
  21907. };
  21908. /**
  21909. * List of compilation checks
  21910. */
  21911. checks: {
  21912. emitVertex: boolean;
  21913. emitFragment: boolean;
  21914. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  21915. };
  21916. /**
  21917. * Is vertex program allowed to be empty?
  21918. */
  21919. allowEmptyVertexProgram: boolean;
  21920. /** Creates a new shared data */
  21921. constructor();
  21922. /**
  21923. * Emits console errors and exceptions if there is a failing check
  21924. */
  21925. emitErrors(): void;
  21926. }
  21927. }
  21928. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  21929. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21930. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21931. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  21932. /**
  21933. * Class used to store node based material build state
  21934. */
  21935. export class NodeMaterialBuildState {
  21936. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  21937. supportUniformBuffers: boolean;
  21938. /**
  21939. * Gets the list of emitted attributes
  21940. */
  21941. attributes: string[];
  21942. /**
  21943. * Gets the list of emitted uniforms
  21944. */
  21945. uniforms: string[];
  21946. /**
  21947. * Gets the list of emitted constants
  21948. */
  21949. constants: string[];
  21950. /**
  21951. * Gets the list of emitted samplers
  21952. */
  21953. samplers: string[];
  21954. /**
  21955. * Gets the list of emitted functions
  21956. */
  21957. functions: {
  21958. [key: string]: string;
  21959. };
  21960. /**
  21961. * Gets the list of emitted extensions
  21962. */
  21963. extensions: {
  21964. [key: string]: string;
  21965. };
  21966. /**
  21967. * Gets the target of the compilation state
  21968. */
  21969. target: NodeMaterialBlockTargets;
  21970. /**
  21971. * Gets the list of emitted counters
  21972. */
  21973. counters: {
  21974. [key: string]: number;
  21975. };
  21976. /**
  21977. * Shared data between multiple NodeMaterialBuildState instances
  21978. */
  21979. sharedData: NodeMaterialBuildStateSharedData;
  21980. /** @hidden */
  21981. _vertexState: NodeMaterialBuildState;
  21982. /** @hidden */
  21983. _attributeDeclaration: string;
  21984. /** @hidden */
  21985. _uniformDeclaration: string;
  21986. /** @hidden */
  21987. _constantDeclaration: string;
  21988. /** @hidden */
  21989. _samplerDeclaration: string;
  21990. /** @hidden */
  21991. _varyingTransfer: string;
  21992. /** @hidden */
  21993. _injectAtEnd: string;
  21994. private _repeatableContentAnchorIndex;
  21995. /** @hidden */
  21996. _builtCompilationString: string;
  21997. /**
  21998. * Gets the emitted compilation strings
  21999. */
  22000. compilationString: string;
  22001. /**
  22002. * Finalize the compilation strings
  22003. * @param state defines the current compilation state
  22004. */
  22005. finalize(state: NodeMaterialBuildState): void;
  22006. /** @hidden */
  22007. get _repeatableContentAnchor(): string;
  22008. /** @hidden */
  22009. _getFreeVariableName(prefix: string): string;
  22010. /** @hidden */
  22011. _getFreeDefineName(prefix: string): string;
  22012. /** @hidden */
  22013. _excludeVariableName(name: string): void;
  22014. /** @hidden */
  22015. _emit2DSampler(name: string): void;
  22016. /** @hidden */
  22017. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22018. /** @hidden */
  22019. _emitExtension(name: string, extension: string, define?: string): void;
  22020. /** @hidden */
  22021. _emitFunction(name: string, code: string, comments: string): void;
  22022. /** @hidden */
  22023. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22024. replaceStrings?: {
  22025. search: RegExp;
  22026. replace: string;
  22027. }[];
  22028. repeatKey?: string;
  22029. }): string;
  22030. /** @hidden */
  22031. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22032. repeatKey?: string;
  22033. removeAttributes?: boolean;
  22034. removeUniforms?: boolean;
  22035. removeVaryings?: boolean;
  22036. removeIfDef?: boolean;
  22037. replaceStrings?: {
  22038. search: RegExp;
  22039. replace: string;
  22040. }[];
  22041. }, storeKey?: string): void;
  22042. /** @hidden */
  22043. _registerTempVariable(name: string): boolean;
  22044. /** @hidden */
  22045. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22046. /** @hidden */
  22047. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22048. /** @hidden */
  22049. _emitFloat(value: number): string;
  22050. }
  22051. }
  22052. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22053. /**
  22054. * Helper class used to generate session unique ID
  22055. */
  22056. export class UniqueIdGenerator {
  22057. private static _UniqueIdCounter;
  22058. /**
  22059. * Gets an unique (relatively to the current scene) Id
  22060. */
  22061. static get UniqueId(): number;
  22062. }
  22063. }
  22064. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22065. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22066. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22067. import { Nullable } from "babylonjs/types";
  22068. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22069. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22070. import { Effect } from "babylonjs/Materials/effect";
  22071. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22072. import { Mesh } from "babylonjs/Meshes/mesh";
  22073. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22074. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22075. import { Scene } from "babylonjs/scene";
  22076. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22077. /**
  22078. * Defines a block that can be used inside a node based material
  22079. */
  22080. export class NodeMaterialBlock {
  22081. private _buildId;
  22082. private _buildTarget;
  22083. private _target;
  22084. private _isFinalMerger;
  22085. private _isInput;
  22086. private _name;
  22087. protected _isUnique: boolean;
  22088. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22089. inputsAreExclusive: boolean;
  22090. /** @hidden */
  22091. _codeVariableName: string;
  22092. /** @hidden */
  22093. _inputs: NodeMaterialConnectionPoint[];
  22094. /** @hidden */
  22095. _outputs: NodeMaterialConnectionPoint[];
  22096. /** @hidden */
  22097. _preparationId: number;
  22098. /**
  22099. * Gets the name of the block
  22100. */
  22101. get name(): string;
  22102. /**
  22103. * Sets the name of the block. Will check if the name is valid.
  22104. */
  22105. set name(newName: string);
  22106. /**
  22107. * Gets or sets the unique id of the node
  22108. */
  22109. uniqueId: number;
  22110. /**
  22111. * Gets or sets the comments associated with this block
  22112. */
  22113. comments: string;
  22114. /**
  22115. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22116. */
  22117. get isUnique(): boolean;
  22118. /**
  22119. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22120. */
  22121. get isFinalMerger(): boolean;
  22122. /**
  22123. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22124. */
  22125. get isInput(): boolean;
  22126. /**
  22127. * Gets or sets the build Id
  22128. */
  22129. get buildId(): number;
  22130. set buildId(value: number);
  22131. /**
  22132. * Gets or sets the target of the block
  22133. */
  22134. get target(): NodeMaterialBlockTargets;
  22135. set target(value: NodeMaterialBlockTargets);
  22136. /**
  22137. * Gets the list of input points
  22138. */
  22139. get inputs(): NodeMaterialConnectionPoint[];
  22140. /** Gets the list of output points */
  22141. get outputs(): NodeMaterialConnectionPoint[];
  22142. /**
  22143. * Find an input by its name
  22144. * @param name defines the name of the input to look for
  22145. * @returns the input or null if not found
  22146. */
  22147. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22148. /**
  22149. * Find an output by its name
  22150. * @param name defines the name of the outputto look for
  22151. * @returns the output or null if not found
  22152. */
  22153. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22154. /**
  22155. * Creates a new NodeMaterialBlock
  22156. * @param name defines the block name
  22157. * @param target defines the target of that block (Vertex by default)
  22158. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22159. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22160. */
  22161. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22162. /**
  22163. * Initialize the block and prepare the context for build
  22164. * @param state defines the state that will be used for the build
  22165. */
  22166. initialize(state: NodeMaterialBuildState): void;
  22167. /**
  22168. * Bind data to effect. Will only be called for blocks with isBindable === true
  22169. * @param effect defines the effect to bind data to
  22170. * @param nodeMaterial defines the hosting NodeMaterial
  22171. * @param mesh defines the mesh that will be rendered
  22172. * @param subMesh defines the submesh that will be rendered
  22173. */
  22174. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22175. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22176. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22177. protected _writeFloat(value: number): string;
  22178. /**
  22179. * Gets the current class name e.g. "NodeMaterialBlock"
  22180. * @returns the class name
  22181. */
  22182. getClassName(): string;
  22183. /**
  22184. * Register a new input. Must be called inside a block constructor
  22185. * @param name defines the connection point name
  22186. * @param type defines the connection point type
  22187. * @param isOptional defines a boolean indicating that this input can be omitted
  22188. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22189. * @param point an already created connection point. If not provided, create a new one
  22190. * @returns the current block
  22191. */
  22192. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22193. /**
  22194. * Register a new output. Must be called inside a block constructor
  22195. * @param name defines the connection point name
  22196. * @param type defines the connection point type
  22197. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22198. * @param point an already created connection point. If not provided, create a new one
  22199. * @returns the current block
  22200. */
  22201. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22202. /**
  22203. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22204. * @param forOutput defines an optional connection point to check compatibility with
  22205. * @returns the first available input or null
  22206. */
  22207. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22208. /**
  22209. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22210. * @param forBlock defines an optional block to check compatibility with
  22211. * @returns the first available input or null
  22212. */
  22213. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22214. /**
  22215. * Gets the sibling of the given output
  22216. * @param current defines the current output
  22217. * @returns the next output in the list or null
  22218. */
  22219. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22220. /**
  22221. * Connect current block with another block
  22222. * @param other defines the block to connect with
  22223. * @param options define the various options to help pick the right connections
  22224. * @returns the current block
  22225. */
  22226. connectTo(other: NodeMaterialBlock, options?: {
  22227. input?: string;
  22228. output?: string;
  22229. outputSwizzle?: string;
  22230. }): this | undefined;
  22231. protected _buildBlock(state: NodeMaterialBuildState): void;
  22232. /**
  22233. * Add uniforms, samplers and uniform buffers at compilation time
  22234. * @param state defines the state to update
  22235. * @param nodeMaterial defines the node material requesting the update
  22236. * @param defines defines the material defines to update
  22237. * @param uniformBuffers defines the list of uniform buffer names
  22238. */
  22239. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22240. /**
  22241. * Add potential fallbacks if shader compilation fails
  22242. * @param mesh defines the mesh to be rendered
  22243. * @param fallbacks defines the current prioritized list of fallbacks
  22244. */
  22245. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22246. /**
  22247. * Initialize defines for shader compilation
  22248. * @param mesh defines the mesh to be rendered
  22249. * @param nodeMaterial defines the node material requesting the update
  22250. * @param defines defines the material defines to update
  22251. * @param useInstances specifies that instances should be used
  22252. */
  22253. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22254. /**
  22255. * Update defines for shader compilation
  22256. * @param mesh defines the mesh to be rendered
  22257. * @param nodeMaterial defines the node material requesting the update
  22258. * @param defines defines the material defines to update
  22259. * @param useInstances specifies that instances should be used
  22260. * @param subMesh defines which submesh to render
  22261. */
  22262. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22263. /**
  22264. * Lets the block try to connect some inputs automatically
  22265. * @param material defines the hosting NodeMaterial
  22266. */
  22267. autoConfigure(material: NodeMaterial): void;
  22268. /**
  22269. * Function called when a block is declared as repeatable content generator
  22270. * @param vertexShaderState defines the current compilation state for the vertex shader
  22271. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22272. * @param mesh defines the mesh to be rendered
  22273. * @param defines defines the material defines to update
  22274. */
  22275. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22276. /**
  22277. * Checks if the block is ready
  22278. * @param mesh defines the mesh to be rendered
  22279. * @param nodeMaterial defines the node material requesting the update
  22280. * @param defines defines the material defines to update
  22281. * @param useInstances specifies that instances should be used
  22282. * @returns true if the block is ready
  22283. */
  22284. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22285. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22286. private _processBuild;
  22287. /**
  22288. * Validates the new name for the block node.
  22289. * @param newName the new name to be given to the node.
  22290. * @returns false if the name is a reserve word, else true.
  22291. */
  22292. validateBlockName(newName: string): boolean;
  22293. /**
  22294. * Compile the current node and generate the shader code
  22295. * @param state defines the current compilation state (uniforms, samplers, current string)
  22296. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22297. * @returns true if already built
  22298. */
  22299. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22300. protected _inputRename(name: string): string;
  22301. protected _outputRename(name: string): string;
  22302. protected _dumpPropertiesCode(): string;
  22303. /** @hidden */
  22304. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22305. /** @hidden */
  22306. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22307. /**
  22308. * Clone the current block to a new identical block
  22309. * @param scene defines the hosting scene
  22310. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22311. * @returns a copy of the current block
  22312. */
  22313. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22314. /**
  22315. * Serializes this block in a JSON representation
  22316. * @returns the serialized block object
  22317. */
  22318. serialize(): any;
  22319. /** @hidden */
  22320. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22321. private _deserializePortDisplayNamesAndExposedOnFrame;
  22322. /**
  22323. * Release resources
  22324. */
  22325. dispose(): void;
  22326. }
  22327. }
  22328. declare module "babylonjs/Materials/pushMaterial" {
  22329. import { Nullable } from "babylonjs/types";
  22330. import { Scene } from "babylonjs/scene";
  22331. import { Matrix } from "babylonjs/Maths/math.vector";
  22332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22333. import { Mesh } from "babylonjs/Meshes/mesh";
  22334. import { Material } from "babylonjs/Materials/material";
  22335. import { Effect } from "babylonjs/Materials/effect";
  22336. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22337. /**
  22338. * Base class of materials working in push mode in babylon JS
  22339. * @hidden
  22340. */
  22341. export class PushMaterial extends Material {
  22342. protected _activeEffect: Effect;
  22343. protected _normalMatrix: Matrix;
  22344. constructor(name: string, scene: Scene);
  22345. getEffect(): Effect;
  22346. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22347. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22348. /**
  22349. * Binds the given world matrix to the active effect
  22350. *
  22351. * @param world the matrix to bind
  22352. */
  22353. bindOnlyWorldMatrix(world: Matrix): void;
  22354. /**
  22355. * Binds the given normal matrix to the active effect
  22356. *
  22357. * @param normalMatrix the matrix to bind
  22358. */
  22359. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22360. bind(world: Matrix, mesh?: Mesh): void;
  22361. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22362. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22363. }
  22364. }
  22365. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22366. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22367. /**
  22368. * Root class for all node material optimizers
  22369. */
  22370. export class NodeMaterialOptimizer {
  22371. /**
  22372. * Function used to optimize a NodeMaterial graph
  22373. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22374. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22375. */
  22376. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22377. }
  22378. }
  22379. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22380. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22381. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22382. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22383. import { Scene } from "babylonjs/scene";
  22384. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22385. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22386. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22387. /**
  22388. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22389. */
  22390. export class TransformBlock extends NodeMaterialBlock {
  22391. /**
  22392. * Defines the value to use to complement W value to transform it to a Vector4
  22393. */
  22394. complementW: number;
  22395. /**
  22396. * Defines the value to use to complement z value to transform it to a Vector4
  22397. */
  22398. complementZ: number;
  22399. /**
  22400. * Creates a new TransformBlock
  22401. * @param name defines the block name
  22402. */
  22403. constructor(name: string);
  22404. /**
  22405. * Gets the current class name
  22406. * @returns the class name
  22407. */
  22408. getClassName(): string;
  22409. /**
  22410. * Gets the vector input
  22411. */
  22412. get vector(): NodeMaterialConnectionPoint;
  22413. /**
  22414. * Gets the output component
  22415. */
  22416. get output(): NodeMaterialConnectionPoint;
  22417. /**
  22418. * Gets the xyz output component
  22419. */
  22420. get xyz(): NodeMaterialConnectionPoint;
  22421. /**
  22422. * Gets the matrix transform input
  22423. */
  22424. get transform(): NodeMaterialConnectionPoint;
  22425. protected _buildBlock(state: NodeMaterialBuildState): this;
  22426. /**
  22427. * Update 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. * @param subMesh defines which submesh to render
  22433. */
  22434. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22435. serialize(): any;
  22436. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22437. protected _dumpPropertiesCode(): string;
  22438. }
  22439. }
  22440. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22441. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22442. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22443. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22444. /**
  22445. * Block used to output the vertex position
  22446. */
  22447. export class VertexOutputBlock extends NodeMaterialBlock {
  22448. /**
  22449. * Creates a new VertexOutputBlock
  22450. * @param name defines the block name
  22451. */
  22452. constructor(name: string);
  22453. /**
  22454. * Gets the current class name
  22455. * @returns the class name
  22456. */
  22457. getClassName(): string;
  22458. /**
  22459. * Gets the vector input component
  22460. */
  22461. get vector(): NodeMaterialConnectionPoint;
  22462. protected _buildBlock(state: NodeMaterialBuildState): this;
  22463. }
  22464. }
  22465. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22466. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22467. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22468. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22469. /**
  22470. * Block used to output the final color
  22471. */
  22472. export class FragmentOutputBlock extends NodeMaterialBlock {
  22473. /**
  22474. * Create a new FragmentOutputBlock
  22475. * @param name defines the block name
  22476. */
  22477. constructor(name: string);
  22478. /**
  22479. * Gets the current class name
  22480. * @returns the class name
  22481. */
  22482. getClassName(): string;
  22483. /**
  22484. * Gets the rgba input component
  22485. */
  22486. get rgba(): NodeMaterialConnectionPoint;
  22487. /**
  22488. * Gets the rgb input component
  22489. */
  22490. get rgb(): NodeMaterialConnectionPoint;
  22491. /**
  22492. * Gets the a input component
  22493. */
  22494. get a(): NodeMaterialConnectionPoint;
  22495. protected _buildBlock(state: NodeMaterialBuildState): this;
  22496. }
  22497. }
  22498. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22499. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22500. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22501. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22502. /**
  22503. * Block used for the particle ramp gradient section
  22504. */
  22505. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22506. /**
  22507. * Create a new ParticleRampGradientBlock
  22508. * @param name defines the block name
  22509. */
  22510. constructor(name: string);
  22511. /**
  22512. * Gets the current class name
  22513. * @returns the class name
  22514. */
  22515. getClassName(): string;
  22516. /**
  22517. * Gets the color input component
  22518. */
  22519. get color(): NodeMaterialConnectionPoint;
  22520. /**
  22521. * Gets the rampColor output component
  22522. */
  22523. get rampColor(): NodeMaterialConnectionPoint;
  22524. /**
  22525. * Initialize the block and prepare the context for build
  22526. * @param state defines the state that will be used for the build
  22527. */
  22528. initialize(state: NodeMaterialBuildState): void;
  22529. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22530. }
  22531. }
  22532. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22533. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22534. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22535. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22536. /**
  22537. * Block used for the particle blend multiply section
  22538. */
  22539. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22540. /**
  22541. * Create a new ParticleBlendMultiplyBlock
  22542. * @param name defines the block name
  22543. */
  22544. constructor(name: string);
  22545. /**
  22546. * Gets the current class name
  22547. * @returns the class name
  22548. */
  22549. getClassName(): string;
  22550. /**
  22551. * Gets the color input component
  22552. */
  22553. get color(): NodeMaterialConnectionPoint;
  22554. /**
  22555. * Gets the alphaTexture input component
  22556. */
  22557. get alphaTexture(): NodeMaterialConnectionPoint;
  22558. /**
  22559. * Gets the alphaColor input component
  22560. */
  22561. get alphaColor(): NodeMaterialConnectionPoint;
  22562. /**
  22563. * Gets the blendColor output component
  22564. */
  22565. get blendColor(): NodeMaterialConnectionPoint;
  22566. /**
  22567. * Initialize the block and prepare the context for build
  22568. * @param state defines the state that will be used for the build
  22569. */
  22570. initialize(state: NodeMaterialBuildState): void;
  22571. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22572. }
  22573. }
  22574. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22575. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22576. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22577. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22578. /**
  22579. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22580. */
  22581. export class VectorMergerBlock extends NodeMaterialBlock {
  22582. /**
  22583. * Create a new VectorMergerBlock
  22584. * @param name defines the block name
  22585. */
  22586. constructor(name: string);
  22587. /**
  22588. * Gets the current class name
  22589. * @returns the class name
  22590. */
  22591. getClassName(): string;
  22592. /**
  22593. * Gets the xyz component (input)
  22594. */
  22595. get xyzIn(): NodeMaterialConnectionPoint;
  22596. /**
  22597. * Gets the xy component (input)
  22598. */
  22599. get xyIn(): NodeMaterialConnectionPoint;
  22600. /**
  22601. * Gets the x component (input)
  22602. */
  22603. get x(): NodeMaterialConnectionPoint;
  22604. /**
  22605. * Gets the y component (input)
  22606. */
  22607. get y(): NodeMaterialConnectionPoint;
  22608. /**
  22609. * Gets the z component (input)
  22610. */
  22611. get z(): NodeMaterialConnectionPoint;
  22612. /**
  22613. * Gets the w component (input)
  22614. */
  22615. get w(): NodeMaterialConnectionPoint;
  22616. /**
  22617. * Gets the xyzw component (output)
  22618. */
  22619. get xyzw(): NodeMaterialConnectionPoint;
  22620. /**
  22621. * Gets the xyz component (output)
  22622. */
  22623. get xyzOut(): NodeMaterialConnectionPoint;
  22624. /**
  22625. * Gets the xy component (output)
  22626. */
  22627. get xyOut(): NodeMaterialConnectionPoint;
  22628. /**
  22629. * Gets the xy component (output)
  22630. * @deprecated Please use xyOut instead.
  22631. */
  22632. get xy(): NodeMaterialConnectionPoint;
  22633. /**
  22634. * Gets the xyz component (output)
  22635. * @deprecated Please use xyzOut instead.
  22636. */
  22637. get xyz(): NodeMaterialConnectionPoint;
  22638. protected _buildBlock(state: NodeMaterialBuildState): this;
  22639. }
  22640. }
  22641. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22642. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22643. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22644. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22645. import { Vector2 } from "babylonjs/Maths/math.vector";
  22646. import { Scene } from "babylonjs/scene";
  22647. /**
  22648. * Block used to remap a float from a range to a new one
  22649. */
  22650. export class RemapBlock extends NodeMaterialBlock {
  22651. /**
  22652. * Gets or sets the source range
  22653. */
  22654. sourceRange: Vector2;
  22655. /**
  22656. * Gets or sets the target range
  22657. */
  22658. targetRange: Vector2;
  22659. /**
  22660. * Creates a new RemapBlock
  22661. * @param name defines the block name
  22662. */
  22663. constructor(name: string);
  22664. /**
  22665. * Gets the current class name
  22666. * @returns the class name
  22667. */
  22668. getClassName(): string;
  22669. /**
  22670. * Gets the input component
  22671. */
  22672. get input(): NodeMaterialConnectionPoint;
  22673. /**
  22674. * Gets the source min input component
  22675. */
  22676. get sourceMin(): NodeMaterialConnectionPoint;
  22677. /**
  22678. * Gets the source max input component
  22679. */
  22680. get sourceMax(): NodeMaterialConnectionPoint;
  22681. /**
  22682. * Gets the target min input component
  22683. */
  22684. get targetMin(): NodeMaterialConnectionPoint;
  22685. /**
  22686. * Gets the target max input component
  22687. */
  22688. get targetMax(): NodeMaterialConnectionPoint;
  22689. /**
  22690. * Gets the output component
  22691. */
  22692. get output(): NodeMaterialConnectionPoint;
  22693. protected _buildBlock(state: NodeMaterialBuildState): this;
  22694. protected _dumpPropertiesCode(): string;
  22695. serialize(): any;
  22696. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22697. }
  22698. }
  22699. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22700. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22701. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22702. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22703. /**
  22704. * Block used to multiply 2 values
  22705. */
  22706. export class MultiplyBlock extends NodeMaterialBlock {
  22707. /**
  22708. * Creates a new MultiplyBlock
  22709. * @param name defines the block name
  22710. */
  22711. constructor(name: string);
  22712. /**
  22713. * Gets the current class name
  22714. * @returns the class name
  22715. */
  22716. getClassName(): string;
  22717. /**
  22718. * Gets the left operand input component
  22719. */
  22720. get left(): NodeMaterialConnectionPoint;
  22721. /**
  22722. * Gets the right operand input component
  22723. */
  22724. get right(): NodeMaterialConnectionPoint;
  22725. /**
  22726. * Gets the output component
  22727. */
  22728. get output(): NodeMaterialConnectionPoint;
  22729. protected _buildBlock(state: NodeMaterialBuildState): this;
  22730. }
  22731. }
  22732. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22733. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22734. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22735. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22736. /**
  22737. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22738. */
  22739. export class ColorSplitterBlock extends NodeMaterialBlock {
  22740. /**
  22741. * Create a new ColorSplitterBlock
  22742. * @param name defines the block name
  22743. */
  22744. constructor(name: string);
  22745. /**
  22746. * Gets the current class name
  22747. * @returns the class name
  22748. */
  22749. getClassName(): string;
  22750. /**
  22751. * Gets the rgba component (input)
  22752. */
  22753. get rgba(): NodeMaterialConnectionPoint;
  22754. /**
  22755. * Gets the rgb component (input)
  22756. */
  22757. get rgbIn(): NodeMaterialConnectionPoint;
  22758. /**
  22759. * Gets the rgb component (output)
  22760. */
  22761. get rgbOut(): NodeMaterialConnectionPoint;
  22762. /**
  22763. * Gets the r component (output)
  22764. */
  22765. get r(): NodeMaterialConnectionPoint;
  22766. /**
  22767. * Gets the g component (output)
  22768. */
  22769. get g(): NodeMaterialConnectionPoint;
  22770. /**
  22771. * Gets the b component (output)
  22772. */
  22773. get b(): NodeMaterialConnectionPoint;
  22774. /**
  22775. * Gets the a component (output)
  22776. */
  22777. get a(): NodeMaterialConnectionPoint;
  22778. protected _inputRename(name: string): string;
  22779. protected _outputRename(name: string): string;
  22780. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22781. }
  22782. }
  22783. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22784. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22785. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22786. import { Scene } from "babylonjs/scene";
  22787. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22788. import { Matrix } from "babylonjs/Maths/math.vector";
  22789. import { Mesh } from "babylonjs/Meshes/mesh";
  22790. import { Engine } from "babylonjs/Engines/engine";
  22791. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22792. import { Observable } from "babylonjs/Misc/observable";
  22793. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22794. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22795. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22796. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22797. import { Nullable } from "babylonjs/types";
  22798. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22799. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22800. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22801. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22802. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22803. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22804. import { Effect } from "babylonjs/Materials/effect";
  22805. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22806. import { Camera } from "babylonjs/Cameras/camera";
  22807. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22808. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22809. /**
  22810. * Interface used to configure the node material editor
  22811. */
  22812. export interface INodeMaterialEditorOptions {
  22813. /** Define the URl to load node editor script */
  22814. editorURL?: string;
  22815. }
  22816. /** @hidden */
  22817. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22818. NORMAL: boolean;
  22819. TANGENT: boolean;
  22820. UV1: boolean;
  22821. /** BONES */
  22822. NUM_BONE_INFLUENCERS: number;
  22823. BonesPerMesh: number;
  22824. BONETEXTURE: boolean;
  22825. /** MORPH TARGETS */
  22826. MORPHTARGETS: boolean;
  22827. MORPHTARGETS_NORMAL: boolean;
  22828. MORPHTARGETS_TANGENT: boolean;
  22829. MORPHTARGETS_UV: boolean;
  22830. NUM_MORPH_INFLUENCERS: number;
  22831. /** IMAGE PROCESSING */
  22832. IMAGEPROCESSING: boolean;
  22833. VIGNETTE: boolean;
  22834. VIGNETTEBLENDMODEMULTIPLY: boolean;
  22835. VIGNETTEBLENDMODEOPAQUE: boolean;
  22836. TONEMAPPING: boolean;
  22837. TONEMAPPING_ACES: boolean;
  22838. CONTRAST: boolean;
  22839. EXPOSURE: boolean;
  22840. COLORCURVES: boolean;
  22841. COLORGRADING: boolean;
  22842. COLORGRADING3D: boolean;
  22843. SAMPLER3DGREENDEPTH: boolean;
  22844. SAMPLER3DBGRMAP: boolean;
  22845. IMAGEPROCESSINGPOSTPROCESS: boolean;
  22846. /** MISC. */
  22847. BUMPDIRECTUV: number;
  22848. constructor();
  22849. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  22850. }
  22851. /**
  22852. * Class used to configure NodeMaterial
  22853. */
  22854. export interface INodeMaterialOptions {
  22855. /**
  22856. * Defines if blocks should emit comments
  22857. */
  22858. emitComments: boolean;
  22859. }
  22860. /**
  22861. * Class used to create a node based material built by assembling shader blocks
  22862. */
  22863. export class NodeMaterial extends PushMaterial {
  22864. private static _BuildIdGenerator;
  22865. private _options;
  22866. private _vertexCompilationState;
  22867. private _fragmentCompilationState;
  22868. private _sharedData;
  22869. private _buildId;
  22870. private _buildWasSuccessful;
  22871. private _cachedWorldViewMatrix;
  22872. private _cachedWorldViewProjectionMatrix;
  22873. private _optimizers;
  22874. private _animationFrame;
  22875. /** Define the Url to load node editor script */
  22876. static EditorURL: string;
  22877. /** Define the Url to load snippets */
  22878. static SnippetUrl: string;
  22879. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  22880. static IgnoreTexturesAtLoadTime: boolean;
  22881. private BJSNODEMATERIALEDITOR;
  22882. /** Get the inspector from bundle or global */
  22883. private _getGlobalNodeMaterialEditor;
  22884. /**
  22885. * Snippet ID if the material was created from the snippet server
  22886. */
  22887. snippetId: string;
  22888. /**
  22889. * Gets or sets data used by visual editor
  22890. * @see https://nme.babylonjs.com
  22891. */
  22892. editorData: any;
  22893. /**
  22894. * 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)
  22895. */
  22896. ignoreAlpha: boolean;
  22897. /**
  22898. * Defines the maximum number of lights that can be used in the material
  22899. */
  22900. maxSimultaneousLights: number;
  22901. /**
  22902. * Observable raised when the material is built
  22903. */
  22904. onBuildObservable: Observable<NodeMaterial>;
  22905. /**
  22906. * Gets or sets the root nodes of the material vertex shader
  22907. */
  22908. _vertexOutputNodes: NodeMaterialBlock[];
  22909. /**
  22910. * Gets or sets the root nodes of the material fragment (pixel) shader
  22911. */
  22912. _fragmentOutputNodes: NodeMaterialBlock[];
  22913. /** Gets or sets options to control the node material overall behavior */
  22914. get options(): INodeMaterialOptions;
  22915. set options(options: INodeMaterialOptions);
  22916. /**
  22917. * Default configuration related to image processing available in the standard Material.
  22918. */
  22919. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  22920. /**
  22921. * Gets the image processing configuration used either in this material.
  22922. */
  22923. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  22924. /**
  22925. * Sets the Default image processing configuration used either in the this material.
  22926. *
  22927. * If sets to null, the scene one is in use.
  22928. */
  22929. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  22930. /**
  22931. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  22932. */
  22933. attachedBlocks: NodeMaterialBlock[];
  22934. /**
  22935. * Specifies the mode of the node material
  22936. * @hidden
  22937. */
  22938. _mode: NodeMaterialModes;
  22939. /**
  22940. * Gets the mode property
  22941. */
  22942. get mode(): NodeMaterialModes;
  22943. /**
  22944. * Create a new node based material
  22945. * @param name defines the material name
  22946. * @param scene defines the hosting scene
  22947. * @param options defines creation option
  22948. */
  22949. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  22950. /**
  22951. * Gets the current class name of the material e.g. "NodeMaterial"
  22952. * @returns the class name
  22953. */
  22954. getClassName(): string;
  22955. /**
  22956. * Keep track of the image processing observer to allow dispose and replace.
  22957. */
  22958. private _imageProcessingObserver;
  22959. /**
  22960. * Attaches a new image processing configuration to the Standard Material.
  22961. * @param configuration
  22962. */
  22963. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  22964. /**
  22965. * Get a block by its name
  22966. * @param name defines the name of the block to retrieve
  22967. * @returns the required block or null if not found
  22968. */
  22969. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  22970. /**
  22971. * Get a block by its name
  22972. * @param predicate defines the predicate used to find the good candidate
  22973. * @returns the required block or null if not found
  22974. */
  22975. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  22976. /**
  22977. * Get an input block by its name
  22978. * @param predicate defines the predicate used to find the good candidate
  22979. * @returns the required input block or null if not found
  22980. */
  22981. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  22982. /**
  22983. * Gets the list of input blocks attached to this material
  22984. * @returns an array of InputBlocks
  22985. */
  22986. getInputBlocks(): InputBlock[];
  22987. /**
  22988. * Adds a new optimizer to the list of optimizers
  22989. * @param optimizer defines the optimizers to add
  22990. * @returns the current material
  22991. */
  22992. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22993. /**
  22994. * Remove an optimizer from the list of optimizers
  22995. * @param optimizer defines the optimizers to remove
  22996. * @returns the current material
  22997. */
  22998. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22999. /**
  23000. * Add a new block to the list of output nodes
  23001. * @param node defines the node to add
  23002. * @returns the current material
  23003. */
  23004. addOutputNode(node: NodeMaterialBlock): this;
  23005. /**
  23006. * Remove a block from the list of root nodes
  23007. * @param node defines the node to remove
  23008. * @returns the current material
  23009. */
  23010. removeOutputNode(node: NodeMaterialBlock): this;
  23011. private _addVertexOutputNode;
  23012. private _removeVertexOutputNode;
  23013. private _addFragmentOutputNode;
  23014. private _removeFragmentOutputNode;
  23015. /**
  23016. * Specifies if the material will require alpha blending
  23017. * @returns a boolean specifying if alpha blending is needed
  23018. */
  23019. needAlphaBlending(): boolean;
  23020. /**
  23021. * Specifies if this material should be rendered in alpha test mode
  23022. * @returns a boolean specifying if an alpha test is needed.
  23023. */
  23024. needAlphaTesting(): boolean;
  23025. private _initializeBlock;
  23026. private _resetDualBlocks;
  23027. /**
  23028. * Remove a block from the current node material
  23029. * @param block defines the block to remove
  23030. */
  23031. removeBlock(block: NodeMaterialBlock): void;
  23032. /**
  23033. * Build the material and generates the inner effect
  23034. * @param verbose defines if the build should log activity
  23035. */
  23036. build(verbose?: boolean): void;
  23037. /**
  23038. * Runs an otpimization phase to try to improve the shader code
  23039. */
  23040. optimize(): void;
  23041. private _prepareDefinesForAttributes;
  23042. /**
  23043. * Create a post process from the material
  23044. * @param camera The camera to apply the render pass to.
  23045. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23046. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23047. * @param engine The engine which the post process will be applied. (default: current engine)
  23048. * @param reusable If the post process can be reused on the same frame. (default: false)
  23049. * @param textureType Type of textures used when performing the post process. (default: 0)
  23050. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23051. * @returns the post process created
  23052. */
  23053. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23054. /**
  23055. * Create the post process effect from the material
  23056. * @param postProcess The post process to create the effect for
  23057. */
  23058. createEffectForPostProcess(postProcess: PostProcess): void;
  23059. private _createEffectOrPostProcess;
  23060. private _createEffectForParticles;
  23061. /**
  23062. * Create the effect to be used as the custom effect for a particle system
  23063. * @param particleSystem Particle system to create the effect for
  23064. * @param onCompiled defines a function to call when the effect creation is successful
  23065. * @param onError defines a function to call when the effect creation has failed
  23066. */
  23067. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23068. private _processDefines;
  23069. /**
  23070. * Get if the submesh is ready to be used and all its information available.
  23071. * Child classes can use it to update shaders
  23072. * @param mesh defines the mesh to check
  23073. * @param subMesh defines which submesh to check
  23074. * @param useInstances specifies that instances should be used
  23075. * @returns a boolean indicating that the submesh is ready or not
  23076. */
  23077. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23078. /**
  23079. * Get a string representing the shaders built by the current node graph
  23080. */
  23081. get compiledShaders(): string;
  23082. /**
  23083. * Binds the world matrix to the material
  23084. * @param world defines the world transformation matrix
  23085. */
  23086. bindOnlyWorldMatrix(world: Matrix): void;
  23087. /**
  23088. * Binds the submesh to this material by preparing the effect and shader to draw
  23089. * @param world defines the world transformation matrix
  23090. * @param mesh defines the mesh containing the submesh
  23091. * @param subMesh defines the submesh to bind the material to
  23092. */
  23093. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23094. /**
  23095. * Gets the active textures from the material
  23096. * @returns an array of textures
  23097. */
  23098. getActiveTextures(): BaseTexture[];
  23099. /**
  23100. * Gets the list of texture blocks
  23101. * @returns an array of texture blocks
  23102. */
  23103. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23104. /**
  23105. * Specifies if the material uses a texture
  23106. * @param texture defines the texture to check against the material
  23107. * @returns a boolean specifying if the material uses the texture
  23108. */
  23109. hasTexture(texture: BaseTexture): boolean;
  23110. /**
  23111. * Disposes the material
  23112. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23113. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23114. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23115. */
  23116. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23117. /** Creates the node editor window. */
  23118. private _createNodeEditor;
  23119. /**
  23120. * Launch the node material editor
  23121. * @param config Define the configuration of the editor
  23122. * @return a promise fulfilled when the node editor is visible
  23123. */
  23124. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23125. /**
  23126. * Clear the current material
  23127. */
  23128. clear(): void;
  23129. /**
  23130. * Clear the current material and set it to a default state
  23131. */
  23132. setToDefault(): void;
  23133. /**
  23134. * Clear the current material and set it to a default state for post process
  23135. */
  23136. setToDefaultPostProcess(): void;
  23137. /**
  23138. * Clear the current material and set it to a default state for particle
  23139. */
  23140. setToDefaultParticle(): void;
  23141. /**
  23142. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23143. * @param url defines the url to load from
  23144. * @returns a promise that will fullfil when the material is fully loaded
  23145. */
  23146. loadAsync(url: string): Promise<void>;
  23147. private _gatherBlocks;
  23148. /**
  23149. * Generate a string containing the code declaration required to create an equivalent of this material
  23150. * @returns a string
  23151. */
  23152. generateCode(): string;
  23153. /**
  23154. * Serializes this material in a JSON representation
  23155. * @returns the serialized material object
  23156. */
  23157. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23158. private _restoreConnections;
  23159. /**
  23160. * Clear the current graph and load a new one from a serialization object
  23161. * @param source defines the JSON representation of the material
  23162. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23163. * @param merge defines whether or not the source must be merged or replace the current content
  23164. */
  23165. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23166. /**
  23167. * Makes a duplicate of the current material.
  23168. * @param name - name to use for the new material.
  23169. */
  23170. clone(name: string): NodeMaterial;
  23171. /**
  23172. * Creates a node material from parsed material data
  23173. * @param source defines the JSON representation of the material
  23174. * @param scene defines the hosting scene
  23175. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23176. * @returns a new node material
  23177. */
  23178. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23179. /**
  23180. * Creates a node material from a snippet saved in a remote file
  23181. * @param name defines the name of the material to create
  23182. * @param url defines the url to load from
  23183. * @param scene defines the hosting scene
  23184. * @returns a promise that will resolve to the new node material
  23185. */
  23186. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23187. /**
  23188. * Creates a node material from a snippet saved by the node material editor
  23189. * @param snippetId defines the snippet to load
  23190. * @param scene defines the hosting scene
  23191. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23192. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23193. * @returns a promise that will resolve to the new node material
  23194. */
  23195. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23196. /**
  23197. * Creates a new node material set to default basic configuration
  23198. * @param name defines the name of the material
  23199. * @param scene defines the hosting scene
  23200. * @returns a new NodeMaterial
  23201. */
  23202. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23203. }
  23204. }
  23205. declare module "babylonjs/PostProcesses/postProcess" {
  23206. import { Nullable } from "babylonjs/types";
  23207. import { SmartArray } from "babylonjs/Misc/smartArray";
  23208. import { Observable } from "babylonjs/Misc/observable";
  23209. import { Vector2 } from "babylonjs/Maths/math.vector";
  23210. import { Camera } from "babylonjs/Cameras/camera";
  23211. import { Effect } from "babylonjs/Materials/effect";
  23212. import "babylonjs/Shaders/postprocess.vertex";
  23213. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23214. import { Engine } from "babylonjs/Engines/engine";
  23215. import { Color4 } from "babylonjs/Maths/math.color";
  23216. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23217. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23218. import { Scene } from "babylonjs/scene";
  23219. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23220. /**
  23221. * Size options for a post process
  23222. */
  23223. export type PostProcessOptions = {
  23224. width: number;
  23225. height: number;
  23226. };
  23227. /**
  23228. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23229. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23230. */
  23231. export class PostProcess {
  23232. /** Name of the PostProcess. */
  23233. name: string;
  23234. /**
  23235. * Gets or sets the unique id of the post process
  23236. */
  23237. uniqueId: number;
  23238. /**
  23239. * Width of the texture to apply the post process on
  23240. */
  23241. width: number;
  23242. /**
  23243. * Height of the texture to apply the post process on
  23244. */
  23245. height: number;
  23246. /**
  23247. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23248. */
  23249. nodeMaterialSource: Nullable<NodeMaterial>;
  23250. /**
  23251. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23252. * @hidden
  23253. */
  23254. _outputTexture: Nullable<InternalTexture>;
  23255. /**
  23256. * Sampling mode used by the shader
  23257. * See https://doc.babylonjs.com/classes/3.1/texture
  23258. */
  23259. renderTargetSamplingMode: number;
  23260. /**
  23261. * Clear color to use when screen clearing
  23262. */
  23263. clearColor: Color4;
  23264. /**
  23265. * If the buffer needs to be cleared before applying the post process. (default: true)
  23266. * Should be set to false if shader will overwrite all previous pixels.
  23267. */
  23268. autoClear: boolean;
  23269. /**
  23270. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23271. */
  23272. alphaMode: number;
  23273. /**
  23274. * Sets the setAlphaBlendConstants of the babylon engine
  23275. */
  23276. alphaConstants: Color4;
  23277. /**
  23278. * Animations to be used for the post processing
  23279. */
  23280. animations: import("babylonjs/Animations/animation").Animation[];
  23281. /**
  23282. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23283. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23284. */
  23285. enablePixelPerfectMode: boolean;
  23286. /**
  23287. * Force the postprocess to be applied without taking in account viewport
  23288. */
  23289. forceFullscreenViewport: boolean;
  23290. /**
  23291. * List of inspectable custom properties (used by the Inspector)
  23292. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23293. */
  23294. inspectableCustomProperties: IInspectable[];
  23295. /**
  23296. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23297. *
  23298. * | Value | Type | Description |
  23299. * | ----- | ----------------------------------- | ----------- |
  23300. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23301. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23302. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23303. *
  23304. */
  23305. scaleMode: number;
  23306. /**
  23307. * Force textures to be a power of two (default: false)
  23308. */
  23309. alwaysForcePOT: boolean;
  23310. private _samples;
  23311. /**
  23312. * Number of sample textures (default: 1)
  23313. */
  23314. get samples(): number;
  23315. set samples(n: number);
  23316. /**
  23317. * Modify the scale of the post process to be the same as the viewport (default: false)
  23318. */
  23319. adaptScaleToCurrentViewport: boolean;
  23320. private _camera;
  23321. protected _scene: Scene;
  23322. private _engine;
  23323. private _options;
  23324. private _reusable;
  23325. private _textureType;
  23326. private _textureFormat;
  23327. /**
  23328. * Smart array of input and output textures for the post process.
  23329. * @hidden
  23330. */
  23331. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23332. /**
  23333. * The index in _textures that corresponds to the output texture.
  23334. * @hidden
  23335. */
  23336. _currentRenderTextureInd: number;
  23337. private _effect;
  23338. private _samplers;
  23339. private _fragmentUrl;
  23340. private _vertexUrl;
  23341. private _parameters;
  23342. private _scaleRatio;
  23343. protected _indexParameters: any;
  23344. private _shareOutputWithPostProcess;
  23345. private _texelSize;
  23346. private _forcedOutputTexture;
  23347. /**
  23348. * Returns the fragment url or shader name used in the post process.
  23349. * @returns the fragment url or name in the shader store.
  23350. */
  23351. getEffectName(): string;
  23352. /**
  23353. * An event triggered when the postprocess is activated.
  23354. */
  23355. onActivateObservable: Observable<Camera>;
  23356. private _onActivateObserver;
  23357. /**
  23358. * A function that is added to the onActivateObservable
  23359. */
  23360. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23361. /**
  23362. * An event triggered when the postprocess changes its size.
  23363. */
  23364. onSizeChangedObservable: Observable<PostProcess>;
  23365. private _onSizeChangedObserver;
  23366. /**
  23367. * A function that is added to the onSizeChangedObservable
  23368. */
  23369. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23370. /**
  23371. * An event triggered when the postprocess applies its effect.
  23372. */
  23373. onApplyObservable: Observable<Effect>;
  23374. private _onApplyObserver;
  23375. /**
  23376. * A function that is added to the onApplyObservable
  23377. */
  23378. set onApply(callback: (effect: Effect) => void);
  23379. /**
  23380. * An event triggered before rendering the postprocess
  23381. */
  23382. onBeforeRenderObservable: Observable<Effect>;
  23383. private _onBeforeRenderObserver;
  23384. /**
  23385. * A function that is added to the onBeforeRenderObservable
  23386. */
  23387. set onBeforeRender(callback: (effect: Effect) => void);
  23388. /**
  23389. * An event triggered after rendering the postprocess
  23390. */
  23391. onAfterRenderObservable: Observable<Effect>;
  23392. private _onAfterRenderObserver;
  23393. /**
  23394. * A function that is added to the onAfterRenderObservable
  23395. */
  23396. set onAfterRender(callback: (efect: Effect) => void);
  23397. /**
  23398. * 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
  23399. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23400. */
  23401. get inputTexture(): InternalTexture;
  23402. set inputTexture(value: InternalTexture);
  23403. /**
  23404. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23405. * the only way to unset it is to use this function to restore its internal state
  23406. */
  23407. restoreDefaultInputTexture(): void;
  23408. /**
  23409. * Gets the camera which post process is applied to.
  23410. * @returns The camera the post process is applied to.
  23411. */
  23412. getCamera(): Camera;
  23413. /**
  23414. * Gets the texel size of the postprocess.
  23415. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23416. */
  23417. get texelSize(): Vector2;
  23418. /**
  23419. * Creates a new instance PostProcess
  23420. * @param name The name of the PostProcess.
  23421. * @param fragmentUrl The url of the fragment shader to be used.
  23422. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23423. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23424. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23425. * @param camera The camera to apply the render pass to.
  23426. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23427. * @param engine The engine which the post process will be applied. (default: current engine)
  23428. * @param reusable If the post process can be reused on the same frame. (default: false)
  23429. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23430. * @param textureType Type of textures used when performing the post process. (default: 0)
  23431. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23432. * @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
  23433. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23434. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23435. */
  23436. constructor(
  23437. /** Name of the PostProcess. */
  23438. 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);
  23439. /**
  23440. * Gets a string idenfifying the name of the class
  23441. * @returns "PostProcess" string
  23442. */
  23443. getClassName(): string;
  23444. /**
  23445. * Gets the engine which this post process belongs to.
  23446. * @returns The engine the post process was enabled with.
  23447. */
  23448. getEngine(): Engine;
  23449. /**
  23450. * The effect that is created when initializing the post process.
  23451. * @returns The created effect corresponding the the postprocess.
  23452. */
  23453. getEffect(): Effect;
  23454. /**
  23455. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23456. * @param postProcess The post process to share the output with.
  23457. * @returns This post process.
  23458. */
  23459. shareOutputWith(postProcess: PostProcess): PostProcess;
  23460. /**
  23461. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23462. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23463. */
  23464. useOwnOutput(): void;
  23465. /**
  23466. * Updates the effect with the current post process compile time values and recompiles the shader.
  23467. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23468. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23469. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23470. * @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
  23471. * @param onCompiled Called when the shader has been compiled.
  23472. * @param onError Called if there is an error when compiling a shader.
  23473. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23474. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23475. */
  23476. 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;
  23477. /**
  23478. * The post process is reusable if it can be used multiple times within one frame.
  23479. * @returns If the post process is reusable
  23480. */
  23481. isReusable(): boolean;
  23482. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23483. markTextureDirty(): void;
  23484. /**
  23485. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23486. * 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.
  23487. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23488. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23489. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23490. * @returns The target texture that was bound to be written to.
  23491. */
  23492. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23493. /**
  23494. * If the post process is supported.
  23495. */
  23496. get isSupported(): boolean;
  23497. /**
  23498. * The aspect ratio of the output texture.
  23499. */
  23500. get aspectRatio(): number;
  23501. /**
  23502. * Get a value indicating if the post-process is ready to be used
  23503. * @returns true if the post-process is ready (shader is compiled)
  23504. */
  23505. isReady(): boolean;
  23506. /**
  23507. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23508. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23509. */
  23510. apply(): Nullable<Effect>;
  23511. private _disposeTextures;
  23512. /**
  23513. * Disposes the post process.
  23514. * @param camera The camera to dispose the post process on.
  23515. */
  23516. dispose(camera?: Camera): void;
  23517. }
  23518. }
  23519. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23520. /** @hidden */
  23521. export var kernelBlurVaryingDeclaration: {
  23522. name: string;
  23523. shader: string;
  23524. };
  23525. }
  23526. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23527. /** @hidden */
  23528. export var kernelBlurFragment: {
  23529. name: string;
  23530. shader: string;
  23531. };
  23532. }
  23533. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23534. /** @hidden */
  23535. export var kernelBlurFragment2: {
  23536. name: string;
  23537. shader: string;
  23538. };
  23539. }
  23540. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23541. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23542. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23543. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23544. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23545. /** @hidden */
  23546. export var kernelBlurPixelShader: {
  23547. name: string;
  23548. shader: string;
  23549. };
  23550. }
  23551. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23552. /** @hidden */
  23553. export var kernelBlurVertex: {
  23554. name: string;
  23555. shader: string;
  23556. };
  23557. }
  23558. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23559. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23560. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23561. /** @hidden */
  23562. export var kernelBlurVertexShader: {
  23563. name: string;
  23564. shader: string;
  23565. };
  23566. }
  23567. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23568. import { Vector2 } from "babylonjs/Maths/math.vector";
  23569. import { Nullable } from "babylonjs/types";
  23570. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23571. import { Camera } from "babylonjs/Cameras/camera";
  23572. import { Effect } from "babylonjs/Materials/effect";
  23573. import { Engine } from "babylonjs/Engines/engine";
  23574. import "babylonjs/Shaders/kernelBlur.fragment";
  23575. import "babylonjs/Shaders/kernelBlur.vertex";
  23576. /**
  23577. * The Blur Post Process which blurs an image based on a kernel and direction.
  23578. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23579. */
  23580. export class BlurPostProcess extends PostProcess {
  23581. /** The direction in which to blur the image. */
  23582. direction: Vector2;
  23583. private blockCompilation;
  23584. protected _kernel: number;
  23585. protected _idealKernel: number;
  23586. protected _packedFloat: boolean;
  23587. private _staticDefines;
  23588. /**
  23589. * Sets the length in pixels of the blur sample region
  23590. */
  23591. set kernel(v: number);
  23592. /**
  23593. * Gets the length in pixels of the blur sample region
  23594. */
  23595. get kernel(): number;
  23596. /**
  23597. * Sets wether or not the blur needs to unpack/repack floats
  23598. */
  23599. set packedFloat(v: boolean);
  23600. /**
  23601. * Gets wether or not the blur is unpacking/repacking floats
  23602. */
  23603. get packedFloat(): boolean;
  23604. /**
  23605. * Creates a new instance BlurPostProcess
  23606. * @param name The name of the effect.
  23607. * @param direction The direction in which to blur the image.
  23608. * @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.
  23609. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23610. * @param camera The camera to apply the render pass to.
  23611. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23612. * @param engine The engine which the post process will be applied. (default: current engine)
  23613. * @param reusable If the post process can be reused on the same frame. (default: false)
  23614. * @param textureType Type of textures used when performing the post process. (default: 0)
  23615. * @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)
  23616. */
  23617. constructor(name: string,
  23618. /** The direction in which to blur the image. */
  23619. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23620. /**
  23621. * Updates the effect with the current post process compile time values and recompiles the shader.
  23622. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23623. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23624. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23625. * @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
  23626. * @param onCompiled Called when the shader has been compiled.
  23627. * @param onError Called if there is an error when compiling a shader.
  23628. */
  23629. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23630. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23631. /**
  23632. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23633. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23634. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23635. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23636. * The gaps between physical kernels are compensated for in the weighting of the samples
  23637. * @param idealKernel Ideal blur kernel.
  23638. * @return Nearest best kernel.
  23639. */
  23640. protected _nearestBestKernel(idealKernel: number): number;
  23641. /**
  23642. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23643. * @param x The point on the Gaussian distribution to sample.
  23644. * @return the value of the Gaussian function at x.
  23645. */
  23646. protected _gaussianWeight(x: number): number;
  23647. /**
  23648. * Generates a string that can be used as a floating point number in GLSL.
  23649. * @param x Value to print.
  23650. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23651. * @return GLSL float string.
  23652. */
  23653. protected _glslFloat(x: number, decimalFigures?: number): string;
  23654. }
  23655. }
  23656. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23657. import { Scene } from "babylonjs/scene";
  23658. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23659. import { Plane } from "babylonjs/Maths/math.plane";
  23660. /**
  23661. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23662. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23663. * You can then easily use it as a reflectionTexture on a flat surface.
  23664. * In case the surface is not a plane, please consider relying on reflection probes.
  23665. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23666. */
  23667. export class MirrorTexture extends RenderTargetTexture {
  23668. private scene;
  23669. /**
  23670. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23671. * 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.
  23672. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23673. */
  23674. mirrorPlane: Plane;
  23675. /**
  23676. * Define the blur ratio used to blur the reflection if needed.
  23677. */
  23678. set blurRatio(value: number);
  23679. get blurRatio(): number;
  23680. /**
  23681. * Define the adaptive blur kernel used to blur the reflection if needed.
  23682. * This will autocompute the closest best match for the `blurKernel`
  23683. */
  23684. set adaptiveBlurKernel(value: number);
  23685. /**
  23686. * Define the blur kernel used to blur the reflection if needed.
  23687. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23688. */
  23689. set blurKernel(value: number);
  23690. /**
  23691. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23692. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23693. */
  23694. set blurKernelX(value: number);
  23695. get blurKernelX(): number;
  23696. /**
  23697. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23698. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23699. */
  23700. set blurKernelY(value: number);
  23701. get blurKernelY(): number;
  23702. private _autoComputeBlurKernel;
  23703. protected _onRatioRescale(): void;
  23704. private _updateGammaSpace;
  23705. private _imageProcessingConfigChangeObserver;
  23706. private _transformMatrix;
  23707. private _mirrorMatrix;
  23708. private _savedViewMatrix;
  23709. private _blurX;
  23710. private _blurY;
  23711. private _adaptiveBlurKernel;
  23712. private _blurKernelX;
  23713. private _blurKernelY;
  23714. private _blurRatio;
  23715. /**
  23716. * Instantiates a Mirror Texture.
  23717. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23718. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23719. * You can then easily use it as a reflectionTexture on a flat surface.
  23720. * In case the surface is not a plane, please consider relying on reflection probes.
  23721. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23722. * @param name
  23723. * @param size
  23724. * @param scene
  23725. * @param generateMipMaps
  23726. * @param type
  23727. * @param samplingMode
  23728. * @param generateDepthBuffer
  23729. */
  23730. constructor(name: string, size: number | {
  23731. width: number;
  23732. height: number;
  23733. } | {
  23734. ratio: number;
  23735. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23736. private _preparePostProcesses;
  23737. /**
  23738. * Clone the mirror texture.
  23739. * @returns the cloned texture
  23740. */
  23741. clone(): MirrorTexture;
  23742. /**
  23743. * Serialize the texture to a JSON representation you could use in Parse later on
  23744. * @returns the serialized JSON representation
  23745. */
  23746. serialize(): any;
  23747. /**
  23748. * Dispose the texture and release its associated resources.
  23749. */
  23750. dispose(): void;
  23751. }
  23752. }
  23753. declare module "babylonjs/Materials/Textures/texture" {
  23754. import { Observable } from "babylonjs/Misc/observable";
  23755. import { Nullable } from "babylonjs/types";
  23756. import { Matrix } from "babylonjs/Maths/math.vector";
  23757. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23758. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23759. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23760. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23761. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23762. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23763. import { Scene } from "babylonjs/scene";
  23764. /**
  23765. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23766. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23767. */
  23768. export class Texture extends BaseTexture {
  23769. /**
  23770. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23771. */
  23772. static SerializeBuffers: boolean;
  23773. /** @hidden */
  23774. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23775. /** @hidden */
  23776. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23777. /** @hidden */
  23778. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23779. /** nearest is mag = nearest and min = nearest and mip = linear */
  23780. static readonly NEAREST_SAMPLINGMODE: number;
  23781. /** nearest is mag = nearest and min = nearest and mip = linear */
  23782. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23783. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23784. static readonly BILINEAR_SAMPLINGMODE: number;
  23785. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23786. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23787. /** Trilinear is mag = linear and min = linear and mip = linear */
  23788. static readonly TRILINEAR_SAMPLINGMODE: number;
  23789. /** Trilinear is mag = linear and min = linear and mip = linear */
  23790. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23791. /** mag = nearest and min = nearest and mip = nearest */
  23792. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23793. /** mag = nearest and min = linear and mip = nearest */
  23794. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23795. /** mag = nearest and min = linear and mip = linear */
  23796. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23797. /** mag = nearest and min = linear and mip = none */
  23798. static readonly NEAREST_LINEAR: number;
  23799. /** mag = nearest and min = nearest and mip = none */
  23800. static readonly NEAREST_NEAREST: number;
  23801. /** mag = linear and min = nearest and mip = nearest */
  23802. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23803. /** mag = linear and min = nearest and mip = linear */
  23804. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  23805. /** mag = linear and min = linear and mip = none */
  23806. static readonly LINEAR_LINEAR: number;
  23807. /** mag = linear and min = nearest and mip = none */
  23808. static readonly LINEAR_NEAREST: number;
  23809. /** Explicit coordinates mode */
  23810. static readonly EXPLICIT_MODE: number;
  23811. /** Spherical coordinates mode */
  23812. static readonly SPHERICAL_MODE: number;
  23813. /** Planar coordinates mode */
  23814. static readonly PLANAR_MODE: number;
  23815. /** Cubic coordinates mode */
  23816. static readonly CUBIC_MODE: number;
  23817. /** Projection coordinates mode */
  23818. static readonly PROJECTION_MODE: number;
  23819. /** Inverse Cubic coordinates mode */
  23820. static readonly SKYBOX_MODE: number;
  23821. /** Inverse Cubic coordinates mode */
  23822. static readonly INVCUBIC_MODE: number;
  23823. /** Equirectangular coordinates mode */
  23824. static readonly EQUIRECTANGULAR_MODE: number;
  23825. /** Equirectangular Fixed coordinates mode */
  23826. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  23827. /** Equirectangular Fixed Mirrored coordinates mode */
  23828. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  23829. /** Texture is not repeating outside of 0..1 UVs */
  23830. static readonly CLAMP_ADDRESSMODE: number;
  23831. /** Texture is repeating outside of 0..1 UVs */
  23832. static readonly WRAP_ADDRESSMODE: number;
  23833. /** Texture is repeating and mirrored */
  23834. static readonly MIRROR_ADDRESSMODE: number;
  23835. /**
  23836. * 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
  23837. */
  23838. static UseSerializedUrlIfAny: boolean;
  23839. /**
  23840. * Define the url of the texture.
  23841. */
  23842. url: Nullable<string>;
  23843. /**
  23844. * Define an offset on the texture to offset the u coordinates of the UVs
  23845. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  23846. */
  23847. uOffset: number;
  23848. /**
  23849. * Define an offset on the texture to offset the v coordinates of the UVs
  23850. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  23851. */
  23852. vOffset: number;
  23853. /**
  23854. * Define an offset on the texture to scale the u coordinates of the UVs
  23855. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  23856. */
  23857. uScale: number;
  23858. /**
  23859. * Define an offset on the texture to scale the v coordinates of the UVs
  23860. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  23861. */
  23862. vScale: number;
  23863. /**
  23864. * Define an offset on the texture to rotate around the u coordinates of the UVs
  23865. * @see https://doc.babylonjs.com/how_to/more_materials
  23866. */
  23867. uAng: number;
  23868. /**
  23869. * Define an offset on the texture to rotate around the v coordinates of the UVs
  23870. * @see https://doc.babylonjs.com/how_to/more_materials
  23871. */
  23872. vAng: number;
  23873. /**
  23874. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  23875. * @see https://doc.babylonjs.com/how_to/more_materials
  23876. */
  23877. wAng: number;
  23878. /**
  23879. * Defines the center of rotation (U)
  23880. */
  23881. uRotationCenter: number;
  23882. /**
  23883. * Defines the center of rotation (V)
  23884. */
  23885. vRotationCenter: number;
  23886. /**
  23887. * Defines the center of rotation (W)
  23888. */
  23889. wRotationCenter: number;
  23890. /**
  23891. * Are mip maps generated for this texture or not.
  23892. */
  23893. get noMipmap(): boolean;
  23894. /**
  23895. * List of inspectable custom properties (used by the Inspector)
  23896. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23897. */
  23898. inspectableCustomProperties: Nullable<IInspectable[]>;
  23899. private _noMipmap;
  23900. /** @hidden */
  23901. _invertY: boolean;
  23902. private _rowGenerationMatrix;
  23903. private _cachedTextureMatrix;
  23904. private _projectionModeMatrix;
  23905. private _t0;
  23906. private _t1;
  23907. private _t2;
  23908. private _cachedUOffset;
  23909. private _cachedVOffset;
  23910. private _cachedUScale;
  23911. private _cachedVScale;
  23912. private _cachedUAng;
  23913. private _cachedVAng;
  23914. private _cachedWAng;
  23915. private _cachedProjectionMatrixId;
  23916. private _cachedCoordinatesMode;
  23917. /** @hidden */
  23918. protected _initialSamplingMode: number;
  23919. /** @hidden */
  23920. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  23921. private _deleteBuffer;
  23922. protected _format: Nullable<number>;
  23923. private _delayedOnLoad;
  23924. private _delayedOnError;
  23925. private _mimeType?;
  23926. /**
  23927. * Observable triggered once the texture has been loaded.
  23928. */
  23929. onLoadObservable: Observable<Texture>;
  23930. protected _isBlocking: boolean;
  23931. /**
  23932. * Is the texture preventing material to render while loading.
  23933. * If false, a default texture will be used instead of the loading one during the preparation step.
  23934. */
  23935. set isBlocking(value: boolean);
  23936. get isBlocking(): boolean;
  23937. /**
  23938. * Get the current sampling mode associated with the texture.
  23939. */
  23940. get samplingMode(): number;
  23941. /**
  23942. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  23943. */
  23944. get invertY(): boolean;
  23945. /**
  23946. * Instantiates a new texture.
  23947. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23948. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23949. * @param url defines the url of the picture to load as a texture
  23950. * @param sceneOrEngine defines the scene or engine the texture will belong to
  23951. * @param noMipmap defines if the texture will require mip maps or not
  23952. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  23953. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23954. * @param onLoad defines a callback triggered when the texture has been loaded
  23955. * @param onError defines a callback triggered when an error occurred during the loading session
  23956. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  23957. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  23958. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23959. * @param mimeType defines an optional mime type information
  23960. */
  23961. 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);
  23962. /**
  23963. * Update the url (and optional buffer) of this texture if url was null during construction.
  23964. * @param url the url of the texture
  23965. * @param buffer the buffer of the texture (defaults to null)
  23966. * @param onLoad callback called when the texture is loaded (defaults to null)
  23967. */
  23968. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  23969. /**
  23970. * Finish the loading sequence of a texture flagged as delayed load.
  23971. * @hidden
  23972. */
  23973. delayLoad(): void;
  23974. private _prepareRowForTextureGeneration;
  23975. /**
  23976. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  23977. * @returns the transform matrix of the texture.
  23978. */
  23979. getTextureMatrix(uBase?: number): Matrix;
  23980. /**
  23981. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  23982. * @returns The reflection texture transform
  23983. */
  23984. getReflectionTextureMatrix(): Matrix;
  23985. /**
  23986. * Clones the texture.
  23987. * @returns the cloned texture
  23988. */
  23989. clone(): Texture;
  23990. /**
  23991. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  23992. * @returns The JSON representation of the texture
  23993. */
  23994. serialize(): any;
  23995. /**
  23996. * Get the current class name of the texture useful for serialization or dynamic coding.
  23997. * @returns "Texture"
  23998. */
  23999. getClassName(): string;
  24000. /**
  24001. * Dispose the texture and release its associated resources.
  24002. */
  24003. dispose(): void;
  24004. /**
  24005. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24006. * @param parsedTexture Define the JSON representation of the texture
  24007. * @param scene Define the scene the parsed texture should be instantiated in
  24008. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24009. * @returns The parsed texture if successful
  24010. */
  24011. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24012. /**
  24013. * Creates a texture from its base 64 representation.
  24014. * @param data Define the base64 payload without the data: prefix
  24015. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24016. * @param scene Define the scene the texture should belong to
  24017. * @param noMipmap Forces the texture to not create mip map information if true
  24018. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24019. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24020. * @param onLoad define a callback triggered when the texture has been loaded
  24021. * @param onError define a callback triggered when an error occurred during the loading session
  24022. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24023. * @returns the created texture
  24024. */
  24025. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24026. /**
  24027. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24028. * @param data Define the base64 payload without the data: prefix
  24029. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24030. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24031. * @param scene Define the scene the texture should belong to
  24032. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24033. * @param noMipmap Forces the texture to not create mip map information if true
  24034. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24035. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24036. * @param onLoad define a callback triggered when the texture has been loaded
  24037. * @param onError define a callback triggered when an error occurred during the loading session
  24038. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24039. * @returns the created texture
  24040. */
  24041. 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;
  24042. }
  24043. }
  24044. declare module "babylonjs/PostProcesses/postProcessManager" {
  24045. import { Nullable } from "babylonjs/types";
  24046. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24047. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24048. import { Scene } from "babylonjs/scene";
  24049. /**
  24050. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24051. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24052. */
  24053. export class PostProcessManager {
  24054. private _scene;
  24055. private _indexBuffer;
  24056. private _vertexBuffers;
  24057. /**
  24058. * Creates a new instance PostProcess
  24059. * @param scene The scene that the post process is associated with.
  24060. */
  24061. constructor(scene: Scene);
  24062. private _prepareBuffers;
  24063. private _buildIndexBuffer;
  24064. /**
  24065. * Rebuilds the vertex buffers of the manager.
  24066. * @hidden
  24067. */
  24068. _rebuild(): void;
  24069. /**
  24070. * Prepares a frame to be run through a post process.
  24071. * @param sourceTexture The input texture to the post procesess. (default: null)
  24072. * @param postProcesses An array of post processes to be run. (default: null)
  24073. * @returns True if the post processes were able to be run.
  24074. * @hidden
  24075. */
  24076. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24077. /**
  24078. * Manually render a set of post processes to a texture.
  24079. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24080. * @param postProcesses An array of post processes to be run.
  24081. * @param targetTexture The target texture to render to.
  24082. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24083. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24084. * @param lodLevel defines which lod of the texture to render to
  24085. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24086. */
  24087. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24088. /**
  24089. * Finalize the result of the output of the postprocesses.
  24090. * @param doNotPresent If true the result will not be displayed to the screen.
  24091. * @param targetTexture The target texture to render to.
  24092. * @param faceIndex The index of the face to bind the target texture to.
  24093. * @param postProcesses The array of post processes to render.
  24094. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24095. * @hidden
  24096. */
  24097. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24098. /**
  24099. * Disposes of the post process manager.
  24100. */
  24101. dispose(): void;
  24102. }
  24103. }
  24104. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24105. import { Observable } from "babylonjs/Misc/observable";
  24106. import { SmartArray } from "babylonjs/Misc/smartArray";
  24107. import { Nullable, Immutable } from "babylonjs/types";
  24108. import { Camera } from "babylonjs/Cameras/camera";
  24109. import { Scene } from "babylonjs/scene";
  24110. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24111. import { Color4 } from "babylonjs/Maths/math.color";
  24112. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24113. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24114. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24115. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24116. import { Texture } from "babylonjs/Materials/Textures/texture";
  24117. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24118. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24119. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24120. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24121. import { Engine } from "babylonjs/Engines/engine";
  24122. /**
  24123. * This Helps creating a texture that will be created from a camera in your scene.
  24124. * It is basically a dynamic texture that could be used to create special effects for instance.
  24125. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24126. */
  24127. export class RenderTargetTexture extends Texture {
  24128. isCube: boolean;
  24129. /**
  24130. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24131. */
  24132. static readonly REFRESHRATE_RENDER_ONCE: number;
  24133. /**
  24134. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24135. */
  24136. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24137. /**
  24138. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24139. * the central point of your effect and can save a lot of performances.
  24140. */
  24141. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24142. /**
  24143. * Use this predicate to dynamically define the list of mesh you want to render.
  24144. * If set, the renderList property will be overwritten.
  24145. */
  24146. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24147. private _renderList;
  24148. /**
  24149. * Use this list to define the list of mesh you want to render.
  24150. */
  24151. get renderList(): Nullable<Array<AbstractMesh>>;
  24152. set renderList(value: Nullable<Array<AbstractMesh>>);
  24153. /**
  24154. * Use this function to overload the renderList array at rendering time.
  24155. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24156. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24157. * the cube (if the RTT is a cube, else layerOrFace=0).
  24158. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24159. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24160. * hold dummy elements!
  24161. */
  24162. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24163. private _hookArray;
  24164. /**
  24165. * Define if particles should be rendered in your texture.
  24166. */
  24167. renderParticles: boolean;
  24168. /**
  24169. * Define if sprites should be rendered in your texture.
  24170. */
  24171. renderSprites: boolean;
  24172. /**
  24173. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  24174. */
  24175. coordinatesMode: number;
  24176. /**
  24177. * Define the camera used to render the texture.
  24178. */
  24179. activeCamera: Nullable<Camera>;
  24180. /**
  24181. * Override the mesh isReady function with your own one.
  24182. */
  24183. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24184. /**
  24185. * Override the render function of the texture with your own one.
  24186. */
  24187. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24188. /**
  24189. * Define if camera post processes should be use while rendering the texture.
  24190. */
  24191. useCameraPostProcesses: boolean;
  24192. /**
  24193. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24194. */
  24195. ignoreCameraViewport: boolean;
  24196. private _postProcessManager;
  24197. private _postProcesses;
  24198. private _resizeObserver;
  24199. /**
  24200. * An event triggered when the texture is unbind.
  24201. */
  24202. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24203. /**
  24204. * An event triggered when the texture is unbind.
  24205. */
  24206. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24207. private _onAfterUnbindObserver;
  24208. /**
  24209. * Set a after unbind callback in the texture.
  24210. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24211. */
  24212. set onAfterUnbind(callback: () => void);
  24213. /**
  24214. * An event triggered before rendering the texture
  24215. */
  24216. onBeforeRenderObservable: Observable<number>;
  24217. private _onBeforeRenderObserver;
  24218. /**
  24219. * Set a before render callback in the texture.
  24220. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24221. */
  24222. set onBeforeRender(callback: (faceIndex: number) => void);
  24223. /**
  24224. * An event triggered after rendering the texture
  24225. */
  24226. onAfterRenderObservable: Observable<number>;
  24227. private _onAfterRenderObserver;
  24228. /**
  24229. * Set a after render callback in the texture.
  24230. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24231. */
  24232. set onAfterRender(callback: (faceIndex: number) => void);
  24233. /**
  24234. * An event triggered after the texture clear
  24235. */
  24236. onClearObservable: Observable<Engine>;
  24237. private _onClearObserver;
  24238. /**
  24239. * Set a clear callback in the texture.
  24240. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24241. */
  24242. set onClear(callback: (Engine: Engine) => void);
  24243. /**
  24244. * An event triggered when the texture is resized.
  24245. */
  24246. onResizeObservable: Observable<RenderTargetTexture>;
  24247. /**
  24248. * Define the clear color of the Render Target if it should be different from the scene.
  24249. */
  24250. clearColor: Color4;
  24251. protected _size: number | {
  24252. width: number;
  24253. height: number;
  24254. layers?: number;
  24255. };
  24256. protected _initialSizeParameter: number | {
  24257. width: number;
  24258. height: number;
  24259. } | {
  24260. ratio: number;
  24261. };
  24262. protected _sizeRatio: Nullable<number>;
  24263. /** @hidden */
  24264. _generateMipMaps: boolean;
  24265. protected _renderingManager: RenderingManager;
  24266. /** @hidden */
  24267. _waitingRenderList: string[];
  24268. protected _doNotChangeAspectRatio: boolean;
  24269. protected _currentRefreshId: number;
  24270. protected _refreshRate: number;
  24271. protected _textureMatrix: Matrix;
  24272. protected _samples: number;
  24273. protected _renderTargetOptions: RenderTargetCreationOptions;
  24274. /**
  24275. * Gets render target creation options that were used.
  24276. */
  24277. get renderTargetOptions(): RenderTargetCreationOptions;
  24278. protected _onRatioRescale(): void;
  24279. /**
  24280. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24281. * It must define where the camera used to render the texture is set
  24282. */
  24283. boundingBoxPosition: Vector3;
  24284. private _boundingBoxSize;
  24285. /**
  24286. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24287. * When defined, the cubemap will switch to local mode
  24288. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24289. * @example https://www.babylonjs-playground.com/#RNASML
  24290. */
  24291. set boundingBoxSize(value: Vector3);
  24292. get boundingBoxSize(): Vector3;
  24293. /**
  24294. * In case the RTT has been created with a depth texture, get the associated
  24295. * depth texture.
  24296. * Otherwise, return null.
  24297. */
  24298. get depthStencilTexture(): Nullable<InternalTexture>;
  24299. /**
  24300. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24301. * or used a shadow, depth texture...
  24302. * @param name The friendly name of the texture
  24303. * @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)
  24304. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24305. * @param generateMipMaps True if mip maps need to be generated after render.
  24306. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24307. * @param type The type of the buffer in the RTT (int, half float, float...)
  24308. * @param isCube True if a cube texture needs to be created
  24309. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24310. * @param generateDepthBuffer True to generate a depth buffer
  24311. * @param generateStencilBuffer True to generate a stencil buffer
  24312. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24313. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24314. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24315. */
  24316. constructor(name: string, size: number | {
  24317. width: number;
  24318. height: number;
  24319. layers?: number;
  24320. } | {
  24321. ratio: number;
  24322. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24323. /**
  24324. * Creates a depth stencil texture.
  24325. * This is only available in WebGL 2 or with the depth texture extension available.
  24326. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24327. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24328. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24329. */
  24330. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24331. private _processSizeParameter;
  24332. /**
  24333. * Define the number of samples to use in case of MSAA.
  24334. * It defaults to one meaning no MSAA has been enabled.
  24335. */
  24336. get samples(): number;
  24337. set samples(value: number);
  24338. /**
  24339. * Resets the refresh counter of the texture and start bak from scratch.
  24340. * Could be useful to regenerate the texture if it is setup to render only once.
  24341. */
  24342. resetRefreshCounter(): void;
  24343. /**
  24344. * Define the refresh rate of the texture or the rendering frequency.
  24345. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24346. */
  24347. get refreshRate(): number;
  24348. set refreshRate(value: number);
  24349. /**
  24350. * Adds a post process to the render target rendering passes.
  24351. * @param postProcess define the post process to add
  24352. */
  24353. addPostProcess(postProcess: PostProcess): void;
  24354. /**
  24355. * Clear all the post processes attached to the render target
  24356. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24357. */
  24358. clearPostProcesses(dispose?: boolean): void;
  24359. /**
  24360. * Remove one of the post process from the list of attached post processes to the texture
  24361. * @param postProcess define the post process to remove from the list
  24362. */
  24363. removePostProcess(postProcess: PostProcess): void;
  24364. /** @hidden */
  24365. _shouldRender(): boolean;
  24366. /**
  24367. * Gets the actual render size of the texture.
  24368. * @returns the width of the render size
  24369. */
  24370. getRenderSize(): number;
  24371. /**
  24372. * Gets the actual render width of the texture.
  24373. * @returns the width of the render size
  24374. */
  24375. getRenderWidth(): number;
  24376. /**
  24377. * Gets the actual render height of the texture.
  24378. * @returns the height of the render size
  24379. */
  24380. getRenderHeight(): number;
  24381. /**
  24382. * Gets the actual number of layers of the texture.
  24383. * @returns the number of layers
  24384. */
  24385. getRenderLayers(): number;
  24386. /**
  24387. * Get if the texture can be rescaled or not.
  24388. */
  24389. get canRescale(): boolean;
  24390. /**
  24391. * Resize the texture using a ratio.
  24392. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24393. */
  24394. scale(ratio: number): void;
  24395. /**
  24396. * Get the texture reflection matrix used to rotate/transform the reflection.
  24397. * @returns the reflection matrix
  24398. */
  24399. getReflectionTextureMatrix(): Matrix;
  24400. /**
  24401. * Resize the texture to a new desired size.
  24402. * Be carrefull as it will recreate all the data in the new texture.
  24403. * @param size Define the new size. It can be:
  24404. * - a number for squared texture,
  24405. * - an object containing { width: number, height: number }
  24406. * - or an object containing a ratio { ratio: number }
  24407. */
  24408. resize(size: number | {
  24409. width: number;
  24410. height: number;
  24411. } | {
  24412. ratio: number;
  24413. }): void;
  24414. private _defaultRenderListPrepared;
  24415. /**
  24416. * Renders all the objects from the render list into the texture.
  24417. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24418. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24419. */
  24420. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24421. private _bestReflectionRenderTargetDimension;
  24422. private _prepareRenderingManager;
  24423. /**
  24424. * @hidden
  24425. * @param faceIndex face index to bind to if this is a cubetexture
  24426. * @param layer defines the index of the texture to bind in the array
  24427. */
  24428. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24429. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24430. private renderToTarget;
  24431. /**
  24432. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24433. * This allowed control for front to back rendering or reversly depending of the special needs.
  24434. *
  24435. * @param renderingGroupId The rendering group id corresponding to its index
  24436. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24437. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24438. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24439. */
  24440. 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;
  24441. /**
  24442. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24443. *
  24444. * @param renderingGroupId The rendering group id corresponding to its index
  24445. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24446. */
  24447. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24448. /**
  24449. * Clones the texture.
  24450. * @returns the cloned texture
  24451. */
  24452. clone(): RenderTargetTexture;
  24453. /**
  24454. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24455. * @returns The JSON representation of the texture
  24456. */
  24457. serialize(): any;
  24458. /**
  24459. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24460. */
  24461. disposeFramebufferObjects(): void;
  24462. /**
  24463. * Dispose the texture and release its associated resources.
  24464. */
  24465. dispose(): void;
  24466. /** @hidden */
  24467. _rebuild(): void;
  24468. /**
  24469. * Clear the info related to rendering groups preventing retention point in material dispose.
  24470. */
  24471. freeRenderingGroups(): void;
  24472. /**
  24473. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24474. * @returns the view count
  24475. */
  24476. getViewCount(): number;
  24477. }
  24478. }
  24479. declare module "babylonjs/Misc/guid" {
  24480. /**
  24481. * Class used to manipulate GUIDs
  24482. */
  24483. export class GUID {
  24484. /**
  24485. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24486. * Be aware Math.random() could cause collisions, but:
  24487. * "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"
  24488. * @returns a pseudo random id
  24489. */
  24490. static RandomId(): string;
  24491. }
  24492. }
  24493. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24494. import { Nullable } from "babylonjs/types";
  24495. import { Scene } from "babylonjs/scene";
  24496. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24497. import { Material } from "babylonjs/Materials/material";
  24498. import { Effect } from "babylonjs/Materials/effect";
  24499. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24500. /**
  24501. * Options to be used when creating a shadow depth material
  24502. */
  24503. export interface IIOptionShadowDepthMaterial {
  24504. /** Variables in the vertex shader code that need to have their names remapped.
  24505. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24506. * "var_name" should be either: worldPos or vNormalW
  24507. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24508. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24509. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24510. */
  24511. remappedVariables?: string[];
  24512. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24513. standalone?: boolean;
  24514. }
  24515. /**
  24516. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24517. */
  24518. export class ShadowDepthWrapper {
  24519. private _scene;
  24520. private _options?;
  24521. private _baseMaterial;
  24522. private _onEffectCreatedObserver;
  24523. private _subMeshToEffect;
  24524. private _subMeshToDepthEffect;
  24525. private _meshes;
  24526. /** @hidden */
  24527. _matriceNames: any;
  24528. /** Gets the standalone status of the wrapper */
  24529. get standalone(): boolean;
  24530. /** Gets the base material the wrapper is built upon */
  24531. get baseMaterial(): Material;
  24532. /**
  24533. * Instantiate a new shadow depth wrapper.
  24534. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24535. * generate the shadow depth map. For more information, please refer to the documentation:
  24536. * https://doc.babylonjs.com/babylon101/shadows
  24537. * @param baseMaterial Material to wrap
  24538. * @param scene Define the scene the material belongs to
  24539. * @param options Options used to create the wrapper
  24540. */
  24541. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24542. /**
  24543. * Gets the effect to use to generate the depth map
  24544. * @param subMesh subMesh to get the effect for
  24545. * @param shadowGenerator shadow generator to get the effect for
  24546. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24547. */
  24548. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24549. /**
  24550. * Specifies that the submesh is ready to be used for depth rendering
  24551. * @param subMesh submesh to check
  24552. * @param defines the list of defines to take into account when checking the effect
  24553. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24554. * @param useInstances specifies that instances should be used
  24555. * @returns a boolean indicating that the submesh is ready or not
  24556. */
  24557. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24558. /**
  24559. * Disposes the resources
  24560. */
  24561. dispose(): void;
  24562. private _makeEffect;
  24563. }
  24564. }
  24565. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24566. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24567. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24568. import { Nullable } from "babylonjs/types";
  24569. module "babylonjs/Engines/thinEngine" {
  24570. interface ThinEngine {
  24571. /**
  24572. * Unbind a list of render target textures from the webGL context
  24573. * This is used only when drawBuffer extension or webGL2 are active
  24574. * @param textures defines the render target textures to unbind
  24575. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24576. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24577. */
  24578. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24579. /**
  24580. * Create a multi render target texture
  24581. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24582. * @param size defines the size of the texture
  24583. * @param options defines the creation options
  24584. * @returns the cube texture as an InternalTexture
  24585. */
  24586. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24587. /**
  24588. * Update the sample count for a given multiple render target texture
  24589. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24590. * @param textures defines the textures to update
  24591. * @param samples defines the sample count to set
  24592. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24593. */
  24594. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24595. /**
  24596. * Select a subsets of attachments to draw to.
  24597. * @param attachments gl attachments
  24598. */
  24599. bindAttachments(attachments: number[]): void;
  24600. }
  24601. }
  24602. }
  24603. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24604. import { Scene } from "babylonjs/scene";
  24605. import { Engine } from "babylonjs/Engines/engine";
  24606. import { Texture } from "babylonjs/Materials/Textures/texture";
  24607. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24608. import "babylonjs/Engines/Extensions/engine.multiRender";
  24609. /**
  24610. * Creation options of the multi render target texture.
  24611. */
  24612. export interface IMultiRenderTargetOptions {
  24613. /**
  24614. * Define if the texture needs to create mip maps after render.
  24615. */
  24616. generateMipMaps?: boolean;
  24617. /**
  24618. * Define the types of all the draw buffers we want to create
  24619. */
  24620. types?: number[];
  24621. /**
  24622. * Define the sampling modes of all the draw buffers we want to create
  24623. */
  24624. samplingModes?: number[];
  24625. /**
  24626. * Define if a depth buffer is required
  24627. */
  24628. generateDepthBuffer?: boolean;
  24629. /**
  24630. * Define if a stencil buffer is required
  24631. */
  24632. generateStencilBuffer?: boolean;
  24633. /**
  24634. * Define if a depth texture is required instead of a depth buffer
  24635. */
  24636. generateDepthTexture?: boolean;
  24637. /**
  24638. * Define the number of desired draw buffers
  24639. */
  24640. textureCount?: number;
  24641. /**
  24642. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24643. */
  24644. doNotChangeAspectRatio?: boolean;
  24645. /**
  24646. * Define the default type of the buffers we are creating
  24647. */
  24648. defaultType?: number;
  24649. }
  24650. /**
  24651. * A multi render target, like a render target provides the ability to render to a texture.
  24652. * Unlike the render target, it can render to several draw buffers in one draw.
  24653. * This is specially interesting in deferred rendering or for any effects requiring more than
  24654. * just one color from a single pass.
  24655. */
  24656. export class MultiRenderTarget extends RenderTargetTexture {
  24657. private _internalTextures;
  24658. private _textures;
  24659. private _multiRenderTargetOptions;
  24660. private _count;
  24661. /**
  24662. * Get if draw buffers are currently supported by the used hardware and browser.
  24663. */
  24664. get isSupported(): boolean;
  24665. /**
  24666. * Get the list of textures generated by the multi render target.
  24667. */
  24668. get textures(): Texture[];
  24669. /**
  24670. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24671. */
  24672. get count(): number;
  24673. /**
  24674. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24675. */
  24676. get depthTexture(): Texture;
  24677. /**
  24678. * Set the wrapping mode on U of all the textures we are rendering to.
  24679. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24680. */
  24681. set wrapU(wrap: number);
  24682. /**
  24683. * Set the wrapping mode on V of all the textures we are rendering to.
  24684. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24685. */
  24686. set wrapV(wrap: number);
  24687. /**
  24688. * Instantiate a new multi render target texture.
  24689. * A multi render target, like a render target provides the ability to render to a texture.
  24690. * Unlike the render target, it can render to several draw buffers in one draw.
  24691. * This is specially interesting in deferred rendering or for any effects requiring more than
  24692. * just one color from a single pass.
  24693. * @param name Define the name of the texture
  24694. * @param size Define the size of the buffers to render to
  24695. * @param count Define the number of target we are rendering into
  24696. * @param scene Define the scene the texture belongs to
  24697. * @param options Define the options used to create the multi render target
  24698. */
  24699. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24700. /** @hidden */
  24701. _rebuild(): void;
  24702. private _createInternalTextures;
  24703. private _createTextures;
  24704. /**
  24705. * Define the number of samples used if MSAA is enabled.
  24706. */
  24707. get samples(): number;
  24708. set samples(value: number);
  24709. /**
  24710. * Resize all the textures in the multi render target.
  24711. * Be carrefull as it will recreate all the data in the new texture.
  24712. * @param size Define the new size
  24713. */
  24714. resize(size: any): void;
  24715. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24716. /**
  24717. * Dispose the render targets and their associated resources
  24718. */
  24719. dispose(): void;
  24720. /**
  24721. * Release all the underlying texture used as draw buffers.
  24722. */
  24723. releaseInternalTextures(): void;
  24724. }
  24725. }
  24726. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24727. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24728. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24729. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24730. /** @hidden */
  24731. export var imageProcessingPixelShader: {
  24732. name: string;
  24733. shader: string;
  24734. };
  24735. }
  24736. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24737. import { Nullable } from "babylonjs/types";
  24738. import { Color4 } from "babylonjs/Maths/math.color";
  24739. import { Camera } from "babylonjs/Cameras/camera";
  24740. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24741. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24742. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24743. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24744. import { Engine } from "babylonjs/Engines/engine";
  24745. import "babylonjs/Shaders/imageProcessing.fragment";
  24746. import "babylonjs/Shaders/postprocess.vertex";
  24747. /**
  24748. * ImageProcessingPostProcess
  24749. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24750. */
  24751. export class ImageProcessingPostProcess extends PostProcess {
  24752. /**
  24753. * Default configuration related to image processing available in the PBR Material.
  24754. */
  24755. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24756. /**
  24757. * Gets the image processing configuration used either in this material.
  24758. */
  24759. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24760. /**
  24761. * Sets the Default image processing configuration used either in the this material.
  24762. *
  24763. * If sets to null, the scene one is in use.
  24764. */
  24765. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24766. /**
  24767. * Keep track of the image processing observer to allow dispose and replace.
  24768. */
  24769. private _imageProcessingObserver;
  24770. /**
  24771. * Attaches a new image processing configuration to the PBR Material.
  24772. * @param configuration
  24773. */
  24774. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24775. /**
  24776. * If the post process is supported.
  24777. */
  24778. get isSupported(): boolean;
  24779. /**
  24780. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24781. */
  24782. get colorCurves(): Nullable<ColorCurves>;
  24783. /**
  24784. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24785. */
  24786. set colorCurves(value: Nullable<ColorCurves>);
  24787. /**
  24788. * Gets wether the color curves effect is enabled.
  24789. */
  24790. get colorCurvesEnabled(): boolean;
  24791. /**
  24792. * Sets wether the color curves effect is enabled.
  24793. */
  24794. set colorCurvesEnabled(value: boolean);
  24795. /**
  24796. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24797. */
  24798. get colorGradingTexture(): Nullable<BaseTexture>;
  24799. /**
  24800. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24801. */
  24802. set colorGradingTexture(value: Nullable<BaseTexture>);
  24803. /**
  24804. * Gets wether the color grading effect is enabled.
  24805. */
  24806. get colorGradingEnabled(): boolean;
  24807. /**
  24808. * Gets wether the color grading effect is enabled.
  24809. */
  24810. set colorGradingEnabled(value: boolean);
  24811. /**
  24812. * Gets exposure used in the effect.
  24813. */
  24814. get exposure(): number;
  24815. /**
  24816. * Sets exposure used in the effect.
  24817. */
  24818. set exposure(value: number);
  24819. /**
  24820. * Gets wether tonemapping is enabled or not.
  24821. */
  24822. get toneMappingEnabled(): boolean;
  24823. /**
  24824. * Sets wether tonemapping is enabled or not
  24825. */
  24826. set toneMappingEnabled(value: boolean);
  24827. /**
  24828. * Gets the type of tone mapping effect.
  24829. */
  24830. get toneMappingType(): number;
  24831. /**
  24832. * Sets the type of tone mapping effect.
  24833. */
  24834. set toneMappingType(value: number);
  24835. /**
  24836. * Gets contrast used in the effect.
  24837. */
  24838. get contrast(): number;
  24839. /**
  24840. * Sets contrast used in the effect.
  24841. */
  24842. set contrast(value: number);
  24843. /**
  24844. * Gets Vignette stretch size.
  24845. */
  24846. get vignetteStretch(): number;
  24847. /**
  24848. * Sets Vignette stretch size.
  24849. */
  24850. set vignetteStretch(value: number);
  24851. /**
  24852. * Gets Vignette centre X Offset.
  24853. */
  24854. get vignetteCentreX(): number;
  24855. /**
  24856. * Sets Vignette centre X Offset.
  24857. */
  24858. set vignetteCentreX(value: number);
  24859. /**
  24860. * Gets Vignette centre Y Offset.
  24861. */
  24862. get vignetteCentreY(): number;
  24863. /**
  24864. * Sets Vignette centre Y Offset.
  24865. */
  24866. set vignetteCentreY(value: number);
  24867. /**
  24868. * Gets Vignette weight or intensity of the vignette effect.
  24869. */
  24870. get vignetteWeight(): number;
  24871. /**
  24872. * Sets Vignette weight or intensity of the vignette effect.
  24873. */
  24874. set vignetteWeight(value: number);
  24875. /**
  24876. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  24877. * if vignetteEnabled is set to true.
  24878. */
  24879. get vignetteColor(): Color4;
  24880. /**
  24881. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  24882. * if vignetteEnabled is set to true.
  24883. */
  24884. set vignetteColor(value: Color4);
  24885. /**
  24886. * Gets Camera field of view used by the Vignette effect.
  24887. */
  24888. get vignetteCameraFov(): number;
  24889. /**
  24890. * Sets Camera field of view used by the Vignette effect.
  24891. */
  24892. set vignetteCameraFov(value: number);
  24893. /**
  24894. * Gets the vignette blend mode allowing different kind of effect.
  24895. */
  24896. get vignetteBlendMode(): number;
  24897. /**
  24898. * Sets the vignette blend mode allowing different kind of effect.
  24899. */
  24900. set vignetteBlendMode(value: number);
  24901. /**
  24902. * Gets wether the vignette effect is enabled.
  24903. */
  24904. get vignetteEnabled(): boolean;
  24905. /**
  24906. * Sets wether the vignette effect is enabled.
  24907. */
  24908. set vignetteEnabled(value: boolean);
  24909. private _fromLinearSpace;
  24910. /**
  24911. * Gets wether the input of the processing is in Gamma or Linear Space.
  24912. */
  24913. get fromLinearSpace(): boolean;
  24914. /**
  24915. * Sets wether the input of the processing is in Gamma or Linear Space.
  24916. */
  24917. set fromLinearSpace(value: boolean);
  24918. /**
  24919. * Defines cache preventing GC.
  24920. */
  24921. private _defines;
  24922. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  24923. /**
  24924. * "ImageProcessingPostProcess"
  24925. * @returns "ImageProcessingPostProcess"
  24926. */
  24927. getClassName(): string;
  24928. /**
  24929. * @hidden
  24930. */
  24931. _updateParameters(): void;
  24932. dispose(camera?: Camera): void;
  24933. }
  24934. }
  24935. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  24936. /** @hidden */
  24937. export var fibonacci: {
  24938. name: string;
  24939. shader: string;
  24940. };
  24941. }
  24942. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  24943. /** @hidden */
  24944. export var subSurfaceScatteringFunctions: {
  24945. name: string;
  24946. shader: string;
  24947. };
  24948. }
  24949. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  24950. /** @hidden */
  24951. export var diffusionProfile: {
  24952. name: string;
  24953. shader: string;
  24954. };
  24955. }
  24956. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  24957. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  24958. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24959. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  24960. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  24961. /** @hidden */
  24962. export var subSurfaceScatteringPixelShader: {
  24963. name: string;
  24964. shader: string;
  24965. };
  24966. }
  24967. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  24968. import { Nullable } from "babylonjs/types";
  24969. import { Camera } from "babylonjs/Cameras/camera";
  24970. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24971. import { Engine } from "babylonjs/Engines/engine";
  24972. import { Scene } from "babylonjs/scene";
  24973. import "babylonjs/Shaders/imageProcessing.fragment";
  24974. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  24975. import "babylonjs/Shaders/postprocess.vertex";
  24976. /**
  24977. * Sub surface scattering post process
  24978. */
  24979. export class SubSurfaceScatteringPostProcess extends PostProcess {
  24980. /** @hidden */
  24981. texelWidth: number;
  24982. /** @hidden */
  24983. texelHeight: number;
  24984. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  24985. }
  24986. }
  24987. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  24988. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24989. /**
  24990. * Interface for defining prepass effects in the prepass post-process pipeline
  24991. */
  24992. export interface PrePassEffectConfiguration {
  24993. /**
  24994. * Post process to attach for this effect
  24995. */
  24996. postProcess: PostProcess;
  24997. /**
  24998. * Is the effect enabled
  24999. */
  25000. enabled: boolean;
  25001. /**
  25002. * Disposes the effect configuration
  25003. */
  25004. dispose(): void;
  25005. /**
  25006. * Disposes the effect configuration
  25007. */
  25008. createPostProcess: () => PostProcess;
  25009. }
  25010. }
  25011. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25012. import { Scene } from "babylonjs/scene";
  25013. import { Color3 } from "babylonjs/Maths/math.color";
  25014. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25015. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25016. /**
  25017. * Contains all parameters needed for the prepass to perform
  25018. * screen space subsurface scattering
  25019. */
  25020. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25021. private _ssDiffusionS;
  25022. private _ssFilterRadii;
  25023. private _ssDiffusionD;
  25024. /**
  25025. * Post process to attach for screen space subsurface scattering
  25026. */
  25027. postProcess: SubSurfaceScatteringPostProcess;
  25028. /**
  25029. * Diffusion profile color for subsurface scattering
  25030. */
  25031. get ssDiffusionS(): number[];
  25032. /**
  25033. * Diffusion profile max color channel value for subsurface scattering
  25034. */
  25035. get ssDiffusionD(): number[];
  25036. /**
  25037. * Diffusion profile filter radius for subsurface scattering
  25038. */
  25039. get ssFilterRadii(): number[];
  25040. /**
  25041. * Is subsurface enabled
  25042. */
  25043. enabled: boolean;
  25044. /**
  25045. * Diffusion profile colors for subsurface scattering
  25046. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25047. * See ...
  25048. * Note that you can only store up to 5 of them
  25049. */
  25050. ssDiffusionProfileColors: Color3[];
  25051. /**
  25052. * Defines the ratio real world => scene units.
  25053. * Used for subsurface scattering
  25054. */
  25055. metersPerUnit: number;
  25056. private _scene;
  25057. /**
  25058. * Builds a subsurface configuration object
  25059. * @param scene The scene
  25060. */
  25061. constructor(scene: Scene);
  25062. /**
  25063. * Adds a new diffusion profile.
  25064. * Useful for more realistic subsurface scattering on diverse materials.
  25065. * @param color The color of the diffusion profile. Should be the average color of the material.
  25066. * @return The index of the diffusion profile for the material subsurface configuration
  25067. */
  25068. addDiffusionProfile(color: Color3): number;
  25069. /**
  25070. * Creates the sss post process
  25071. * @return The created post process
  25072. */
  25073. createPostProcess(): SubSurfaceScatteringPostProcess;
  25074. /**
  25075. * Deletes all diffusion profiles.
  25076. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25077. */
  25078. clearAllDiffusionProfiles(): void;
  25079. /**
  25080. * Disposes this object
  25081. */
  25082. dispose(): void;
  25083. /**
  25084. * @hidden
  25085. * https://zero-radiance.github.io/post/sampling-diffusion/
  25086. *
  25087. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25088. * ------------------------------------------------------------------------------------
  25089. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25090. * PDF[r, phi, s] = r * R[r, phi, s]
  25091. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25092. * ------------------------------------------------------------------------------------
  25093. * We importance sample the color channel with the widest scattering distance.
  25094. */
  25095. getDiffusionProfileParameters(color: Color3): number;
  25096. /**
  25097. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25098. * 'u' is the random number (the value of the CDF): [0, 1).
  25099. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25100. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25101. */
  25102. private _sampleBurleyDiffusionProfile;
  25103. }
  25104. }
  25105. declare module "babylonjs/Rendering/prePassRenderer" {
  25106. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25107. import { Scene } from "babylonjs/scene";
  25108. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25109. import { Effect } from "babylonjs/Materials/effect";
  25110. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25111. /**
  25112. * Renders a pre pass of the scene
  25113. * This means every mesh in the scene will be rendered to a render target texture
  25114. * And then this texture will be composited to the rendering canvas with post processes
  25115. * It is necessary for effects like subsurface scattering or deferred shading
  25116. */
  25117. export class PrePassRenderer {
  25118. /** @hidden */
  25119. static _SceneComponentInitialization: (scene: Scene) => void;
  25120. private _scene;
  25121. private _engine;
  25122. private _isDirty;
  25123. /**
  25124. * Number of textures in the multi render target texture where the scene is directly rendered
  25125. */
  25126. readonly mrtCount: number;
  25127. /**
  25128. * The render target where the scene is directly rendered
  25129. */
  25130. prePassRT: MultiRenderTarget;
  25131. private _mrtTypes;
  25132. private _multiRenderAttachments;
  25133. private _defaultAttachments;
  25134. private _clearAttachments;
  25135. private _postProcesses;
  25136. private readonly _clearColor;
  25137. /**
  25138. * Image processing post process for composition
  25139. */
  25140. imageProcessingPostProcess: ImageProcessingPostProcess;
  25141. /**
  25142. * Configuration for sub surface scattering post process
  25143. */
  25144. subSurfaceConfiguration: SubSurfaceConfiguration;
  25145. /**
  25146. * Should materials render their geometry on the MRT
  25147. */
  25148. materialsShouldRenderGeometry: boolean;
  25149. /**
  25150. * Should materials render the irradiance information on the MRT
  25151. */
  25152. materialsShouldRenderIrradiance: boolean;
  25153. private _enabled;
  25154. /**
  25155. * Indicates if the prepass is enabled
  25156. */
  25157. get enabled(): boolean;
  25158. /**
  25159. * How many samples are used for MSAA of the scene render target
  25160. */
  25161. get samples(): number;
  25162. set samples(n: number);
  25163. /**
  25164. * Instanciates a prepass renderer
  25165. * @param scene The scene
  25166. */
  25167. constructor(scene: Scene);
  25168. private _initializeAttachments;
  25169. private _createCompositionEffect;
  25170. /**
  25171. * Indicates if rendering a prepass is supported
  25172. */
  25173. get isSupported(): boolean;
  25174. /**
  25175. * Sets the proper output textures to draw in the engine.
  25176. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25177. */
  25178. bindAttachmentsForEffect(effect: Effect): void;
  25179. /**
  25180. * @hidden
  25181. */
  25182. _beforeCameraDraw(): void;
  25183. /**
  25184. * @hidden
  25185. */
  25186. _afterCameraDraw(): void;
  25187. private _checkRTSize;
  25188. private _bindFrameBuffer;
  25189. /**
  25190. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25191. */
  25192. clear(): void;
  25193. private _setState;
  25194. private _enable;
  25195. private _disable;
  25196. private _resetPostProcessChain;
  25197. private _bindPostProcessChain;
  25198. /**
  25199. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25200. */
  25201. markAsDirty(): void;
  25202. private _update;
  25203. /**
  25204. * Disposes the prepass renderer.
  25205. */
  25206. dispose(): void;
  25207. }
  25208. }
  25209. declare module "babylonjs/Materials/material" {
  25210. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25211. import { SmartArray } from "babylonjs/Misc/smartArray";
  25212. import { Observable } from "babylonjs/Misc/observable";
  25213. import { Nullable } from "babylonjs/types";
  25214. import { Scene } from "babylonjs/scene";
  25215. import { Matrix } from "babylonjs/Maths/math.vector";
  25216. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25217. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25218. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25219. import { Effect } from "babylonjs/Materials/effect";
  25220. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25221. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25222. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25223. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25224. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25225. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25226. import { Mesh } from "babylonjs/Meshes/mesh";
  25227. import { Animation } from "babylonjs/Animations/animation";
  25228. /**
  25229. * Options for compiling materials.
  25230. */
  25231. export interface IMaterialCompilationOptions {
  25232. /**
  25233. * Defines whether clip planes are enabled.
  25234. */
  25235. clipPlane: boolean;
  25236. /**
  25237. * Defines whether instances are enabled.
  25238. */
  25239. useInstances: boolean;
  25240. }
  25241. /**
  25242. * Options passed when calling customShaderNameResolve
  25243. */
  25244. export interface ICustomShaderNameResolveOptions {
  25245. /**
  25246. * 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
  25247. */
  25248. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25249. }
  25250. /**
  25251. * Base class for the main features of a material in Babylon.js
  25252. */
  25253. export class Material implements IAnimatable {
  25254. /**
  25255. * Returns the triangle fill mode
  25256. */
  25257. static readonly TriangleFillMode: number;
  25258. /**
  25259. * Returns the wireframe mode
  25260. */
  25261. static readonly WireFrameFillMode: number;
  25262. /**
  25263. * Returns the point fill mode
  25264. */
  25265. static readonly PointFillMode: number;
  25266. /**
  25267. * Returns the point list draw mode
  25268. */
  25269. static readonly PointListDrawMode: number;
  25270. /**
  25271. * Returns the line list draw mode
  25272. */
  25273. static readonly LineListDrawMode: number;
  25274. /**
  25275. * Returns the line loop draw mode
  25276. */
  25277. static readonly LineLoopDrawMode: number;
  25278. /**
  25279. * Returns the line strip draw mode
  25280. */
  25281. static readonly LineStripDrawMode: number;
  25282. /**
  25283. * Returns the triangle strip draw mode
  25284. */
  25285. static readonly TriangleStripDrawMode: number;
  25286. /**
  25287. * Returns the triangle fan draw mode
  25288. */
  25289. static readonly TriangleFanDrawMode: number;
  25290. /**
  25291. * Stores the clock-wise side orientation
  25292. */
  25293. static readonly ClockWiseSideOrientation: number;
  25294. /**
  25295. * Stores the counter clock-wise side orientation
  25296. */
  25297. static readonly CounterClockWiseSideOrientation: number;
  25298. /**
  25299. * The dirty texture flag value
  25300. */
  25301. static readonly TextureDirtyFlag: number;
  25302. /**
  25303. * The dirty light flag value
  25304. */
  25305. static readonly LightDirtyFlag: number;
  25306. /**
  25307. * The dirty fresnel flag value
  25308. */
  25309. static readonly FresnelDirtyFlag: number;
  25310. /**
  25311. * The dirty attribute flag value
  25312. */
  25313. static readonly AttributesDirtyFlag: number;
  25314. /**
  25315. * The dirty misc flag value
  25316. */
  25317. static readonly MiscDirtyFlag: number;
  25318. /**
  25319. * The all dirty flag value
  25320. */
  25321. static readonly AllDirtyFlag: number;
  25322. /**
  25323. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25324. */
  25325. static readonly MATERIAL_OPAQUE: number;
  25326. /**
  25327. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25328. */
  25329. static readonly MATERIAL_ALPHATEST: number;
  25330. /**
  25331. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25332. */
  25333. static readonly MATERIAL_ALPHABLEND: number;
  25334. /**
  25335. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25336. * They are also discarded below the alpha cutoff threshold to improve performances.
  25337. */
  25338. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25339. /**
  25340. * The Whiteout method is used to blend normals.
  25341. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25342. */
  25343. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25344. /**
  25345. * The Reoriented Normal Mapping method is used to blend normals.
  25346. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25347. */
  25348. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25349. /**
  25350. * Custom callback helping to override the default shader used in the material.
  25351. */
  25352. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25353. /**
  25354. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25355. */
  25356. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25357. /**
  25358. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25359. * This means that the material can keep using a previous shader while a new one is being compiled.
  25360. * This is mostly used when shader parallel compilation is supported (true by default)
  25361. */
  25362. allowShaderHotSwapping: boolean;
  25363. /**
  25364. * The ID of the material
  25365. */
  25366. id: string;
  25367. /**
  25368. * Gets or sets the unique id of the material
  25369. */
  25370. uniqueId: number;
  25371. /**
  25372. * The name of the material
  25373. */
  25374. name: string;
  25375. /**
  25376. * Gets or sets user defined metadata
  25377. */
  25378. metadata: any;
  25379. /**
  25380. * For internal use only. Please do not use.
  25381. */
  25382. reservedDataStore: any;
  25383. /**
  25384. * Specifies if the ready state should be checked on each call
  25385. */
  25386. checkReadyOnEveryCall: boolean;
  25387. /**
  25388. * Specifies if the ready state should be checked once
  25389. */
  25390. checkReadyOnlyOnce: boolean;
  25391. /**
  25392. * The state of the material
  25393. */
  25394. state: string;
  25395. /**
  25396. * If the material can be rendered to several textures with MRT extension
  25397. */
  25398. get canRenderToMRT(): boolean;
  25399. /**
  25400. * The alpha value of the material
  25401. */
  25402. protected _alpha: number;
  25403. /**
  25404. * List of inspectable custom properties (used by the Inspector)
  25405. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25406. */
  25407. inspectableCustomProperties: IInspectable[];
  25408. /**
  25409. * Sets the alpha value of the material
  25410. */
  25411. set alpha(value: number);
  25412. /**
  25413. * Gets the alpha value of the material
  25414. */
  25415. get alpha(): number;
  25416. /**
  25417. * Specifies if back face culling is enabled
  25418. */
  25419. protected _backFaceCulling: boolean;
  25420. /**
  25421. * Sets the back-face culling state
  25422. */
  25423. set backFaceCulling(value: boolean);
  25424. /**
  25425. * Gets the back-face culling state
  25426. */
  25427. get backFaceCulling(): boolean;
  25428. /**
  25429. * Stores the value for side orientation
  25430. */
  25431. sideOrientation: number;
  25432. /**
  25433. * Callback triggered when the material is compiled
  25434. */
  25435. onCompiled: Nullable<(effect: Effect) => void>;
  25436. /**
  25437. * Callback triggered when an error occurs
  25438. */
  25439. onError: Nullable<(effect: Effect, errors: string) => void>;
  25440. /**
  25441. * Callback triggered to get the render target textures
  25442. */
  25443. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25444. /**
  25445. * Gets a boolean indicating that current material needs to register RTT
  25446. */
  25447. get hasRenderTargetTextures(): boolean;
  25448. /**
  25449. * Specifies if the material should be serialized
  25450. */
  25451. doNotSerialize: boolean;
  25452. /**
  25453. * @hidden
  25454. */
  25455. _storeEffectOnSubMeshes: boolean;
  25456. /**
  25457. * Stores the animations for the material
  25458. */
  25459. animations: Nullable<Array<Animation>>;
  25460. /**
  25461. * An event triggered when the material is disposed
  25462. */
  25463. onDisposeObservable: Observable<Material>;
  25464. /**
  25465. * An observer which watches for dispose events
  25466. */
  25467. private _onDisposeObserver;
  25468. private _onUnBindObservable;
  25469. /**
  25470. * Called during a dispose event
  25471. */
  25472. set onDispose(callback: () => void);
  25473. private _onBindObservable;
  25474. /**
  25475. * An event triggered when the material is bound
  25476. */
  25477. get onBindObservable(): Observable<AbstractMesh>;
  25478. /**
  25479. * An observer which watches for bind events
  25480. */
  25481. private _onBindObserver;
  25482. /**
  25483. * Called during a bind event
  25484. */
  25485. set onBind(callback: (Mesh: AbstractMesh) => void);
  25486. /**
  25487. * An event triggered when the material is unbound
  25488. */
  25489. get onUnBindObservable(): Observable<Material>;
  25490. protected _onEffectCreatedObservable: Nullable<Observable<{
  25491. effect: Effect;
  25492. subMesh: Nullable<SubMesh>;
  25493. }>>;
  25494. /**
  25495. * An event triggered when the effect is (re)created
  25496. */
  25497. get onEffectCreatedObservable(): Observable<{
  25498. effect: Effect;
  25499. subMesh: Nullable<SubMesh>;
  25500. }>;
  25501. /**
  25502. * Stores the value of the alpha mode
  25503. */
  25504. private _alphaMode;
  25505. /**
  25506. * Sets the value of the alpha mode.
  25507. *
  25508. * | Value | Type | Description |
  25509. * | --- | --- | --- |
  25510. * | 0 | ALPHA_DISABLE | |
  25511. * | 1 | ALPHA_ADD | |
  25512. * | 2 | ALPHA_COMBINE | |
  25513. * | 3 | ALPHA_SUBTRACT | |
  25514. * | 4 | ALPHA_MULTIPLY | |
  25515. * | 5 | ALPHA_MAXIMIZED | |
  25516. * | 6 | ALPHA_ONEONE | |
  25517. * | 7 | ALPHA_PREMULTIPLIED | |
  25518. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25519. * | 9 | ALPHA_INTERPOLATE | |
  25520. * | 10 | ALPHA_SCREENMODE | |
  25521. *
  25522. */
  25523. set alphaMode(value: number);
  25524. /**
  25525. * Gets the value of the alpha mode
  25526. */
  25527. get alphaMode(): number;
  25528. /**
  25529. * Stores the state of the need depth pre-pass value
  25530. */
  25531. private _needDepthPrePass;
  25532. /**
  25533. * Sets the need depth pre-pass value
  25534. */
  25535. set needDepthPrePass(value: boolean);
  25536. /**
  25537. * Gets the depth pre-pass value
  25538. */
  25539. get needDepthPrePass(): boolean;
  25540. /**
  25541. * Specifies if depth writing should be disabled
  25542. */
  25543. disableDepthWrite: boolean;
  25544. /**
  25545. * Specifies if color writing should be disabled
  25546. */
  25547. disableColorWrite: boolean;
  25548. /**
  25549. * Specifies if depth writing should be forced
  25550. */
  25551. forceDepthWrite: boolean;
  25552. /**
  25553. * Specifies the depth function that should be used. 0 means the default engine function
  25554. */
  25555. depthFunction: number;
  25556. /**
  25557. * Specifies if there should be a separate pass for culling
  25558. */
  25559. separateCullingPass: boolean;
  25560. /**
  25561. * Stores the state specifing if fog should be enabled
  25562. */
  25563. private _fogEnabled;
  25564. /**
  25565. * Sets the state for enabling fog
  25566. */
  25567. set fogEnabled(value: boolean);
  25568. /**
  25569. * Gets the value of the fog enabled state
  25570. */
  25571. get fogEnabled(): boolean;
  25572. /**
  25573. * Stores the size of points
  25574. */
  25575. pointSize: number;
  25576. /**
  25577. * Stores the z offset value
  25578. */
  25579. zOffset: number;
  25580. get wireframe(): boolean;
  25581. /**
  25582. * Sets the state of wireframe mode
  25583. */
  25584. set wireframe(value: boolean);
  25585. /**
  25586. * Gets the value specifying if point clouds are enabled
  25587. */
  25588. get pointsCloud(): boolean;
  25589. /**
  25590. * Sets the state of point cloud mode
  25591. */
  25592. set pointsCloud(value: boolean);
  25593. /**
  25594. * Gets the material fill mode
  25595. */
  25596. get fillMode(): number;
  25597. /**
  25598. * Sets the material fill mode
  25599. */
  25600. set fillMode(value: number);
  25601. /**
  25602. * @hidden
  25603. * Stores the effects for the material
  25604. */
  25605. _effect: Nullable<Effect>;
  25606. /**
  25607. * Specifies if uniform buffers should be used
  25608. */
  25609. private _useUBO;
  25610. /**
  25611. * Stores a reference to the scene
  25612. */
  25613. private _scene;
  25614. /**
  25615. * Stores the fill mode state
  25616. */
  25617. private _fillMode;
  25618. /**
  25619. * Specifies if the depth write state should be cached
  25620. */
  25621. private _cachedDepthWriteState;
  25622. /**
  25623. * Specifies if the color write state should be cached
  25624. */
  25625. private _cachedColorWriteState;
  25626. /**
  25627. * Specifies if the depth function state should be cached
  25628. */
  25629. private _cachedDepthFunctionState;
  25630. /**
  25631. * Stores the uniform buffer
  25632. */
  25633. protected _uniformBuffer: UniformBuffer;
  25634. /** @hidden */
  25635. _indexInSceneMaterialArray: number;
  25636. /** @hidden */
  25637. meshMap: Nullable<{
  25638. [id: string]: AbstractMesh | undefined;
  25639. }>;
  25640. /**
  25641. * Creates a material instance
  25642. * @param name defines the name of the material
  25643. * @param scene defines the scene to reference
  25644. * @param doNotAdd specifies if the material should be added to the scene
  25645. */
  25646. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25647. /**
  25648. * Returns a string representation of the current material
  25649. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25650. * @returns a string with material information
  25651. */
  25652. toString(fullDetails?: boolean): string;
  25653. /**
  25654. * Gets the class name of the material
  25655. * @returns a string with the class name of the material
  25656. */
  25657. getClassName(): string;
  25658. /**
  25659. * Specifies if updates for the material been locked
  25660. */
  25661. get isFrozen(): boolean;
  25662. /**
  25663. * Locks updates for the material
  25664. */
  25665. freeze(): void;
  25666. /**
  25667. * Unlocks updates for the material
  25668. */
  25669. unfreeze(): void;
  25670. /**
  25671. * Specifies if the material is ready to be used
  25672. * @param mesh defines the mesh to check
  25673. * @param useInstances specifies if instances should be used
  25674. * @returns a boolean indicating if the material is ready to be used
  25675. */
  25676. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25677. /**
  25678. * Specifies that the submesh is ready to be used
  25679. * @param mesh defines the mesh to check
  25680. * @param subMesh defines which submesh to check
  25681. * @param useInstances specifies that instances should be used
  25682. * @returns a boolean indicating that the submesh is ready or not
  25683. */
  25684. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25685. /**
  25686. * Returns the material effect
  25687. * @returns the effect associated with the material
  25688. */
  25689. getEffect(): Nullable<Effect>;
  25690. /**
  25691. * Returns the current scene
  25692. * @returns a Scene
  25693. */
  25694. getScene(): Scene;
  25695. /**
  25696. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25697. */
  25698. protected _forceAlphaTest: boolean;
  25699. /**
  25700. * The transparency mode of the material.
  25701. */
  25702. protected _transparencyMode: Nullable<number>;
  25703. /**
  25704. * Gets the current transparency mode.
  25705. */
  25706. get transparencyMode(): Nullable<number>;
  25707. /**
  25708. * Sets the transparency mode of the material.
  25709. *
  25710. * | Value | Type | Description |
  25711. * | ----- | ----------------------------------- | ----------- |
  25712. * | 0 | OPAQUE | |
  25713. * | 1 | ALPHATEST | |
  25714. * | 2 | ALPHABLEND | |
  25715. * | 3 | ALPHATESTANDBLEND | |
  25716. *
  25717. */
  25718. set transparencyMode(value: Nullable<number>);
  25719. /**
  25720. * Returns true if alpha blending should be disabled.
  25721. */
  25722. protected get _disableAlphaBlending(): boolean;
  25723. /**
  25724. * Specifies whether or not this material should be rendered in alpha blend mode.
  25725. * @returns a boolean specifying if alpha blending is needed
  25726. */
  25727. needAlphaBlending(): boolean;
  25728. /**
  25729. * Specifies if the mesh will require alpha blending
  25730. * @param mesh defines the mesh to check
  25731. * @returns a boolean specifying if alpha blending is needed for the mesh
  25732. */
  25733. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25734. /**
  25735. * Specifies whether or not this material should be rendered in alpha test mode.
  25736. * @returns a boolean specifying if an alpha test is needed.
  25737. */
  25738. needAlphaTesting(): boolean;
  25739. /**
  25740. * Specifies if material alpha testing should be turned on for the mesh
  25741. * @param mesh defines the mesh to check
  25742. */
  25743. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25744. /**
  25745. * Gets the texture used for the alpha test
  25746. * @returns the texture to use for alpha testing
  25747. */
  25748. getAlphaTestTexture(): Nullable<BaseTexture>;
  25749. /**
  25750. * Marks the material to indicate that it needs to be re-calculated
  25751. */
  25752. markDirty(): void;
  25753. /** @hidden */
  25754. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25755. /**
  25756. * Binds the material to the mesh
  25757. * @param world defines the world transformation matrix
  25758. * @param mesh defines the mesh to bind the material to
  25759. */
  25760. bind(world: Matrix, mesh?: Mesh): void;
  25761. /**
  25762. * Binds the submesh to the material
  25763. * @param world defines the world transformation matrix
  25764. * @param mesh defines the mesh containing the submesh
  25765. * @param subMesh defines the submesh to bind the material to
  25766. */
  25767. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25768. /**
  25769. * Binds the world matrix to the material
  25770. * @param world defines the world transformation matrix
  25771. */
  25772. bindOnlyWorldMatrix(world: Matrix): void;
  25773. /**
  25774. * Binds the scene's uniform buffer to the effect.
  25775. * @param effect defines the effect to bind to the scene uniform buffer
  25776. * @param sceneUbo defines the uniform buffer storing scene data
  25777. */
  25778. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25779. /**
  25780. * Binds the view matrix to the effect
  25781. * @param effect defines the effect to bind the view matrix to
  25782. */
  25783. bindView(effect: Effect): void;
  25784. /**
  25785. * Binds the view projection matrix to the effect
  25786. * @param effect defines the effect to bind the view projection matrix to
  25787. */
  25788. bindViewProjection(effect: Effect): void;
  25789. /**
  25790. * Processes to execute after binding the material to a mesh
  25791. * @param mesh defines the rendered mesh
  25792. */
  25793. protected _afterBind(mesh?: Mesh): void;
  25794. /**
  25795. * Unbinds the material from the mesh
  25796. */
  25797. unbind(): void;
  25798. /**
  25799. * Gets the active textures from the material
  25800. * @returns an array of textures
  25801. */
  25802. getActiveTextures(): BaseTexture[];
  25803. /**
  25804. * Specifies if the material uses a texture
  25805. * @param texture defines the texture to check against the material
  25806. * @returns a boolean specifying if the material uses the texture
  25807. */
  25808. hasTexture(texture: BaseTexture): boolean;
  25809. /**
  25810. * Makes a duplicate of the material, and gives it a new name
  25811. * @param name defines the new name for the duplicated material
  25812. * @returns the cloned material
  25813. */
  25814. clone(name: string): Nullable<Material>;
  25815. /**
  25816. * Gets the meshes bound to the material
  25817. * @returns an array of meshes bound to the material
  25818. */
  25819. getBindedMeshes(): AbstractMesh[];
  25820. /**
  25821. * Force shader compilation
  25822. * @param mesh defines the mesh associated with this material
  25823. * @param onCompiled defines a function to execute once the material is compiled
  25824. * @param options defines the options to configure the compilation
  25825. * @param onError defines a function to execute if the material fails compiling
  25826. */
  25827. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  25828. /**
  25829. * Force shader compilation
  25830. * @param mesh defines the mesh that will use this material
  25831. * @param options defines additional options for compiling the shaders
  25832. * @returns a promise that resolves when the compilation completes
  25833. */
  25834. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  25835. private static readonly _AllDirtyCallBack;
  25836. private static readonly _ImageProcessingDirtyCallBack;
  25837. private static readonly _TextureDirtyCallBack;
  25838. private static readonly _FresnelDirtyCallBack;
  25839. private static readonly _MiscDirtyCallBack;
  25840. private static readonly _LightsDirtyCallBack;
  25841. private static readonly _AttributeDirtyCallBack;
  25842. private static _FresnelAndMiscDirtyCallBack;
  25843. private static _TextureAndMiscDirtyCallBack;
  25844. private static readonly _DirtyCallbackArray;
  25845. private static readonly _RunDirtyCallBacks;
  25846. /**
  25847. * Marks a define in the material to indicate that it needs to be re-computed
  25848. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  25849. */
  25850. markAsDirty(flag: number): void;
  25851. /**
  25852. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  25853. * @param func defines a function which checks material defines against the submeshes
  25854. */
  25855. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  25856. /**
  25857. * Indicates that the scene should check if the rendering now needs a prepass
  25858. */
  25859. protected _markScenePrePassDirty(): void;
  25860. /**
  25861. * Indicates that we need to re-calculated for all submeshes
  25862. */
  25863. protected _markAllSubMeshesAsAllDirty(): void;
  25864. /**
  25865. * Indicates that image processing needs to be re-calculated for all submeshes
  25866. */
  25867. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  25868. /**
  25869. * Indicates that textures need to be re-calculated for all submeshes
  25870. */
  25871. protected _markAllSubMeshesAsTexturesDirty(): void;
  25872. /**
  25873. * Indicates that fresnel needs to be re-calculated for all submeshes
  25874. */
  25875. protected _markAllSubMeshesAsFresnelDirty(): void;
  25876. /**
  25877. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  25878. */
  25879. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  25880. /**
  25881. * Indicates that lights need to be re-calculated for all submeshes
  25882. */
  25883. protected _markAllSubMeshesAsLightsDirty(): void;
  25884. /**
  25885. * Indicates that attributes need to be re-calculated for all submeshes
  25886. */
  25887. protected _markAllSubMeshesAsAttributesDirty(): void;
  25888. /**
  25889. * Indicates that misc needs to be re-calculated for all submeshes
  25890. */
  25891. protected _markAllSubMeshesAsMiscDirty(): void;
  25892. /**
  25893. * Indicates that textures and misc need to be re-calculated for all submeshes
  25894. */
  25895. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  25896. /**
  25897. * Sets the required values to the prepass renderer.
  25898. * @param prePassRenderer defines the prepass renderer to setup.
  25899. * @returns true if the pre pass is needed.
  25900. */
  25901. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  25902. /**
  25903. * Disposes the material
  25904. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  25905. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  25906. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  25907. */
  25908. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  25909. /** @hidden */
  25910. private releaseVertexArrayObject;
  25911. /**
  25912. * Serializes this material
  25913. * @returns the serialized material object
  25914. */
  25915. serialize(): any;
  25916. /**
  25917. * Creates a material from parsed material data
  25918. * @param parsedMaterial defines parsed material data
  25919. * @param scene defines the hosting scene
  25920. * @param rootUrl defines the root URL to use to load textures
  25921. * @returns a new material
  25922. */
  25923. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  25924. }
  25925. }
  25926. declare module "babylonjs/Materials/multiMaterial" {
  25927. import { Nullable } from "babylonjs/types";
  25928. import { Scene } from "babylonjs/scene";
  25929. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25930. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25931. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25932. import { Material } from "babylonjs/Materials/material";
  25933. /**
  25934. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25935. * separate meshes. This can be use to improve performances.
  25936. * @see https://doc.babylonjs.com/how_to/multi_materials
  25937. */
  25938. export class MultiMaterial extends Material {
  25939. private _subMaterials;
  25940. /**
  25941. * Gets or Sets the list of Materials used within the multi material.
  25942. * They need to be ordered according to the submeshes order in the associated mesh
  25943. */
  25944. get subMaterials(): Nullable<Material>[];
  25945. set subMaterials(value: Nullable<Material>[]);
  25946. /**
  25947. * Function used to align with Node.getChildren()
  25948. * @returns the list of Materials used within the multi material
  25949. */
  25950. getChildren(): Nullable<Material>[];
  25951. /**
  25952. * Instantiates a new Multi Material
  25953. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25954. * separate meshes. This can be use to improve performances.
  25955. * @see https://doc.babylonjs.com/how_to/multi_materials
  25956. * @param name Define the name in the scene
  25957. * @param scene Define the scene the material belongs to
  25958. */
  25959. constructor(name: string, scene: Scene);
  25960. private _hookArray;
  25961. /**
  25962. * Get one of the submaterial by its index in the submaterials array
  25963. * @param index The index to look the sub material at
  25964. * @returns The Material if the index has been defined
  25965. */
  25966. getSubMaterial(index: number): Nullable<Material>;
  25967. /**
  25968. * Get the list of active textures for the whole sub materials list.
  25969. * @returns All the textures that will be used during the rendering
  25970. */
  25971. getActiveTextures(): BaseTexture[];
  25972. /**
  25973. * Gets the current class name of the material e.g. "MultiMaterial"
  25974. * Mainly use in serialization.
  25975. * @returns the class name
  25976. */
  25977. getClassName(): string;
  25978. /**
  25979. * Checks if the material is ready to render the requested sub mesh
  25980. * @param mesh Define the mesh the submesh belongs to
  25981. * @param subMesh Define the sub mesh to look readyness for
  25982. * @param useInstances Define whether or not the material is used with instances
  25983. * @returns true if ready, otherwise false
  25984. */
  25985. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25986. /**
  25987. * Clones the current material and its related sub materials
  25988. * @param name Define the name of the newly cloned material
  25989. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  25990. * @returns the cloned material
  25991. */
  25992. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  25993. /**
  25994. * Serializes the materials into a JSON representation.
  25995. * @returns the JSON representation
  25996. */
  25997. serialize(): any;
  25998. /**
  25999. * Dispose the material and release its associated resources
  26000. * @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)
  26001. * @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)
  26002. * @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)
  26003. */
  26004. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26005. /**
  26006. * Creates a MultiMaterial from parsed MultiMaterial data.
  26007. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26008. * @param scene defines the hosting scene
  26009. * @returns a new MultiMaterial
  26010. */
  26011. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26012. }
  26013. }
  26014. declare module "babylonjs/Meshes/subMesh" {
  26015. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26016. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26017. import { Engine } from "babylonjs/Engines/engine";
  26018. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26019. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26020. import { Effect } from "babylonjs/Materials/effect";
  26021. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26022. import { Plane } from "babylonjs/Maths/math.plane";
  26023. import { Collider } from "babylonjs/Collisions/collider";
  26024. import { Material } from "babylonjs/Materials/material";
  26025. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26026. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26027. import { Mesh } from "babylonjs/Meshes/mesh";
  26028. import { Ray } from "babylonjs/Culling/ray";
  26029. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26030. /**
  26031. * Defines a subdivision inside a mesh
  26032. */
  26033. export class SubMesh implements ICullable {
  26034. /** the material index to use */
  26035. materialIndex: number;
  26036. /** vertex index start */
  26037. verticesStart: number;
  26038. /** vertices count */
  26039. verticesCount: number;
  26040. /** index start */
  26041. indexStart: number;
  26042. /** indices count */
  26043. indexCount: number;
  26044. /** @hidden */
  26045. _materialDefines: Nullable<MaterialDefines>;
  26046. /** @hidden */
  26047. _materialEffect: Nullable<Effect>;
  26048. /** @hidden */
  26049. _effectOverride: Nullable<Effect>;
  26050. /**
  26051. * Gets material defines used by the effect associated to the sub mesh
  26052. */
  26053. get materialDefines(): Nullable<MaterialDefines>;
  26054. /**
  26055. * Sets material defines used by the effect associated to the sub mesh
  26056. */
  26057. set materialDefines(defines: Nullable<MaterialDefines>);
  26058. /**
  26059. * Gets associated effect
  26060. */
  26061. get effect(): Nullable<Effect>;
  26062. /**
  26063. * Sets associated effect (effect used to render this submesh)
  26064. * @param effect defines the effect to associate with
  26065. * @param defines defines the set of defines used to compile this effect
  26066. */
  26067. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26068. /** @hidden */
  26069. _linesIndexCount: number;
  26070. private _mesh;
  26071. private _renderingMesh;
  26072. private _boundingInfo;
  26073. private _linesIndexBuffer;
  26074. /** @hidden */
  26075. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26076. /** @hidden */
  26077. _trianglePlanes: Plane[];
  26078. /** @hidden */
  26079. _lastColliderTransformMatrix: Nullable<Matrix>;
  26080. /** @hidden */
  26081. _renderId: number;
  26082. /** @hidden */
  26083. _alphaIndex: number;
  26084. /** @hidden */
  26085. _distanceToCamera: number;
  26086. /** @hidden */
  26087. _id: number;
  26088. private _currentMaterial;
  26089. /**
  26090. * Add a new submesh to a mesh
  26091. * @param materialIndex defines the material index to use
  26092. * @param verticesStart defines vertex index start
  26093. * @param verticesCount defines vertices count
  26094. * @param indexStart defines index start
  26095. * @param indexCount defines indices count
  26096. * @param mesh defines the parent mesh
  26097. * @param renderingMesh defines an optional rendering mesh
  26098. * @param createBoundingBox defines if bounding box should be created for this submesh
  26099. * @returns the new submesh
  26100. */
  26101. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26102. /**
  26103. * Creates a new submesh
  26104. * @param materialIndex defines the material index to use
  26105. * @param verticesStart defines vertex index start
  26106. * @param verticesCount defines vertices count
  26107. * @param indexStart defines index start
  26108. * @param indexCount defines indices count
  26109. * @param mesh defines the parent mesh
  26110. * @param renderingMesh defines an optional rendering mesh
  26111. * @param createBoundingBox defines if bounding box should be created for this submesh
  26112. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26113. */
  26114. constructor(
  26115. /** the material index to use */
  26116. materialIndex: number,
  26117. /** vertex index start */
  26118. verticesStart: number,
  26119. /** vertices count */
  26120. verticesCount: number,
  26121. /** index start */
  26122. indexStart: number,
  26123. /** indices count */
  26124. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26125. /**
  26126. * Returns true if this submesh covers the entire parent mesh
  26127. * @ignorenaming
  26128. */
  26129. get IsGlobal(): boolean;
  26130. /**
  26131. * Returns the submesh BoudingInfo object
  26132. * @returns current bounding info (or mesh's one if the submesh is global)
  26133. */
  26134. getBoundingInfo(): BoundingInfo;
  26135. /**
  26136. * Sets the submesh BoundingInfo
  26137. * @param boundingInfo defines the new bounding info to use
  26138. * @returns the SubMesh
  26139. */
  26140. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26141. /**
  26142. * Returns the mesh of the current submesh
  26143. * @return the parent mesh
  26144. */
  26145. getMesh(): AbstractMesh;
  26146. /**
  26147. * Returns the rendering mesh of the submesh
  26148. * @returns the rendering mesh (could be different from parent mesh)
  26149. */
  26150. getRenderingMesh(): Mesh;
  26151. /**
  26152. * Returns the replacement mesh of the submesh
  26153. * @returns the replacement mesh (could be different from parent mesh)
  26154. */
  26155. getReplacementMesh(): Nullable<AbstractMesh>;
  26156. /**
  26157. * Returns the effective mesh of the submesh
  26158. * @returns the effective mesh (could be different from parent mesh)
  26159. */
  26160. getEffectiveMesh(): AbstractMesh;
  26161. /**
  26162. * Returns the submesh material
  26163. * @returns null or the current material
  26164. */
  26165. getMaterial(): Nullable<Material>;
  26166. private _IsMultiMaterial;
  26167. /**
  26168. * Sets a new updated BoundingInfo object to the submesh
  26169. * @param data defines an optional position array to use to determine the bounding info
  26170. * @returns the SubMesh
  26171. */
  26172. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26173. /** @hidden */
  26174. _checkCollision(collider: Collider): boolean;
  26175. /**
  26176. * Updates the submesh BoundingInfo
  26177. * @param world defines the world matrix to use to update the bounding info
  26178. * @returns the submesh
  26179. */
  26180. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26181. /**
  26182. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26183. * @param frustumPlanes defines the frustum planes
  26184. * @returns true if the submesh is intersecting with the frustum
  26185. */
  26186. isInFrustum(frustumPlanes: Plane[]): boolean;
  26187. /**
  26188. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26189. * @param frustumPlanes defines the frustum planes
  26190. * @returns true if the submesh is inside the frustum
  26191. */
  26192. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26193. /**
  26194. * Renders the submesh
  26195. * @param enableAlphaMode defines if alpha needs to be used
  26196. * @returns the submesh
  26197. */
  26198. render(enableAlphaMode: boolean): SubMesh;
  26199. /**
  26200. * @hidden
  26201. */
  26202. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26203. /**
  26204. * Checks if the submesh intersects with a ray
  26205. * @param ray defines the ray to test
  26206. * @returns true is the passed ray intersects the submesh bounding box
  26207. */
  26208. canIntersects(ray: Ray): boolean;
  26209. /**
  26210. * Intersects current submesh with a ray
  26211. * @param ray defines the ray to test
  26212. * @param positions defines mesh's positions array
  26213. * @param indices defines mesh's indices array
  26214. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26215. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26216. * @returns intersection info or null if no intersection
  26217. */
  26218. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26219. /** @hidden */
  26220. private _intersectLines;
  26221. /** @hidden */
  26222. private _intersectUnIndexedLines;
  26223. /** @hidden */
  26224. private _intersectTriangles;
  26225. /** @hidden */
  26226. private _intersectUnIndexedTriangles;
  26227. /** @hidden */
  26228. _rebuild(): void;
  26229. /**
  26230. * Creates a new submesh from the passed mesh
  26231. * @param newMesh defines the new hosting mesh
  26232. * @param newRenderingMesh defines an optional rendering mesh
  26233. * @returns the new submesh
  26234. */
  26235. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26236. /**
  26237. * Release associated resources
  26238. */
  26239. dispose(): void;
  26240. /**
  26241. * Gets the class name
  26242. * @returns the string "SubMesh".
  26243. */
  26244. getClassName(): string;
  26245. /**
  26246. * Creates a new submesh from indices data
  26247. * @param materialIndex the index of the main mesh material
  26248. * @param startIndex the index where to start the copy in the mesh indices array
  26249. * @param indexCount the number of indices to copy then from the startIndex
  26250. * @param mesh the main mesh to create the submesh from
  26251. * @param renderingMesh the optional rendering mesh
  26252. * @returns a new submesh
  26253. */
  26254. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26255. }
  26256. }
  26257. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26258. /**
  26259. * Class used to represent data loading progression
  26260. */
  26261. export class SceneLoaderFlags {
  26262. private static _ForceFullSceneLoadingForIncremental;
  26263. private static _ShowLoadingScreen;
  26264. private static _CleanBoneMatrixWeights;
  26265. private static _loggingLevel;
  26266. /**
  26267. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26268. */
  26269. static get ForceFullSceneLoadingForIncremental(): boolean;
  26270. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26271. /**
  26272. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26273. */
  26274. static get ShowLoadingScreen(): boolean;
  26275. static set ShowLoadingScreen(value: boolean);
  26276. /**
  26277. * Defines the current logging level (while loading the scene)
  26278. * @ignorenaming
  26279. */
  26280. static get loggingLevel(): number;
  26281. static set loggingLevel(value: number);
  26282. /**
  26283. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26284. */
  26285. static get CleanBoneMatrixWeights(): boolean;
  26286. static set CleanBoneMatrixWeights(value: boolean);
  26287. }
  26288. }
  26289. declare module "babylonjs/Meshes/geometry" {
  26290. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26291. import { Scene } from "babylonjs/scene";
  26292. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26293. import { Engine } from "babylonjs/Engines/engine";
  26294. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26295. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26296. import { Effect } from "babylonjs/Materials/effect";
  26297. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26298. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26299. import { Mesh } from "babylonjs/Meshes/mesh";
  26300. /**
  26301. * Class used to store geometry data (vertex buffers + index buffer)
  26302. */
  26303. export class Geometry implements IGetSetVerticesData {
  26304. /**
  26305. * Gets or sets the ID of the geometry
  26306. */
  26307. id: string;
  26308. /**
  26309. * Gets or sets the unique ID of the geometry
  26310. */
  26311. uniqueId: number;
  26312. /**
  26313. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26314. */
  26315. delayLoadState: number;
  26316. /**
  26317. * Gets the file containing the data to load when running in delay load state
  26318. */
  26319. delayLoadingFile: Nullable<string>;
  26320. /**
  26321. * Callback called when the geometry is updated
  26322. */
  26323. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26324. private _scene;
  26325. private _engine;
  26326. private _meshes;
  26327. private _totalVertices;
  26328. /** @hidden */
  26329. _indices: IndicesArray;
  26330. /** @hidden */
  26331. _vertexBuffers: {
  26332. [key: string]: VertexBuffer;
  26333. };
  26334. private _isDisposed;
  26335. private _extend;
  26336. private _boundingBias;
  26337. /** @hidden */
  26338. _delayInfo: Array<string>;
  26339. private _indexBuffer;
  26340. private _indexBufferIsUpdatable;
  26341. /** @hidden */
  26342. _boundingInfo: Nullable<BoundingInfo>;
  26343. /** @hidden */
  26344. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26345. /** @hidden */
  26346. _softwareSkinningFrameId: number;
  26347. private _vertexArrayObjects;
  26348. private _updatable;
  26349. /** @hidden */
  26350. _positions: Nullable<Vector3[]>;
  26351. /**
  26352. * 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
  26353. */
  26354. get boundingBias(): Vector2;
  26355. /**
  26356. * 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
  26357. */
  26358. set boundingBias(value: Vector2);
  26359. /**
  26360. * Static function used to attach a new empty geometry to a mesh
  26361. * @param mesh defines the mesh to attach the geometry to
  26362. * @returns the new Geometry
  26363. */
  26364. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26365. /** Get the list of meshes using this geometry */
  26366. get meshes(): Mesh[];
  26367. /**
  26368. * 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
  26369. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26370. */
  26371. useBoundingInfoFromGeometry: boolean;
  26372. /**
  26373. * Creates a new geometry
  26374. * @param id defines the unique ID
  26375. * @param scene defines the hosting scene
  26376. * @param vertexData defines the VertexData used to get geometry data
  26377. * @param updatable defines if geometry must be updatable (false by default)
  26378. * @param mesh defines the mesh that will be associated with the geometry
  26379. */
  26380. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26381. /**
  26382. * Gets the current extend of the geometry
  26383. */
  26384. get extend(): {
  26385. minimum: Vector3;
  26386. maximum: Vector3;
  26387. };
  26388. /**
  26389. * Gets the hosting scene
  26390. * @returns the hosting Scene
  26391. */
  26392. getScene(): Scene;
  26393. /**
  26394. * Gets the hosting engine
  26395. * @returns the hosting Engine
  26396. */
  26397. getEngine(): Engine;
  26398. /**
  26399. * Defines if the geometry is ready to use
  26400. * @returns true if the geometry is ready to be used
  26401. */
  26402. isReady(): boolean;
  26403. /**
  26404. * Gets a value indicating that the geometry should not be serialized
  26405. */
  26406. get doNotSerialize(): boolean;
  26407. /** @hidden */
  26408. _rebuild(): void;
  26409. /**
  26410. * Affects all geometry data in one call
  26411. * @param vertexData defines the geometry data
  26412. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26413. */
  26414. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26415. /**
  26416. * Set specific vertex data
  26417. * @param kind defines the data kind (Position, normal, etc...)
  26418. * @param data defines the vertex data to use
  26419. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26420. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26421. */
  26422. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26423. /**
  26424. * Removes a specific vertex data
  26425. * @param kind defines the data kind (Position, normal, etc...)
  26426. */
  26427. removeVerticesData(kind: string): void;
  26428. /**
  26429. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26430. * @param buffer defines the vertex buffer to use
  26431. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26432. */
  26433. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26434. /**
  26435. * Update a specific vertex buffer
  26436. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26437. * It will do nothing if the buffer is not updatable
  26438. * @param kind defines the data kind (Position, normal, etc...)
  26439. * @param data defines the data to use
  26440. * @param offset defines the offset in the target buffer where to store the data
  26441. * @param useBytes set to true if the offset is in bytes
  26442. */
  26443. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26444. /**
  26445. * Update a specific vertex buffer
  26446. * This function will create a new buffer if the current one is not updatable
  26447. * @param kind defines the data kind (Position, normal, etc...)
  26448. * @param data defines the data to use
  26449. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26450. */
  26451. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26452. private _updateBoundingInfo;
  26453. /** @hidden */
  26454. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26455. /**
  26456. * Gets total number of vertices
  26457. * @returns the total number of vertices
  26458. */
  26459. getTotalVertices(): number;
  26460. /**
  26461. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26462. * @param kind defines the data kind (Position, normal, etc...)
  26463. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26464. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26465. * @returns a float array containing vertex data
  26466. */
  26467. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26468. /**
  26469. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26470. * @param kind defines the data kind (Position, normal, etc...)
  26471. * @returns true if the vertex buffer with the specified kind is updatable
  26472. */
  26473. isVertexBufferUpdatable(kind: string): boolean;
  26474. /**
  26475. * Gets a specific vertex buffer
  26476. * @param kind defines the data kind (Position, normal, etc...)
  26477. * @returns a VertexBuffer
  26478. */
  26479. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26480. /**
  26481. * Returns all vertex buffers
  26482. * @return an object holding all vertex buffers indexed by kind
  26483. */
  26484. getVertexBuffers(): Nullable<{
  26485. [key: string]: VertexBuffer;
  26486. }>;
  26487. /**
  26488. * Gets a boolean indicating if specific vertex buffer is present
  26489. * @param kind defines the data kind (Position, normal, etc...)
  26490. * @returns true if data is present
  26491. */
  26492. isVerticesDataPresent(kind: string): boolean;
  26493. /**
  26494. * Gets a list of all attached data kinds (Position, normal, etc...)
  26495. * @returns a list of string containing all kinds
  26496. */
  26497. getVerticesDataKinds(): string[];
  26498. /**
  26499. * Update index buffer
  26500. * @param indices defines the indices to store in the index buffer
  26501. * @param offset defines the offset in the target buffer where to store the data
  26502. * @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)
  26503. */
  26504. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26505. /**
  26506. * Creates a new index buffer
  26507. * @param indices defines the indices to store in the index buffer
  26508. * @param totalVertices defines the total number of vertices (could be null)
  26509. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26510. */
  26511. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26512. /**
  26513. * Return the total number of indices
  26514. * @returns the total number of indices
  26515. */
  26516. getTotalIndices(): number;
  26517. /**
  26518. * Gets the index buffer array
  26519. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26520. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26521. * @returns the index buffer array
  26522. */
  26523. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26524. /**
  26525. * Gets the index buffer
  26526. * @return the index buffer
  26527. */
  26528. getIndexBuffer(): Nullable<DataBuffer>;
  26529. /** @hidden */
  26530. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26531. /**
  26532. * Release the associated resources for a specific mesh
  26533. * @param mesh defines the source mesh
  26534. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26535. */
  26536. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26537. /**
  26538. * Apply current geometry to a given mesh
  26539. * @param mesh defines the mesh to apply geometry to
  26540. */
  26541. applyToMesh(mesh: Mesh): void;
  26542. private _updateExtend;
  26543. private _applyToMesh;
  26544. private notifyUpdate;
  26545. /**
  26546. * Load the geometry if it was flagged as delay loaded
  26547. * @param scene defines the hosting scene
  26548. * @param onLoaded defines a callback called when the geometry is loaded
  26549. */
  26550. load(scene: Scene, onLoaded?: () => void): void;
  26551. private _queueLoad;
  26552. /**
  26553. * Invert the geometry to move from a right handed system to a left handed one.
  26554. */
  26555. toLeftHanded(): void;
  26556. /** @hidden */
  26557. _resetPointsArrayCache(): void;
  26558. /** @hidden */
  26559. _generatePointsArray(): boolean;
  26560. /**
  26561. * Gets a value indicating if the geometry is disposed
  26562. * @returns true if the geometry was disposed
  26563. */
  26564. isDisposed(): boolean;
  26565. private _disposeVertexArrayObjects;
  26566. /**
  26567. * Free all associated resources
  26568. */
  26569. dispose(): void;
  26570. /**
  26571. * Clone the current geometry into a new geometry
  26572. * @param id defines the unique ID of the new geometry
  26573. * @returns a new geometry object
  26574. */
  26575. copy(id: string): Geometry;
  26576. /**
  26577. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26578. * @return a JSON representation of the current geometry data (without the vertices data)
  26579. */
  26580. serialize(): any;
  26581. private toNumberArray;
  26582. /**
  26583. * Serialize all vertices data into a JSON oject
  26584. * @returns a JSON representation of the current geometry data
  26585. */
  26586. serializeVerticeData(): any;
  26587. /**
  26588. * Extracts a clone of a mesh geometry
  26589. * @param mesh defines the source mesh
  26590. * @param id defines the unique ID of the new geometry object
  26591. * @returns the new geometry object
  26592. */
  26593. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26594. /**
  26595. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26596. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26597. * Be aware Math.random() could cause collisions, but:
  26598. * "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"
  26599. * @returns a string containing a new GUID
  26600. */
  26601. static RandomId(): string;
  26602. /** @hidden */
  26603. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26604. private static _CleanMatricesWeights;
  26605. /**
  26606. * Create a new geometry from persisted data (Using .babylon file format)
  26607. * @param parsedVertexData defines the persisted data
  26608. * @param scene defines the hosting scene
  26609. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26610. * @returns the new geometry object
  26611. */
  26612. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26613. }
  26614. }
  26615. declare module "babylonjs/Meshes/mesh.vertexData" {
  26616. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26617. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26618. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26619. import { Geometry } from "babylonjs/Meshes/geometry";
  26620. import { Mesh } from "babylonjs/Meshes/mesh";
  26621. /**
  26622. * Define an interface for all classes that will get and set the data on vertices
  26623. */
  26624. export interface IGetSetVerticesData {
  26625. /**
  26626. * Gets a boolean indicating if specific vertex data is present
  26627. * @param kind defines the vertex data kind to use
  26628. * @returns true is data kind is present
  26629. */
  26630. isVerticesDataPresent(kind: string): boolean;
  26631. /**
  26632. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26633. * @param kind defines the data kind (Position, normal, etc...)
  26634. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26635. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26636. * @returns a float array containing vertex data
  26637. */
  26638. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26639. /**
  26640. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26641. * @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.
  26642. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26643. * @returns the indices array or an empty array if the mesh has no geometry
  26644. */
  26645. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26646. /**
  26647. * Set specific vertex data
  26648. * @param kind defines the data kind (Position, normal, etc...)
  26649. * @param data defines the vertex data to use
  26650. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26651. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26652. */
  26653. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26654. /**
  26655. * Update a specific associated vertex buffer
  26656. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26657. * - VertexBuffer.PositionKind
  26658. * - VertexBuffer.UVKind
  26659. * - VertexBuffer.UV2Kind
  26660. * - VertexBuffer.UV3Kind
  26661. * - VertexBuffer.UV4Kind
  26662. * - VertexBuffer.UV5Kind
  26663. * - VertexBuffer.UV6Kind
  26664. * - VertexBuffer.ColorKind
  26665. * - VertexBuffer.MatricesIndicesKind
  26666. * - VertexBuffer.MatricesIndicesExtraKind
  26667. * - VertexBuffer.MatricesWeightsKind
  26668. * - VertexBuffer.MatricesWeightsExtraKind
  26669. * @param data defines the data source
  26670. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26671. * @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)
  26672. */
  26673. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26674. /**
  26675. * Creates a new index buffer
  26676. * @param indices defines the indices to store in the index buffer
  26677. * @param totalVertices defines the total number of vertices (could be null)
  26678. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26679. */
  26680. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26681. }
  26682. /**
  26683. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26684. */
  26685. export class VertexData {
  26686. /**
  26687. * Mesh side orientation : usually the external or front surface
  26688. */
  26689. static readonly FRONTSIDE: number;
  26690. /**
  26691. * Mesh side orientation : usually the internal or back surface
  26692. */
  26693. static readonly BACKSIDE: number;
  26694. /**
  26695. * Mesh side orientation : both internal and external or front and back surfaces
  26696. */
  26697. static readonly DOUBLESIDE: number;
  26698. /**
  26699. * Mesh side orientation : by default, `FRONTSIDE`
  26700. */
  26701. static readonly DEFAULTSIDE: number;
  26702. /**
  26703. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26704. */
  26705. positions: Nullable<FloatArray>;
  26706. /**
  26707. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26708. */
  26709. normals: Nullable<FloatArray>;
  26710. /**
  26711. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26712. */
  26713. tangents: Nullable<FloatArray>;
  26714. /**
  26715. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26716. */
  26717. uvs: Nullable<FloatArray>;
  26718. /**
  26719. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26720. */
  26721. uvs2: Nullable<FloatArray>;
  26722. /**
  26723. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26724. */
  26725. uvs3: Nullable<FloatArray>;
  26726. /**
  26727. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26728. */
  26729. uvs4: Nullable<FloatArray>;
  26730. /**
  26731. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26732. */
  26733. uvs5: Nullable<FloatArray>;
  26734. /**
  26735. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26736. */
  26737. uvs6: Nullable<FloatArray>;
  26738. /**
  26739. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26740. */
  26741. colors: Nullable<FloatArray>;
  26742. /**
  26743. * 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).
  26744. */
  26745. matricesIndices: Nullable<FloatArray>;
  26746. /**
  26747. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26748. */
  26749. matricesWeights: Nullable<FloatArray>;
  26750. /**
  26751. * An array extending the number of possible indices
  26752. */
  26753. matricesIndicesExtra: Nullable<FloatArray>;
  26754. /**
  26755. * An array extending the number of possible weights when the number of indices is extended
  26756. */
  26757. matricesWeightsExtra: Nullable<FloatArray>;
  26758. /**
  26759. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26760. */
  26761. indices: Nullable<IndicesArray>;
  26762. /**
  26763. * Uses the passed data array to set the set the values for the specified kind of data
  26764. * @param data a linear array of floating numbers
  26765. * @param kind the type of data that is being set, eg positions, colors etc
  26766. */
  26767. set(data: FloatArray, kind: string): void;
  26768. /**
  26769. * Associates the vertexData to the passed Mesh.
  26770. * Sets it as updatable or not (default `false`)
  26771. * @param mesh the mesh the vertexData is applied to
  26772. * @param updatable when used and having the value true allows new data to update the vertexData
  26773. * @returns the VertexData
  26774. */
  26775. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26776. /**
  26777. * Associates the vertexData to the passed Geometry.
  26778. * Sets it as updatable or not (default `false`)
  26779. * @param geometry the geometry the vertexData is applied to
  26780. * @param updatable when used and having the value true allows new data to update the vertexData
  26781. * @returns VertexData
  26782. */
  26783. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26784. /**
  26785. * Updates the associated mesh
  26786. * @param mesh the mesh to be updated
  26787. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26788. * @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
  26789. * @returns VertexData
  26790. */
  26791. updateMesh(mesh: Mesh): VertexData;
  26792. /**
  26793. * Updates the associated geometry
  26794. * @param geometry the geometry to be updated
  26795. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26796. * @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
  26797. * @returns VertexData.
  26798. */
  26799. updateGeometry(geometry: Geometry): VertexData;
  26800. private _applyTo;
  26801. private _update;
  26802. /**
  26803. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26804. * @param matrix the transforming matrix
  26805. * @returns the VertexData
  26806. */
  26807. transform(matrix: Matrix): VertexData;
  26808. /**
  26809. * Merges the passed VertexData into the current one
  26810. * @param other the VertexData to be merged into the current one
  26811. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  26812. * @returns the modified VertexData
  26813. */
  26814. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  26815. private _mergeElement;
  26816. private _validate;
  26817. /**
  26818. * Serializes the VertexData
  26819. * @returns a serialized object
  26820. */
  26821. serialize(): any;
  26822. /**
  26823. * Extracts the vertexData from a mesh
  26824. * @param mesh the mesh from which to extract the VertexData
  26825. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  26826. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  26827. * @returns the object VertexData associated to the passed mesh
  26828. */
  26829. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  26830. /**
  26831. * Extracts the vertexData from the geometry
  26832. * @param geometry the geometry from which to extract the VertexData
  26833. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  26834. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  26835. * @returns the object VertexData associated to the passed mesh
  26836. */
  26837. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  26838. private static _ExtractFrom;
  26839. /**
  26840. * Creates the VertexData for a Ribbon
  26841. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  26842. * * pathArray array of paths, each of which an array of successive Vector3
  26843. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  26844. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  26845. * * 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
  26846. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26847. * * 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)
  26848. * * 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)
  26849. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  26850. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  26851. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  26852. * @returns the VertexData of the ribbon
  26853. */
  26854. static CreateRibbon(options: {
  26855. pathArray: Vector3[][];
  26856. closeArray?: boolean;
  26857. closePath?: boolean;
  26858. offset?: number;
  26859. sideOrientation?: number;
  26860. frontUVs?: Vector4;
  26861. backUVs?: Vector4;
  26862. invertUV?: boolean;
  26863. uvs?: Vector2[];
  26864. colors?: Color4[];
  26865. }): VertexData;
  26866. /**
  26867. * Creates the VertexData for a box
  26868. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26869. * * size sets the width, height and depth of the box to the value of size, optional default 1
  26870. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  26871. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  26872. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  26873. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26874. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26875. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26876. * * 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)
  26877. * * 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)
  26878. * @returns the VertexData of the box
  26879. */
  26880. static CreateBox(options: {
  26881. size?: number;
  26882. width?: number;
  26883. height?: number;
  26884. depth?: number;
  26885. faceUV?: Vector4[];
  26886. faceColors?: Color4[];
  26887. sideOrientation?: number;
  26888. frontUVs?: Vector4;
  26889. backUVs?: Vector4;
  26890. }): VertexData;
  26891. /**
  26892. * Creates the VertexData for a tiled box
  26893. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26894. * * faceTiles sets the pattern, tile size and number of tiles for a face
  26895. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26896. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26897. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26898. * @returns the VertexData of the box
  26899. */
  26900. static CreateTiledBox(options: {
  26901. pattern?: number;
  26902. width?: number;
  26903. height?: number;
  26904. depth?: number;
  26905. tileSize?: number;
  26906. tileWidth?: number;
  26907. tileHeight?: number;
  26908. alignHorizontal?: number;
  26909. alignVertical?: number;
  26910. faceUV?: Vector4[];
  26911. faceColors?: Color4[];
  26912. sideOrientation?: number;
  26913. }): VertexData;
  26914. /**
  26915. * Creates the VertexData for a tiled plane
  26916. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26917. * * pattern a limited pattern arrangement depending on the number
  26918. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  26919. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  26920. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  26921. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26922. * * 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)
  26923. * * 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)
  26924. * @returns the VertexData of the tiled plane
  26925. */
  26926. static CreateTiledPlane(options: {
  26927. pattern?: number;
  26928. tileSize?: number;
  26929. tileWidth?: number;
  26930. tileHeight?: number;
  26931. size?: number;
  26932. width?: number;
  26933. height?: number;
  26934. alignHorizontal?: number;
  26935. alignVertical?: number;
  26936. sideOrientation?: number;
  26937. frontUVs?: Vector4;
  26938. backUVs?: Vector4;
  26939. }): VertexData;
  26940. /**
  26941. * Creates the VertexData for an ellipsoid, defaults to a sphere
  26942. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26943. * * segments sets the number of horizontal strips optional, default 32
  26944. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  26945. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  26946. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  26947. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  26948. * * 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
  26949. * * 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
  26950. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26951. * * 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)
  26952. * * 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)
  26953. * @returns the VertexData of the ellipsoid
  26954. */
  26955. static CreateSphere(options: {
  26956. segments?: number;
  26957. diameter?: number;
  26958. diameterX?: number;
  26959. diameterY?: number;
  26960. diameterZ?: number;
  26961. arc?: number;
  26962. slice?: number;
  26963. sideOrientation?: number;
  26964. frontUVs?: Vector4;
  26965. backUVs?: Vector4;
  26966. }): VertexData;
  26967. /**
  26968. * Creates the VertexData for a cylinder, cone or prism
  26969. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26970. * * height sets the height (y direction) of the cylinder, optional, default 2
  26971. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  26972. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  26973. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  26974. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  26975. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  26976. * * 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
  26977. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  26978. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  26979. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  26980. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  26981. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26982. * * 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)
  26983. * * 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)
  26984. * @returns the VertexData of the cylinder, cone or prism
  26985. */
  26986. static CreateCylinder(options: {
  26987. height?: number;
  26988. diameterTop?: number;
  26989. diameterBottom?: number;
  26990. diameter?: number;
  26991. tessellation?: number;
  26992. subdivisions?: number;
  26993. arc?: number;
  26994. faceColors?: Color4[];
  26995. faceUV?: Vector4[];
  26996. hasRings?: boolean;
  26997. enclose?: boolean;
  26998. sideOrientation?: number;
  26999. frontUVs?: Vector4;
  27000. backUVs?: Vector4;
  27001. }): VertexData;
  27002. /**
  27003. * Creates the VertexData for a torus
  27004. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27005. * * diameter the diameter of the torus, optional default 1
  27006. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27007. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27008. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27009. * * 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)
  27010. * * 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)
  27011. * @returns the VertexData of the torus
  27012. */
  27013. static CreateTorus(options: {
  27014. diameter?: number;
  27015. thickness?: number;
  27016. tessellation?: number;
  27017. sideOrientation?: number;
  27018. frontUVs?: Vector4;
  27019. backUVs?: Vector4;
  27020. }): VertexData;
  27021. /**
  27022. * Creates the VertexData of the LineSystem
  27023. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27024. * - lines an array of lines, each line being an array of successive Vector3
  27025. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27026. * @returns the VertexData of the LineSystem
  27027. */
  27028. static CreateLineSystem(options: {
  27029. lines: Vector3[][];
  27030. colors?: Nullable<Color4[][]>;
  27031. }): VertexData;
  27032. /**
  27033. * Create the VertexData for a DashedLines
  27034. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27035. * - points an array successive Vector3
  27036. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27037. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27038. * - dashNb the intended total number of dashes, optional, default 200
  27039. * @returns the VertexData for the DashedLines
  27040. */
  27041. static CreateDashedLines(options: {
  27042. points: Vector3[];
  27043. dashSize?: number;
  27044. gapSize?: number;
  27045. dashNb?: number;
  27046. }): VertexData;
  27047. /**
  27048. * Creates the VertexData for a Ground
  27049. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27050. * - width the width (x direction) of the ground, optional, default 1
  27051. * - height the height (z direction) of the ground, optional, default 1
  27052. * - subdivisions the number of subdivisions per side, optional, default 1
  27053. * @returns the VertexData of the Ground
  27054. */
  27055. static CreateGround(options: {
  27056. width?: number;
  27057. height?: number;
  27058. subdivisions?: number;
  27059. subdivisionsX?: number;
  27060. subdivisionsY?: number;
  27061. }): VertexData;
  27062. /**
  27063. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27064. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27065. * * xmin the ground minimum X coordinate, optional, default -1
  27066. * * zmin the ground minimum Z coordinate, optional, default -1
  27067. * * xmax the ground maximum X coordinate, optional, default 1
  27068. * * zmax the ground maximum Z coordinate, optional, default 1
  27069. * * 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}
  27070. * * 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}
  27071. * @returns the VertexData of the TiledGround
  27072. */
  27073. static CreateTiledGround(options: {
  27074. xmin: number;
  27075. zmin: number;
  27076. xmax: number;
  27077. zmax: number;
  27078. subdivisions?: {
  27079. w: number;
  27080. h: number;
  27081. };
  27082. precision?: {
  27083. w: number;
  27084. h: number;
  27085. };
  27086. }): VertexData;
  27087. /**
  27088. * Creates the VertexData of the Ground designed from a heightmap
  27089. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27090. * * width the width (x direction) of the ground
  27091. * * height the height (z direction) of the ground
  27092. * * subdivisions the number of subdivisions per side
  27093. * * minHeight the minimum altitude on the ground, optional, default 0
  27094. * * maxHeight the maximum altitude on the ground, optional default 1
  27095. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27096. * * buffer the array holding the image color data
  27097. * * bufferWidth the width of image
  27098. * * bufferHeight the height of image
  27099. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27100. * @returns the VertexData of the Ground designed from a heightmap
  27101. */
  27102. static CreateGroundFromHeightMap(options: {
  27103. width: number;
  27104. height: number;
  27105. subdivisions: number;
  27106. minHeight: number;
  27107. maxHeight: number;
  27108. colorFilter: Color3;
  27109. buffer: Uint8Array;
  27110. bufferWidth: number;
  27111. bufferHeight: number;
  27112. alphaFilter: number;
  27113. }): VertexData;
  27114. /**
  27115. * Creates the VertexData for a Plane
  27116. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27117. * * size sets the width and height of the plane to the value of size, optional default 1
  27118. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27119. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27120. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27121. * * 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)
  27122. * * 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)
  27123. * @returns the VertexData of the box
  27124. */
  27125. static CreatePlane(options: {
  27126. size?: number;
  27127. width?: number;
  27128. height?: number;
  27129. sideOrientation?: number;
  27130. frontUVs?: Vector4;
  27131. backUVs?: Vector4;
  27132. }): VertexData;
  27133. /**
  27134. * Creates the VertexData of the Disc or regular Polygon
  27135. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27136. * * radius the radius of the disc, optional default 0.5
  27137. * * tessellation the number of polygon sides, optional, default 64
  27138. * * 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
  27139. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27140. * * 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)
  27141. * * 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)
  27142. * @returns the VertexData of the box
  27143. */
  27144. static CreateDisc(options: {
  27145. radius?: number;
  27146. tessellation?: number;
  27147. arc?: number;
  27148. sideOrientation?: number;
  27149. frontUVs?: Vector4;
  27150. backUVs?: Vector4;
  27151. }): VertexData;
  27152. /**
  27153. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27154. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27155. * @param polygon a mesh built from polygonTriangulation.build()
  27156. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27157. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27158. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27159. * @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)
  27160. * @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)
  27161. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27162. * @returns the VertexData of the Polygon
  27163. */
  27164. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27165. /**
  27166. * Creates the VertexData of the IcoSphere
  27167. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27168. * * radius the radius of the IcoSphere, optional default 1
  27169. * * radiusX allows stretching in the x direction, optional, default radius
  27170. * * radiusY allows stretching in the y direction, optional, default radius
  27171. * * radiusZ allows stretching in the z direction, optional, default radius
  27172. * * flat when true creates a flat shaded mesh, optional, default true
  27173. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27174. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27175. * * 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)
  27176. * * 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)
  27177. * @returns the VertexData of the IcoSphere
  27178. */
  27179. static CreateIcoSphere(options: {
  27180. radius?: number;
  27181. radiusX?: number;
  27182. radiusY?: number;
  27183. radiusZ?: number;
  27184. flat?: boolean;
  27185. subdivisions?: number;
  27186. sideOrientation?: number;
  27187. frontUVs?: Vector4;
  27188. backUVs?: Vector4;
  27189. }): VertexData;
  27190. /**
  27191. * Creates the VertexData for a Polyhedron
  27192. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27193. * * type provided types are:
  27194. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27195. * * 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)
  27196. * * size the size of the IcoSphere, optional default 1
  27197. * * sizeX allows stretching in the x direction, optional, default size
  27198. * * sizeY allows stretching in the y direction, optional, default size
  27199. * * sizeZ allows stretching in the z direction, optional, default size
  27200. * * 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
  27201. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27202. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27203. * * flat when true creates a flat shaded mesh, optional, default true
  27204. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27205. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27206. * * 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)
  27207. * * 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)
  27208. * @returns the VertexData of the Polyhedron
  27209. */
  27210. static CreatePolyhedron(options: {
  27211. type?: number;
  27212. size?: number;
  27213. sizeX?: number;
  27214. sizeY?: number;
  27215. sizeZ?: number;
  27216. custom?: any;
  27217. faceUV?: Vector4[];
  27218. faceColors?: Color4[];
  27219. flat?: boolean;
  27220. sideOrientation?: number;
  27221. frontUVs?: Vector4;
  27222. backUVs?: Vector4;
  27223. }): VertexData;
  27224. /**
  27225. * Creates the VertexData for a TorusKnot
  27226. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27227. * * radius the radius of the torus knot, optional, default 2
  27228. * * tube the thickness of the tube, optional, default 0.5
  27229. * * radialSegments the number of sides on each tube segments, optional, default 32
  27230. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27231. * * p the number of windings around the z axis, optional, default 2
  27232. * * q the number of windings around the x axis, optional, default 3
  27233. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27234. * * 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)
  27235. * * 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)
  27236. * @returns the VertexData of the Torus Knot
  27237. */
  27238. static CreateTorusKnot(options: {
  27239. radius?: number;
  27240. tube?: number;
  27241. radialSegments?: number;
  27242. tubularSegments?: number;
  27243. p?: number;
  27244. q?: number;
  27245. sideOrientation?: number;
  27246. frontUVs?: Vector4;
  27247. backUVs?: Vector4;
  27248. }): VertexData;
  27249. /**
  27250. * Compute normals for given positions and indices
  27251. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27252. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27253. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27254. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27255. * * facetNormals : optional array of facet normals (vector3)
  27256. * * facetPositions : optional array of facet positions (vector3)
  27257. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27258. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27259. * * bInfo : optional bounding info, required for facetPartitioning computation
  27260. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27261. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27262. * * useRightHandedSystem: optional boolean to for right handed system computation
  27263. * * depthSort : optional boolean to enable the facet depth sort computation
  27264. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27265. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27266. */
  27267. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27268. facetNormals?: any;
  27269. facetPositions?: any;
  27270. facetPartitioning?: any;
  27271. ratio?: number;
  27272. bInfo?: any;
  27273. bbSize?: Vector3;
  27274. subDiv?: any;
  27275. useRightHandedSystem?: boolean;
  27276. depthSort?: boolean;
  27277. distanceTo?: Vector3;
  27278. depthSortedFacets?: any;
  27279. }): void;
  27280. /** @hidden */
  27281. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27282. /**
  27283. * Applies VertexData created from the imported parameters to the geometry
  27284. * @param parsedVertexData the parsed data from an imported file
  27285. * @param geometry the geometry to apply the VertexData to
  27286. */
  27287. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27288. }
  27289. }
  27290. declare module "babylonjs/Morph/morphTarget" {
  27291. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27292. import { Observable } from "babylonjs/Misc/observable";
  27293. import { Nullable, FloatArray } from "babylonjs/types";
  27294. import { Scene } from "babylonjs/scene";
  27295. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27296. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27297. /**
  27298. * Defines a target to use with MorphTargetManager
  27299. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27300. */
  27301. export class MorphTarget implements IAnimatable {
  27302. /** defines the name of the target */
  27303. name: string;
  27304. /**
  27305. * Gets or sets the list of animations
  27306. */
  27307. animations: import("babylonjs/Animations/animation").Animation[];
  27308. private _scene;
  27309. private _positions;
  27310. private _normals;
  27311. private _tangents;
  27312. private _uvs;
  27313. private _influence;
  27314. private _uniqueId;
  27315. /**
  27316. * Observable raised when the influence changes
  27317. */
  27318. onInfluenceChanged: Observable<boolean>;
  27319. /** @hidden */
  27320. _onDataLayoutChanged: Observable<void>;
  27321. /**
  27322. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27323. */
  27324. get influence(): number;
  27325. set influence(influence: number);
  27326. /**
  27327. * Gets or sets the id of the morph Target
  27328. */
  27329. id: string;
  27330. private _animationPropertiesOverride;
  27331. /**
  27332. * Gets or sets the animation properties override
  27333. */
  27334. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27335. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27336. /**
  27337. * Creates a new MorphTarget
  27338. * @param name defines the name of the target
  27339. * @param influence defines the influence to use
  27340. * @param scene defines the scene the morphtarget belongs to
  27341. */
  27342. constructor(
  27343. /** defines the name of the target */
  27344. name: string, influence?: number, scene?: Nullable<Scene>);
  27345. /**
  27346. * Gets the unique ID of this manager
  27347. */
  27348. get uniqueId(): number;
  27349. /**
  27350. * Gets a boolean defining if the target contains position data
  27351. */
  27352. get hasPositions(): boolean;
  27353. /**
  27354. * Gets a boolean defining if the target contains normal data
  27355. */
  27356. get hasNormals(): boolean;
  27357. /**
  27358. * Gets a boolean defining if the target contains tangent data
  27359. */
  27360. get hasTangents(): boolean;
  27361. /**
  27362. * Gets a boolean defining if the target contains texture coordinates data
  27363. */
  27364. get hasUVs(): boolean;
  27365. /**
  27366. * Affects position data to this target
  27367. * @param data defines the position data to use
  27368. */
  27369. setPositions(data: Nullable<FloatArray>): void;
  27370. /**
  27371. * Gets the position data stored in this target
  27372. * @returns a FloatArray containing the position data (or null if not present)
  27373. */
  27374. getPositions(): Nullable<FloatArray>;
  27375. /**
  27376. * Affects normal data to this target
  27377. * @param data defines the normal data to use
  27378. */
  27379. setNormals(data: Nullable<FloatArray>): void;
  27380. /**
  27381. * Gets the normal data stored in this target
  27382. * @returns a FloatArray containing the normal data (or null if not present)
  27383. */
  27384. getNormals(): Nullable<FloatArray>;
  27385. /**
  27386. * Affects tangent data to this target
  27387. * @param data defines the tangent data to use
  27388. */
  27389. setTangents(data: Nullable<FloatArray>): void;
  27390. /**
  27391. * Gets the tangent data stored in this target
  27392. * @returns a FloatArray containing the tangent data (or null if not present)
  27393. */
  27394. getTangents(): Nullable<FloatArray>;
  27395. /**
  27396. * Affects texture coordinates data to this target
  27397. * @param data defines the texture coordinates data to use
  27398. */
  27399. setUVs(data: Nullable<FloatArray>): void;
  27400. /**
  27401. * Gets the texture coordinates data stored in this target
  27402. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27403. */
  27404. getUVs(): Nullable<FloatArray>;
  27405. /**
  27406. * Clone the current target
  27407. * @returns a new MorphTarget
  27408. */
  27409. clone(): MorphTarget;
  27410. /**
  27411. * Serializes the current target into a Serialization object
  27412. * @returns the serialized object
  27413. */
  27414. serialize(): any;
  27415. /**
  27416. * Returns the string "MorphTarget"
  27417. * @returns "MorphTarget"
  27418. */
  27419. getClassName(): string;
  27420. /**
  27421. * Creates a new target from serialized data
  27422. * @param serializationObject defines the serialized data to use
  27423. * @returns a new MorphTarget
  27424. */
  27425. static Parse(serializationObject: any): MorphTarget;
  27426. /**
  27427. * Creates a MorphTarget from mesh data
  27428. * @param mesh defines the source mesh
  27429. * @param name defines the name to use for the new target
  27430. * @param influence defines the influence to attach to the target
  27431. * @returns a new MorphTarget
  27432. */
  27433. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27434. }
  27435. }
  27436. declare module "babylonjs/Morph/morphTargetManager" {
  27437. import { Nullable } from "babylonjs/types";
  27438. import { Scene } from "babylonjs/scene";
  27439. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27440. /**
  27441. * This class is used to deform meshes using morphing between different targets
  27442. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27443. */
  27444. export class MorphTargetManager {
  27445. private _targets;
  27446. private _targetInfluenceChangedObservers;
  27447. private _targetDataLayoutChangedObservers;
  27448. private _activeTargets;
  27449. private _scene;
  27450. private _influences;
  27451. private _supportsNormals;
  27452. private _supportsTangents;
  27453. private _supportsUVs;
  27454. private _vertexCount;
  27455. private _uniqueId;
  27456. private _tempInfluences;
  27457. /**
  27458. * Gets or sets a boolean indicating if normals must be morphed
  27459. */
  27460. enableNormalMorphing: boolean;
  27461. /**
  27462. * Gets or sets a boolean indicating if tangents must be morphed
  27463. */
  27464. enableTangentMorphing: boolean;
  27465. /**
  27466. * Gets or sets a boolean indicating if UV must be morphed
  27467. */
  27468. enableUVMorphing: boolean;
  27469. /**
  27470. * Creates a new MorphTargetManager
  27471. * @param scene defines the current scene
  27472. */
  27473. constructor(scene?: Nullable<Scene>);
  27474. /**
  27475. * Gets the unique ID of this manager
  27476. */
  27477. get uniqueId(): number;
  27478. /**
  27479. * Gets the number of vertices handled by this manager
  27480. */
  27481. get vertexCount(): number;
  27482. /**
  27483. * Gets a boolean indicating if this manager supports morphing of normals
  27484. */
  27485. get supportsNormals(): boolean;
  27486. /**
  27487. * Gets a boolean indicating if this manager supports morphing of tangents
  27488. */
  27489. get supportsTangents(): boolean;
  27490. /**
  27491. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27492. */
  27493. get supportsUVs(): boolean;
  27494. /**
  27495. * Gets the number of targets stored in this manager
  27496. */
  27497. get numTargets(): number;
  27498. /**
  27499. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27500. */
  27501. get numInfluencers(): number;
  27502. /**
  27503. * Gets the list of influences (one per target)
  27504. */
  27505. get influences(): Float32Array;
  27506. /**
  27507. * Gets the active target at specified index. An active target is a target with an influence > 0
  27508. * @param index defines the index to check
  27509. * @returns the requested target
  27510. */
  27511. getActiveTarget(index: number): MorphTarget;
  27512. /**
  27513. * Gets the target at specified index
  27514. * @param index defines the index to check
  27515. * @returns the requested target
  27516. */
  27517. getTarget(index: number): MorphTarget;
  27518. /**
  27519. * Add a new target to this manager
  27520. * @param target defines the target to add
  27521. */
  27522. addTarget(target: MorphTarget): void;
  27523. /**
  27524. * Removes a target from the manager
  27525. * @param target defines the target to remove
  27526. */
  27527. removeTarget(target: MorphTarget): void;
  27528. /**
  27529. * Clone the current manager
  27530. * @returns a new MorphTargetManager
  27531. */
  27532. clone(): MorphTargetManager;
  27533. /**
  27534. * Serializes the current manager into a Serialization object
  27535. * @returns the serialized object
  27536. */
  27537. serialize(): any;
  27538. private _syncActiveTargets;
  27539. /**
  27540. * Syncrhonize the targets with all the meshes using this morph target manager
  27541. */
  27542. synchronize(): void;
  27543. /**
  27544. * Creates a new MorphTargetManager from serialized data
  27545. * @param serializationObject defines the serialized data
  27546. * @param scene defines the hosting scene
  27547. * @returns the new MorphTargetManager
  27548. */
  27549. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27550. }
  27551. }
  27552. declare module "babylonjs/Meshes/meshLODLevel" {
  27553. import { Mesh } from "babylonjs/Meshes/mesh";
  27554. import { Nullable } from "babylonjs/types";
  27555. /**
  27556. * Class used to represent a specific level of detail of a mesh
  27557. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27558. */
  27559. export class MeshLODLevel {
  27560. /** Defines the distance where this level should start being displayed */
  27561. distance: number;
  27562. /** Defines the mesh to use to render this level */
  27563. mesh: Nullable<Mesh>;
  27564. /**
  27565. * Creates a new LOD level
  27566. * @param distance defines the distance where this level should star being displayed
  27567. * @param mesh defines the mesh to use to render this level
  27568. */
  27569. constructor(
  27570. /** Defines the distance where this level should start being displayed */
  27571. distance: number,
  27572. /** Defines the mesh to use to render this level */
  27573. mesh: Nullable<Mesh>);
  27574. }
  27575. }
  27576. declare module "babylonjs/Misc/canvasGenerator" {
  27577. /**
  27578. * Helper class used to generate a canvas to manipulate images
  27579. */
  27580. export class CanvasGenerator {
  27581. /**
  27582. * Create a new canvas (or offscreen canvas depending on the context)
  27583. * @param width defines the expected width
  27584. * @param height defines the expected height
  27585. * @return a new canvas or offscreen canvas
  27586. */
  27587. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27588. }
  27589. }
  27590. declare module "babylonjs/Meshes/groundMesh" {
  27591. import { Scene } from "babylonjs/scene";
  27592. import { Vector3 } from "babylonjs/Maths/math.vector";
  27593. import { Mesh } from "babylonjs/Meshes/mesh";
  27594. /**
  27595. * Mesh representing the gorund
  27596. */
  27597. export class GroundMesh extends Mesh {
  27598. /** If octree should be generated */
  27599. generateOctree: boolean;
  27600. private _heightQuads;
  27601. /** @hidden */
  27602. _subdivisionsX: number;
  27603. /** @hidden */
  27604. _subdivisionsY: number;
  27605. /** @hidden */
  27606. _width: number;
  27607. /** @hidden */
  27608. _height: number;
  27609. /** @hidden */
  27610. _minX: number;
  27611. /** @hidden */
  27612. _maxX: number;
  27613. /** @hidden */
  27614. _minZ: number;
  27615. /** @hidden */
  27616. _maxZ: number;
  27617. constructor(name: string, scene: Scene);
  27618. /**
  27619. * "GroundMesh"
  27620. * @returns "GroundMesh"
  27621. */
  27622. getClassName(): string;
  27623. /**
  27624. * The minimum of x and y subdivisions
  27625. */
  27626. get subdivisions(): number;
  27627. /**
  27628. * X subdivisions
  27629. */
  27630. get subdivisionsX(): number;
  27631. /**
  27632. * Y subdivisions
  27633. */
  27634. get subdivisionsY(): number;
  27635. /**
  27636. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27637. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27638. * @param chunksCount the number of subdivisions for x and y
  27639. * @param octreeBlocksSize (Default: 32)
  27640. */
  27641. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27642. /**
  27643. * Returns a height (y) value in the Worl system :
  27644. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27645. * @param x x coordinate
  27646. * @param z z coordinate
  27647. * @returns the ground y position if (x, z) are outside the ground surface.
  27648. */
  27649. getHeightAtCoordinates(x: number, z: number): number;
  27650. /**
  27651. * Returns a normalized vector (Vector3) orthogonal to the ground
  27652. * at the ground coordinates (x, z) expressed in the World system.
  27653. * @param x x coordinate
  27654. * @param z z coordinate
  27655. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27656. */
  27657. getNormalAtCoordinates(x: number, z: number): Vector3;
  27658. /**
  27659. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27660. * at the ground coordinates (x, z) expressed in the World system.
  27661. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27662. * @param x x coordinate
  27663. * @param z z coordinate
  27664. * @param ref vector to store the result
  27665. * @returns the GroundMesh.
  27666. */
  27667. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27668. /**
  27669. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27670. * if the ground has been updated.
  27671. * This can be used in the render loop.
  27672. * @returns the GroundMesh.
  27673. */
  27674. updateCoordinateHeights(): GroundMesh;
  27675. private _getFacetAt;
  27676. private _initHeightQuads;
  27677. private _computeHeightQuads;
  27678. /**
  27679. * Serializes this ground mesh
  27680. * @param serializationObject object to write serialization to
  27681. */
  27682. serialize(serializationObject: any): void;
  27683. /**
  27684. * Parses a serialized ground mesh
  27685. * @param parsedMesh the serialized mesh
  27686. * @param scene the scene to create the ground mesh in
  27687. * @returns the created ground mesh
  27688. */
  27689. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27690. }
  27691. }
  27692. declare module "babylonjs/Physics/physicsJoint" {
  27693. import { Vector3 } from "babylonjs/Maths/math.vector";
  27694. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27695. /**
  27696. * Interface for Physics-Joint data
  27697. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27698. */
  27699. export interface PhysicsJointData {
  27700. /**
  27701. * The main pivot of the joint
  27702. */
  27703. mainPivot?: Vector3;
  27704. /**
  27705. * The connected pivot of the joint
  27706. */
  27707. connectedPivot?: Vector3;
  27708. /**
  27709. * The main axis of the joint
  27710. */
  27711. mainAxis?: Vector3;
  27712. /**
  27713. * The connected axis of the joint
  27714. */
  27715. connectedAxis?: Vector3;
  27716. /**
  27717. * The collision of the joint
  27718. */
  27719. collision?: boolean;
  27720. /**
  27721. * Native Oimo/Cannon/Energy data
  27722. */
  27723. nativeParams?: any;
  27724. }
  27725. /**
  27726. * This is a holder class for the physics joint created by the physics plugin
  27727. * It holds a set of functions to control the underlying joint
  27728. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27729. */
  27730. export class PhysicsJoint {
  27731. /**
  27732. * The type of the physics joint
  27733. */
  27734. type: number;
  27735. /**
  27736. * The data for the physics joint
  27737. */
  27738. jointData: PhysicsJointData;
  27739. private _physicsJoint;
  27740. protected _physicsPlugin: IPhysicsEnginePlugin;
  27741. /**
  27742. * Initializes the physics joint
  27743. * @param type The type of the physics joint
  27744. * @param jointData The data for the physics joint
  27745. */
  27746. constructor(
  27747. /**
  27748. * The type of the physics joint
  27749. */
  27750. type: number,
  27751. /**
  27752. * The data for the physics joint
  27753. */
  27754. jointData: PhysicsJointData);
  27755. /**
  27756. * Gets the physics joint
  27757. */
  27758. get physicsJoint(): any;
  27759. /**
  27760. * Sets the physics joint
  27761. */
  27762. set physicsJoint(newJoint: any);
  27763. /**
  27764. * Sets the physics plugin
  27765. */
  27766. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27767. /**
  27768. * Execute a function that is physics-plugin specific.
  27769. * @param {Function} func the function that will be executed.
  27770. * It accepts two parameters: the physics world and the physics joint
  27771. */
  27772. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27773. /**
  27774. * Distance-Joint type
  27775. */
  27776. static DistanceJoint: number;
  27777. /**
  27778. * Hinge-Joint type
  27779. */
  27780. static HingeJoint: number;
  27781. /**
  27782. * Ball-and-Socket joint type
  27783. */
  27784. static BallAndSocketJoint: number;
  27785. /**
  27786. * Wheel-Joint type
  27787. */
  27788. static WheelJoint: number;
  27789. /**
  27790. * Slider-Joint type
  27791. */
  27792. static SliderJoint: number;
  27793. /**
  27794. * Prismatic-Joint type
  27795. */
  27796. static PrismaticJoint: number;
  27797. /**
  27798. * Universal-Joint type
  27799. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27800. */
  27801. static UniversalJoint: number;
  27802. /**
  27803. * Hinge-Joint 2 type
  27804. */
  27805. static Hinge2Joint: number;
  27806. /**
  27807. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  27808. */
  27809. static PointToPointJoint: number;
  27810. /**
  27811. * Spring-Joint type
  27812. */
  27813. static SpringJoint: number;
  27814. /**
  27815. * Lock-Joint type
  27816. */
  27817. static LockJoint: number;
  27818. }
  27819. /**
  27820. * A class representing a physics distance joint
  27821. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27822. */
  27823. export class DistanceJoint extends PhysicsJoint {
  27824. /**
  27825. *
  27826. * @param jointData The data for the Distance-Joint
  27827. */
  27828. constructor(jointData: DistanceJointData);
  27829. /**
  27830. * Update the predefined distance.
  27831. * @param maxDistance The maximum preferred distance
  27832. * @param minDistance The minimum preferred distance
  27833. */
  27834. updateDistance(maxDistance: number, minDistance?: number): void;
  27835. }
  27836. /**
  27837. * Represents a Motor-Enabled Joint
  27838. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27839. */
  27840. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  27841. /**
  27842. * Initializes the Motor-Enabled Joint
  27843. * @param type The type of the joint
  27844. * @param jointData The physica joint data for the joint
  27845. */
  27846. constructor(type: number, jointData: PhysicsJointData);
  27847. /**
  27848. * Set the motor values.
  27849. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27850. * @param force the force to apply
  27851. * @param maxForce max force for this motor.
  27852. */
  27853. setMotor(force?: number, maxForce?: number): void;
  27854. /**
  27855. * Set the motor's limits.
  27856. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27857. * @param upperLimit The upper limit of the motor
  27858. * @param lowerLimit The lower limit of the motor
  27859. */
  27860. setLimit(upperLimit: number, lowerLimit?: number): void;
  27861. }
  27862. /**
  27863. * This class represents a single physics Hinge-Joint
  27864. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27865. */
  27866. export class HingeJoint extends MotorEnabledJoint {
  27867. /**
  27868. * Initializes the Hinge-Joint
  27869. * @param jointData The joint data for the Hinge-Joint
  27870. */
  27871. constructor(jointData: PhysicsJointData);
  27872. /**
  27873. * Set the motor values.
  27874. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27875. * @param {number} force the force to apply
  27876. * @param {number} maxForce max force for this motor.
  27877. */
  27878. setMotor(force?: number, maxForce?: number): void;
  27879. /**
  27880. * Set the motor's limits.
  27881. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27882. * @param upperLimit The upper limit of the motor
  27883. * @param lowerLimit The lower limit of the motor
  27884. */
  27885. setLimit(upperLimit: number, lowerLimit?: number): void;
  27886. }
  27887. /**
  27888. * This class represents a dual hinge physics joint (same as wheel joint)
  27889. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27890. */
  27891. export class Hinge2Joint extends MotorEnabledJoint {
  27892. /**
  27893. * Initializes the Hinge2-Joint
  27894. * @param jointData The joint data for the Hinge2-Joint
  27895. */
  27896. constructor(jointData: PhysicsJointData);
  27897. /**
  27898. * Set the motor values.
  27899. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27900. * @param {number} targetSpeed the speed the motor is to reach
  27901. * @param {number} maxForce max force for this motor.
  27902. * @param {motorIndex} the motor's index, 0 or 1.
  27903. */
  27904. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  27905. /**
  27906. * Set the motor limits.
  27907. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27908. * @param {number} upperLimit the upper limit
  27909. * @param {number} lowerLimit lower limit
  27910. * @param {motorIndex} the motor's index, 0 or 1.
  27911. */
  27912. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27913. }
  27914. /**
  27915. * Interface for a motor enabled joint
  27916. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27917. */
  27918. export interface IMotorEnabledJoint {
  27919. /**
  27920. * Physics joint
  27921. */
  27922. physicsJoint: any;
  27923. /**
  27924. * Sets the motor of the motor-enabled joint
  27925. * @param force The force of the motor
  27926. * @param maxForce The maximum force of the motor
  27927. * @param motorIndex The index of the motor
  27928. */
  27929. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  27930. /**
  27931. * Sets the limit of the motor
  27932. * @param upperLimit The upper limit of the motor
  27933. * @param lowerLimit The lower limit of the motor
  27934. * @param motorIndex The index of the motor
  27935. */
  27936. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27937. }
  27938. /**
  27939. * Joint data for a Distance-Joint
  27940. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27941. */
  27942. export interface DistanceJointData extends PhysicsJointData {
  27943. /**
  27944. * Max distance the 2 joint objects can be apart
  27945. */
  27946. maxDistance: number;
  27947. }
  27948. /**
  27949. * Joint data from a spring joint
  27950. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27951. */
  27952. export interface SpringJointData extends PhysicsJointData {
  27953. /**
  27954. * Length of the spring
  27955. */
  27956. length: number;
  27957. /**
  27958. * Stiffness of the spring
  27959. */
  27960. stiffness: number;
  27961. /**
  27962. * Damping of the spring
  27963. */
  27964. damping: number;
  27965. /** this callback will be called when applying the force to the impostors. */
  27966. forceApplicationCallback: () => void;
  27967. }
  27968. }
  27969. declare module "babylonjs/Physics/physicsRaycastResult" {
  27970. import { Vector3 } from "babylonjs/Maths/math.vector";
  27971. /**
  27972. * Holds the data for the raycast result
  27973. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27974. */
  27975. export class PhysicsRaycastResult {
  27976. private _hasHit;
  27977. private _hitDistance;
  27978. private _hitNormalWorld;
  27979. private _hitPointWorld;
  27980. private _rayFromWorld;
  27981. private _rayToWorld;
  27982. /**
  27983. * Gets if there was a hit
  27984. */
  27985. get hasHit(): boolean;
  27986. /**
  27987. * Gets the distance from the hit
  27988. */
  27989. get hitDistance(): number;
  27990. /**
  27991. * Gets the hit normal/direction in the world
  27992. */
  27993. get hitNormalWorld(): Vector3;
  27994. /**
  27995. * Gets the hit point in the world
  27996. */
  27997. get hitPointWorld(): Vector3;
  27998. /**
  27999. * Gets the ray "start point" of the ray in the world
  28000. */
  28001. get rayFromWorld(): Vector3;
  28002. /**
  28003. * Gets the ray "end point" of the ray in the world
  28004. */
  28005. get rayToWorld(): Vector3;
  28006. /**
  28007. * Sets the hit data (normal & point in world space)
  28008. * @param hitNormalWorld defines the normal in world space
  28009. * @param hitPointWorld defines the point in world space
  28010. */
  28011. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28012. /**
  28013. * Sets the distance from the start point to the hit point
  28014. * @param distance
  28015. */
  28016. setHitDistance(distance: number): void;
  28017. /**
  28018. * Calculates the distance manually
  28019. */
  28020. calculateHitDistance(): void;
  28021. /**
  28022. * Resets all the values to default
  28023. * @param from The from point on world space
  28024. * @param to The to point on world space
  28025. */
  28026. reset(from?: Vector3, to?: Vector3): void;
  28027. }
  28028. /**
  28029. * Interface for the size containing width and height
  28030. */
  28031. interface IXYZ {
  28032. /**
  28033. * X
  28034. */
  28035. x: number;
  28036. /**
  28037. * Y
  28038. */
  28039. y: number;
  28040. /**
  28041. * Z
  28042. */
  28043. z: number;
  28044. }
  28045. }
  28046. declare module "babylonjs/Physics/IPhysicsEngine" {
  28047. import { Nullable } from "babylonjs/types";
  28048. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28049. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28050. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28051. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28052. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28053. /**
  28054. * Interface used to describe a physics joint
  28055. */
  28056. export interface PhysicsImpostorJoint {
  28057. /** Defines the main impostor to which the joint is linked */
  28058. mainImpostor: PhysicsImpostor;
  28059. /** Defines the impostor that is connected to the main impostor using this joint */
  28060. connectedImpostor: PhysicsImpostor;
  28061. /** Defines the joint itself */
  28062. joint: PhysicsJoint;
  28063. }
  28064. /** @hidden */
  28065. export interface IPhysicsEnginePlugin {
  28066. world: any;
  28067. name: string;
  28068. setGravity(gravity: Vector3): void;
  28069. setTimeStep(timeStep: number): void;
  28070. getTimeStep(): number;
  28071. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28072. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28073. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28074. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28075. removePhysicsBody(impostor: PhysicsImpostor): void;
  28076. generateJoint(joint: PhysicsImpostorJoint): void;
  28077. removeJoint(joint: PhysicsImpostorJoint): void;
  28078. isSupported(): boolean;
  28079. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28080. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28081. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28082. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28083. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28084. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28085. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28086. getBodyMass(impostor: PhysicsImpostor): number;
  28087. getBodyFriction(impostor: PhysicsImpostor): number;
  28088. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28089. getBodyRestitution(impostor: PhysicsImpostor): number;
  28090. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28091. getBodyPressure?(impostor: PhysicsImpostor): number;
  28092. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28093. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28094. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28095. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28096. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28097. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28098. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28099. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28100. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28101. sleepBody(impostor: PhysicsImpostor): void;
  28102. wakeUpBody(impostor: PhysicsImpostor): void;
  28103. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28104. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28105. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28106. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28107. getRadius(impostor: PhysicsImpostor): number;
  28108. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28109. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28110. dispose(): void;
  28111. }
  28112. /**
  28113. * Interface used to define a physics engine
  28114. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28115. */
  28116. export interface IPhysicsEngine {
  28117. /**
  28118. * Gets the gravity vector used by the simulation
  28119. */
  28120. gravity: Vector3;
  28121. /**
  28122. * Sets the gravity vector used by the simulation
  28123. * @param gravity defines the gravity vector to use
  28124. */
  28125. setGravity(gravity: Vector3): void;
  28126. /**
  28127. * Set the time step of the physics engine.
  28128. * Default is 1/60.
  28129. * To slow it down, enter 1/600 for example.
  28130. * To speed it up, 1/30
  28131. * @param newTimeStep the new timestep to apply to this world.
  28132. */
  28133. setTimeStep(newTimeStep: number): void;
  28134. /**
  28135. * Get the time step of the physics engine.
  28136. * @returns the current time step
  28137. */
  28138. getTimeStep(): number;
  28139. /**
  28140. * Set the sub time step of the physics engine.
  28141. * Default is 0 meaning there is no sub steps
  28142. * To increase physics resolution precision, set a small value (like 1 ms)
  28143. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28144. */
  28145. setSubTimeStep(subTimeStep: number): void;
  28146. /**
  28147. * Get the sub time step of the physics engine.
  28148. * @returns the current sub time step
  28149. */
  28150. getSubTimeStep(): number;
  28151. /**
  28152. * Release all resources
  28153. */
  28154. dispose(): void;
  28155. /**
  28156. * Gets the name of the current physics plugin
  28157. * @returns the name of the plugin
  28158. */
  28159. getPhysicsPluginName(): string;
  28160. /**
  28161. * Adding a new impostor for the impostor tracking.
  28162. * This will be done by the impostor itself.
  28163. * @param impostor the impostor to add
  28164. */
  28165. addImpostor(impostor: PhysicsImpostor): void;
  28166. /**
  28167. * Remove an impostor from the engine.
  28168. * This impostor and its mesh will not longer be updated by the physics engine.
  28169. * @param impostor the impostor to remove
  28170. */
  28171. removeImpostor(impostor: PhysicsImpostor): void;
  28172. /**
  28173. * Add a joint to the physics engine
  28174. * @param mainImpostor defines the main impostor to which the joint is added.
  28175. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28176. * @param joint defines the joint that will connect both impostors.
  28177. */
  28178. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28179. /**
  28180. * Removes a joint from the simulation
  28181. * @param mainImpostor defines the impostor used with the joint
  28182. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28183. * @param joint defines the joint to remove
  28184. */
  28185. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28186. /**
  28187. * Gets the current plugin used to run the simulation
  28188. * @returns current plugin
  28189. */
  28190. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28191. /**
  28192. * Gets the list of physic impostors
  28193. * @returns an array of PhysicsImpostor
  28194. */
  28195. getImpostors(): Array<PhysicsImpostor>;
  28196. /**
  28197. * Gets the impostor for a physics enabled object
  28198. * @param object defines the object impersonated by the impostor
  28199. * @returns the PhysicsImpostor or null if not found
  28200. */
  28201. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28202. /**
  28203. * Gets the impostor for a physics body object
  28204. * @param body defines physics body used by the impostor
  28205. * @returns the PhysicsImpostor or null if not found
  28206. */
  28207. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28208. /**
  28209. * Does a raycast in the physics world
  28210. * @param from when should the ray start?
  28211. * @param to when should the ray end?
  28212. * @returns PhysicsRaycastResult
  28213. */
  28214. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28215. /**
  28216. * Called by the scene. No need to call it.
  28217. * @param delta defines the timespam between frames
  28218. */
  28219. _step(delta: number): void;
  28220. }
  28221. }
  28222. declare module "babylonjs/Physics/physicsImpostor" {
  28223. import { Nullable, IndicesArray } from "babylonjs/types";
  28224. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28225. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28226. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28227. import { Scene } from "babylonjs/scene";
  28228. import { Bone } from "babylonjs/Bones/bone";
  28229. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28230. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28231. import { Space } from "babylonjs/Maths/math.axis";
  28232. /**
  28233. * The interface for the physics imposter parameters
  28234. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28235. */
  28236. export interface PhysicsImpostorParameters {
  28237. /**
  28238. * The mass of the physics imposter
  28239. */
  28240. mass: number;
  28241. /**
  28242. * The friction of the physics imposter
  28243. */
  28244. friction?: number;
  28245. /**
  28246. * The coefficient of restitution of the physics imposter
  28247. */
  28248. restitution?: number;
  28249. /**
  28250. * The native options of the physics imposter
  28251. */
  28252. nativeOptions?: any;
  28253. /**
  28254. * Specifies if the parent should be ignored
  28255. */
  28256. ignoreParent?: boolean;
  28257. /**
  28258. * Specifies if bi-directional transformations should be disabled
  28259. */
  28260. disableBidirectionalTransformation?: boolean;
  28261. /**
  28262. * The pressure inside the physics imposter, soft object only
  28263. */
  28264. pressure?: number;
  28265. /**
  28266. * The stiffness the physics imposter, soft object only
  28267. */
  28268. stiffness?: number;
  28269. /**
  28270. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28271. */
  28272. velocityIterations?: number;
  28273. /**
  28274. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28275. */
  28276. positionIterations?: number;
  28277. /**
  28278. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28279. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28280. * Add to fix multiple points
  28281. */
  28282. fixedPoints?: number;
  28283. /**
  28284. * The collision margin around a soft object
  28285. */
  28286. margin?: number;
  28287. /**
  28288. * The collision margin around a soft object
  28289. */
  28290. damping?: number;
  28291. /**
  28292. * The path for a rope based on an extrusion
  28293. */
  28294. path?: any;
  28295. /**
  28296. * The shape of an extrusion used for a rope based on an extrusion
  28297. */
  28298. shape?: any;
  28299. }
  28300. /**
  28301. * Interface for a physics-enabled object
  28302. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28303. */
  28304. export interface IPhysicsEnabledObject {
  28305. /**
  28306. * The position of the physics-enabled object
  28307. */
  28308. position: Vector3;
  28309. /**
  28310. * The rotation of the physics-enabled object
  28311. */
  28312. rotationQuaternion: Nullable<Quaternion>;
  28313. /**
  28314. * The scale of the physics-enabled object
  28315. */
  28316. scaling: Vector3;
  28317. /**
  28318. * The rotation of the physics-enabled object
  28319. */
  28320. rotation?: Vector3;
  28321. /**
  28322. * The parent of the physics-enabled object
  28323. */
  28324. parent?: any;
  28325. /**
  28326. * The bounding info of the physics-enabled object
  28327. * @returns The bounding info of the physics-enabled object
  28328. */
  28329. getBoundingInfo(): BoundingInfo;
  28330. /**
  28331. * Computes the world matrix
  28332. * @param force Specifies if the world matrix should be computed by force
  28333. * @returns A world matrix
  28334. */
  28335. computeWorldMatrix(force: boolean): Matrix;
  28336. /**
  28337. * Gets the world matrix
  28338. * @returns A world matrix
  28339. */
  28340. getWorldMatrix?(): Matrix;
  28341. /**
  28342. * Gets the child meshes
  28343. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28344. * @returns An array of abstract meshes
  28345. */
  28346. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28347. /**
  28348. * Gets the vertex data
  28349. * @param kind The type of vertex data
  28350. * @returns A nullable array of numbers, or a float32 array
  28351. */
  28352. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28353. /**
  28354. * Gets the indices from the mesh
  28355. * @returns A nullable array of index arrays
  28356. */
  28357. getIndices?(): Nullable<IndicesArray>;
  28358. /**
  28359. * Gets the scene from the mesh
  28360. * @returns the indices array or null
  28361. */
  28362. getScene?(): Scene;
  28363. /**
  28364. * Gets the absolute position from the mesh
  28365. * @returns the absolute position
  28366. */
  28367. getAbsolutePosition(): Vector3;
  28368. /**
  28369. * Gets the absolute pivot point from the mesh
  28370. * @returns the absolute pivot point
  28371. */
  28372. getAbsolutePivotPoint(): Vector3;
  28373. /**
  28374. * Rotates the mesh
  28375. * @param axis The axis of rotation
  28376. * @param amount The amount of rotation
  28377. * @param space The space of the rotation
  28378. * @returns The rotation transform node
  28379. */
  28380. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28381. /**
  28382. * Translates the mesh
  28383. * @param axis The axis of translation
  28384. * @param distance The distance of translation
  28385. * @param space The space of the translation
  28386. * @returns The transform node
  28387. */
  28388. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28389. /**
  28390. * Sets the absolute position of the mesh
  28391. * @param absolutePosition The absolute position of the mesh
  28392. * @returns The transform node
  28393. */
  28394. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28395. /**
  28396. * Gets the class name of the mesh
  28397. * @returns The class name
  28398. */
  28399. getClassName(): string;
  28400. }
  28401. /**
  28402. * Represents a physics imposter
  28403. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28404. */
  28405. export class PhysicsImpostor {
  28406. /**
  28407. * The physics-enabled object used as the physics imposter
  28408. */
  28409. object: IPhysicsEnabledObject;
  28410. /**
  28411. * The type of the physics imposter
  28412. */
  28413. type: number;
  28414. private _options;
  28415. private _scene?;
  28416. /**
  28417. * The default object size of the imposter
  28418. */
  28419. static DEFAULT_OBJECT_SIZE: Vector3;
  28420. /**
  28421. * The identity quaternion of the imposter
  28422. */
  28423. static IDENTITY_QUATERNION: Quaternion;
  28424. /** @hidden */
  28425. _pluginData: any;
  28426. private _physicsEngine;
  28427. private _physicsBody;
  28428. private _bodyUpdateRequired;
  28429. private _onBeforePhysicsStepCallbacks;
  28430. private _onAfterPhysicsStepCallbacks;
  28431. /** @hidden */
  28432. _onPhysicsCollideCallbacks: Array<{
  28433. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28434. otherImpostors: Array<PhysicsImpostor>;
  28435. }>;
  28436. private _deltaPosition;
  28437. private _deltaRotation;
  28438. private _deltaRotationConjugated;
  28439. /** @hidden */
  28440. _isFromLine: boolean;
  28441. private _parent;
  28442. private _isDisposed;
  28443. private static _tmpVecs;
  28444. private static _tmpQuat;
  28445. /**
  28446. * Specifies if the physics imposter is disposed
  28447. */
  28448. get isDisposed(): boolean;
  28449. /**
  28450. * Gets the mass of the physics imposter
  28451. */
  28452. get mass(): number;
  28453. set mass(value: number);
  28454. /**
  28455. * Gets the coefficient of friction
  28456. */
  28457. get friction(): number;
  28458. /**
  28459. * Sets the coefficient of friction
  28460. */
  28461. set friction(value: number);
  28462. /**
  28463. * Gets the coefficient of restitution
  28464. */
  28465. get restitution(): number;
  28466. /**
  28467. * Sets the coefficient of restitution
  28468. */
  28469. set restitution(value: number);
  28470. /**
  28471. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28472. */
  28473. get pressure(): number;
  28474. /**
  28475. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28476. */
  28477. set pressure(value: number);
  28478. /**
  28479. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28480. */
  28481. get stiffness(): number;
  28482. /**
  28483. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28484. */
  28485. set stiffness(value: number);
  28486. /**
  28487. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28488. */
  28489. get velocityIterations(): number;
  28490. /**
  28491. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28492. */
  28493. set velocityIterations(value: number);
  28494. /**
  28495. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28496. */
  28497. get positionIterations(): number;
  28498. /**
  28499. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28500. */
  28501. set positionIterations(value: number);
  28502. /**
  28503. * The unique id of the physics imposter
  28504. * set by the physics engine when adding this impostor to the array
  28505. */
  28506. uniqueId: number;
  28507. /**
  28508. * @hidden
  28509. */
  28510. soft: boolean;
  28511. /**
  28512. * @hidden
  28513. */
  28514. segments: number;
  28515. private _joints;
  28516. /**
  28517. * Initializes the physics imposter
  28518. * @param object The physics-enabled object used as the physics imposter
  28519. * @param type The type of the physics imposter
  28520. * @param _options The options for the physics imposter
  28521. * @param _scene The Babylon scene
  28522. */
  28523. constructor(
  28524. /**
  28525. * The physics-enabled object used as the physics imposter
  28526. */
  28527. object: IPhysicsEnabledObject,
  28528. /**
  28529. * The type of the physics imposter
  28530. */
  28531. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28532. /**
  28533. * This function will completly initialize this impostor.
  28534. * It will create a new body - but only if this mesh has no parent.
  28535. * If it has, this impostor will not be used other than to define the impostor
  28536. * of the child mesh.
  28537. * @hidden
  28538. */
  28539. _init(): void;
  28540. private _getPhysicsParent;
  28541. /**
  28542. * Should a new body be generated.
  28543. * @returns boolean specifying if body initialization is required
  28544. */
  28545. isBodyInitRequired(): boolean;
  28546. /**
  28547. * Sets the updated scaling
  28548. * @param updated Specifies if the scaling is updated
  28549. */
  28550. setScalingUpdated(): void;
  28551. /**
  28552. * Force a regeneration of this or the parent's impostor's body.
  28553. * Use under cautious - This will remove all joints already implemented.
  28554. */
  28555. forceUpdate(): void;
  28556. /**
  28557. * Gets the body that holds this impostor. Either its own, or its parent.
  28558. */
  28559. get physicsBody(): any;
  28560. /**
  28561. * Get the parent of the physics imposter
  28562. * @returns Physics imposter or null
  28563. */
  28564. get parent(): Nullable<PhysicsImpostor>;
  28565. /**
  28566. * Sets the parent of the physics imposter
  28567. */
  28568. set parent(value: Nullable<PhysicsImpostor>);
  28569. /**
  28570. * Set the physics body. Used mainly by the physics engine/plugin
  28571. */
  28572. set physicsBody(physicsBody: any);
  28573. /**
  28574. * Resets the update flags
  28575. */
  28576. resetUpdateFlags(): void;
  28577. /**
  28578. * Gets the object extend size
  28579. * @returns the object extend size
  28580. */
  28581. getObjectExtendSize(): Vector3;
  28582. /**
  28583. * Gets the object center
  28584. * @returns The object center
  28585. */
  28586. getObjectCenter(): Vector3;
  28587. /**
  28588. * Get a specific parameter from the options parameters
  28589. * @param paramName The object parameter name
  28590. * @returns The object parameter
  28591. */
  28592. getParam(paramName: string): any;
  28593. /**
  28594. * Sets a specific parameter in the options given to the physics plugin
  28595. * @param paramName The parameter name
  28596. * @param value The value of the parameter
  28597. */
  28598. setParam(paramName: string, value: number): void;
  28599. /**
  28600. * Specifically change the body's mass option. Won't recreate the physics body object
  28601. * @param mass The mass of the physics imposter
  28602. */
  28603. setMass(mass: number): void;
  28604. /**
  28605. * Gets the linear velocity
  28606. * @returns linear velocity or null
  28607. */
  28608. getLinearVelocity(): Nullable<Vector3>;
  28609. /**
  28610. * Sets the linear velocity
  28611. * @param velocity linear velocity or null
  28612. */
  28613. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28614. /**
  28615. * Gets the angular velocity
  28616. * @returns angular velocity or null
  28617. */
  28618. getAngularVelocity(): Nullable<Vector3>;
  28619. /**
  28620. * Sets the angular velocity
  28621. * @param velocity The velocity or null
  28622. */
  28623. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28624. /**
  28625. * Execute a function with the physics plugin native code
  28626. * Provide a function the will have two variables - the world object and the physics body object
  28627. * @param func The function to execute with the physics plugin native code
  28628. */
  28629. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28630. /**
  28631. * Register a function that will be executed before the physics world is stepping forward
  28632. * @param func The function to execute before the physics world is stepped forward
  28633. */
  28634. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28635. /**
  28636. * Unregister a function that will be executed before the physics world is stepping forward
  28637. * @param func The function to execute before the physics world is stepped forward
  28638. */
  28639. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28640. /**
  28641. * Register a function that will be executed after the physics step
  28642. * @param func The function to execute after physics step
  28643. */
  28644. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28645. /**
  28646. * Unregisters a function that will be executed after the physics step
  28647. * @param func The function to execute after physics step
  28648. */
  28649. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28650. /**
  28651. * register a function that will be executed when this impostor collides against a different body
  28652. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28653. * @param func Callback that is executed on collision
  28654. */
  28655. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28656. /**
  28657. * Unregisters the physics imposter on contact
  28658. * @param collideAgainst The physics object to collide against
  28659. * @param func Callback to execute on collision
  28660. */
  28661. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28662. private _tmpQuat;
  28663. private _tmpQuat2;
  28664. /**
  28665. * Get the parent rotation
  28666. * @returns The parent rotation
  28667. */
  28668. getParentsRotation(): Quaternion;
  28669. /**
  28670. * this function is executed by the physics engine.
  28671. */
  28672. beforeStep: () => void;
  28673. /**
  28674. * this function is executed by the physics engine
  28675. */
  28676. afterStep: () => void;
  28677. /**
  28678. * Legacy collision detection event support
  28679. */
  28680. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28681. /**
  28682. * event and body object due to cannon's event-based architecture.
  28683. */
  28684. onCollide: (e: {
  28685. body: any;
  28686. }) => void;
  28687. /**
  28688. * Apply a force
  28689. * @param force The force to apply
  28690. * @param contactPoint The contact point for the force
  28691. * @returns The physics imposter
  28692. */
  28693. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28694. /**
  28695. * Apply an impulse
  28696. * @param force The impulse force
  28697. * @param contactPoint The contact point for the impulse force
  28698. * @returns The physics imposter
  28699. */
  28700. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28701. /**
  28702. * A help function to create a joint
  28703. * @param otherImpostor A physics imposter used to create a joint
  28704. * @param jointType The type of joint
  28705. * @param jointData The data for the joint
  28706. * @returns The physics imposter
  28707. */
  28708. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28709. /**
  28710. * Add a joint to this impostor with a different impostor
  28711. * @param otherImpostor A physics imposter used to add a joint
  28712. * @param joint The joint to add
  28713. * @returns The physics imposter
  28714. */
  28715. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28716. /**
  28717. * Add an anchor to a cloth impostor
  28718. * @param otherImpostor rigid impostor to anchor to
  28719. * @param width ratio across width from 0 to 1
  28720. * @param height ratio up height from 0 to 1
  28721. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28722. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28723. * @returns impostor the soft imposter
  28724. */
  28725. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28726. /**
  28727. * Add a hook to a rope impostor
  28728. * @param otherImpostor rigid impostor to anchor to
  28729. * @param length ratio across rope from 0 to 1
  28730. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28731. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28732. * @returns impostor the rope imposter
  28733. */
  28734. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28735. /**
  28736. * Will keep this body still, in a sleep mode.
  28737. * @returns the physics imposter
  28738. */
  28739. sleep(): PhysicsImpostor;
  28740. /**
  28741. * Wake the body up.
  28742. * @returns The physics imposter
  28743. */
  28744. wakeUp(): PhysicsImpostor;
  28745. /**
  28746. * Clones the physics imposter
  28747. * @param newObject The physics imposter clones to this physics-enabled object
  28748. * @returns A nullable physics imposter
  28749. */
  28750. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28751. /**
  28752. * Disposes the physics imposter
  28753. */
  28754. dispose(): void;
  28755. /**
  28756. * Sets the delta position
  28757. * @param position The delta position amount
  28758. */
  28759. setDeltaPosition(position: Vector3): void;
  28760. /**
  28761. * Sets the delta rotation
  28762. * @param rotation The delta rotation amount
  28763. */
  28764. setDeltaRotation(rotation: Quaternion): void;
  28765. /**
  28766. * Gets the box size of the physics imposter and stores the result in the input parameter
  28767. * @param result Stores the box size
  28768. * @returns The physics imposter
  28769. */
  28770. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28771. /**
  28772. * Gets the radius of the physics imposter
  28773. * @returns Radius of the physics imposter
  28774. */
  28775. getRadius(): number;
  28776. /**
  28777. * Sync a bone with this impostor
  28778. * @param bone The bone to sync to the impostor.
  28779. * @param boneMesh The mesh that the bone is influencing.
  28780. * @param jointPivot The pivot of the joint / bone in local space.
  28781. * @param distToJoint Optional distance from the impostor to the joint.
  28782. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28783. */
  28784. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28785. /**
  28786. * Sync impostor to a bone
  28787. * @param bone The bone that the impostor will be synced to.
  28788. * @param boneMesh The mesh that the bone is influencing.
  28789. * @param jointPivot The pivot of the joint / bone in local space.
  28790. * @param distToJoint Optional distance from the impostor to the joint.
  28791. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28792. * @param boneAxis Optional vector3 axis the bone is aligned with
  28793. */
  28794. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28795. /**
  28796. * No-Imposter type
  28797. */
  28798. static NoImpostor: number;
  28799. /**
  28800. * Sphere-Imposter type
  28801. */
  28802. static SphereImpostor: number;
  28803. /**
  28804. * Box-Imposter type
  28805. */
  28806. static BoxImpostor: number;
  28807. /**
  28808. * Plane-Imposter type
  28809. */
  28810. static PlaneImpostor: number;
  28811. /**
  28812. * Mesh-imposter type
  28813. */
  28814. static MeshImpostor: number;
  28815. /**
  28816. * Capsule-Impostor type (Ammo.js plugin only)
  28817. */
  28818. static CapsuleImpostor: number;
  28819. /**
  28820. * Cylinder-Imposter type
  28821. */
  28822. static CylinderImpostor: number;
  28823. /**
  28824. * Particle-Imposter type
  28825. */
  28826. static ParticleImpostor: number;
  28827. /**
  28828. * Heightmap-Imposter type
  28829. */
  28830. static HeightmapImpostor: number;
  28831. /**
  28832. * ConvexHull-Impostor type (Ammo.js plugin only)
  28833. */
  28834. static ConvexHullImpostor: number;
  28835. /**
  28836. * Custom-Imposter type (Ammo.js plugin only)
  28837. */
  28838. static CustomImpostor: number;
  28839. /**
  28840. * Rope-Imposter type
  28841. */
  28842. static RopeImpostor: number;
  28843. /**
  28844. * Cloth-Imposter type
  28845. */
  28846. static ClothImpostor: number;
  28847. /**
  28848. * Softbody-Imposter type
  28849. */
  28850. static SoftbodyImpostor: number;
  28851. }
  28852. }
  28853. declare module "babylonjs/Meshes/mesh" {
  28854. import { Observable } from "babylonjs/Misc/observable";
  28855. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28856. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  28857. import { Camera } from "babylonjs/Cameras/camera";
  28858. import { Scene } from "babylonjs/scene";
  28859. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  28860. import { Color4 } from "babylonjs/Maths/math.color";
  28861. import { Engine } from "babylonjs/Engines/engine";
  28862. import { Node } from "babylonjs/node";
  28863. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  28864. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  28865. import { Buffer } from "babylonjs/Meshes/buffer";
  28866. import { Geometry } from "babylonjs/Meshes/geometry";
  28867. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28868. import { SubMesh } from "babylonjs/Meshes/subMesh";
  28869. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  28870. import { Effect } from "babylonjs/Materials/effect";
  28871. import { Material } from "babylonjs/Materials/material";
  28872. import { Skeleton } from "babylonjs/Bones/skeleton";
  28873. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  28874. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  28875. import { Path3D } from "babylonjs/Maths/math.path";
  28876. import { Plane } from "babylonjs/Maths/math.plane";
  28877. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28878. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  28879. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  28880. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  28881. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28882. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  28883. /**
  28884. * @hidden
  28885. **/
  28886. export class _CreationDataStorage {
  28887. closePath?: boolean;
  28888. closeArray?: boolean;
  28889. idx: number[];
  28890. dashSize: number;
  28891. gapSize: number;
  28892. path3D: Path3D;
  28893. pathArray: Vector3[][];
  28894. arc: number;
  28895. radius: number;
  28896. cap: number;
  28897. tessellation: number;
  28898. }
  28899. /**
  28900. * @hidden
  28901. **/
  28902. class _InstanceDataStorage {
  28903. visibleInstances: any;
  28904. batchCache: _InstancesBatch;
  28905. instancesBufferSize: number;
  28906. instancesBuffer: Nullable<Buffer>;
  28907. instancesData: Float32Array;
  28908. overridenInstanceCount: number;
  28909. isFrozen: boolean;
  28910. previousBatch: Nullable<_InstancesBatch>;
  28911. hardwareInstancedRendering: boolean;
  28912. sideOrientation: number;
  28913. manualUpdate: boolean;
  28914. }
  28915. /**
  28916. * @hidden
  28917. **/
  28918. export class _InstancesBatch {
  28919. mustReturn: boolean;
  28920. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  28921. renderSelf: boolean[];
  28922. hardwareInstancedRendering: boolean[];
  28923. }
  28924. /**
  28925. * @hidden
  28926. **/
  28927. class _ThinInstanceDataStorage {
  28928. instancesCount: number;
  28929. matrixBuffer: Nullable<Buffer>;
  28930. matrixBufferSize: number;
  28931. matrixData: Nullable<Float32Array>;
  28932. boundingVectors: Array<Vector3>;
  28933. }
  28934. /**
  28935. * Class used to represent renderable models
  28936. */
  28937. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  28938. /**
  28939. * Mesh side orientation : usually the external or front surface
  28940. */
  28941. static readonly FRONTSIDE: number;
  28942. /**
  28943. * Mesh side orientation : usually the internal or back surface
  28944. */
  28945. static readonly BACKSIDE: number;
  28946. /**
  28947. * Mesh side orientation : both internal and external or front and back surfaces
  28948. */
  28949. static readonly DOUBLESIDE: number;
  28950. /**
  28951. * Mesh side orientation : by default, `FRONTSIDE`
  28952. */
  28953. static readonly DEFAULTSIDE: number;
  28954. /**
  28955. * Mesh cap setting : no cap
  28956. */
  28957. static readonly NO_CAP: number;
  28958. /**
  28959. * Mesh cap setting : one cap at the beginning of the mesh
  28960. */
  28961. static readonly CAP_START: number;
  28962. /**
  28963. * Mesh cap setting : one cap at the end of the mesh
  28964. */
  28965. static readonly CAP_END: number;
  28966. /**
  28967. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  28968. */
  28969. static readonly CAP_ALL: number;
  28970. /**
  28971. * Mesh pattern setting : no flip or rotate
  28972. */
  28973. static readonly NO_FLIP: number;
  28974. /**
  28975. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  28976. */
  28977. static readonly FLIP_TILE: number;
  28978. /**
  28979. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  28980. */
  28981. static readonly ROTATE_TILE: number;
  28982. /**
  28983. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  28984. */
  28985. static readonly FLIP_ROW: number;
  28986. /**
  28987. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  28988. */
  28989. static readonly ROTATE_ROW: number;
  28990. /**
  28991. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  28992. */
  28993. static readonly FLIP_N_ROTATE_TILE: number;
  28994. /**
  28995. * Mesh pattern setting : rotate pattern and rotate
  28996. */
  28997. static readonly FLIP_N_ROTATE_ROW: number;
  28998. /**
  28999. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29000. */
  29001. static readonly CENTER: number;
  29002. /**
  29003. * Mesh tile positioning : part tiles on left
  29004. */
  29005. static readonly LEFT: number;
  29006. /**
  29007. * Mesh tile positioning : part tiles on right
  29008. */
  29009. static readonly RIGHT: number;
  29010. /**
  29011. * Mesh tile positioning : part tiles on top
  29012. */
  29013. static readonly TOP: number;
  29014. /**
  29015. * Mesh tile positioning : part tiles on bottom
  29016. */
  29017. static readonly BOTTOM: number;
  29018. /**
  29019. * Gets the default side orientation.
  29020. * @param orientation the orientation to value to attempt to get
  29021. * @returns the default orientation
  29022. * @hidden
  29023. */
  29024. static _GetDefaultSideOrientation(orientation?: number): number;
  29025. private _internalMeshDataInfo;
  29026. get computeBonesUsingShaders(): boolean;
  29027. set computeBonesUsingShaders(value: boolean);
  29028. /**
  29029. * An event triggered before rendering the mesh
  29030. */
  29031. get onBeforeRenderObservable(): Observable<Mesh>;
  29032. /**
  29033. * An event triggered before binding the mesh
  29034. */
  29035. get onBeforeBindObservable(): Observable<Mesh>;
  29036. /**
  29037. * An event triggered after rendering the mesh
  29038. */
  29039. get onAfterRenderObservable(): Observable<Mesh>;
  29040. /**
  29041. * An event triggered before drawing the mesh
  29042. */
  29043. get onBeforeDrawObservable(): Observable<Mesh>;
  29044. private _onBeforeDrawObserver;
  29045. /**
  29046. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29047. */
  29048. set onBeforeDraw(callback: () => void);
  29049. get hasInstances(): boolean;
  29050. get hasThinInstances(): boolean;
  29051. /**
  29052. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29053. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29054. */
  29055. delayLoadState: number;
  29056. /**
  29057. * Gets the list of instances created from this mesh
  29058. * it is not supposed to be modified manually.
  29059. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29060. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29061. */
  29062. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29063. /**
  29064. * Gets the file containing delay loading data for this mesh
  29065. */
  29066. delayLoadingFile: string;
  29067. /** @hidden */
  29068. _binaryInfo: any;
  29069. /**
  29070. * User defined function used to change how LOD level selection is done
  29071. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29072. */
  29073. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29074. /**
  29075. * Gets or sets the morph target manager
  29076. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29077. */
  29078. get morphTargetManager(): Nullable<MorphTargetManager>;
  29079. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29080. /** @hidden */
  29081. _creationDataStorage: Nullable<_CreationDataStorage>;
  29082. /** @hidden */
  29083. _geometry: Nullable<Geometry>;
  29084. /** @hidden */
  29085. _delayInfo: Array<string>;
  29086. /** @hidden */
  29087. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29088. /** @hidden */
  29089. _instanceDataStorage: _InstanceDataStorage;
  29090. /** @hidden */
  29091. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29092. private _effectiveMaterial;
  29093. /** @hidden */
  29094. _shouldGenerateFlatShading: boolean;
  29095. /** @hidden */
  29096. _originalBuilderSideOrientation: number;
  29097. /**
  29098. * Use this property to change the original side orientation defined at construction time
  29099. */
  29100. overrideMaterialSideOrientation: Nullable<number>;
  29101. /**
  29102. * Gets the source mesh (the one used to clone this one from)
  29103. */
  29104. get source(): Nullable<Mesh>;
  29105. /**
  29106. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29107. */
  29108. get isUnIndexed(): boolean;
  29109. set isUnIndexed(value: boolean);
  29110. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29111. get worldMatrixInstancedBuffer(): Float32Array;
  29112. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29113. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29114. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29115. /**
  29116. * @constructor
  29117. * @param name The value used by scene.getMeshByName() to do a lookup.
  29118. * @param scene The scene to add this mesh to.
  29119. * @param parent The parent of this mesh, if it has one
  29120. * @param source An optional Mesh from which geometry is shared, cloned.
  29121. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29122. * When false, achieved by calling a clone(), also passing False.
  29123. * This will make creation of children, recursive.
  29124. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29125. */
  29126. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29127. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29128. doNotInstantiate: boolean;
  29129. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29130. /**
  29131. * Gets the class name
  29132. * @returns the string "Mesh".
  29133. */
  29134. getClassName(): string;
  29135. /** @hidden */
  29136. get _isMesh(): boolean;
  29137. /**
  29138. * Returns a description of this mesh
  29139. * @param fullDetails define if full details about this mesh must be used
  29140. * @returns a descriptive string representing this mesh
  29141. */
  29142. toString(fullDetails?: boolean): string;
  29143. /** @hidden */
  29144. _unBindEffect(): void;
  29145. /**
  29146. * Gets a boolean indicating if this mesh has LOD
  29147. */
  29148. get hasLODLevels(): boolean;
  29149. /**
  29150. * Gets the list of MeshLODLevel associated with the current mesh
  29151. * @returns an array of MeshLODLevel
  29152. */
  29153. getLODLevels(): MeshLODLevel[];
  29154. private _sortLODLevels;
  29155. /**
  29156. * Add a mesh as LOD level triggered at the given distance.
  29157. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29158. * @param distance The distance from the center of the object to show this level
  29159. * @param mesh The mesh to be added as LOD level (can be null)
  29160. * @return This mesh (for chaining)
  29161. */
  29162. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29163. /**
  29164. * Returns the LOD level mesh at the passed distance or null if not found.
  29165. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29166. * @param distance The distance from the center of the object to show this level
  29167. * @returns a Mesh or `null`
  29168. */
  29169. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29170. /**
  29171. * Remove a mesh from the LOD array
  29172. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29173. * @param mesh defines the mesh to be removed
  29174. * @return This mesh (for chaining)
  29175. */
  29176. removeLODLevel(mesh: Mesh): Mesh;
  29177. /**
  29178. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29179. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29180. * @param camera defines the camera to use to compute distance
  29181. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29182. * @return This mesh (for chaining)
  29183. */
  29184. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29185. /**
  29186. * Gets the mesh internal Geometry object
  29187. */
  29188. get geometry(): Nullable<Geometry>;
  29189. /**
  29190. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29191. * @returns the total number of vertices
  29192. */
  29193. getTotalVertices(): number;
  29194. /**
  29195. * Returns the content of an associated vertex buffer
  29196. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29197. * - VertexBuffer.PositionKind
  29198. * - VertexBuffer.UVKind
  29199. * - VertexBuffer.UV2Kind
  29200. * - VertexBuffer.UV3Kind
  29201. * - VertexBuffer.UV4Kind
  29202. * - VertexBuffer.UV5Kind
  29203. * - VertexBuffer.UV6Kind
  29204. * - VertexBuffer.ColorKind
  29205. * - VertexBuffer.MatricesIndicesKind
  29206. * - VertexBuffer.MatricesIndicesExtraKind
  29207. * - VertexBuffer.MatricesWeightsKind
  29208. * - VertexBuffer.MatricesWeightsExtraKind
  29209. * @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
  29210. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29211. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29212. */
  29213. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29214. /**
  29215. * Returns the mesh VertexBuffer object from the requested `kind`
  29216. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29217. * - VertexBuffer.PositionKind
  29218. * - VertexBuffer.NormalKind
  29219. * - VertexBuffer.UVKind
  29220. * - VertexBuffer.UV2Kind
  29221. * - VertexBuffer.UV3Kind
  29222. * - VertexBuffer.UV4Kind
  29223. * - VertexBuffer.UV5Kind
  29224. * - VertexBuffer.UV6Kind
  29225. * - VertexBuffer.ColorKind
  29226. * - VertexBuffer.MatricesIndicesKind
  29227. * - VertexBuffer.MatricesIndicesExtraKind
  29228. * - VertexBuffer.MatricesWeightsKind
  29229. * - VertexBuffer.MatricesWeightsExtraKind
  29230. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29231. */
  29232. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29233. /**
  29234. * Tests if a specific vertex buffer is associated with this mesh
  29235. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29236. * - VertexBuffer.PositionKind
  29237. * - VertexBuffer.NormalKind
  29238. * - VertexBuffer.UVKind
  29239. * - VertexBuffer.UV2Kind
  29240. * - VertexBuffer.UV3Kind
  29241. * - VertexBuffer.UV4Kind
  29242. * - VertexBuffer.UV5Kind
  29243. * - VertexBuffer.UV6Kind
  29244. * - VertexBuffer.ColorKind
  29245. * - VertexBuffer.MatricesIndicesKind
  29246. * - VertexBuffer.MatricesIndicesExtraKind
  29247. * - VertexBuffer.MatricesWeightsKind
  29248. * - VertexBuffer.MatricesWeightsExtraKind
  29249. * @returns a boolean
  29250. */
  29251. isVerticesDataPresent(kind: string): boolean;
  29252. /**
  29253. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29254. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29255. * - VertexBuffer.PositionKind
  29256. * - VertexBuffer.UVKind
  29257. * - VertexBuffer.UV2Kind
  29258. * - VertexBuffer.UV3Kind
  29259. * - VertexBuffer.UV4Kind
  29260. * - VertexBuffer.UV5Kind
  29261. * - VertexBuffer.UV6Kind
  29262. * - VertexBuffer.ColorKind
  29263. * - VertexBuffer.MatricesIndicesKind
  29264. * - VertexBuffer.MatricesIndicesExtraKind
  29265. * - VertexBuffer.MatricesWeightsKind
  29266. * - VertexBuffer.MatricesWeightsExtraKind
  29267. * @returns a boolean
  29268. */
  29269. isVertexBufferUpdatable(kind: string): boolean;
  29270. /**
  29271. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29272. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29273. * - VertexBuffer.PositionKind
  29274. * - VertexBuffer.NormalKind
  29275. * - VertexBuffer.UVKind
  29276. * - VertexBuffer.UV2Kind
  29277. * - VertexBuffer.UV3Kind
  29278. * - VertexBuffer.UV4Kind
  29279. * - VertexBuffer.UV5Kind
  29280. * - VertexBuffer.UV6Kind
  29281. * - VertexBuffer.ColorKind
  29282. * - VertexBuffer.MatricesIndicesKind
  29283. * - VertexBuffer.MatricesIndicesExtraKind
  29284. * - VertexBuffer.MatricesWeightsKind
  29285. * - VertexBuffer.MatricesWeightsExtraKind
  29286. * @returns an array of strings
  29287. */
  29288. getVerticesDataKinds(): string[];
  29289. /**
  29290. * Returns a positive integer : the total number of indices in this mesh geometry.
  29291. * @returns the numner of indices or zero if the mesh has no geometry.
  29292. */
  29293. getTotalIndices(): number;
  29294. /**
  29295. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29296. * @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.
  29297. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29298. * @returns the indices array or an empty array if the mesh has no geometry
  29299. */
  29300. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29301. get isBlocked(): boolean;
  29302. /**
  29303. * Determine if the current mesh is ready to be rendered
  29304. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29305. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29306. * @returns true if all associated assets are ready (material, textures, shaders)
  29307. */
  29308. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29309. /**
  29310. * 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.
  29311. */
  29312. get areNormalsFrozen(): boolean;
  29313. /**
  29314. * 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.
  29315. * @returns the current mesh
  29316. */
  29317. freezeNormals(): Mesh;
  29318. /**
  29319. * 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
  29320. * @returns the current mesh
  29321. */
  29322. unfreezeNormals(): Mesh;
  29323. /**
  29324. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29325. */
  29326. set overridenInstanceCount(count: number);
  29327. /** @hidden */
  29328. _preActivate(): Mesh;
  29329. /** @hidden */
  29330. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29331. /** @hidden */
  29332. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29333. protected _afterComputeWorldMatrix(): void;
  29334. /** @hidden */
  29335. _postActivate(): void;
  29336. /**
  29337. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29338. * This means the mesh underlying bounding box and sphere are recomputed.
  29339. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29340. * @returns the current mesh
  29341. */
  29342. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29343. /** @hidden */
  29344. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29345. /**
  29346. * This function will subdivide the mesh into multiple submeshes
  29347. * @param count defines the expected number of submeshes
  29348. */
  29349. subdivide(count: number): void;
  29350. /**
  29351. * Copy a FloatArray into a specific associated vertex buffer
  29352. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29353. * - VertexBuffer.PositionKind
  29354. * - VertexBuffer.UVKind
  29355. * - VertexBuffer.UV2Kind
  29356. * - VertexBuffer.UV3Kind
  29357. * - VertexBuffer.UV4Kind
  29358. * - VertexBuffer.UV5Kind
  29359. * - VertexBuffer.UV6Kind
  29360. * - VertexBuffer.ColorKind
  29361. * - VertexBuffer.MatricesIndicesKind
  29362. * - VertexBuffer.MatricesIndicesExtraKind
  29363. * - VertexBuffer.MatricesWeightsKind
  29364. * - VertexBuffer.MatricesWeightsExtraKind
  29365. * @param data defines the data source
  29366. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29367. * @param stride defines the data stride size (can be null)
  29368. * @returns the current mesh
  29369. */
  29370. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29371. /**
  29372. * Delete a vertex buffer associated with this mesh
  29373. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29374. * - VertexBuffer.PositionKind
  29375. * - VertexBuffer.UVKind
  29376. * - VertexBuffer.UV2Kind
  29377. * - VertexBuffer.UV3Kind
  29378. * - VertexBuffer.UV4Kind
  29379. * - VertexBuffer.UV5Kind
  29380. * - VertexBuffer.UV6Kind
  29381. * - VertexBuffer.ColorKind
  29382. * - VertexBuffer.MatricesIndicesKind
  29383. * - VertexBuffer.MatricesIndicesExtraKind
  29384. * - VertexBuffer.MatricesWeightsKind
  29385. * - VertexBuffer.MatricesWeightsExtraKind
  29386. */
  29387. removeVerticesData(kind: string): void;
  29388. /**
  29389. * Flags an associated vertex buffer as updatable
  29390. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29391. * - VertexBuffer.PositionKind
  29392. * - VertexBuffer.UVKind
  29393. * - VertexBuffer.UV2Kind
  29394. * - VertexBuffer.UV3Kind
  29395. * - VertexBuffer.UV4Kind
  29396. * - VertexBuffer.UV5Kind
  29397. * - VertexBuffer.UV6Kind
  29398. * - VertexBuffer.ColorKind
  29399. * - VertexBuffer.MatricesIndicesKind
  29400. * - VertexBuffer.MatricesIndicesExtraKind
  29401. * - VertexBuffer.MatricesWeightsKind
  29402. * - VertexBuffer.MatricesWeightsExtraKind
  29403. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29404. */
  29405. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29406. /**
  29407. * Sets the mesh global Vertex Buffer
  29408. * @param buffer defines the buffer to use
  29409. * @returns the current mesh
  29410. */
  29411. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29412. /**
  29413. * Update a specific associated vertex buffer
  29414. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29415. * - VertexBuffer.PositionKind
  29416. * - VertexBuffer.UVKind
  29417. * - VertexBuffer.UV2Kind
  29418. * - VertexBuffer.UV3Kind
  29419. * - VertexBuffer.UV4Kind
  29420. * - VertexBuffer.UV5Kind
  29421. * - VertexBuffer.UV6Kind
  29422. * - VertexBuffer.ColorKind
  29423. * - VertexBuffer.MatricesIndicesKind
  29424. * - VertexBuffer.MatricesIndicesExtraKind
  29425. * - VertexBuffer.MatricesWeightsKind
  29426. * - VertexBuffer.MatricesWeightsExtraKind
  29427. * @param data defines the data source
  29428. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29429. * @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)
  29430. * @returns the current mesh
  29431. */
  29432. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29433. /**
  29434. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29435. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29436. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29437. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29438. * @returns the current mesh
  29439. */
  29440. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29441. /**
  29442. * Creates a un-shared specific occurence of the geometry for the mesh.
  29443. * @returns the current mesh
  29444. */
  29445. makeGeometryUnique(): Mesh;
  29446. /**
  29447. * Set the index buffer of this mesh
  29448. * @param indices defines the source data
  29449. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29450. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29451. * @returns the current mesh
  29452. */
  29453. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29454. /**
  29455. * Update the current index buffer
  29456. * @param indices defines the source data
  29457. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29458. * @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)
  29459. * @returns the current mesh
  29460. */
  29461. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29462. /**
  29463. * Invert the geometry to move from a right handed system to a left handed one.
  29464. * @returns the current mesh
  29465. */
  29466. toLeftHanded(): Mesh;
  29467. /** @hidden */
  29468. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29469. /** @hidden */
  29470. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29471. /**
  29472. * Registers for this mesh a javascript function called just before the rendering process
  29473. * @param func defines the function to call before rendering this mesh
  29474. * @returns the current mesh
  29475. */
  29476. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29477. /**
  29478. * Disposes a previously registered javascript function called before the rendering
  29479. * @param func defines the function to remove
  29480. * @returns the current mesh
  29481. */
  29482. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29483. /**
  29484. * Registers for this mesh a javascript function called just after the rendering is complete
  29485. * @param func defines the function to call after rendering this mesh
  29486. * @returns the current mesh
  29487. */
  29488. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29489. /**
  29490. * Disposes a previously registered javascript function called after the rendering.
  29491. * @param func defines the function to remove
  29492. * @returns the current mesh
  29493. */
  29494. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29495. /** @hidden */
  29496. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29497. /** @hidden */
  29498. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29499. /** @hidden */
  29500. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29501. /** @hidden */
  29502. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29503. /** @hidden */
  29504. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29505. /** @hidden */
  29506. _rebuild(): void;
  29507. /** @hidden */
  29508. _freeze(): void;
  29509. /** @hidden */
  29510. _unFreeze(): void;
  29511. /**
  29512. * 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
  29513. * @param subMesh defines the subMesh to render
  29514. * @param enableAlphaMode defines if alpha mode can be changed
  29515. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29516. * @returns the current mesh
  29517. */
  29518. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29519. private _onBeforeDraw;
  29520. /**
  29521. * Renormalize the mesh and patch it up if there are no weights
  29522. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29523. * However in the case of zero weights then we set just a single influence to 1.
  29524. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29525. */
  29526. cleanMatrixWeights(): void;
  29527. private normalizeSkinFourWeights;
  29528. private normalizeSkinWeightsAndExtra;
  29529. /**
  29530. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29531. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29532. * the user know there was an issue with importing the mesh
  29533. * @returns a validation object with skinned, valid and report string
  29534. */
  29535. validateSkinning(): {
  29536. skinned: boolean;
  29537. valid: boolean;
  29538. report: string;
  29539. };
  29540. /** @hidden */
  29541. _checkDelayState(): Mesh;
  29542. private _queueLoad;
  29543. /**
  29544. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29545. * A mesh is in the frustum if its bounding box intersects the frustum
  29546. * @param frustumPlanes defines the frustum to test
  29547. * @returns true if the mesh is in the frustum planes
  29548. */
  29549. isInFrustum(frustumPlanes: Plane[]): boolean;
  29550. /**
  29551. * Sets the mesh material by the material or multiMaterial `id` property
  29552. * @param id is a string identifying the material or the multiMaterial
  29553. * @returns the current mesh
  29554. */
  29555. setMaterialByID(id: string): Mesh;
  29556. /**
  29557. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29558. * @returns an array of IAnimatable
  29559. */
  29560. getAnimatables(): IAnimatable[];
  29561. /**
  29562. * Modifies the mesh geometry according to the passed transformation matrix.
  29563. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29564. * The mesh normals are modified using the same transformation.
  29565. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29566. * @param transform defines the transform matrix to use
  29567. * @see https://doc.babylonjs.com/resources/baking_transformations
  29568. * @returns the current mesh
  29569. */
  29570. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29571. /**
  29572. * Modifies the mesh geometry according to its own current World Matrix.
  29573. * The mesh World Matrix is then reset.
  29574. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29575. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29576. * @see https://doc.babylonjs.com/resources/baking_transformations
  29577. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29578. * @returns the current mesh
  29579. */
  29580. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29581. /** @hidden */
  29582. get _positions(): Nullable<Vector3[]>;
  29583. /** @hidden */
  29584. _resetPointsArrayCache(): Mesh;
  29585. /** @hidden */
  29586. _generatePointsArray(): boolean;
  29587. /**
  29588. * Returns a new Mesh object generated from the current mesh properties.
  29589. * This method must not get confused with createInstance()
  29590. * @param name is a string, the name given to the new mesh
  29591. * @param newParent can be any Node object (default `null`)
  29592. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29593. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29594. * @returns a new mesh
  29595. */
  29596. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29597. /**
  29598. * Releases resources associated with this mesh.
  29599. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29600. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29601. */
  29602. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29603. /** @hidden */
  29604. _disposeInstanceSpecificData(): void;
  29605. /** @hidden */
  29606. _disposeThinInstanceSpecificData(): void;
  29607. /**
  29608. * Modifies the mesh geometry according to a displacement map.
  29609. * 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.
  29610. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29611. * @param url is a string, the URL from the image file is to be downloaded.
  29612. * @param minHeight is the lower limit of the displacement.
  29613. * @param maxHeight is the upper limit of the displacement.
  29614. * @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.
  29615. * @param uvOffset is an optional vector2 used to offset UV.
  29616. * @param uvScale is an optional vector2 used to scale UV.
  29617. * @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.
  29618. * @returns the Mesh.
  29619. */
  29620. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29621. /**
  29622. * Modifies the mesh geometry according to a displacementMap buffer.
  29623. * 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.
  29624. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29625. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29626. * @param heightMapWidth is the width of the buffer image.
  29627. * @param heightMapHeight is the height of the buffer image.
  29628. * @param minHeight is the lower limit of the displacement.
  29629. * @param maxHeight is the upper limit of the displacement.
  29630. * @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.
  29631. * @param uvOffset is an optional vector2 used to offset UV.
  29632. * @param uvScale is an optional vector2 used to scale UV.
  29633. * @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.
  29634. * @returns the Mesh.
  29635. */
  29636. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29637. /**
  29638. * Modify the mesh to get a flat shading rendering.
  29639. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29640. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29641. * @returns current mesh
  29642. */
  29643. convertToFlatShadedMesh(): Mesh;
  29644. /**
  29645. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29646. * In other words, more vertices, no more indices and a single bigger VBO.
  29647. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29648. * @returns current mesh
  29649. */
  29650. convertToUnIndexedMesh(): Mesh;
  29651. /**
  29652. * Inverses facet orientations.
  29653. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29654. * @param flipNormals will also inverts the normals
  29655. * @returns current mesh
  29656. */
  29657. flipFaces(flipNormals?: boolean): Mesh;
  29658. /**
  29659. * Increase the number of facets and hence vertices in a mesh
  29660. * Vertex normals are interpolated from existing vertex normals
  29661. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29662. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29663. */
  29664. increaseVertices(numberPerEdge: number): void;
  29665. /**
  29666. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29667. * This will undo any application of covertToFlatShadedMesh
  29668. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29669. */
  29670. forceSharedVertices(): void;
  29671. /** @hidden */
  29672. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29673. /** @hidden */
  29674. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29675. /**
  29676. * Creates a new InstancedMesh object from the mesh model.
  29677. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29678. * @param name defines the name of the new instance
  29679. * @returns a new InstancedMesh
  29680. */
  29681. createInstance(name: string): InstancedMesh;
  29682. /**
  29683. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29684. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29685. * @returns the current mesh
  29686. */
  29687. synchronizeInstances(): Mesh;
  29688. /**
  29689. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29690. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29691. * This should be used together with the simplification to avoid disappearing triangles.
  29692. * @param successCallback an optional success callback to be called after the optimization finished.
  29693. * @returns the current mesh
  29694. */
  29695. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29696. /**
  29697. * Serialize current mesh
  29698. * @param serializationObject defines the object which will receive the serialization data
  29699. */
  29700. serialize(serializationObject: any): void;
  29701. /** @hidden */
  29702. _syncGeometryWithMorphTargetManager(): void;
  29703. /** @hidden */
  29704. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29705. /**
  29706. * Returns a new Mesh object parsed from the source provided.
  29707. * @param parsedMesh is the source
  29708. * @param scene defines the hosting scene
  29709. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29710. * @returns a new Mesh
  29711. */
  29712. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29713. /**
  29714. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29715. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29716. * @param name defines the name of the mesh to create
  29717. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29718. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29719. * @param closePath creates a seam between the first and the last points of each path of the path array
  29720. * @param offset is taken in account only if the `pathArray` is containing a single path
  29721. * @param scene defines the hosting scene
  29722. * @param updatable defines if the mesh must be flagged as updatable
  29723. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29724. * @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)
  29725. * @returns a new Mesh
  29726. */
  29727. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29728. /**
  29729. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29730. * @param name defines the name of the mesh to create
  29731. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29732. * @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
  29733. * @param scene defines the hosting scene
  29734. * @param updatable defines if the mesh must be flagged as updatable
  29735. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29736. * @returns a new Mesh
  29737. */
  29738. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29739. /**
  29740. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29741. * @param name defines the name of the mesh to create
  29742. * @param size sets the size (float) of each box side (default 1)
  29743. * @param scene defines the hosting scene
  29744. * @param updatable defines if the mesh must be flagged as updatable
  29745. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29746. * @returns a new Mesh
  29747. */
  29748. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29749. /**
  29750. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29751. * @param name defines the name of the mesh to create
  29752. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29753. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29754. * @param scene defines the hosting scene
  29755. * @param updatable defines if the mesh must be flagged as updatable
  29756. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29757. * @returns a new Mesh
  29758. */
  29759. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29760. /**
  29761. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29762. * @param name defines the name of the mesh to create
  29763. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29764. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29765. * @param scene defines the hosting scene
  29766. * @returns a new Mesh
  29767. */
  29768. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29769. /**
  29770. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29771. * @param name defines the name of the mesh to create
  29772. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29773. * @param diameterTop set the top cap diameter (floats, default 1)
  29774. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29775. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29776. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29777. * @param scene defines the hosting scene
  29778. * @param updatable defines if the mesh must be flagged as updatable
  29779. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29780. * @returns a new Mesh
  29781. */
  29782. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29783. /**
  29784. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29785. * @param name defines the name of the mesh to create
  29786. * @param diameter sets the diameter size (float) of the torus (default 1)
  29787. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29788. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29789. * @param scene defines the hosting scene
  29790. * @param updatable defines if the mesh must be flagged as updatable
  29791. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29792. * @returns a new Mesh
  29793. */
  29794. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29795. /**
  29796. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29797. * @param name defines the name of the mesh to create
  29798. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29799. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29800. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29801. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29802. * @param p the number of windings on X axis (positive integers, default 2)
  29803. * @param q the number of windings on Y axis (positive integers, default 3)
  29804. * @param scene defines the hosting scene
  29805. * @param updatable defines if the mesh must be flagged as updatable
  29806. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29807. * @returns a new Mesh
  29808. */
  29809. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29810. /**
  29811. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  29812. * @param name defines the name of the mesh to create
  29813. * @param points is an array successive Vector3
  29814. * @param scene defines the hosting scene
  29815. * @param updatable defines if the mesh must be flagged as updatable
  29816. * @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).
  29817. * @returns a new Mesh
  29818. */
  29819. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  29820. /**
  29821. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  29822. * @param name defines the name of the mesh to create
  29823. * @param points is an array successive Vector3
  29824. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  29825. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  29826. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  29827. * @param scene defines the hosting scene
  29828. * @param updatable defines if the mesh must be flagged as updatable
  29829. * @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)
  29830. * @returns a new Mesh
  29831. */
  29832. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  29833. /**
  29834. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  29835. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  29836. * 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.
  29837. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29838. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  29839. * Remember you can only change the shape positions, not their number when updating a polygon.
  29840. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  29841. * @param name defines the name of the mesh to create
  29842. * @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
  29843. * @param scene defines the hosting scene
  29844. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29845. * @param updatable defines if the mesh must be flagged as updatable
  29846. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29847. * @param earcutInjection can be used to inject your own earcut reference
  29848. * @returns a new Mesh
  29849. */
  29850. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29851. /**
  29852. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  29853. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  29854. * @param name defines the name of the mesh to create
  29855. * @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
  29856. * @param depth defines the height of extrusion
  29857. * @param scene defines the hosting scene
  29858. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29859. * @param updatable defines if the mesh must be flagged as updatable
  29860. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29861. * @param earcutInjection can be used to inject your own earcut reference
  29862. * @returns a new Mesh
  29863. */
  29864. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29865. /**
  29866. * Creates an extruded shape mesh.
  29867. * 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
  29868. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29869. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29870. * @param name defines the name of the mesh to create
  29871. * @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
  29872. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29873. * @param scale is the value to scale the shape
  29874. * @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
  29875. * @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
  29876. * @param scene defines the hosting scene
  29877. * @param updatable defines if the mesh must be flagged as updatable
  29878. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29879. * @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)
  29880. * @returns a new Mesh
  29881. */
  29882. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29883. /**
  29884. * Creates an custom extruded shape mesh.
  29885. * The custom extrusion is a parametric shape.
  29886. * It has no predefined shape. Its final shape will depend on the input parameters.
  29887. * Please consider using the same method from the MeshBuilder class instead
  29888. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29889. * @param name defines the name of the mesh to create
  29890. * @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
  29891. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29892. * @param scaleFunction is a custom Javascript function called on each path point
  29893. * @param rotationFunction is a custom Javascript function called on each path point
  29894. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  29895. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  29896. * @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
  29897. * @param scene defines the hosting scene
  29898. * @param updatable defines if the mesh must be flagged as updatable
  29899. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29900. * @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)
  29901. * @returns a new Mesh
  29902. */
  29903. 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;
  29904. /**
  29905. * Creates lathe mesh.
  29906. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  29907. * Please consider using the same method from the MeshBuilder class instead
  29908. * @param name defines the name of the mesh to create
  29909. * @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
  29910. * @param radius is the radius value of the lathe
  29911. * @param tessellation is the side number of the lathe.
  29912. * @param scene defines the hosting scene
  29913. * @param updatable defines if the mesh must be flagged as updatable
  29914. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29915. * @returns a new Mesh
  29916. */
  29917. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29918. /**
  29919. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  29920. * @param name defines the name of the mesh to create
  29921. * @param size sets the size (float) of both sides of the plane at once (default 1)
  29922. * @param scene defines the hosting scene
  29923. * @param updatable defines if the mesh must be flagged as updatable
  29924. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29925. * @returns a new Mesh
  29926. */
  29927. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29928. /**
  29929. * Creates a ground mesh.
  29930. * Please consider using the same method from the MeshBuilder class instead
  29931. * @param name defines the name of the mesh to create
  29932. * @param width set the width of the ground
  29933. * @param height set the height of the ground
  29934. * @param subdivisions sets the number of subdivisions per side
  29935. * @param scene defines the hosting scene
  29936. * @param updatable defines if the mesh must be flagged as updatable
  29937. * @returns a new Mesh
  29938. */
  29939. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  29940. /**
  29941. * Creates a tiled ground mesh.
  29942. * Please consider using the same method from the MeshBuilder class instead
  29943. * @param name defines the name of the mesh to create
  29944. * @param xmin set the ground minimum X coordinate
  29945. * @param zmin set the ground minimum Y coordinate
  29946. * @param xmax set the ground maximum X coordinate
  29947. * @param zmax set the ground maximum Z coordinate
  29948. * @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
  29949. * @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
  29950. * @param scene defines the hosting scene
  29951. * @param updatable defines if the mesh must be flagged as updatable
  29952. * @returns a new Mesh
  29953. */
  29954. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  29955. w: number;
  29956. h: number;
  29957. }, precision: {
  29958. w: number;
  29959. h: number;
  29960. }, scene: Scene, updatable?: boolean): Mesh;
  29961. /**
  29962. * Creates a ground mesh from a height map.
  29963. * Please consider using the same method from the MeshBuilder class instead
  29964. * @see https://doc.babylonjs.com/babylon101/height_map
  29965. * @param name defines the name of the mesh to create
  29966. * @param url sets the URL of the height map image resource
  29967. * @param width set the ground width size
  29968. * @param height set the ground height size
  29969. * @param subdivisions sets the number of subdivision per side
  29970. * @param minHeight is the minimum altitude on the ground
  29971. * @param maxHeight is the maximum altitude on the ground
  29972. * @param scene defines the hosting scene
  29973. * @param updatable defines if the mesh must be flagged as updatable
  29974. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  29975. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  29976. * @returns a new Mesh
  29977. */
  29978. 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;
  29979. /**
  29980. * Creates a tube mesh.
  29981. * The tube is a parametric shape.
  29982. * It has no predefined shape. Its final shape will depend on the input parameters.
  29983. * Please consider using the same method from the MeshBuilder class instead
  29984. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29985. * @param name defines the name of the mesh to create
  29986. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  29987. * @param radius sets the tube radius size
  29988. * @param tessellation is the number of sides on the tubular surface
  29989. * @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
  29990. * @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
  29991. * @param scene defines the hosting scene
  29992. * @param updatable defines if the mesh must be flagged as updatable
  29993. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29994. * @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)
  29995. * @returns a new Mesh
  29996. */
  29997. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  29998. (i: number, distance: number): number;
  29999. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30000. /**
  30001. * Creates a polyhedron mesh.
  30002. * Please consider using the same method from the MeshBuilder class instead.
  30003. * * 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
  30004. * * The parameter `size` (positive float, default 1) sets the polygon size
  30005. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30006. * * 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`
  30007. * * 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
  30008. * * 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)`)
  30009. * * 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
  30010. * * 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
  30011. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30012. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30013. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30014. * @param name defines the name of the mesh to create
  30015. * @param options defines the options used to create the mesh
  30016. * @param scene defines the hosting scene
  30017. * @returns a new Mesh
  30018. */
  30019. static CreatePolyhedron(name: string, options: {
  30020. type?: number;
  30021. size?: number;
  30022. sizeX?: number;
  30023. sizeY?: number;
  30024. sizeZ?: number;
  30025. custom?: any;
  30026. faceUV?: Vector4[];
  30027. faceColors?: Color4[];
  30028. updatable?: boolean;
  30029. sideOrientation?: number;
  30030. }, scene: Scene): Mesh;
  30031. /**
  30032. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30033. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30034. * * 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`)
  30035. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30036. * * 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
  30037. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30038. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30039. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30040. * @param name defines the name of the mesh
  30041. * @param options defines the options used to create the mesh
  30042. * @param scene defines the hosting scene
  30043. * @returns a new Mesh
  30044. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30045. */
  30046. static CreateIcoSphere(name: string, options: {
  30047. radius?: number;
  30048. flat?: boolean;
  30049. subdivisions?: number;
  30050. sideOrientation?: number;
  30051. updatable?: boolean;
  30052. }, scene: Scene): Mesh;
  30053. /**
  30054. * Creates a decal mesh.
  30055. * Please consider using the same method from the MeshBuilder class instead.
  30056. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30057. * @param name defines the name of the mesh
  30058. * @param sourceMesh defines the mesh receiving the decal
  30059. * @param position sets the position of the decal in world coordinates
  30060. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30061. * @param size sets the decal scaling
  30062. * @param angle sets the angle to rotate the decal
  30063. * @returns a new Mesh
  30064. */
  30065. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30066. /**
  30067. * Prepare internal position array for software CPU skinning
  30068. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30069. */
  30070. setPositionsForCPUSkinning(): Float32Array;
  30071. /**
  30072. * Prepare internal normal array for software CPU skinning
  30073. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30074. */
  30075. setNormalsForCPUSkinning(): Float32Array;
  30076. /**
  30077. * Updates the vertex buffer by applying transformation from the bones
  30078. * @param skeleton defines the skeleton to apply to current mesh
  30079. * @returns the current mesh
  30080. */
  30081. applySkeleton(skeleton: Skeleton): Mesh;
  30082. /**
  30083. * 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
  30084. * @param meshes defines the list of meshes to scan
  30085. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30086. */
  30087. static MinMax(meshes: AbstractMesh[]): {
  30088. min: Vector3;
  30089. max: Vector3;
  30090. };
  30091. /**
  30092. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30093. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30094. * @returns a vector3
  30095. */
  30096. static Center(meshesOrMinMaxVector: {
  30097. min: Vector3;
  30098. max: Vector3;
  30099. } | AbstractMesh[]): Vector3;
  30100. /**
  30101. * Merge the array of meshes into a single mesh for performance reasons.
  30102. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30103. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30104. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30105. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30106. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30107. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30108. * @returns a new mesh
  30109. */
  30110. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30111. /** @hidden */
  30112. addInstance(instance: InstancedMesh): void;
  30113. /** @hidden */
  30114. removeInstance(instance: InstancedMesh): void;
  30115. }
  30116. }
  30117. declare module "babylonjs/Cameras/camera" {
  30118. import { SmartArray } from "babylonjs/Misc/smartArray";
  30119. import { Observable } from "babylonjs/Misc/observable";
  30120. import { Nullable } from "babylonjs/types";
  30121. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30122. import { Scene } from "babylonjs/scene";
  30123. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30124. import { Node } from "babylonjs/node";
  30125. import { Mesh } from "babylonjs/Meshes/mesh";
  30126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30127. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30128. import { Viewport } from "babylonjs/Maths/math.viewport";
  30129. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30130. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30131. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30132. import { Ray } from "babylonjs/Culling/ray";
  30133. /**
  30134. * This is the base class of all the camera used in the application.
  30135. * @see https://doc.babylonjs.com/features/cameras
  30136. */
  30137. export class Camera extends Node {
  30138. /** @hidden */
  30139. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30140. /**
  30141. * This is the default projection mode used by the cameras.
  30142. * It helps recreating a feeling of perspective and better appreciate depth.
  30143. * This is the best way to simulate real life cameras.
  30144. */
  30145. static readonly PERSPECTIVE_CAMERA: number;
  30146. /**
  30147. * This helps creating camera with an orthographic mode.
  30148. * 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.
  30149. */
  30150. static readonly ORTHOGRAPHIC_CAMERA: number;
  30151. /**
  30152. * This is the default FOV mode for perspective cameras.
  30153. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30154. */
  30155. static readonly FOVMODE_VERTICAL_FIXED: number;
  30156. /**
  30157. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30158. */
  30159. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30160. /**
  30161. * This specifies ther is no need for a camera rig.
  30162. * Basically only one eye is rendered corresponding to the camera.
  30163. */
  30164. static readonly RIG_MODE_NONE: number;
  30165. /**
  30166. * Simulates a camera Rig with one blue eye and one red eye.
  30167. * This can be use with 3d blue and red glasses.
  30168. */
  30169. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30170. /**
  30171. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30172. */
  30173. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30174. /**
  30175. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30176. */
  30177. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30178. /**
  30179. * Defines that both eyes of the camera will be rendered over under each other.
  30180. */
  30181. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30182. /**
  30183. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30184. */
  30185. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30186. /**
  30187. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30188. */
  30189. static readonly RIG_MODE_VR: number;
  30190. /**
  30191. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30192. */
  30193. static readonly RIG_MODE_WEBVR: number;
  30194. /**
  30195. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30196. */
  30197. static readonly RIG_MODE_CUSTOM: number;
  30198. /**
  30199. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30200. */
  30201. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30202. /**
  30203. * Define the input manager associated with the camera.
  30204. */
  30205. inputs: CameraInputsManager<Camera>;
  30206. /** @hidden */
  30207. _position: Vector3;
  30208. /**
  30209. * Define the current local position of the camera in the scene
  30210. */
  30211. get position(): Vector3;
  30212. set position(newPosition: Vector3);
  30213. /**
  30214. * The vector the camera should consider as up.
  30215. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30216. */
  30217. upVector: Vector3;
  30218. /**
  30219. * Define the current limit on the left side for an orthographic camera
  30220. * In scene unit
  30221. */
  30222. orthoLeft: Nullable<number>;
  30223. /**
  30224. * Define the current limit on the right side for an orthographic camera
  30225. * In scene unit
  30226. */
  30227. orthoRight: Nullable<number>;
  30228. /**
  30229. * Define the current limit on the bottom side for an orthographic camera
  30230. * In scene unit
  30231. */
  30232. orthoBottom: Nullable<number>;
  30233. /**
  30234. * Define the current limit on the top side for an orthographic camera
  30235. * In scene unit
  30236. */
  30237. orthoTop: Nullable<number>;
  30238. /**
  30239. * Field Of View is set in Radians. (default is 0.8)
  30240. */
  30241. fov: number;
  30242. /**
  30243. * Define the minimum distance the camera can see from.
  30244. * This is important to note that the depth buffer are not infinite and the closer it starts
  30245. * the more your scene might encounter depth fighting issue.
  30246. */
  30247. minZ: number;
  30248. /**
  30249. * Define the maximum distance the camera can see to.
  30250. * This is important to note that the depth buffer are not infinite and the further it end
  30251. * the more your scene might encounter depth fighting issue.
  30252. */
  30253. maxZ: number;
  30254. /**
  30255. * Define the default inertia of the camera.
  30256. * This helps giving a smooth feeling to the camera movement.
  30257. */
  30258. inertia: number;
  30259. /**
  30260. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30261. */
  30262. mode: number;
  30263. /**
  30264. * Define whether the camera is intermediate.
  30265. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30266. */
  30267. isIntermediate: boolean;
  30268. /**
  30269. * Define the viewport of the camera.
  30270. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30271. */
  30272. viewport: Viewport;
  30273. /**
  30274. * Restricts the camera to viewing objects with the same layerMask.
  30275. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30276. */
  30277. layerMask: number;
  30278. /**
  30279. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30280. */
  30281. fovMode: number;
  30282. /**
  30283. * Rig mode of the camera.
  30284. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30285. * This is normally controlled byt the camera themselves as internal use.
  30286. */
  30287. cameraRigMode: number;
  30288. /**
  30289. * Defines the distance between both "eyes" in case of a RIG
  30290. */
  30291. interaxialDistance: number;
  30292. /**
  30293. * Defines if stereoscopic rendering is done side by side or over under.
  30294. */
  30295. isStereoscopicSideBySide: boolean;
  30296. /**
  30297. * 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
  30298. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30299. * else in the scene. (Eg. security camera)
  30300. *
  30301. * 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)
  30302. */
  30303. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30304. /**
  30305. * When set, the camera will render to this render target instead of the default canvas
  30306. *
  30307. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30308. */
  30309. outputRenderTarget: Nullable<RenderTargetTexture>;
  30310. /**
  30311. * Observable triggered when the camera view matrix has changed.
  30312. */
  30313. onViewMatrixChangedObservable: Observable<Camera>;
  30314. /**
  30315. * Observable triggered when the camera Projection matrix has changed.
  30316. */
  30317. onProjectionMatrixChangedObservable: Observable<Camera>;
  30318. /**
  30319. * Observable triggered when the inputs have been processed.
  30320. */
  30321. onAfterCheckInputsObservable: Observable<Camera>;
  30322. /**
  30323. * Observable triggered when reset has been called and applied to the camera.
  30324. */
  30325. onRestoreStateObservable: Observable<Camera>;
  30326. /**
  30327. * Is this camera a part of a rig system?
  30328. */
  30329. isRigCamera: boolean;
  30330. /**
  30331. * If isRigCamera set to true this will be set with the parent camera.
  30332. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30333. */
  30334. rigParent?: Camera;
  30335. /** @hidden */
  30336. _cameraRigParams: any;
  30337. /** @hidden */
  30338. _rigCameras: Camera[];
  30339. /** @hidden */
  30340. _rigPostProcess: Nullable<PostProcess>;
  30341. protected _webvrViewMatrix: Matrix;
  30342. /** @hidden */
  30343. _skipRendering: boolean;
  30344. /** @hidden */
  30345. _projectionMatrix: Matrix;
  30346. /** @hidden */
  30347. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30348. /** @hidden */
  30349. _activeMeshes: SmartArray<AbstractMesh>;
  30350. protected _globalPosition: Vector3;
  30351. /** @hidden */
  30352. _computedViewMatrix: Matrix;
  30353. private _doNotComputeProjectionMatrix;
  30354. private _transformMatrix;
  30355. private _frustumPlanes;
  30356. private _refreshFrustumPlanes;
  30357. private _storedFov;
  30358. private _stateStored;
  30359. /**
  30360. * Instantiates a new camera object.
  30361. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30362. * @see https://doc.babylonjs.com/features/cameras
  30363. * @param name Defines the name of the camera in the scene
  30364. * @param position Defines the position of the camera
  30365. * @param scene Defines the scene the camera belongs too
  30366. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30367. */
  30368. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30369. /**
  30370. * Store current camera state (fov, position, etc..)
  30371. * @returns the camera
  30372. */
  30373. storeState(): Camera;
  30374. /**
  30375. * Restores the camera state values if it has been stored. You must call storeState() first
  30376. */
  30377. protected _restoreStateValues(): boolean;
  30378. /**
  30379. * Restored camera state. You must call storeState() first.
  30380. * @returns true if restored and false otherwise
  30381. */
  30382. restoreState(): boolean;
  30383. /**
  30384. * Gets the class name of the camera.
  30385. * @returns the class name
  30386. */
  30387. getClassName(): string;
  30388. /** @hidden */
  30389. readonly _isCamera: boolean;
  30390. /**
  30391. * Gets a string representation of the camera useful for debug purpose.
  30392. * @param fullDetails Defines that a more verboe level of logging is required
  30393. * @returns the string representation
  30394. */
  30395. toString(fullDetails?: boolean): string;
  30396. /**
  30397. * Gets the current world space position of the camera.
  30398. */
  30399. get globalPosition(): Vector3;
  30400. /**
  30401. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30402. * @returns the active meshe list
  30403. */
  30404. getActiveMeshes(): SmartArray<AbstractMesh>;
  30405. /**
  30406. * Check whether a mesh is part of the current active mesh list of the camera
  30407. * @param mesh Defines the mesh to check
  30408. * @returns true if active, false otherwise
  30409. */
  30410. isActiveMesh(mesh: Mesh): boolean;
  30411. /**
  30412. * Is this camera ready to be used/rendered
  30413. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30414. * @return true if the camera is ready
  30415. */
  30416. isReady(completeCheck?: boolean): boolean;
  30417. /** @hidden */
  30418. _initCache(): void;
  30419. /** @hidden */
  30420. _updateCache(ignoreParentClass?: boolean): void;
  30421. /** @hidden */
  30422. _isSynchronized(): boolean;
  30423. /** @hidden */
  30424. _isSynchronizedViewMatrix(): boolean;
  30425. /** @hidden */
  30426. _isSynchronizedProjectionMatrix(): boolean;
  30427. /**
  30428. * Attach the input controls to a specific dom element to get the input from.
  30429. * @param element Defines the element the controls should be listened from
  30430. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30431. */
  30432. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30433. /**
  30434. * Detach the current controls from the specified dom element.
  30435. * @param element Defines the element to stop listening the inputs from
  30436. */
  30437. detachControl(element: HTMLElement): void;
  30438. /**
  30439. * Update the camera state according to the different inputs gathered during the frame.
  30440. */
  30441. update(): void;
  30442. /** @hidden */
  30443. _checkInputs(): void;
  30444. /** @hidden */
  30445. get rigCameras(): Camera[];
  30446. /**
  30447. * Gets the post process used by the rig cameras
  30448. */
  30449. get rigPostProcess(): Nullable<PostProcess>;
  30450. /**
  30451. * Internal, gets the first post proces.
  30452. * @returns the first post process to be run on this camera.
  30453. */
  30454. _getFirstPostProcess(): Nullable<PostProcess>;
  30455. private _cascadePostProcessesToRigCams;
  30456. /**
  30457. * Attach a post process to the camera.
  30458. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30459. * @param postProcess The post process to attach to the camera
  30460. * @param insertAt The position of the post process in case several of them are in use in the scene
  30461. * @returns the position the post process has been inserted at
  30462. */
  30463. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30464. /**
  30465. * Detach a post process to the camera.
  30466. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30467. * @param postProcess The post process to detach from the camera
  30468. */
  30469. detachPostProcess(postProcess: PostProcess): void;
  30470. /**
  30471. * Gets the current world matrix of the camera
  30472. */
  30473. getWorldMatrix(): Matrix;
  30474. /** @hidden */
  30475. _getViewMatrix(): Matrix;
  30476. /**
  30477. * Gets the current view matrix of the camera.
  30478. * @param force forces the camera to recompute the matrix without looking at the cached state
  30479. * @returns the view matrix
  30480. */
  30481. getViewMatrix(force?: boolean): Matrix;
  30482. /**
  30483. * Freeze the projection matrix.
  30484. * It will prevent the cache check of the camera projection compute and can speed up perf
  30485. * if no parameter of the camera are meant to change
  30486. * @param projection Defines manually a projection if necessary
  30487. */
  30488. freezeProjectionMatrix(projection?: Matrix): void;
  30489. /**
  30490. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30491. */
  30492. unfreezeProjectionMatrix(): void;
  30493. /**
  30494. * Gets the current projection matrix of the camera.
  30495. * @param force forces the camera to recompute the matrix without looking at the cached state
  30496. * @returns the projection matrix
  30497. */
  30498. getProjectionMatrix(force?: boolean): Matrix;
  30499. /**
  30500. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30501. * @returns a Matrix
  30502. */
  30503. getTransformationMatrix(): Matrix;
  30504. private _updateFrustumPlanes;
  30505. /**
  30506. * Checks if a cullable object (mesh...) is in the camera frustum
  30507. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30508. * @param target The object to check
  30509. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30510. * @returns true if the object is in frustum otherwise false
  30511. */
  30512. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30513. /**
  30514. * Checks if a cullable object (mesh...) is in the camera frustum
  30515. * Unlike isInFrustum this cheks the full bounding box
  30516. * @param target The object to check
  30517. * @returns true if the object is in frustum otherwise false
  30518. */
  30519. isCompletelyInFrustum(target: ICullable): boolean;
  30520. /**
  30521. * Gets a ray in the forward direction from the camera.
  30522. * @param length Defines the length of the ray to create
  30523. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30524. * @param origin Defines the start point of the ray which defaults to the camera position
  30525. * @returns the forward ray
  30526. */
  30527. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30528. /**
  30529. * Gets a ray in the forward direction from the camera.
  30530. * @param refRay the ray to (re)use when setting the values
  30531. * @param length Defines the length of the ray to create
  30532. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30533. * @param origin Defines the start point of the ray which defaults to the camera position
  30534. * @returns the forward ray
  30535. */
  30536. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30537. /**
  30538. * Releases resources associated with this node.
  30539. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30540. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30541. */
  30542. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30543. /** @hidden */
  30544. _isLeftCamera: boolean;
  30545. /**
  30546. * Gets the left camera of a rig setup in case of Rigged Camera
  30547. */
  30548. get isLeftCamera(): boolean;
  30549. /** @hidden */
  30550. _isRightCamera: boolean;
  30551. /**
  30552. * Gets the right camera of a rig setup in case of Rigged Camera
  30553. */
  30554. get isRightCamera(): boolean;
  30555. /**
  30556. * Gets the left camera of a rig setup in case of Rigged Camera
  30557. */
  30558. get leftCamera(): Nullable<FreeCamera>;
  30559. /**
  30560. * Gets the right camera of a rig setup in case of Rigged Camera
  30561. */
  30562. get rightCamera(): Nullable<FreeCamera>;
  30563. /**
  30564. * Gets the left camera target of a rig setup in case of Rigged Camera
  30565. * @returns the target position
  30566. */
  30567. getLeftTarget(): Nullable<Vector3>;
  30568. /**
  30569. * Gets the right camera target of a rig setup in case of Rigged Camera
  30570. * @returns the target position
  30571. */
  30572. getRightTarget(): Nullable<Vector3>;
  30573. /**
  30574. * @hidden
  30575. */
  30576. setCameraRigMode(mode: number, rigParams: any): void;
  30577. /** @hidden */
  30578. static _setStereoscopicRigMode(camera: Camera): void;
  30579. /** @hidden */
  30580. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30581. /** @hidden */
  30582. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30583. /** @hidden */
  30584. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30585. /** @hidden */
  30586. _getVRProjectionMatrix(): Matrix;
  30587. protected _updateCameraRotationMatrix(): void;
  30588. protected _updateWebVRCameraRotationMatrix(): void;
  30589. /**
  30590. * This function MUST be overwritten by the different WebVR cameras available.
  30591. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30592. * @hidden
  30593. */
  30594. _getWebVRProjectionMatrix(): Matrix;
  30595. /**
  30596. * This function MUST be overwritten by the different WebVR cameras available.
  30597. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30598. * @hidden
  30599. */
  30600. _getWebVRViewMatrix(): Matrix;
  30601. /** @hidden */
  30602. setCameraRigParameter(name: string, value: any): void;
  30603. /**
  30604. * needs to be overridden by children so sub has required properties to be copied
  30605. * @hidden
  30606. */
  30607. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30608. /**
  30609. * May need to be overridden by children
  30610. * @hidden
  30611. */
  30612. _updateRigCameras(): void;
  30613. /** @hidden */
  30614. _setupInputs(): void;
  30615. /**
  30616. * Serialiaze the camera setup to a json represention
  30617. * @returns the JSON representation
  30618. */
  30619. serialize(): any;
  30620. /**
  30621. * Clones the current camera.
  30622. * @param name The cloned camera name
  30623. * @returns the cloned camera
  30624. */
  30625. clone(name: string): Camera;
  30626. /**
  30627. * Gets the direction of the camera relative to a given local axis.
  30628. * @param localAxis Defines the reference axis to provide a relative direction.
  30629. * @return the direction
  30630. */
  30631. getDirection(localAxis: Vector3): Vector3;
  30632. /**
  30633. * Returns the current camera absolute rotation
  30634. */
  30635. get absoluteRotation(): Quaternion;
  30636. /**
  30637. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30638. * @param localAxis Defines the reference axis to provide a relative direction.
  30639. * @param result Defines the vector to store the result in
  30640. */
  30641. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30642. /**
  30643. * Gets a camera constructor for a given camera type
  30644. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30645. * @param name The name of the camera the result will be able to instantiate
  30646. * @param scene The scene the result will construct the camera in
  30647. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30648. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30649. * @returns a factory method to construc the camera
  30650. */
  30651. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30652. /**
  30653. * Compute the world matrix of the camera.
  30654. * @returns the camera world matrix
  30655. */
  30656. computeWorldMatrix(): Matrix;
  30657. /**
  30658. * Parse a JSON and creates the camera from the parsed information
  30659. * @param parsedCamera The JSON to parse
  30660. * @param scene The scene to instantiate the camera in
  30661. * @returns the newly constructed camera
  30662. */
  30663. static Parse(parsedCamera: any, scene: Scene): Camera;
  30664. }
  30665. }
  30666. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30667. import { Nullable } from "babylonjs/types";
  30668. import { Scene } from "babylonjs/scene";
  30669. import { Vector4 } from "babylonjs/Maths/math.vector";
  30670. import { Mesh } from "babylonjs/Meshes/mesh";
  30671. /**
  30672. * Class containing static functions to help procedurally build meshes
  30673. */
  30674. export class DiscBuilder {
  30675. /**
  30676. * Creates a plane polygonal mesh. By default, this is a disc
  30677. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30678. * * 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
  30679. * * 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
  30680. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30681. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30683. * @param name defines the name of the mesh
  30684. * @param options defines the options used to create the mesh
  30685. * @param scene defines the hosting scene
  30686. * @returns the plane polygonal mesh
  30687. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30688. */
  30689. static CreateDisc(name: string, options: {
  30690. radius?: number;
  30691. tessellation?: number;
  30692. arc?: number;
  30693. updatable?: boolean;
  30694. sideOrientation?: number;
  30695. frontUVs?: Vector4;
  30696. backUVs?: Vector4;
  30697. }, scene?: Nullable<Scene>): Mesh;
  30698. }
  30699. }
  30700. declare module "babylonjs/Materials/fresnelParameters" {
  30701. import { DeepImmutable } from "babylonjs/types";
  30702. import { Color3 } from "babylonjs/Maths/math.color";
  30703. /**
  30704. * Options to be used when creating a FresnelParameters.
  30705. */
  30706. export type IFresnelParametersCreationOptions = {
  30707. /**
  30708. * Define the color used on edges (grazing angle)
  30709. */
  30710. leftColor?: Color3;
  30711. /**
  30712. * Define the color used on center
  30713. */
  30714. rightColor?: Color3;
  30715. /**
  30716. * Define bias applied to computed fresnel term
  30717. */
  30718. bias?: number;
  30719. /**
  30720. * Defined the power exponent applied to fresnel term
  30721. */
  30722. power?: number;
  30723. /**
  30724. * Define if the fresnel effect is enable or not.
  30725. */
  30726. isEnabled?: boolean;
  30727. };
  30728. /**
  30729. * Serialized format for FresnelParameters.
  30730. */
  30731. export type IFresnelParametersSerialized = {
  30732. /**
  30733. * Define the color used on edges (grazing angle) [as an array]
  30734. */
  30735. leftColor: number[];
  30736. /**
  30737. * Define the color used on center [as an array]
  30738. */
  30739. rightColor: number[];
  30740. /**
  30741. * Define bias applied to computed fresnel term
  30742. */
  30743. bias: number;
  30744. /**
  30745. * Defined the power exponent applied to fresnel term
  30746. */
  30747. power?: number;
  30748. /**
  30749. * Define if the fresnel effect is enable or not.
  30750. */
  30751. isEnabled: boolean;
  30752. };
  30753. /**
  30754. * This represents all the required information to add a fresnel effect on a material:
  30755. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30756. */
  30757. export class FresnelParameters {
  30758. private _isEnabled;
  30759. /**
  30760. * Define if the fresnel effect is enable or not.
  30761. */
  30762. get isEnabled(): boolean;
  30763. set isEnabled(value: boolean);
  30764. /**
  30765. * Define the color used on edges (grazing angle)
  30766. */
  30767. leftColor: Color3;
  30768. /**
  30769. * Define the color used on center
  30770. */
  30771. rightColor: Color3;
  30772. /**
  30773. * Define bias applied to computed fresnel term
  30774. */
  30775. bias: number;
  30776. /**
  30777. * Defined the power exponent applied to fresnel term
  30778. */
  30779. power: number;
  30780. /**
  30781. * Creates a new FresnelParameters object.
  30782. *
  30783. * @param options provide your own settings to optionally to override defaults
  30784. */
  30785. constructor(options?: IFresnelParametersCreationOptions);
  30786. /**
  30787. * Clones the current fresnel and its valuues
  30788. * @returns a clone fresnel configuration
  30789. */
  30790. clone(): FresnelParameters;
  30791. /**
  30792. * Determines equality between FresnelParameters objects
  30793. * @param otherFresnelParameters defines the second operand
  30794. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30795. */
  30796. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30797. /**
  30798. * Serializes the current fresnel parameters to a JSON representation.
  30799. * @return the JSON serialization
  30800. */
  30801. serialize(): IFresnelParametersSerialized;
  30802. /**
  30803. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  30804. * @param parsedFresnelParameters Define the JSON representation
  30805. * @returns the parsed parameters
  30806. */
  30807. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  30808. }
  30809. }
  30810. declare module "babylonjs/Materials/materialFlags" {
  30811. /**
  30812. * This groups all the flags used to control the materials channel.
  30813. */
  30814. export class MaterialFlags {
  30815. private static _DiffuseTextureEnabled;
  30816. /**
  30817. * Are diffuse textures enabled in the application.
  30818. */
  30819. static get DiffuseTextureEnabled(): boolean;
  30820. static set DiffuseTextureEnabled(value: boolean);
  30821. private static _DetailTextureEnabled;
  30822. /**
  30823. * Are detail textures enabled in the application.
  30824. */
  30825. static get DetailTextureEnabled(): boolean;
  30826. static set DetailTextureEnabled(value: boolean);
  30827. private static _AmbientTextureEnabled;
  30828. /**
  30829. * Are ambient textures enabled in the application.
  30830. */
  30831. static get AmbientTextureEnabled(): boolean;
  30832. static set AmbientTextureEnabled(value: boolean);
  30833. private static _OpacityTextureEnabled;
  30834. /**
  30835. * Are opacity textures enabled in the application.
  30836. */
  30837. static get OpacityTextureEnabled(): boolean;
  30838. static set OpacityTextureEnabled(value: boolean);
  30839. private static _ReflectionTextureEnabled;
  30840. /**
  30841. * Are reflection textures enabled in the application.
  30842. */
  30843. static get ReflectionTextureEnabled(): boolean;
  30844. static set ReflectionTextureEnabled(value: boolean);
  30845. private static _EmissiveTextureEnabled;
  30846. /**
  30847. * Are emissive textures enabled in the application.
  30848. */
  30849. static get EmissiveTextureEnabled(): boolean;
  30850. static set EmissiveTextureEnabled(value: boolean);
  30851. private static _SpecularTextureEnabled;
  30852. /**
  30853. * Are specular textures enabled in the application.
  30854. */
  30855. static get SpecularTextureEnabled(): boolean;
  30856. static set SpecularTextureEnabled(value: boolean);
  30857. private static _BumpTextureEnabled;
  30858. /**
  30859. * Are bump textures enabled in the application.
  30860. */
  30861. static get BumpTextureEnabled(): boolean;
  30862. static set BumpTextureEnabled(value: boolean);
  30863. private static _LightmapTextureEnabled;
  30864. /**
  30865. * Are lightmap textures enabled in the application.
  30866. */
  30867. static get LightmapTextureEnabled(): boolean;
  30868. static set LightmapTextureEnabled(value: boolean);
  30869. private static _RefractionTextureEnabled;
  30870. /**
  30871. * Are refraction textures enabled in the application.
  30872. */
  30873. static get RefractionTextureEnabled(): boolean;
  30874. static set RefractionTextureEnabled(value: boolean);
  30875. private static _ColorGradingTextureEnabled;
  30876. /**
  30877. * Are color grading textures enabled in the application.
  30878. */
  30879. static get ColorGradingTextureEnabled(): boolean;
  30880. static set ColorGradingTextureEnabled(value: boolean);
  30881. private static _FresnelEnabled;
  30882. /**
  30883. * Are fresnels enabled in the application.
  30884. */
  30885. static get FresnelEnabled(): boolean;
  30886. static set FresnelEnabled(value: boolean);
  30887. private static _ClearCoatTextureEnabled;
  30888. /**
  30889. * Are clear coat textures enabled in the application.
  30890. */
  30891. static get ClearCoatTextureEnabled(): boolean;
  30892. static set ClearCoatTextureEnabled(value: boolean);
  30893. private static _ClearCoatBumpTextureEnabled;
  30894. /**
  30895. * Are clear coat bump textures enabled in the application.
  30896. */
  30897. static get ClearCoatBumpTextureEnabled(): boolean;
  30898. static set ClearCoatBumpTextureEnabled(value: boolean);
  30899. private static _ClearCoatTintTextureEnabled;
  30900. /**
  30901. * Are clear coat tint textures enabled in the application.
  30902. */
  30903. static get ClearCoatTintTextureEnabled(): boolean;
  30904. static set ClearCoatTintTextureEnabled(value: boolean);
  30905. private static _SheenTextureEnabled;
  30906. /**
  30907. * Are sheen textures enabled in the application.
  30908. */
  30909. static get SheenTextureEnabled(): boolean;
  30910. static set SheenTextureEnabled(value: boolean);
  30911. private static _AnisotropicTextureEnabled;
  30912. /**
  30913. * Are anisotropic textures enabled in the application.
  30914. */
  30915. static get AnisotropicTextureEnabled(): boolean;
  30916. static set AnisotropicTextureEnabled(value: boolean);
  30917. private static _ThicknessTextureEnabled;
  30918. /**
  30919. * Are thickness textures enabled in the application.
  30920. */
  30921. static get ThicknessTextureEnabled(): boolean;
  30922. static set ThicknessTextureEnabled(value: boolean);
  30923. }
  30924. }
  30925. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  30926. /** @hidden */
  30927. export var defaultFragmentDeclaration: {
  30928. name: string;
  30929. shader: string;
  30930. };
  30931. }
  30932. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  30933. /** @hidden */
  30934. export var defaultUboDeclaration: {
  30935. name: string;
  30936. shader: string;
  30937. };
  30938. }
  30939. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  30940. /** @hidden */
  30941. export var prePassDeclaration: {
  30942. name: string;
  30943. shader: string;
  30944. };
  30945. }
  30946. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  30947. /** @hidden */
  30948. export var lightFragmentDeclaration: {
  30949. name: string;
  30950. shader: string;
  30951. };
  30952. }
  30953. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  30954. /** @hidden */
  30955. export var lightUboDeclaration: {
  30956. name: string;
  30957. shader: string;
  30958. };
  30959. }
  30960. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  30961. /** @hidden */
  30962. export var lightsFragmentFunctions: {
  30963. name: string;
  30964. shader: string;
  30965. };
  30966. }
  30967. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  30968. /** @hidden */
  30969. export var shadowsFragmentFunctions: {
  30970. name: string;
  30971. shader: string;
  30972. };
  30973. }
  30974. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  30975. /** @hidden */
  30976. export var fresnelFunction: {
  30977. name: string;
  30978. shader: string;
  30979. };
  30980. }
  30981. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  30982. /** @hidden */
  30983. export var bumpFragmentMainFunctions: {
  30984. name: string;
  30985. shader: string;
  30986. };
  30987. }
  30988. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  30989. /** @hidden */
  30990. export var bumpFragmentFunctions: {
  30991. name: string;
  30992. shader: string;
  30993. };
  30994. }
  30995. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  30996. /** @hidden */
  30997. export var logDepthDeclaration: {
  30998. name: string;
  30999. shader: string;
  31000. };
  31001. }
  31002. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31003. /** @hidden */
  31004. export var bumpFragment: {
  31005. name: string;
  31006. shader: string;
  31007. };
  31008. }
  31009. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31010. /** @hidden */
  31011. export var depthPrePass: {
  31012. name: string;
  31013. shader: string;
  31014. };
  31015. }
  31016. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31017. /** @hidden */
  31018. export var lightFragment: {
  31019. name: string;
  31020. shader: string;
  31021. };
  31022. }
  31023. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31024. /** @hidden */
  31025. export var logDepthFragment: {
  31026. name: string;
  31027. shader: string;
  31028. };
  31029. }
  31030. declare module "babylonjs/Shaders/default.fragment" {
  31031. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31032. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31033. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31034. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31035. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31036. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31037. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31038. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31039. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31040. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31041. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31042. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31043. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31044. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31045. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31046. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31047. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31048. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31049. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31050. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31051. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31052. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31053. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31054. /** @hidden */
  31055. export var defaultPixelShader: {
  31056. name: string;
  31057. shader: string;
  31058. };
  31059. }
  31060. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31061. /** @hidden */
  31062. export var defaultVertexDeclaration: {
  31063. name: string;
  31064. shader: string;
  31065. };
  31066. }
  31067. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31068. /** @hidden */
  31069. export var bumpVertexDeclaration: {
  31070. name: string;
  31071. shader: string;
  31072. };
  31073. }
  31074. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31075. /** @hidden */
  31076. export var bumpVertex: {
  31077. name: string;
  31078. shader: string;
  31079. };
  31080. }
  31081. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31082. /** @hidden */
  31083. export var fogVertex: {
  31084. name: string;
  31085. shader: string;
  31086. };
  31087. }
  31088. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31089. /** @hidden */
  31090. export var shadowsVertex: {
  31091. name: string;
  31092. shader: string;
  31093. };
  31094. }
  31095. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31096. /** @hidden */
  31097. export var pointCloudVertex: {
  31098. name: string;
  31099. shader: string;
  31100. };
  31101. }
  31102. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31103. /** @hidden */
  31104. export var logDepthVertex: {
  31105. name: string;
  31106. shader: string;
  31107. };
  31108. }
  31109. declare module "babylonjs/Shaders/default.vertex" {
  31110. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31111. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31112. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31113. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31114. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31115. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31116. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31117. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31118. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31119. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31120. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31121. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31122. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31123. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31124. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31125. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31126. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31127. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31128. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31129. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31130. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31131. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31132. /** @hidden */
  31133. export var defaultVertexShader: {
  31134. name: string;
  31135. shader: string;
  31136. };
  31137. }
  31138. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31139. import { Nullable } from "babylonjs/types";
  31140. import { Scene } from "babylonjs/scene";
  31141. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31142. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31143. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31144. /**
  31145. * @hidden
  31146. */
  31147. export interface IMaterialDetailMapDefines {
  31148. DETAIL: boolean;
  31149. DETAILDIRECTUV: number;
  31150. DETAIL_NORMALBLENDMETHOD: number;
  31151. /** @hidden */
  31152. _areTexturesDirty: boolean;
  31153. }
  31154. /**
  31155. * Define the code related to the detail map parameters of a material
  31156. *
  31157. * Inspired from:
  31158. * 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
  31159. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31160. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31161. */
  31162. export class DetailMapConfiguration {
  31163. private _texture;
  31164. /**
  31165. * The detail texture of the material.
  31166. */
  31167. texture: Nullable<BaseTexture>;
  31168. /**
  31169. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31170. * Bigger values mean stronger blending
  31171. */
  31172. diffuseBlendLevel: number;
  31173. /**
  31174. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31175. * Bigger values mean stronger blending. Only used with PBR materials
  31176. */
  31177. roughnessBlendLevel: number;
  31178. /**
  31179. * Defines how strong the bump effect from the detail map is
  31180. * Bigger values mean stronger effect
  31181. */
  31182. bumpLevel: number;
  31183. private _normalBlendMethod;
  31184. /**
  31185. * The method used to blend the bump and detail normals together
  31186. */
  31187. normalBlendMethod: number;
  31188. private _isEnabled;
  31189. /**
  31190. * Enable or disable the detail map on this material
  31191. */
  31192. isEnabled: boolean;
  31193. /** @hidden */
  31194. private _internalMarkAllSubMeshesAsTexturesDirty;
  31195. /** @hidden */
  31196. _markAllSubMeshesAsTexturesDirty(): void;
  31197. /**
  31198. * Instantiate a new detail map
  31199. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31200. */
  31201. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31202. /**
  31203. * Gets whether the submesh is ready to be used or not.
  31204. * @param defines the list of "defines" to update.
  31205. * @param scene defines the scene the material belongs to.
  31206. * @returns - boolean indicating that the submesh is ready or not.
  31207. */
  31208. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31209. /**
  31210. * Update the defines for detail map usage
  31211. * @param defines the list of "defines" to update.
  31212. * @param scene defines the scene the material belongs to.
  31213. */
  31214. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31215. /**
  31216. * Binds the material data.
  31217. * @param uniformBuffer defines the Uniform buffer to fill in.
  31218. * @param scene defines the scene the material belongs to.
  31219. * @param isFrozen defines whether the material is frozen or not.
  31220. */
  31221. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31222. /**
  31223. * Checks to see if a texture is used in the material.
  31224. * @param texture - Base texture to use.
  31225. * @returns - Boolean specifying if a texture is used in the material.
  31226. */
  31227. hasTexture(texture: BaseTexture): boolean;
  31228. /**
  31229. * Returns an array of the actively used textures.
  31230. * @param activeTextures Array of BaseTextures
  31231. */
  31232. getActiveTextures(activeTextures: BaseTexture[]): void;
  31233. /**
  31234. * Returns the animatable textures.
  31235. * @param animatables Array of animatable textures.
  31236. */
  31237. getAnimatables(animatables: IAnimatable[]): void;
  31238. /**
  31239. * Disposes the resources of the material.
  31240. * @param forceDisposeTextures - Forces the disposal of all textures.
  31241. */
  31242. dispose(forceDisposeTextures?: boolean): void;
  31243. /**
  31244. * Get the current class name useful for serialization or dynamic coding.
  31245. * @returns "DetailMap"
  31246. */
  31247. getClassName(): string;
  31248. /**
  31249. * Add the required uniforms to the current list.
  31250. * @param uniforms defines the current uniform list.
  31251. */
  31252. static AddUniforms(uniforms: string[]): void;
  31253. /**
  31254. * Add the required samplers to the current list.
  31255. * @param samplers defines the current sampler list.
  31256. */
  31257. static AddSamplers(samplers: string[]): void;
  31258. /**
  31259. * Add the required uniforms to the current buffer.
  31260. * @param uniformBuffer defines the current uniform buffer.
  31261. */
  31262. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31263. /**
  31264. * Makes a duplicate of the current instance into another one.
  31265. * @param detailMap define the instance where to copy the info
  31266. */
  31267. copyTo(detailMap: DetailMapConfiguration): void;
  31268. /**
  31269. * Serializes this detail map instance
  31270. * @returns - An object with the serialized instance.
  31271. */
  31272. serialize(): any;
  31273. /**
  31274. * Parses a detail map setting from a serialized object.
  31275. * @param source - Serialized object.
  31276. * @param scene Defines the scene we are parsing for
  31277. * @param rootUrl Defines the rootUrl to load from
  31278. */
  31279. parse(source: any, scene: Scene, rootUrl: string): void;
  31280. }
  31281. }
  31282. declare module "babylonjs/Materials/standardMaterial" {
  31283. import { SmartArray } from "babylonjs/Misc/smartArray";
  31284. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31285. import { Nullable } from "babylonjs/types";
  31286. import { Scene } from "babylonjs/scene";
  31287. import { Matrix } from "babylonjs/Maths/math.vector";
  31288. import { Color3 } from "babylonjs/Maths/math.color";
  31289. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31290. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31291. import { Mesh } from "babylonjs/Meshes/mesh";
  31292. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31293. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31294. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31295. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31296. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31297. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31298. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31299. import "babylonjs/Shaders/default.fragment";
  31300. import "babylonjs/Shaders/default.vertex";
  31301. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31302. /** @hidden */
  31303. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31304. MAINUV1: boolean;
  31305. MAINUV2: boolean;
  31306. DIFFUSE: boolean;
  31307. DIFFUSEDIRECTUV: number;
  31308. DETAIL: boolean;
  31309. DETAILDIRECTUV: number;
  31310. DETAIL_NORMALBLENDMETHOD: number;
  31311. AMBIENT: boolean;
  31312. AMBIENTDIRECTUV: number;
  31313. OPACITY: boolean;
  31314. OPACITYDIRECTUV: number;
  31315. OPACITYRGB: boolean;
  31316. REFLECTION: boolean;
  31317. EMISSIVE: boolean;
  31318. EMISSIVEDIRECTUV: number;
  31319. SPECULAR: boolean;
  31320. SPECULARDIRECTUV: number;
  31321. BUMP: boolean;
  31322. BUMPDIRECTUV: number;
  31323. PARALLAX: boolean;
  31324. PARALLAXOCCLUSION: boolean;
  31325. SPECULAROVERALPHA: boolean;
  31326. CLIPPLANE: boolean;
  31327. CLIPPLANE2: boolean;
  31328. CLIPPLANE3: boolean;
  31329. CLIPPLANE4: boolean;
  31330. CLIPPLANE5: boolean;
  31331. CLIPPLANE6: boolean;
  31332. ALPHATEST: boolean;
  31333. DEPTHPREPASS: boolean;
  31334. ALPHAFROMDIFFUSE: boolean;
  31335. POINTSIZE: boolean;
  31336. FOG: boolean;
  31337. SPECULARTERM: boolean;
  31338. DIFFUSEFRESNEL: boolean;
  31339. OPACITYFRESNEL: boolean;
  31340. REFLECTIONFRESNEL: boolean;
  31341. REFRACTIONFRESNEL: boolean;
  31342. EMISSIVEFRESNEL: boolean;
  31343. FRESNEL: boolean;
  31344. NORMAL: boolean;
  31345. UV1: boolean;
  31346. UV2: boolean;
  31347. VERTEXCOLOR: boolean;
  31348. VERTEXALPHA: boolean;
  31349. NUM_BONE_INFLUENCERS: number;
  31350. BonesPerMesh: number;
  31351. BONETEXTURE: boolean;
  31352. INSTANCES: boolean;
  31353. THIN_INSTANCES: boolean;
  31354. GLOSSINESS: boolean;
  31355. ROUGHNESS: boolean;
  31356. EMISSIVEASILLUMINATION: boolean;
  31357. LINKEMISSIVEWITHDIFFUSE: boolean;
  31358. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31359. LIGHTMAP: boolean;
  31360. LIGHTMAPDIRECTUV: number;
  31361. OBJECTSPACE_NORMALMAP: boolean;
  31362. USELIGHTMAPASSHADOWMAP: boolean;
  31363. REFLECTIONMAP_3D: boolean;
  31364. REFLECTIONMAP_SPHERICAL: boolean;
  31365. REFLECTIONMAP_PLANAR: boolean;
  31366. REFLECTIONMAP_CUBIC: boolean;
  31367. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31368. REFLECTIONMAP_PROJECTION: boolean;
  31369. REFLECTIONMAP_SKYBOX: boolean;
  31370. REFLECTIONMAP_EXPLICIT: boolean;
  31371. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31372. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31373. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31374. INVERTCUBICMAP: boolean;
  31375. LOGARITHMICDEPTH: boolean;
  31376. REFRACTION: boolean;
  31377. REFRACTIONMAP_3D: boolean;
  31378. REFLECTIONOVERALPHA: boolean;
  31379. TWOSIDEDLIGHTING: boolean;
  31380. SHADOWFLOAT: boolean;
  31381. MORPHTARGETS: boolean;
  31382. MORPHTARGETS_NORMAL: boolean;
  31383. MORPHTARGETS_TANGENT: boolean;
  31384. MORPHTARGETS_UV: boolean;
  31385. NUM_MORPH_INFLUENCERS: number;
  31386. NONUNIFORMSCALING: boolean;
  31387. PREMULTIPLYALPHA: boolean;
  31388. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31389. ALPHABLEND: boolean;
  31390. PREPASS: boolean;
  31391. SCENE_MRT_COUNT: number;
  31392. RGBDLIGHTMAP: boolean;
  31393. RGBDREFLECTION: boolean;
  31394. RGBDREFRACTION: boolean;
  31395. IMAGEPROCESSING: boolean;
  31396. VIGNETTE: boolean;
  31397. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31398. VIGNETTEBLENDMODEOPAQUE: boolean;
  31399. TONEMAPPING: boolean;
  31400. TONEMAPPING_ACES: boolean;
  31401. CONTRAST: boolean;
  31402. COLORCURVES: boolean;
  31403. COLORGRADING: boolean;
  31404. COLORGRADING3D: boolean;
  31405. SAMPLER3DGREENDEPTH: boolean;
  31406. SAMPLER3DBGRMAP: boolean;
  31407. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31408. MULTIVIEW: boolean;
  31409. /**
  31410. * If the reflection texture on this material is in linear color space
  31411. * @hidden
  31412. */
  31413. IS_REFLECTION_LINEAR: boolean;
  31414. /**
  31415. * If the refraction texture on this material is in linear color space
  31416. * @hidden
  31417. */
  31418. IS_REFRACTION_LINEAR: boolean;
  31419. EXPOSURE: boolean;
  31420. constructor();
  31421. setReflectionMode(modeToEnable: string): void;
  31422. }
  31423. /**
  31424. * This is the default material used in Babylon. It is the best trade off between quality
  31425. * and performances.
  31426. * @see https://doc.babylonjs.com/babylon101/materials
  31427. */
  31428. export class StandardMaterial extends PushMaterial {
  31429. private _diffuseTexture;
  31430. /**
  31431. * The basic texture of the material as viewed under a light.
  31432. */
  31433. diffuseTexture: Nullable<BaseTexture>;
  31434. private _ambientTexture;
  31435. /**
  31436. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31437. */
  31438. ambientTexture: Nullable<BaseTexture>;
  31439. private _opacityTexture;
  31440. /**
  31441. * Define the transparency of the material from a texture.
  31442. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31443. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31444. */
  31445. opacityTexture: Nullable<BaseTexture>;
  31446. private _reflectionTexture;
  31447. /**
  31448. * Define the texture used to display the reflection.
  31449. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31450. */
  31451. reflectionTexture: Nullable<BaseTexture>;
  31452. private _emissiveTexture;
  31453. /**
  31454. * Define texture of the material as if self lit.
  31455. * This will be mixed in the final result even in the absence of light.
  31456. */
  31457. emissiveTexture: Nullable<BaseTexture>;
  31458. private _specularTexture;
  31459. /**
  31460. * Define how the color and intensity of the highlight given by the light in the material.
  31461. */
  31462. specularTexture: Nullable<BaseTexture>;
  31463. private _bumpTexture;
  31464. /**
  31465. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31466. * 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.
  31467. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31468. */
  31469. bumpTexture: Nullable<BaseTexture>;
  31470. private _lightmapTexture;
  31471. /**
  31472. * Complex lighting can be computationally expensive to compute at runtime.
  31473. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31474. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31475. */
  31476. lightmapTexture: Nullable<BaseTexture>;
  31477. private _refractionTexture;
  31478. /**
  31479. * Define the texture used to display the refraction.
  31480. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31481. */
  31482. refractionTexture: Nullable<BaseTexture>;
  31483. /**
  31484. * The color of the material lit by the environmental background lighting.
  31485. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31486. */
  31487. ambientColor: Color3;
  31488. /**
  31489. * The basic color of the material as viewed under a light.
  31490. */
  31491. diffuseColor: Color3;
  31492. /**
  31493. * Define how the color and intensity of the highlight given by the light in the material.
  31494. */
  31495. specularColor: Color3;
  31496. /**
  31497. * Define the color of the material as if self lit.
  31498. * This will be mixed in the final result even in the absence of light.
  31499. */
  31500. emissiveColor: Color3;
  31501. /**
  31502. * Defines how sharp are the highlights in the material.
  31503. * The bigger the value the sharper giving a more glossy feeling to the result.
  31504. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31505. */
  31506. specularPower: number;
  31507. private _useAlphaFromDiffuseTexture;
  31508. /**
  31509. * Does the transparency come from the diffuse texture alpha channel.
  31510. */
  31511. useAlphaFromDiffuseTexture: boolean;
  31512. private _useEmissiveAsIllumination;
  31513. /**
  31514. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31515. */
  31516. useEmissiveAsIllumination: boolean;
  31517. private _linkEmissiveWithDiffuse;
  31518. /**
  31519. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31520. * the emissive level when the final color is close to one.
  31521. */
  31522. linkEmissiveWithDiffuse: boolean;
  31523. private _useSpecularOverAlpha;
  31524. /**
  31525. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31526. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31527. */
  31528. useSpecularOverAlpha: boolean;
  31529. private _useReflectionOverAlpha;
  31530. /**
  31531. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31532. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31533. */
  31534. useReflectionOverAlpha: boolean;
  31535. private _disableLighting;
  31536. /**
  31537. * Does lights from the scene impacts this material.
  31538. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31539. */
  31540. disableLighting: boolean;
  31541. private _useObjectSpaceNormalMap;
  31542. /**
  31543. * Allows using an object space normal map (instead of tangent space).
  31544. */
  31545. useObjectSpaceNormalMap: boolean;
  31546. private _useParallax;
  31547. /**
  31548. * Is parallax enabled or not.
  31549. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31550. */
  31551. useParallax: boolean;
  31552. private _useParallaxOcclusion;
  31553. /**
  31554. * Is parallax occlusion enabled or not.
  31555. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31556. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31557. */
  31558. useParallaxOcclusion: boolean;
  31559. /**
  31560. * 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.
  31561. */
  31562. parallaxScaleBias: number;
  31563. private _roughness;
  31564. /**
  31565. * Helps to define how blurry the reflections should appears in the material.
  31566. */
  31567. roughness: number;
  31568. /**
  31569. * In case of refraction, define the value of the index of refraction.
  31570. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31571. */
  31572. indexOfRefraction: number;
  31573. /**
  31574. * Invert the refraction texture alongside the y axis.
  31575. * It can be useful with procedural textures or probe for instance.
  31576. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31577. */
  31578. invertRefractionY: boolean;
  31579. /**
  31580. * Defines the alpha limits in alpha test mode.
  31581. */
  31582. alphaCutOff: number;
  31583. private _useLightmapAsShadowmap;
  31584. /**
  31585. * In case of light mapping, define whether the map contains light or shadow informations.
  31586. */
  31587. useLightmapAsShadowmap: boolean;
  31588. private _diffuseFresnelParameters;
  31589. /**
  31590. * Define the diffuse fresnel parameters of the material.
  31591. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31592. */
  31593. diffuseFresnelParameters: FresnelParameters;
  31594. private _opacityFresnelParameters;
  31595. /**
  31596. * Define the opacity fresnel parameters of the material.
  31597. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31598. */
  31599. opacityFresnelParameters: FresnelParameters;
  31600. private _reflectionFresnelParameters;
  31601. /**
  31602. * Define the reflection fresnel parameters of the material.
  31603. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31604. */
  31605. reflectionFresnelParameters: FresnelParameters;
  31606. private _refractionFresnelParameters;
  31607. /**
  31608. * Define the refraction fresnel parameters of the material.
  31609. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31610. */
  31611. refractionFresnelParameters: FresnelParameters;
  31612. private _emissiveFresnelParameters;
  31613. /**
  31614. * Define the emissive fresnel parameters of the material.
  31615. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31616. */
  31617. emissiveFresnelParameters: FresnelParameters;
  31618. private _useReflectionFresnelFromSpecular;
  31619. /**
  31620. * If true automatically deducts the fresnels values from the material specularity.
  31621. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31622. */
  31623. useReflectionFresnelFromSpecular: boolean;
  31624. private _useGlossinessFromSpecularMapAlpha;
  31625. /**
  31626. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31627. */
  31628. useGlossinessFromSpecularMapAlpha: boolean;
  31629. private _maxSimultaneousLights;
  31630. /**
  31631. * Defines the maximum number of lights that can be used in the material
  31632. */
  31633. maxSimultaneousLights: number;
  31634. private _invertNormalMapX;
  31635. /**
  31636. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31637. */
  31638. invertNormalMapX: boolean;
  31639. private _invertNormalMapY;
  31640. /**
  31641. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31642. */
  31643. invertNormalMapY: boolean;
  31644. private _twoSidedLighting;
  31645. /**
  31646. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31647. */
  31648. twoSidedLighting: boolean;
  31649. /**
  31650. * Default configuration related to image processing available in the standard Material.
  31651. */
  31652. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31653. /**
  31654. * Gets the image processing configuration used either in this material.
  31655. */
  31656. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31657. /**
  31658. * Sets the Default image processing configuration used either in the this material.
  31659. *
  31660. * If sets to null, the scene one is in use.
  31661. */
  31662. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31663. /**
  31664. * Keep track of the image processing observer to allow dispose and replace.
  31665. */
  31666. private _imageProcessingObserver;
  31667. /**
  31668. * Attaches a new image processing configuration to the Standard Material.
  31669. * @param configuration
  31670. */
  31671. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31672. /**
  31673. * Gets wether the color curves effect is enabled.
  31674. */
  31675. get cameraColorCurvesEnabled(): boolean;
  31676. /**
  31677. * Sets wether the color curves effect is enabled.
  31678. */
  31679. set cameraColorCurvesEnabled(value: boolean);
  31680. /**
  31681. * Gets wether the color grading effect is enabled.
  31682. */
  31683. get cameraColorGradingEnabled(): boolean;
  31684. /**
  31685. * Gets wether the color grading effect is enabled.
  31686. */
  31687. set cameraColorGradingEnabled(value: boolean);
  31688. /**
  31689. * Gets wether tonemapping is enabled or not.
  31690. */
  31691. get cameraToneMappingEnabled(): boolean;
  31692. /**
  31693. * Sets wether tonemapping is enabled or not
  31694. */
  31695. set cameraToneMappingEnabled(value: boolean);
  31696. /**
  31697. * The camera exposure used on this material.
  31698. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31699. * This corresponds to a photographic exposure.
  31700. */
  31701. get cameraExposure(): number;
  31702. /**
  31703. * The camera exposure used on this material.
  31704. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31705. * This corresponds to a photographic exposure.
  31706. */
  31707. set cameraExposure(value: number);
  31708. /**
  31709. * Gets The camera contrast used on this material.
  31710. */
  31711. get cameraContrast(): number;
  31712. /**
  31713. * Sets The camera contrast used on this material.
  31714. */
  31715. set cameraContrast(value: number);
  31716. /**
  31717. * Gets the Color Grading 2D Lookup Texture.
  31718. */
  31719. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31720. /**
  31721. * Sets the Color Grading 2D Lookup Texture.
  31722. */
  31723. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31724. /**
  31725. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31726. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31727. * 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;
  31728. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31729. */
  31730. get cameraColorCurves(): Nullable<ColorCurves>;
  31731. /**
  31732. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31733. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31734. * 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;
  31735. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31736. */
  31737. set cameraColorCurves(value: Nullable<ColorCurves>);
  31738. /**
  31739. * Can this material render to several textures at once
  31740. */
  31741. get canRenderToMRT(): boolean;
  31742. /**
  31743. * Defines the detail map parameters for the material.
  31744. */
  31745. readonly detailMap: DetailMapConfiguration;
  31746. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31747. protected _worldViewProjectionMatrix: Matrix;
  31748. protected _globalAmbientColor: Color3;
  31749. protected _useLogarithmicDepth: boolean;
  31750. protected _rebuildInParallel: boolean;
  31751. /**
  31752. * Instantiates a new standard material.
  31753. * This is the default material used in Babylon. It is the best trade off between quality
  31754. * and performances.
  31755. * @see https://doc.babylonjs.com/babylon101/materials
  31756. * @param name Define the name of the material in the scene
  31757. * @param scene Define the scene the material belong to
  31758. */
  31759. constructor(name: string, scene: Scene);
  31760. /**
  31761. * Gets a boolean indicating that current material needs to register RTT
  31762. */
  31763. get hasRenderTargetTextures(): boolean;
  31764. /**
  31765. * Gets the current class name of the material e.g. "StandardMaterial"
  31766. * Mainly use in serialization.
  31767. * @returns the class name
  31768. */
  31769. getClassName(): string;
  31770. /**
  31771. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31772. * You can try switching to logarithmic depth.
  31773. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31774. */
  31775. get useLogarithmicDepth(): boolean;
  31776. set useLogarithmicDepth(value: boolean);
  31777. /**
  31778. * Specifies if the material will require alpha blending
  31779. * @returns a boolean specifying if alpha blending is needed
  31780. */
  31781. needAlphaBlending(): boolean;
  31782. /**
  31783. * Specifies if this material should be rendered in alpha test mode
  31784. * @returns a boolean specifying if an alpha test is needed.
  31785. */
  31786. needAlphaTesting(): boolean;
  31787. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31788. /**
  31789. * Get the texture used for alpha test purpose.
  31790. * @returns the diffuse texture in case of the standard material.
  31791. */
  31792. getAlphaTestTexture(): Nullable<BaseTexture>;
  31793. /**
  31794. * Get if the submesh is ready to be used and all its information available.
  31795. * Child classes can use it to update shaders
  31796. * @param mesh defines the mesh to check
  31797. * @param subMesh defines which submesh to check
  31798. * @param useInstances specifies that instances should be used
  31799. * @returns a boolean indicating that the submesh is ready or not
  31800. */
  31801. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  31802. /**
  31803. * Builds the material UBO layouts.
  31804. * Used internally during the effect preparation.
  31805. */
  31806. buildUniformLayout(): void;
  31807. /**
  31808. * Unbinds the material from the mesh
  31809. */
  31810. unbind(): void;
  31811. /**
  31812. * Binds the submesh to this material by preparing the effect and shader to draw
  31813. * @param world defines the world transformation matrix
  31814. * @param mesh defines the mesh containing the submesh
  31815. * @param subMesh defines the submesh to bind the material to
  31816. */
  31817. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  31818. /**
  31819. * Get the list of animatables in the material.
  31820. * @returns the list of animatables object used in the material
  31821. */
  31822. getAnimatables(): IAnimatable[];
  31823. /**
  31824. * Gets the active textures from the material
  31825. * @returns an array of textures
  31826. */
  31827. getActiveTextures(): BaseTexture[];
  31828. /**
  31829. * Specifies if the material uses a texture
  31830. * @param texture defines the texture to check against the material
  31831. * @returns a boolean specifying if the material uses the texture
  31832. */
  31833. hasTexture(texture: BaseTexture): boolean;
  31834. /**
  31835. * Disposes the material
  31836. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  31837. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  31838. */
  31839. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  31840. /**
  31841. * Makes a duplicate of the material, and gives it a new name
  31842. * @param name defines the new name for the duplicated material
  31843. * @returns the cloned material
  31844. */
  31845. clone(name: string): StandardMaterial;
  31846. /**
  31847. * Serializes this material in a JSON representation
  31848. * @returns the serialized material object
  31849. */
  31850. serialize(): any;
  31851. /**
  31852. * Creates a standard material from parsed material data
  31853. * @param source defines the JSON representation of the material
  31854. * @param scene defines the hosting scene
  31855. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  31856. * @returns a new standard material
  31857. */
  31858. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  31859. /**
  31860. * Are diffuse textures enabled in the application.
  31861. */
  31862. static get DiffuseTextureEnabled(): boolean;
  31863. static set DiffuseTextureEnabled(value: boolean);
  31864. /**
  31865. * Are detail textures enabled in the application.
  31866. */
  31867. static get DetailTextureEnabled(): boolean;
  31868. static set DetailTextureEnabled(value: boolean);
  31869. /**
  31870. * Are ambient textures enabled in the application.
  31871. */
  31872. static get AmbientTextureEnabled(): boolean;
  31873. static set AmbientTextureEnabled(value: boolean);
  31874. /**
  31875. * Are opacity textures enabled in the application.
  31876. */
  31877. static get OpacityTextureEnabled(): boolean;
  31878. static set OpacityTextureEnabled(value: boolean);
  31879. /**
  31880. * Are reflection textures enabled in the application.
  31881. */
  31882. static get ReflectionTextureEnabled(): boolean;
  31883. static set ReflectionTextureEnabled(value: boolean);
  31884. /**
  31885. * Are emissive textures enabled in the application.
  31886. */
  31887. static get EmissiveTextureEnabled(): boolean;
  31888. static set EmissiveTextureEnabled(value: boolean);
  31889. /**
  31890. * Are specular textures enabled in the application.
  31891. */
  31892. static get SpecularTextureEnabled(): boolean;
  31893. static set SpecularTextureEnabled(value: boolean);
  31894. /**
  31895. * Are bump textures enabled in the application.
  31896. */
  31897. static get BumpTextureEnabled(): boolean;
  31898. static set BumpTextureEnabled(value: boolean);
  31899. /**
  31900. * Are lightmap textures enabled in the application.
  31901. */
  31902. static get LightmapTextureEnabled(): boolean;
  31903. static set LightmapTextureEnabled(value: boolean);
  31904. /**
  31905. * Are refraction textures enabled in the application.
  31906. */
  31907. static get RefractionTextureEnabled(): boolean;
  31908. static set RefractionTextureEnabled(value: boolean);
  31909. /**
  31910. * Are color grading textures enabled in the application.
  31911. */
  31912. static get ColorGradingTextureEnabled(): boolean;
  31913. static set ColorGradingTextureEnabled(value: boolean);
  31914. /**
  31915. * Are fresnels enabled in the application.
  31916. */
  31917. static get FresnelEnabled(): boolean;
  31918. static set FresnelEnabled(value: boolean);
  31919. }
  31920. }
  31921. declare module "babylonjs/Particles/solidParticleSystem" {
  31922. import { Nullable } from "babylonjs/types";
  31923. import { Mesh } from "babylonjs/Meshes/mesh";
  31924. import { Scene, IDisposable } from "babylonjs/scene";
  31925. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  31926. import { Material } from "babylonjs/Materials/material";
  31927. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  31928. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  31929. /**
  31930. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  31931. *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.
  31932. * The SPS is also a particle system. It provides some methods to manage the particles.
  31933. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  31934. *
  31935. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  31936. */
  31937. export class SolidParticleSystem implements IDisposable {
  31938. /**
  31939. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  31940. * Example : var p = SPS.particles[i];
  31941. */
  31942. particles: SolidParticle[];
  31943. /**
  31944. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  31945. */
  31946. nbParticles: number;
  31947. /**
  31948. * If the particles must ever face the camera (default false). Useful for planar particles.
  31949. */
  31950. billboard: boolean;
  31951. /**
  31952. * Recompute normals when adding a shape
  31953. */
  31954. recomputeNormals: boolean;
  31955. /**
  31956. * This a counter ofr your own usage. It's not set by any SPS functions.
  31957. */
  31958. counter: number;
  31959. /**
  31960. * The SPS name. This name is also given to the underlying mesh.
  31961. */
  31962. name: string;
  31963. /**
  31964. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  31965. */
  31966. mesh: Mesh;
  31967. /**
  31968. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  31969. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  31970. */
  31971. vars: any;
  31972. /**
  31973. * This array is populated when the SPS is set as 'pickable'.
  31974. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  31975. * Each element of this array is an object `{idx: int, faceId: int}`.
  31976. * `idx` is the picked particle index in the `SPS.particles` array
  31977. * `faceId` is the picked face index counted within this particle.
  31978. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  31979. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  31980. * Use the method SPS.pickedParticle(pickingInfo) instead.
  31981. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31982. */
  31983. pickedParticles: {
  31984. idx: number;
  31985. faceId: number;
  31986. }[];
  31987. /**
  31988. * This array is populated when the SPS is set as 'pickable'
  31989. * Each key of this array is a submesh index.
  31990. * Each element of this array is a second array defined like this :
  31991. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  31992. * Each element of this second array is an object `{idx: int, faceId: int}`.
  31993. * `idx` is the picked particle index in the `SPS.particles` array
  31994. * `faceId` is the picked face index counted within this particle.
  31995. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  31996. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31997. */
  31998. pickedBySubMesh: {
  31999. idx: number;
  32000. faceId: number;
  32001. }[][];
  32002. /**
  32003. * This array is populated when `enableDepthSort` is set to true.
  32004. * Each element of this array is an instance of the class DepthSortedParticle.
  32005. */
  32006. depthSortedParticles: DepthSortedParticle[];
  32007. /**
  32008. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32009. * @hidden
  32010. */
  32011. _bSphereOnly: boolean;
  32012. /**
  32013. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32014. * @hidden
  32015. */
  32016. _bSphereRadiusFactor: number;
  32017. private _scene;
  32018. private _positions;
  32019. private _indices;
  32020. private _normals;
  32021. private _colors;
  32022. private _uvs;
  32023. private _indices32;
  32024. private _positions32;
  32025. private _normals32;
  32026. private _fixedNormal32;
  32027. private _colors32;
  32028. private _uvs32;
  32029. private _index;
  32030. private _updatable;
  32031. private _pickable;
  32032. private _isVisibilityBoxLocked;
  32033. private _alwaysVisible;
  32034. private _depthSort;
  32035. private _expandable;
  32036. private _shapeCounter;
  32037. private _copy;
  32038. private _color;
  32039. private _computeParticleColor;
  32040. private _computeParticleTexture;
  32041. private _computeParticleRotation;
  32042. private _computeParticleVertex;
  32043. private _computeBoundingBox;
  32044. private _depthSortParticles;
  32045. private _camera;
  32046. private _mustUnrotateFixedNormals;
  32047. private _particlesIntersect;
  32048. private _needs32Bits;
  32049. private _isNotBuilt;
  32050. private _lastParticleId;
  32051. private _idxOfId;
  32052. private _multimaterialEnabled;
  32053. private _useModelMaterial;
  32054. private _indicesByMaterial;
  32055. private _materialIndexes;
  32056. private _depthSortFunction;
  32057. private _materialSortFunction;
  32058. private _materials;
  32059. private _multimaterial;
  32060. private _materialIndexesById;
  32061. private _defaultMaterial;
  32062. private _autoUpdateSubMeshes;
  32063. private _tmpVertex;
  32064. /**
  32065. * Creates a SPS (Solid Particle System) object.
  32066. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32067. * @param scene (Scene) is the scene in which the SPS is added.
  32068. * @param options defines the options of the sps e.g.
  32069. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32070. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32071. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32072. * * 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.
  32073. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32074. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32075. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32076. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32077. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32078. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32079. */
  32080. constructor(name: string, scene: Scene, options?: {
  32081. updatable?: boolean;
  32082. isPickable?: boolean;
  32083. enableDepthSort?: boolean;
  32084. particleIntersection?: boolean;
  32085. boundingSphereOnly?: boolean;
  32086. bSphereRadiusFactor?: number;
  32087. expandable?: boolean;
  32088. useModelMaterial?: boolean;
  32089. enableMultiMaterial?: boolean;
  32090. });
  32091. /**
  32092. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32093. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32094. * @returns the created mesh
  32095. */
  32096. buildMesh(): Mesh;
  32097. /**
  32098. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32099. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32100. * Thus the particles generated from `digest()` have their property `position` set yet.
  32101. * @param mesh ( Mesh ) is the mesh to be digested
  32102. * @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
  32103. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32104. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32105. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32106. * @returns the current SPS
  32107. */
  32108. digest(mesh: Mesh, options?: {
  32109. facetNb?: number;
  32110. number?: number;
  32111. delta?: number;
  32112. storage?: [];
  32113. }): SolidParticleSystem;
  32114. /**
  32115. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32116. * @hidden
  32117. */
  32118. private _unrotateFixedNormals;
  32119. /**
  32120. * Resets the temporary working copy particle
  32121. * @hidden
  32122. */
  32123. private _resetCopy;
  32124. /**
  32125. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32126. * @param p the current index in the positions array to be updated
  32127. * @param ind the current index in the indices array
  32128. * @param shape a Vector3 array, the shape geometry
  32129. * @param positions the positions array to be updated
  32130. * @param meshInd the shape indices array
  32131. * @param indices the indices array to be updated
  32132. * @param meshUV the shape uv array
  32133. * @param uvs the uv array to be updated
  32134. * @param meshCol the shape color array
  32135. * @param colors the color array to be updated
  32136. * @param meshNor the shape normals array
  32137. * @param normals the normals array to be updated
  32138. * @param idx the particle index
  32139. * @param idxInShape the particle index in its shape
  32140. * @param options the addShape() method passed options
  32141. * @model the particle model
  32142. * @hidden
  32143. */
  32144. private _meshBuilder;
  32145. /**
  32146. * Returns a shape Vector3 array from positions float array
  32147. * @param positions float array
  32148. * @returns a vector3 array
  32149. * @hidden
  32150. */
  32151. private _posToShape;
  32152. /**
  32153. * Returns a shapeUV array from a float uvs (array deep copy)
  32154. * @param uvs as a float array
  32155. * @returns a shapeUV array
  32156. * @hidden
  32157. */
  32158. private _uvsToShapeUV;
  32159. /**
  32160. * Adds a new particle object in the particles array
  32161. * @param idx particle index in particles array
  32162. * @param id particle id
  32163. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32164. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32165. * @param model particle ModelShape object
  32166. * @param shapeId model shape identifier
  32167. * @param idxInShape index of the particle in the current model
  32168. * @param bInfo model bounding info object
  32169. * @param storage target storage array, if any
  32170. * @hidden
  32171. */
  32172. private _addParticle;
  32173. /**
  32174. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32175. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32176. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32177. * @param nb (positive integer) the number of particles to be created from this model
  32178. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32179. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32180. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32181. * @returns the number of shapes in the system
  32182. */
  32183. addShape(mesh: Mesh, nb: number, options?: {
  32184. positionFunction?: any;
  32185. vertexFunction?: any;
  32186. storage?: [];
  32187. }): number;
  32188. /**
  32189. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32190. * @hidden
  32191. */
  32192. private _rebuildParticle;
  32193. /**
  32194. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32195. * @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.
  32196. * @returns the SPS.
  32197. */
  32198. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32199. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32200. * Returns an array with the removed particles.
  32201. * 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.
  32202. * The SPS can't be empty so at least one particle needs to remain in place.
  32203. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32204. * @param start index of the first particle to remove
  32205. * @param end index of the last particle to remove (included)
  32206. * @returns an array populated with the removed particles
  32207. */
  32208. removeParticles(start: number, end: number): SolidParticle[];
  32209. /**
  32210. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32211. * @param solidParticleArray an array populated with Solid Particles objects
  32212. * @returns the SPS
  32213. */
  32214. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32215. /**
  32216. * Creates a new particle and modifies the SPS mesh geometry :
  32217. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32218. * - calls _addParticle() to populate the particle array
  32219. * factorized code from addShape() and insertParticlesFromArray()
  32220. * @param idx particle index in the particles array
  32221. * @param i particle index in its shape
  32222. * @param modelShape particle ModelShape object
  32223. * @param shape shape vertex array
  32224. * @param meshInd shape indices array
  32225. * @param meshUV shape uv array
  32226. * @param meshCol shape color array
  32227. * @param meshNor shape normals array
  32228. * @param bbInfo shape bounding info
  32229. * @param storage target particle storage
  32230. * @options addShape() passed options
  32231. * @hidden
  32232. */
  32233. private _insertNewParticle;
  32234. /**
  32235. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32236. * This method calls `updateParticle()` for each particle of the SPS.
  32237. * For an animated SPS, it is usually called within the render loop.
  32238. * 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.
  32239. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32240. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32241. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32242. * @returns the SPS.
  32243. */
  32244. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32245. /**
  32246. * Disposes the SPS.
  32247. */
  32248. dispose(): void;
  32249. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32250. * idx is the particle index in the SPS
  32251. * faceId is the picked face index counted within this particle.
  32252. * Returns null if the pickInfo can't identify a picked particle.
  32253. * @param pickingInfo (PickingInfo object)
  32254. * @returns {idx: number, faceId: number} or null
  32255. */
  32256. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32257. idx: number;
  32258. faceId: number;
  32259. }>;
  32260. /**
  32261. * Returns a SolidParticle object from its identifier : particle.id
  32262. * @param id (integer) the particle Id
  32263. * @returns the searched particle or null if not found in the SPS.
  32264. */
  32265. getParticleById(id: number): Nullable<SolidParticle>;
  32266. /**
  32267. * Returns a new array populated with the particles having the passed shapeId.
  32268. * @param shapeId (integer) the shape identifier
  32269. * @returns a new solid particle array
  32270. */
  32271. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32272. /**
  32273. * Populates the passed array "ref" with the particles having the passed shapeId.
  32274. * @param shapeId the shape identifier
  32275. * @returns the SPS
  32276. * @param ref
  32277. */
  32278. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32279. /**
  32280. * Computes the required SubMeshes according the materials assigned to the particles.
  32281. * @returns the solid particle system.
  32282. * Does nothing if called before the SPS mesh is built.
  32283. */
  32284. computeSubMeshes(): SolidParticleSystem;
  32285. /**
  32286. * Sorts the solid particles by material when MultiMaterial is enabled.
  32287. * Updates the indices32 array.
  32288. * Updates the indicesByMaterial array.
  32289. * Updates the mesh indices array.
  32290. * @returns the SPS
  32291. * @hidden
  32292. */
  32293. private _sortParticlesByMaterial;
  32294. /**
  32295. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32296. * @hidden
  32297. */
  32298. private _setMaterialIndexesById;
  32299. /**
  32300. * Returns an array with unique values of Materials from the passed array
  32301. * @param array the material array to be checked and filtered
  32302. * @hidden
  32303. */
  32304. private _filterUniqueMaterialId;
  32305. /**
  32306. * Sets a new Standard Material as _defaultMaterial if not already set.
  32307. * @hidden
  32308. */
  32309. private _setDefaultMaterial;
  32310. /**
  32311. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32312. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32313. * @returns the SPS.
  32314. */
  32315. refreshVisibleSize(): SolidParticleSystem;
  32316. /**
  32317. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32318. * @param size the size (float) of the visibility box
  32319. * note : this doesn't lock the SPS mesh bounding box.
  32320. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32321. */
  32322. setVisibilityBox(size: number): void;
  32323. /**
  32324. * Gets whether the SPS as always visible or not
  32325. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32326. */
  32327. get isAlwaysVisible(): boolean;
  32328. /**
  32329. * Sets the SPS as always visible or not
  32330. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32331. */
  32332. set isAlwaysVisible(val: boolean);
  32333. /**
  32334. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32335. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32336. */
  32337. set isVisibilityBoxLocked(val: boolean);
  32338. /**
  32339. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32340. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32341. */
  32342. get isVisibilityBoxLocked(): boolean;
  32343. /**
  32344. * Tells to `setParticles()` to compute the particle rotations or not.
  32345. * Default value : true. The SPS is faster when it's set to false.
  32346. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32347. */
  32348. set computeParticleRotation(val: boolean);
  32349. /**
  32350. * Tells to `setParticles()` to compute the particle colors or not.
  32351. * Default value : true. The SPS is faster when it's set to false.
  32352. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32353. */
  32354. set computeParticleColor(val: boolean);
  32355. set computeParticleTexture(val: boolean);
  32356. /**
  32357. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32358. * Default value : false. The SPS is faster when it's set to false.
  32359. * Note : the particle custom vertex positions aren't stored values.
  32360. */
  32361. set computeParticleVertex(val: boolean);
  32362. /**
  32363. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32364. */
  32365. set computeBoundingBox(val: boolean);
  32366. /**
  32367. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32368. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32369. * Default : `true`
  32370. */
  32371. set depthSortParticles(val: boolean);
  32372. /**
  32373. * Gets if `setParticles()` computes the particle rotations or not.
  32374. * Default value : true. The SPS is faster when it's set to false.
  32375. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32376. */
  32377. get computeParticleRotation(): boolean;
  32378. /**
  32379. * Gets if `setParticles()` computes the particle colors or not.
  32380. * Default value : true. The SPS is faster when it's set to false.
  32381. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32382. */
  32383. get computeParticleColor(): boolean;
  32384. /**
  32385. * Gets if `setParticles()` computes the particle textures or not.
  32386. * Default value : true. The SPS is faster when it's set to false.
  32387. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32388. */
  32389. get computeParticleTexture(): boolean;
  32390. /**
  32391. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32392. * Default value : false. The SPS is faster when it's set to false.
  32393. * Note : the particle custom vertex positions aren't stored values.
  32394. */
  32395. get computeParticleVertex(): boolean;
  32396. /**
  32397. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32398. */
  32399. get computeBoundingBox(): boolean;
  32400. /**
  32401. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32402. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32403. * Default : `true`
  32404. */
  32405. get depthSortParticles(): boolean;
  32406. /**
  32407. * Gets if the SPS is created as expandable at construction time.
  32408. * Default : `false`
  32409. */
  32410. get expandable(): boolean;
  32411. /**
  32412. * Gets if the SPS supports the Multi Materials
  32413. */
  32414. get multimaterialEnabled(): boolean;
  32415. /**
  32416. * Gets if the SPS uses the model materials for its own multimaterial.
  32417. */
  32418. get useModelMaterial(): boolean;
  32419. /**
  32420. * The SPS used material array.
  32421. */
  32422. get materials(): Material[];
  32423. /**
  32424. * Sets the SPS MultiMaterial from the passed materials.
  32425. * Note : the passed array is internally copied and not used then by reference.
  32426. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32427. */
  32428. setMultiMaterial(materials: Material[]): void;
  32429. /**
  32430. * The SPS computed multimaterial object
  32431. */
  32432. get multimaterial(): MultiMaterial;
  32433. set multimaterial(mm: MultiMaterial);
  32434. /**
  32435. * If the subMeshes must be updated on the next call to setParticles()
  32436. */
  32437. get autoUpdateSubMeshes(): boolean;
  32438. set autoUpdateSubMeshes(val: boolean);
  32439. /**
  32440. * This function does nothing. It may be overwritten to set all the particle first values.
  32441. * The SPS doesn't call this function, you may have to call it by your own.
  32442. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32443. */
  32444. initParticles(): void;
  32445. /**
  32446. * This function does nothing. It may be overwritten to recycle a particle.
  32447. * The SPS doesn't call this function, you may have to call it by your own.
  32448. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32449. * @param particle The particle to recycle
  32450. * @returns the recycled particle
  32451. */
  32452. recycleParticle(particle: SolidParticle): SolidParticle;
  32453. /**
  32454. * Updates a particle : this function should be overwritten by the user.
  32455. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32456. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32457. * @example : just set a particle position or velocity and recycle conditions
  32458. * @param particle The particle to update
  32459. * @returns the updated particle
  32460. */
  32461. updateParticle(particle: SolidParticle): SolidParticle;
  32462. /**
  32463. * Updates a vertex of a particle : it can be overwritten by the user.
  32464. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32465. * @param particle the current particle
  32466. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32467. * @param pt the index of the current vertex in the particle shape
  32468. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32469. * @example : just set a vertex particle position or color
  32470. * @returns the sps
  32471. */
  32472. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32473. /**
  32474. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32475. * This does nothing and may be overwritten by the user.
  32476. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32477. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32478. * @param update the boolean update value actually passed to setParticles()
  32479. */
  32480. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32481. /**
  32482. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32483. * This will be passed three parameters.
  32484. * This does nothing and may be overwritten by the user.
  32485. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32486. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32487. * @param update the boolean update value actually passed to setParticles()
  32488. */
  32489. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32490. }
  32491. }
  32492. declare module "babylonjs/Particles/solidParticle" {
  32493. import { Nullable } from "babylonjs/types";
  32494. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32495. import { Color4 } from "babylonjs/Maths/math.color";
  32496. import { Mesh } from "babylonjs/Meshes/mesh";
  32497. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32498. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32499. import { Plane } from "babylonjs/Maths/math.plane";
  32500. import { Material } from "babylonjs/Materials/material";
  32501. /**
  32502. * Represents one particle of a solid particle system.
  32503. */
  32504. export class SolidParticle {
  32505. /**
  32506. * particle global index
  32507. */
  32508. idx: number;
  32509. /**
  32510. * particle identifier
  32511. */
  32512. id: number;
  32513. /**
  32514. * The color of the particle
  32515. */
  32516. color: Nullable<Color4>;
  32517. /**
  32518. * The world space position of the particle.
  32519. */
  32520. position: Vector3;
  32521. /**
  32522. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32523. */
  32524. rotation: Vector3;
  32525. /**
  32526. * The world space rotation quaternion of the particle.
  32527. */
  32528. rotationQuaternion: Nullable<Quaternion>;
  32529. /**
  32530. * The scaling of the particle.
  32531. */
  32532. scaling: Vector3;
  32533. /**
  32534. * The uvs of the particle.
  32535. */
  32536. uvs: Vector4;
  32537. /**
  32538. * The current speed of the particle.
  32539. */
  32540. velocity: Vector3;
  32541. /**
  32542. * The pivot point in the particle local space.
  32543. */
  32544. pivot: Vector3;
  32545. /**
  32546. * Must the particle be translated from its pivot point in its local space ?
  32547. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32548. * Default : false
  32549. */
  32550. translateFromPivot: boolean;
  32551. /**
  32552. * Is the particle active or not ?
  32553. */
  32554. alive: boolean;
  32555. /**
  32556. * Is the particle visible or not ?
  32557. */
  32558. isVisible: boolean;
  32559. /**
  32560. * Index of this particle in the global "positions" array (Internal use)
  32561. * @hidden
  32562. */
  32563. _pos: number;
  32564. /**
  32565. * @hidden Index of this particle in the global "indices" array (Internal use)
  32566. */
  32567. _ind: number;
  32568. /**
  32569. * @hidden ModelShape of this particle (Internal use)
  32570. */
  32571. _model: ModelShape;
  32572. /**
  32573. * ModelShape id of this particle
  32574. */
  32575. shapeId: number;
  32576. /**
  32577. * Index of the particle in its shape id
  32578. */
  32579. idxInShape: number;
  32580. /**
  32581. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32582. */
  32583. _modelBoundingInfo: BoundingInfo;
  32584. /**
  32585. * @hidden Particle BoundingInfo object (Internal use)
  32586. */
  32587. _boundingInfo: BoundingInfo;
  32588. /**
  32589. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32590. */
  32591. _sps: SolidParticleSystem;
  32592. /**
  32593. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32594. */
  32595. _stillInvisible: boolean;
  32596. /**
  32597. * @hidden Last computed particle rotation matrix
  32598. */
  32599. _rotationMatrix: number[];
  32600. /**
  32601. * Parent particle Id, if any.
  32602. * Default null.
  32603. */
  32604. parentId: Nullable<number>;
  32605. /**
  32606. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32607. */
  32608. materialIndex: Nullable<number>;
  32609. /**
  32610. * Custom object or properties.
  32611. */
  32612. props: Nullable<any>;
  32613. /**
  32614. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32615. * The possible values are :
  32616. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32617. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32618. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32619. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32620. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32621. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32622. * */
  32623. cullingStrategy: number;
  32624. /**
  32625. * @hidden Internal global position in the SPS.
  32626. */
  32627. _globalPosition: Vector3;
  32628. /**
  32629. * Creates a Solid Particle object.
  32630. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32631. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32632. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32633. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32634. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32635. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32636. * @param shapeId (integer) is the model shape identifier in the SPS.
  32637. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32638. * @param sps defines the sps it is associated to
  32639. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32640. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32641. */
  32642. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32643. /**
  32644. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32645. * @param target the particle target
  32646. * @returns the current particle
  32647. */
  32648. copyToRef(target: SolidParticle): SolidParticle;
  32649. /**
  32650. * Legacy support, changed scale to scaling
  32651. */
  32652. get scale(): Vector3;
  32653. /**
  32654. * Legacy support, changed scale to scaling
  32655. */
  32656. set scale(scale: Vector3);
  32657. /**
  32658. * Legacy support, changed quaternion to rotationQuaternion
  32659. */
  32660. get quaternion(): Nullable<Quaternion>;
  32661. /**
  32662. * Legacy support, changed quaternion to rotationQuaternion
  32663. */
  32664. set quaternion(q: Nullable<Quaternion>);
  32665. /**
  32666. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32667. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32668. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32669. * @returns true if it intersects
  32670. */
  32671. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32672. /**
  32673. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32674. * A particle is in the frustum if its bounding box intersects the frustum
  32675. * @param frustumPlanes defines the frustum to test
  32676. * @returns true if the particle is in the frustum planes
  32677. */
  32678. isInFrustum(frustumPlanes: Plane[]): boolean;
  32679. /**
  32680. * get the rotation matrix of the particle
  32681. * @hidden
  32682. */
  32683. getRotationMatrix(m: Matrix): void;
  32684. }
  32685. /**
  32686. * Represents the shape of the model used by one particle of a solid particle system.
  32687. * SPS internal tool, don't use it manually.
  32688. */
  32689. export class ModelShape {
  32690. /**
  32691. * The shape id
  32692. * @hidden
  32693. */
  32694. shapeID: number;
  32695. /**
  32696. * flat array of model positions (internal use)
  32697. * @hidden
  32698. */
  32699. _shape: Vector3[];
  32700. /**
  32701. * flat array of model UVs (internal use)
  32702. * @hidden
  32703. */
  32704. _shapeUV: number[];
  32705. /**
  32706. * color array of the model
  32707. * @hidden
  32708. */
  32709. _shapeColors: number[];
  32710. /**
  32711. * indices array of the model
  32712. * @hidden
  32713. */
  32714. _indices: number[];
  32715. /**
  32716. * normals array of the model
  32717. * @hidden
  32718. */
  32719. _normals: number[];
  32720. /**
  32721. * length of the shape in the model indices array (internal use)
  32722. * @hidden
  32723. */
  32724. _indicesLength: number;
  32725. /**
  32726. * Custom position function (internal use)
  32727. * @hidden
  32728. */
  32729. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32730. /**
  32731. * Custom vertex function (internal use)
  32732. * @hidden
  32733. */
  32734. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32735. /**
  32736. * Model material (internal use)
  32737. * @hidden
  32738. */
  32739. _material: Nullable<Material>;
  32740. /**
  32741. * 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.
  32742. * SPS internal tool, don't use it manually.
  32743. * @hidden
  32744. */
  32745. 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>);
  32746. }
  32747. /**
  32748. * Represents a Depth Sorted Particle in the solid particle system.
  32749. * @hidden
  32750. */
  32751. export class DepthSortedParticle {
  32752. /**
  32753. * Particle index
  32754. */
  32755. idx: number;
  32756. /**
  32757. * Index of the particle in the "indices" array
  32758. */
  32759. ind: number;
  32760. /**
  32761. * Length of the particle shape in the "indices" array
  32762. */
  32763. indicesLength: number;
  32764. /**
  32765. * Squared distance from the particle to the camera
  32766. */
  32767. sqDistance: number;
  32768. /**
  32769. * Material index when used with MultiMaterials
  32770. */
  32771. materialIndex: number;
  32772. /**
  32773. * Creates a new sorted particle
  32774. * @param materialIndex
  32775. */
  32776. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32777. }
  32778. /**
  32779. * Represents a solid particle vertex
  32780. */
  32781. export class SolidParticleVertex {
  32782. /**
  32783. * Vertex position
  32784. */
  32785. position: Vector3;
  32786. /**
  32787. * Vertex color
  32788. */
  32789. color: Color4;
  32790. /**
  32791. * Vertex UV
  32792. */
  32793. uv: Vector2;
  32794. /**
  32795. * Creates a new solid particle vertex
  32796. */
  32797. constructor();
  32798. /** Vertex x coordinate */
  32799. get x(): number;
  32800. set x(val: number);
  32801. /** Vertex y coordinate */
  32802. get y(): number;
  32803. set y(val: number);
  32804. /** Vertex z coordinate */
  32805. get z(): number;
  32806. set z(val: number);
  32807. }
  32808. }
  32809. declare module "babylonjs/Collisions/meshCollisionData" {
  32810. import { Collider } from "babylonjs/Collisions/collider";
  32811. import { Vector3 } from "babylonjs/Maths/math.vector";
  32812. import { Nullable } from "babylonjs/types";
  32813. import { Observer } from "babylonjs/Misc/observable";
  32814. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  32815. /**
  32816. * @hidden
  32817. */
  32818. export class _MeshCollisionData {
  32819. _checkCollisions: boolean;
  32820. _collisionMask: number;
  32821. _collisionGroup: number;
  32822. _surroundingMeshes: Nullable<AbstractMesh[]>;
  32823. _collider: Nullable<Collider>;
  32824. _oldPositionForCollisions: Vector3;
  32825. _diffPositionForCollisions: Vector3;
  32826. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  32827. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  32828. }
  32829. }
  32830. declare module "babylonjs/Meshes/abstractMesh" {
  32831. import { Observable } from "babylonjs/Misc/observable";
  32832. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  32833. import { Camera } from "babylonjs/Cameras/camera";
  32834. import { Scene, IDisposable } from "babylonjs/scene";
  32835. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  32836. import { Node } from "babylonjs/node";
  32837. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  32838. import { TransformNode } from "babylonjs/Meshes/transformNode";
  32839. import { SubMesh } from "babylonjs/Meshes/subMesh";
  32840. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32841. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32842. import { Material } from "babylonjs/Materials/material";
  32843. import { Light } from "babylonjs/Lights/light";
  32844. import { Skeleton } from "babylonjs/Bones/skeleton";
  32845. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  32846. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  32847. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  32848. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  32849. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  32850. import { Plane } from "babylonjs/Maths/math.plane";
  32851. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  32852. import { Ray } from "babylonjs/Culling/ray";
  32853. import { Collider } from "babylonjs/Collisions/collider";
  32854. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  32855. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  32856. /** @hidden */
  32857. class _FacetDataStorage {
  32858. facetPositions: Vector3[];
  32859. facetNormals: Vector3[];
  32860. facetPartitioning: number[][];
  32861. facetNb: number;
  32862. partitioningSubdivisions: number;
  32863. partitioningBBoxRatio: number;
  32864. facetDataEnabled: boolean;
  32865. facetParameters: any;
  32866. bbSize: Vector3;
  32867. subDiv: {
  32868. max: number;
  32869. X: number;
  32870. Y: number;
  32871. Z: number;
  32872. };
  32873. facetDepthSort: boolean;
  32874. facetDepthSortEnabled: boolean;
  32875. depthSortedIndices: IndicesArray;
  32876. depthSortedFacets: {
  32877. ind: number;
  32878. sqDistance: number;
  32879. }[];
  32880. facetDepthSortFunction: (f1: {
  32881. ind: number;
  32882. sqDistance: number;
  32883. }, f2: {
  32884. ind: number;
  32885. sqDistance: number;
  32886. }) => number;
  32887. facetDepthSortFrom: Vector3;
  32888. facetDepthSortOrigin: Vector3;
  32889. invertedMatrix: Matrix;
  32890. }
  32891. /**
  32892. * @hidden
  32893. **/
  32894. class _InternalAbstractMeshDataInfo {
  32895. _hasVertexAlpha: boolean;
  32896. _useVertexColors: boolean;
  32897. _numBoneInfluencers: number;
  32898. _applyFog: boolean;
  32899. _receiveShadows: boolean;
  32900. _facetData: _FacetDataStorage;
  32901. _visibility: number;
  32902. _skeleton: Nullable<Skeleton>;
  32903. _layerMask: number;
  32904. _computeBonesUsingShaders: boolean;
  32905. _isActive: boolean;
  32906. _onlyForInstances: boolean;
  32907. _isActiveIntermediate: boolean;
  32908. _onlyForInstancesIntermediate: boolean;
  32909. _actAsRegularMesh: boolean;
  32910. }
  32911. /**
  32912. * Class used to store all common mesh properties
  32913. */
  32914. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  32915. /** No occlusion */
  32916. static OCCLUSION_TYPE_NONE: number;
  32917. /** Occlusion set to optimisitic */
  32918. static OCCLUSION_TYPE_OPTIMISTIC: number;
  32919. /** Occlusion set to strict */
  32920. static OCCLUSION_TYPE_STRICT: number;
  32921. /** Use an accurante occlusion algorithm */
  32922. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  32923. /** Use a conservative occlusion algorithm */
  32924. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  32925. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  32926. * Test order :
  32927. * Is the bounding sphere outside the frustum ?
  32928. * If not, are the bounding box vertices outside the frustum ?
  32929. * It not, then the cullable object is in the frustum.
  32930. */
  32931. static readonly CULLINGSTRATEGY_STANDARD: number;
  32932. /** Culling strategy : Bounding Sphere Only.
  32933. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  32934. * It's also less accurate than the standard because some not visible objects can still be selected.
  32935. * Test : is the bounding sphere outside the frustum ?
  32936. * If not, then the cullable object is in the frustum.
  32937. */
  32938. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  32939. /** Culling strategy : Optimistic Inclusion.
  32940. * This in an inclusion test first, then the standard exclusion test.
  32941. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  32942. * 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.
  32943. * Anyway, it's as accurate as the standard strategy.
  32944. * Test :
  32945. * Is the cullable object bounding sphere center in the frustum ?
  32946. * If not, apply the default culling strategy.
  32947. */
  32948. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  32949. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  32950. * This in an inclusion test first, then the bounding sphere only exclusion test.
  32951. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  32952. * 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.
  32953. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  32954. * Test :
  32955. * Is the cullable object bounding sphere center in the frustum ?
  32956. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  32957. */
  32958. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  32959. /**
  32960. * No billboard
  32961. */
  32962. static get BILLBOARDMODE_NONE(): number;
  32963. /** Billboard on X axis */
  32964. static get BILLBOARDMODE_X(): number;
  32965. /** Billboard on Y axis */
  32966. static get BILLBOARDMODE_Y(): number;
  32967. /** Billboard on Z axis */
  32968. static get BILLBOARDMODE_Z(): number;
  32969. /** Billboard on all axes */
  32970. static get BILLBOARDMODE_ALL(): number;
  32971. /** Billboard on using position instead of orientation */
  32972. static get BILLBOARDMODE_USE_POSITION(): number;
  32973. /** @hidden */
  32974. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  32975. /**
  32976. * The culling strategy to use to check whether the mesh must be rendered or not.
  32977. * This value can be changed at any time and will be used on the next render mesh selection.
  32978. * The possible values are :
  32979. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32980. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32981. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32982. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32983. * Please read each static variable documentation to get details about the culling process.
  32984. * */
  32985. cullingStrategy: number;
  32986. /**
  32987. * Gets the number of facets in the mesh
  32988. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  32989. */
  32990. get facetNb(): number;
  32991. /**
  32992. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  32993. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  32994. */
  32995. get partitioningSubdivisions(): number;
  32996. set partitioningSubdivisions(nb: number);
  32997. /**
  32998. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  32999. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33000. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33001. */
  33002. get partitioningBBoxRatio(): number;
  33003. set partitioningBBoxRatio(ratio: number);
  33004. /**
  33005. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33006. * Works only for updatable meshes.
  33007. * Doesn't work with multi-materials
  33008. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33009. */
  33010. get mustDepthSortFacets(): boolean;
  33011. set mustDepthSortFacets(sort: boolean);
  33012. /**
  33013. * The location (Vector3) where the facet depth sort must be computed from.
  33014. * By default, the active camera position.
  33015. * Used only when facet depth sort is enabled
  33016. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33017. */
  33018. get facetDepthSortFrom(): Vector3;
  33019. set facetDepthSortFrom(location: Vector3);
  33020. /**
  33021. * gets a boolean indicating if facetData is enabled
  33022. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33023. */
  33024. get isFacetDataEnabled(): boolean;
  33025. /** @hidden */
  33026. _updateNonUniformScalingState(value: boolean): boolean;
  33027. /**
  33028. * An event triggered when this mesh collides with another one
  33029. */
  33030. onCollideObservable: Observable<AbstractMesh>;
  33031. /** Set a function to call when this mesh collides with another one */
  33032. set onCollide(callback: () => void);
  33033. /**
  33034. * An event triggered when the collision's position changes
  33035. */
  33036. onCollisionPositionChangeObservable: Observable<Vector3>;
  33037. /** Set a function to call when the collision's position changes */
  33038. set onCollisionPositionChange(callback: () => void);
  33039. /**
  33040. * An event triggered when material is changed
  33041. */
  33042. onMaterialChangedObservable: Observable<AbstractMesh>;
  33043. /**
  33044. * Gets or sets the orientation for POV movement & rotation
  33045. */
  33046. definedFacingForward: boolean;
  33047. /** @hidden */
  33048. _occlusionQuery: Nullable<WebGLQuery>;
  33049. /** @hidden */
  33050. _renderingGroup: Nullable<RenderingGroup>;
  33051. /**
  33052. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33053. */
  33054. get visibility(): number;
  33055. /**
  33056. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33057. */
  33058. set visibility(value: number);
  33059. /** Gets or sets the alpha index used to sort transparent meshes
  33060. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33061. */
  33062. alphaIndex: number;
  33063. /**
  33064. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33065. */
  33066. isVisible: boolean;
  33067. /**
  33068. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33069. */
  33070. isPickable: boolean;
  33071. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33072. showSubMeshesBoundingBox: boolean;
  33073. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33074. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33075. */
  33076. isBlocker: boolean;
  33077. /**
  33078. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33079. */
  33080. enablePointerMoveEvents: boolean;
  33081. /**
  33082. * Specifies the rendering group id for this mesh (0 by default)
  33083. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33084. */
  33085. renderingGroupId: number;
  33086. private _material;
  33087. /** Gets or sets current material */
  33088. get material(): Nullable<Material>;
  33089. set material(value: Nullable<Material>);
  33090. /**
  33091. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33092. * @see https://doc.babylonjs.com/babylon101/shadows
  33093. */
  33094. get receiveShadows(): boolean;
  33095. set receiveShadows(value: boolean);
  33096. /** Defines color to use when rendering outline */
  33097. outlineColor: Color3;
  33098. /** Define width to use when rendering outline */
  33099. outlineWidth: number;
  33100. /** Defines color to use when rendering overlay */
  33101. overlayColor: Color3;
  33102. /** Defines alpha to use when rendering overlay */
  33103. overlayAlpha: number;
  33104. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33105. get hasVertexAlpha(): boolean;
  33106. set hasVertexAlpha(value: boolean);
  33107. /** 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) */
  33108. get useVertexColors(): boolean;
  33109. set useVertexColors(value: boolean);
  33110. /**
  33111. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33112. */
  33113. get computeBonesUsingShaders(): boolean;
  33114. set computeBonesUsingShaders(value: boolean);
  33115. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33116. get numBoneInfluencers(): number;
  33117. set numBoneInfluencers(value: number);
  33118. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33119. get applyFog(): boolean;
  33120. set applyFog(value: boolean);
  33121. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33122. useOctreeForRenderingSelection: boolean;
  33123. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33124. useOctreeForPicking: boolean;
  33125. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33126. useOctreeForCollisions: boolean;
  33127. /**
  33128. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33129. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33130. */
  33131. get layerMask(): number;
  33132. set layerMask(value: number);
  33133. /**
  33134. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33135. */
  33136. alwaysSelectAsActiveMesh: boolean;
  33137. /**
  33138. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33139. */
  33140. doNotSyncBoundingInfo: boolean;
  33141. /**
  33142. * Gets or sets the current action manager
  33143. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33144. */
  33145. actionManager: Nullable<AbstractActionManager>;
  33146. private _meshCollisionData;
  33147. /**
  33148. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33149. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33150. */
  33151. ellipsoid: Vector3;
  33152. /**
  33153. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33154. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33155. */
  33156. ellipsoidOffset: Vector3;
  33157. /**
  33158. * Gets or sets a collision mask used to mask collisions (default is -1).
  33159. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33160. */
  33161. get collisionMask(): number;
  33162. set collisionMask(mask: number);
  33163. /**
  33164. * Gets or sets the current collision group mask (-1 by default).
  33165. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33166. */
  33167. get collisionGroup(): number;
  33168. set collisionGroup(mask: number);
  33169. /**
  33170. * Gets or sets current surrounding meshes (null by default).
  33171. *
  33172. * By default collision detection is tested against every mesh in the scene.
  33173. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33174. * meshes will be tested for the collision.
  33175. *
  33176. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33177. */
  33178. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33179. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33180. /**
  33181. * Defines edge width used when edgesRenderer is enabled
  33182. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33183. */
  33184. edgesWidth: number;
  33185. /**
  33186. * Defines edge color used when edgesRenderer is enabled
  33187. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33188. */
  33189. edgesColor: Color4;
  33190. /** @hidden */
  33191. _edgesRenderer: Nullable<IEdgesRenderer>;
  33192. /** @hidden */
  33193. _masterMesh: Nullable<AbstractMesh>;
  33194. /** @hidden */
  33195. _boundingInfo: Nullable<BoundingInfo>;
  33196. /** @hidden */
  33197. _renderId: number;
  33198. /**
  33199. * Gets or sets the list of subMeshes
  33200. * @see https://doc.babylonjs.com/how_to/multi_materials
  33201. */
  33202. subMeshes: SubMesh[];
  33203. /** @hidden */
  33204. _intersectionsInProgress: AbstractMesh[];
  33205. /** @hidden */
  33206. _unIndexed: boolean;
  33207. /** @hidden */
  33208. _lightSources: Light[];
  33209. /** Gets the list of lights affecting that mesh */
  33210. get lightSources(): Light[];
  33211. /** @hidden */
  33212. get _positions(): Nullable<Vector3[]>;
  33213. /** @hidden */
  33214. _waitingData: {
  33215. lods: Nullable<any>;
  33216. actions: Nullable<any>;
  33217. freezeWorldMatrix: Nullable<boolean>;
  33218. };
  33219. /** @hidden */
  33220. _bonesTransformMatrices: Nullable<Float32Array>;
  33221. /** @hidden */
  33222. _transformMatrixTexture: Nullable<RawTexture>;
  33223. /**
  33224. * Gets or sets a skeleton to apply skining transformations
  33225. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33226. */
  33227. set skeleton(value: Nullable<Skeleton>);
  33228. get skeleton(): Nullable<Skeleton>;
  33229. /**
  33230. * An event triggered when the mesh is rebuilt.
  33231. */
  33232. onRebuildObservable: Observable<AbstractMesh>;
  33233. /**
  33234. * Creates a new AbstractMesh
  33235. * @param name defines the name of the mesh
  33236. * @param scene defines the hosting scene
  33237. */
  33238. constructor(name: string, scene?: Nullable<Scene>);
  33239. /**
  33240. * Returns the string "AbstractMesh"
  33241. * @returns "AbstractMesh"
  33242. */
  33243. getClassName(): string;
  33244. /**
  33245. * Gets a string representation of the current mesh
  33246. * @param fullDetails defines a boolean indicating if full details must be included
  33247. * @returns a string representation of the current mesh
  33248. */
  33249. toString(fullDetails?: boolean): string;
  33250. /**
  33251. * @hidden
  33252. */
  33253. protected _getEffectiveParent(): Nullable<Node>;
  33254. /** @hidden */
  33255. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33256. /** @hidden */
  33257. _rebuild(): void;
  33258. /** @hidden */
  33259. _resyncLightSources(): void;
  33260. /** @hidden */
  33261. _resyncLightSource(light: Light): void;
  33262. /** @hidden */
  33263. _unBindEffect(): void;
  33264. /** @hidden */
  33265. _removeLightSource(light: Light, dispose: boolean): void;
  33266. private _markSubMeshesAsDirty;
  33267. /** @hidden */
  33268. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33269. /** @hidden */
  33270. _markSubMeshesAsAttributesDirty(): void;
  33271. /** @hidden */
  33272. _markSubMeshesAsMiscDirty(): void;
  33273. /**
  33274. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33275. */
  33276. get scaling(): Vector3;
  33277. set scaling(newScaling: Vector3);
  33278. /**
  33279. * Returns true if the mesh is blocked. Implemented by child classes
  33280. */
  33281. get isBlocked(): boolean;
  33282. /**
  33283. * Returns the mesh itself by default. Implemented by child classes
  33284. * @param camera defines the camera to use to pick the right LOD level
  33285. * @returns the currentAbstractMesh
  33286. */
  33287. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33288. /**
  33289. * Returns 0 by default. Implemented by child classes
  33290. * @returns an integer
  33291. */
  33292. getTotalVertices(): number;
  33293. /**
  33294. * Returns a positive integer : the total number of indices in this mesh geometry.
  33295. * @returns the numner of indices or zero if the mesh has no geometry.
  33296. */
  33297. getTotalIndices(): number;
  33298. /**
  33299. * Returns null by default. Implemented by child classes
  33300. * @returns null
  33301. */
  33302. getIndices(): Nullable<IndicesArray>;
  33303. /**
  33304. * Returns the array of the requested vertex data kind. Implemented by child classes
  33305. * @param kind defines the vertex data kind to use
  33306. * @returns null
  33307. */
  33308. getVerticesData(kind: string): Nullable<FloatArray>;
  33309. /**
  33310. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33311. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33312. * Note that a new underlying VertexBuffer object is created each call.
  33313. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33314. * @param kind defines vertex data kind:
  33315. * * VertexBuffer.PositionKind
  33316. * * VertexBuffer.UVKind
  33317. * * VertexBuffer.UV2Kind
  33318. * * VertexBuffer.UV3Kind
  33319. * * VertexBuffer.UV4Kind
  33320. * * VertexBuffer.UV5Kind
  33321. * * VertexBuffer.UV6Kind
  33322. * * VertexBuffer.ColorKind
  33323. * * VertexBuffer.MatricesIndicesKind
  33324. * * VertexBuffer.MatricesIndicesExtraKind
  33325. * * VertexBuffer.MatricesWeightsKind
  33326. * * VertexBuffer.MatricesWeightsExtraKind
  33327. * @param data defines the data source
  33328. * @param updatable defines if the data must be flagged as updatable (or static)
  33329. * @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
  33330. * @returns the current mesh
  33331. */
  33332. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33333. /**
  33334. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33335. * If the mesh has no geometry, it is simply returned as it is.
  33336. * @param kind defines vertex data kind:
  33337. * * VertexBuffer.PositionKind
  33338. * * VertexBuffer.UVKind
  33339. * * VertexBuffer.UV2Kind
  33340. * * VertexBuffer.UV3Kind
  33341. * * VertexBuffer.UV4Kind
  33342. * * VertexBuffer.UV5Kind
  33343. * * VertexBuffer.UV6Kind
  33344. * * VertexBuffer.ColorKind
  33345. * * VertexBuffer.MatricesIndicesKind
  33346. * * VertexBuffer.MatricesIndicesExtraKind
  33347. * * VertexBuffer.MatricesWeightsKind
  33348. * * VertexBuffer.MatricesWeightsExtraKind
  33349. * @param data defines the data source
  33350. * @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
  33351. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33352. * @returns the current mesh
  33353. */
  33354. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33355. /**
  33356. * Sets the mesh indices,
  33357. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33358. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33359. * @param totalVertices Defines the total number of vertices
  33360. * @returns the current mesh
  33361. */
  33362. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33363. /**
  33364. * Gets a boolean indicating if specific vertex data is present
  33365. * @param kind defines the vertex data kind to use
  33366. * @returns true is data kind is present
  33367. */
  33368. isVerticesDataPresent(kind: string): boolean;
  33369. /**
  33370. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33371. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33372. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33373. * @returns a BoundingInfo
  33374. */
  33375. getBoundingInfo(): BoundingInfo;
  33376. /**
  33377. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33378. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33379. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33380. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33381. * @returns the current mesh
  33382. */
  33383. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33384. /**
  33385. * Overwrite the current bounding info
  33386. * @param boundingInfo defines the new bounding info
  33387. * @returns the current mesh
  33388. */
  33389. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33390. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33391. get useBones(): boolean;
  33392. /** @hidden */
  33393. _preActivate(): void;
  33394. /** @hidden */
  33395. _preActivateForIntermediateRendering(renderId: number): void;
  33396. /** @hidden */
  33397. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33398. /** @hidden */
  33399. _postActivate(): void;
  33400. /** @hidden */
  33401. _freeze(): void;
  33402. /** @hidden */
  33403. _unFreeze(): void;
  33404. /**
  33405. * Gets the current world matrix
  33406. * @returns a Matrix
  33407. */
  33408. getWorldMatrix(): Matrix;
  33409. /** @hidden */
  33410. _getWorldMatrixDeterminant(): number;
  33411. /**
  33412. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33413. */
  33414. get isAnInstance(): boolean;
  33415. /**
  33416. * Gets a boolean indicating if this mesh has instances
  33417. */
  33418. get hasInstances(): boolean;
  33419. /**
  33420. * Gets a boolean indicating if this mesh has thin instances
  33421. */
  33422. get hasThinInstances(): boolean;
  33423. /**
  33424. * Perform relative position change from the point of view of behind the front of the mesh.
  33425. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33426. * Supports definition of mesh facing forward or backward
  33427. * @param amountRight defines the distance on the right axis
  33428. * @param amountUp defines the distance on the up axis
  33429. * @param amountForward defines the distance on the forward axis
  33430. * @returns the current mesh
  33431. */
  33432. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33433. /**
  33434. * Calculate relative position change from the point of view of behind the front of the mesh.
  33435. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33436. * Supports definition of mesh facing forward or backward
  33437. * @param amountRight defines the distance on the right axis
  33438. * @param amountUp defines the distance on the up axis
  33439. * @param amountForward defines the distance on the forward axis
  33440. * @returns the new displacement vector
  33441. */
  33442. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33443. /**
  33444. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33445. * Supports definition of mesh facing forward or backward
  33446. * @param flipBack defines the flip
  33447. * @param twirlClockwise defines the twirl
  33448. * @param tiltRight defines the tilt
  33449. * @returns the current mesh
  33450. */
  33451. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33452. /**
  33453. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33454. * Supports definition of mesh facing forward or backward.
  33455. * @param flipBack defines the flip
  33456. * @param twirlClockwise defines the twirl
  33457. * @param tiltRight defines the tilt
  33458. * @returns the new rotation vector
  33459. */
  33460. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33461. /**
  33462. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33463. * This means the mesh underlying bounding box and sphere are recomputed.
  33464. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33465. * @returns the current mesh
  33466. */
  33467. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33468. /** @hidden */
  33469. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33470. /** @hidden */
  33471. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33472. /** @hidden */
  33473. _updateBoundingInfo(): AbstractMesh;
  33474. /** @hidden */
  33475. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33476. /** @hidden */
  33477. protected _afterComputeWorldMatrix(): void;
  33478. /** @hidden */
  33479. get _effectiveMesh(): AbstractMesh;
  33480. /**
  33481. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33482. * A mesh is in the frustum if its bounding box intersects the frustum
  33483. * @param frustumPlanes defines the frustum to test
  33484. * @returns true if the mesh is in the frustum planes
  33485. */
  33486. isInFrustum(frustumPlanes: Plane[]): boolean;
  33487. /**
  33488. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33489. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33490. * @param frustumPlanes defines the frustum to test
  33491. * @returns true if the mesh is completely in the frustum planes
  33492. */
  33493. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33494. /**
  33495. * True if the mesh intersects another mesh or a SolidParticle object
  33496. * @param mesh defines a target mesh or SolidParticle to test
  33497. * @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)
  33498. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33499. * @returns true if there is an intersection
  33500. */
  33501. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33502. /**
  33503. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33504. * @param point defines the point to test
  33505. * @returns true if there is an intersection
  33506. */
  33507. intersectsPoint(point: Vector3): boolean;
  33508. /**
  33509. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33510. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33511. */
  33512. get checkCollisions(): boolean;
  33513. set checkCollisions(collisionEnabled: boolean);
  33514. /**
  33515. * Gets Collider object used to compute collisions (not physics)
  33516. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33517. */
  33518. get collider(): Nullable<Collider>;
  33519. /**
  33520. * Move the mesh using collision engine
  33521. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33522. * @param displacement defines the requested displacement vector
  33523. * @returns the current mesh
  33524. */
  33525. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33526. private _onCollisionPositionChange;
  33527. /** @hidden */
  33528. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33529. /** @hidden */
  33530. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33531. /** @hidden */
  33532. _checkCollision(collider: Collider): AbstractMesh;
  33533. /** @hidden */
  33534. _generatePointsArray(): boolean;
  33535. /**
  33536. * Checks if the passed Ray intersects with the mesh
  33537. * @param ray defines the ray to use
  33538. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33539. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33540. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33541. * @returns the picking info
  33542. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33543. */
  33544. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  33545. /**
  33546. * Clones the current mesh
  33547. * @param name defines the mesh name
  33548. * @param newParent defines the new mesh parent
  33549. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33550. * @returns the new mesh
  33551. */
  33552. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33553. /**
  33554. * Disposes all the submeshes of the current meshnp
  33555. * @returns the current mesh
  33556. */
  33557. releaseSubMeshes(): AbstractMesh;
  33558. /**
  33559. * Releases resources associated with this abstract mesh.
  33560. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33561. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33562. */
  33563. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33564. /**
  33565. * Adds the passed mesh as a child to the current mesh
  33566. * @param mesh defines the child mesh
  33567. * @returns the current mesh
  33568. */
  33569. addChild(mesh: AbstractMesh): AbstractMesh;
  33570. /**
  33571. * Removes the passed mesh from the current mesh children list
  33572. * @param mesh defines the child mesh
  33573. * @returns the current mesh
  33574. */
  33575. removeChild(mesh: AbstractMesh): AbstractMesh;
  33576. /** @hidden */
  33577. private _initFacetData;
  33578. /**
  33579. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33580. * This method can be called within the render loop.
  33581. * 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
  33582. * @returns the current mesh
  33583. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33584. */
  33585. updateFacetData(): AbstractMesh;
  33586. /**
  33587. * Returns the facetLocalNormals array.
  33588. * The normals are expressed in the mesh local spac
  33589. * @returns an array of Vector3
  33590. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33591. */
  33592. getFacetLocalNormals(): Vector3[];
  33593. /**
  33594. * Returns the facetLocalPositions array.
  33595. * The facet positions are expressed in the mesh local space
  33596. * @returns an array of Vector3
  33597. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33598. */
  33599. getFacetLocalPositions(): Vector3[];
  33600. /**
  33601. * Returns the facetLocalPartioning array
  33602. * @returns an array of array of numbers
  33603. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33604. */
  33605. getFacetLocalPartitioning(): number[][];
  33606. /**
  33607. * Returns the i-th facet position in the world system.
  33608. * This method allocates a new Vector3 per call
  33609. * @param i defines the facet index
  33610. * @returns a new Vector3
  33611. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33612. */
  33613. getFacetPosition(i: number): Vector3;
  33614. /**
  33615. * Sets the reference Vector3 with the i-th facet position in the world system
  33616. * @param i defines the facet index
  33617. * @param ref defines the target vector
  33618. * @returns the current mesh
  33619. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33620. */
  33621. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33622. /**
  33623. * Returns the i-th facet normal in the world system.
  33624. * This method allocates a new Vector3 per call
  33625. * @param i defines the facet index
  33626. * @returns a new Vector3
  33627. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33628. */
  33629. getFacetNormal(i: number): Vector3;
  33630. /**
  33631. * Sets the reference Vector3 with the i-th facet normal in the world system
  33632. * @param i defines the facet index
  33633. * @param ref defines the target vector
  33634. * @returns the current mesh
  33635. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33636. */
  33637. getFacetNormalToRef(i: number, ref: Vector3): this;
  33638. /**
  33639. * 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)
  33640. * @param x defines x coordinate
  33641. * @param y defines y coordinate
  33642. * @param z defines z coordinate
  33643. * @returns the array of facet indexes
  33644. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33645. */
  33646. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33647. /**
  33648. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33649. * @param projected sets as the (x,y,z) world projection on the facet
  33650. * @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
  33651. * @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
  33652. * @param x defines x coordinate
  33653. * @param y defines y coordinate
  33654. * @param z defines z coordinate
  33655. * @returns the face index if found (or null instead)
  33656. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33657. */
  33658. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33659. /**
  33660. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33661. * @param projected sets as the (x,y,z) local projection on the facet
  33662. * @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
  33663. * @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
  33664. * @param x defines x coordinate
  33665. * @param y defines y coordinate
  33666. * @param z defines z coordinate
  33667. * @returns the face index if found (or null instead)
  33668. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33669. */
  33670. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33671. /**
  33672. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33673. * @returns the parameters
  33674. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33675. */
  33676. getFacetDataParameters(): any;
  33677. /**
  33678. * Disables the feature FacetData and frees the related memory
  33679. * @returns the current mesh
  33680. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33681. */
  33682. disableFacetData(): AbstractMesh;
  33683. /**
  33684. * Updates the AbstractMesh indices array
  33685. * @param indices defines the data source
  33686. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33687. * @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)
  33688. * @returns the current mesh
  33689. */
  33690. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33691. /**
  33692. * Creates new normals data for the mesh
  33693. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33694. * @returns the current mesh
  33695. */
  33696. createNormals(updatable: boolean): AbstractMesh;
  33697. /**
  33698. * Align the mesh with a normal
  33699. * @param normal defines the normal to use
  33700. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33701. * @returns the current mesh
  33702. */
  33703. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33704. /** @hidden */
  33705. _checkOcclusionQuery(): boolean;
  33706. /**
  33707. * Disables the mesh edge rendering mode
  33708. * @returns the currentAbstractMesh
  33709. */
  33710. disableEdgesRendering(): AbstractMesh;
  33711. /**
  33712. * Enables the edge rendering mode on the mesh.
  33713. * This mode makes the mesh edges visible
  33714. * @param epsilon defines the maximal distance between two angles to detect a face
  33715. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33716. * @returns the currentAbstractMesh
  33717. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33718. */
  33719. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33720. /**
  33721. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33722. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33723. */
  33724. getConnectedParticleSystems(): IParticleSystem[];
  33725. }
  33726. }
  33727. declare module "babylonjs/Actions/actionEvent" {
  33728. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33729. import { Nullable } from "babylonjs/types";
  33730. import { Sprite } from "babylonjs/Sprites/sprite";
  33731. import { Scene } from "babylonjs/scene";
  33732. import { Vector2 } from "babylonjs/Maths/math.vector";
  33733. /**
  33734. * Interface used to define ActionEvent
  33735. */
  33736. export interface IActionEvent {
  33737. /** The mesh or sprite that triggered the action */
  33738. source: any;
  33739. /** The X mouse cursor position at the time of the event */
  33740. pointerX: number;
  33741. /** The Y mouse cursor position at the time of the event */
  33742. pointerY: number;
  33743. /** The mesh that is currently pointed at (can be null) */
  33744. meshUnderPointer: Nullable<AbstractMesh>;
  33745. /** the original (browser) event that triggered the ActionEvent */
  33746. sourceEvent?: any;
  33747. /** additional data for the event */
  33748. additionalData?: any;
  33749. }
  33750. /**
  33751. * ActionEvent is the event being sent when an action is triggered.
  33752. */
  33753. export class ActionEvent implements IActionEvent {
  33754. /** The mesh or sprite that triggered the action */
  33755. source: any;
  33756. /** The X mouse cursor position at the time of the event */
  33757. pointerX: number;
  33758. /** The Y mouse cursor position at the time of the event */
  33759. pointerY: number;
  33760. /** The mesh that is currently pointed at (can be null) */
  33761. meshUnderPointer: Nullable<AbstractMesh>;
  33762. /** the original (browser) event that triggered the ActionEvent */
  33763. sourceEvent?: any;
  33764. /** additional data for the event */
  33765. additionalData?: any;
  33766. /**
  33767. * Creates a new ActionEvent
  33768. * @param source The mesh or sprite that triggered the action
  33769. * @param pointerX The X mouse cursor position at the time of the event
  33770. * @param pointerY The Y mouse cursor position at the time of the event
  33771. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33772. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33773. * @param additionalData additional data for the event
  33774. */
  33775. constructor(
  33776. /** The mesh or sprite that triggered the action */
  33777. source: any,
  33778. /** The X mouse cursor position at the time of the event */
  33779. pointerX: number,
  33780. /** The Y mouse cursor position at the time of the event */
  33781. pointerY: number,
  33782. /** The mesh that is currently pointed at (can be null) */
  33783. meshUnderPointer: Nullable<AbstractMesh>,
  33784. /** the original (browser) event that triggered the ActionEvent */
  33785. sourceEvent?: any,
  33786. /** additional data for the event */
  33787. additionalData?: any);
  33788. /**
  33789. * Helper function to auto-create an ActionEvent from a source mesh.
  33790. * @param source The source mesh that triggered the event
  33791. * @param evt The original (browser) event
  33792. * @param additionalData additional data for the event
  33793. * @returns the new ActionEvent
  33794. */
  33795. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33796. /**
  33797. * Helper function to auto-create an ActionEvent from a source sprite
  33798. * @param source The source sprite that triggered the event
  33799. * @param scene Scene associated with the sprite
  33800. * @param evt The original (browser) event
  33801. * @param additionalData additional data for the event
  33802. * @returns the new ActionEvent
  33803. */
  33804. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  33805. /**
  33806. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  33807. * @param scene the scene where the event occurred
  33808. * @param evt The original (browser) event
  33809. * @returns the new ActionEvent
  33810. */
  33811. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  33812. /**
  33813. * Helper function to auto-create an ActionEvent from a primitive
  33814. * @param prim defines the target primitive
  33815. * @param pointerPos defines the pointer position
  33816. * @param evt The original (browser) event
  33817. * @param additionalData additional data for the event
  33818. * @returns the new ActionEvent
  33819. */
  33820. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  33821. }
  33822. }
  33823. declare module "babylonjs/Actions/abstractActionManager" {
  33824. import { IDisposable } from "babylonjs/scene";
  33825. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  33826. import { IAction } from "babylonjs/Actions/action";
  33827. import { Nullable } from "babylonjs/types";
  33828. /**
  33829. * Abstract class used to decouple action Manager from scene and meshes.
  33830. * Do not instantiate.
  33831. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33832. */
  33833. export abstract class AbstractActionManager implements IDisposable {
  33834. /** Gets the list of active triggers */
  33835. static Triggers: {
  33836. [key: string]: number;
  33837. };
  33838. /** Gets the cursor to use when hovering items */
  33839. hoverCursor: string;
  33840. /** Gets the list of actions */
  33841. actions: IAction[];
  33842. /**
  33843. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  33844. */
  33845. isRecursive: boolean;
  33846. /**
  33847. * Releases all associated resources
  33848. */
  33849. abstract dispose(): void;
  33850. /**
  33851. * Does this action manager has pointer triggers
  33852. */
  33853. abstract get hasPointerTriggers(): boolean;
  33854. /**
  33855. * Does this action manager has pick triggers
  33856. */
  33857. abstract get hasPickTriggers(): boolean;
  33858. /**
  33859. * Process a specific trigger
  33860. * @param trigger defines the trigger to process
  33861. * @param evt defines the event details to be processed
  33862. */
  33863. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  33864. /**
  33865. * Does this action manager handles actions of any of the given triggers
  33866. * @param triggers defines the triggers to be tested
  33867. * @return a boolean indicating whether one (or more) of the triggers is handled
  33868. */
  33869. abstract hasSpecificTriggers(triggers: number[]): boolean;
  33870. /**
  33871. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  33872. * speed.
  33873. * @param triggerA defines the trigger to be tested
  33874. * @param triggerB defines the trigger to be tested
  33875. * @return a boolean indicating whether one (or more) of the triggers is handled
  33876. */
  33877. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  33878. /**
  33879. * Does this action manager handles actions of a given trigger
  33880. * @param trigger defines the trigger to be tested
  33881. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  33882. * @return whether the trigger is handled
  33883. */
  33884. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  33885. /**
  33886. * Serialize this manager to a JSON object
  33887. * @param name defines the property name to store this manager
  33888. * @returns a JSON representation of this manager
  33889. */
  33890. abstract serialize(name: string): any;
  33891. /**
  33892. * Registers an action to this action manager
  33893. * @param action defines the action to be registered
  33894. * @return the action amended (prepared) after registration
  33895. */
  33896. abstract registerAction(action: IAction): Nullable<IAction>;
  33897. /**
  33898. * Unregisters an action to this action manager
  33899. * @param action defines the action to be unregistered
  33900. * @return a boolean indicating whether the action has been unregistered
  33901. */
  33902. abstract unregisterAction(action: IAction): Boolean;
  33903. /**
  33904. * Does exist one action manager with at least one trigger
  33905. **/
  33906. static get HasTriggers(): boolean;
  33907. /**
  33908. * Does exist one action manager with at least one pick trigger
  33909. **/
  33910. static get HasPickTriggers(): boolean;
  33911. /**
  33912. * Does exist one action manager that handles actions of a given trigger
  33913. * @param trigger defines the trigger to be tested
  33914. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  33915. **/
  33916. static HasSpecificTrigger(trigger: number): boolean;
  33917. }
  33918. }
  33919. declare module "babylonjs/node" {
  33920. import { Scene } from "babylonjs/scene";
  33921. import { Nullable } from "babylonjs/types";
  33922. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  33923. import { Engine } from "babylonjs/Engines/engine";
  33924. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  33925. import { Observable } from "babylonjs/Misc/observable";
  33926. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33927. import { IInspectable } from "babylonjs/Misc/iInspectable";
  33928. import { Animatable } from "babylonjs/Animations/animatable";
  33929. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  33930. import { Animation } from "babylonjs/Animations/animation";
  33931. import { AnimationRange } from "babylonjs/Animations/animationRange";
  33932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33933. /**
  33934. * Defines how a node can be built from a string name.
  33935. */
  33936. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  33937. /**
  33938. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  33939. */
  33940. export class Node implements IBehaviorAware<Node> {
  33941. /** @hidden */
  33942. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  33943. private static _NodeConstructors;
  33944. /**
  33945. * Add a new node constructor
  33946. * @param type defines the type name of the node to construct
  33947. * @param constructorFunc defines the constructor function
  33948. */
  33949. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  33950. /**
  33951. * Returns a node constructor based on type name
  33952. * @param type defines the type name
  33953. * @param name defines the new node name
  33954. * @param scene defines the hosting scene
  33955. * @param options defines optional options to transmit to constructors
  33956. * @returns the new constructor or null
  33957. */
  33958. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  33959. /**
  33960. * Gets or sets the name of the node
  33961. */
  33962. name: string;
  33963. /**
  33964. * Gets or sets the id of the node
  33965. */
  33966. id: string;
  33967. /**
  33968. * Gets or sets the unique id of the node
  33969. */
  33970. uniqueId: number;
  33971. /**
  33972. * Gets or sets a string used to store user defined state for the node
  33973. */
  33974. state: string;
  33975. /**
  33976. * Gets or sets an object used to store user defined information for the node
  33977. */
  33978. metadata: any;
  33979. /**
  33980. * For internal use only. Please do not use.
  33981. */
  33982. reservedDataStore: any;
  33983. /**
  33984. * List of inspectable custom properties (used by the Inspector)
  33985. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  33986. */
  33987. inspectableCustomProperties: IInspectable[];
  33988. private _doNotSerialize;
  33989. /**
  33990. * Gets or sets a boolean used to define if the node must be serialized
  33991. */
  33992. get doNotSerialize(): boolean;
  33993. set doNotSerialize(value: boolean);
  33994. /** @hidden */
  33995. _isDisposed: boolean;
  33996. /**
  33997. * Gets a list of Animations associated with the node
  33998. */
  33999. animations: import("babylonjs/Animations/animation").Animation[];
  34000. protected _ranges: {
  34001. [name: string]: Nullable<AnimationRange>;
  34002. };
  34003. /**
  34004. * Callback raised when the node is ready to be used
  34005. */
  34006. onReady: Nullable<(node: Node) => void>;
  34007. private _isEnabled;
  34008. private _isParentEnabled;
  34009. private _isReady;
  34010. /** @hidden */
  34011. _currentRenderId: number;
  34012. private _parentUpdateId;
  34013. /** @hidden */
  34014. _childUpdateId: number;
  34015. /** @hidden */
  34016. _waitingParentId: Nullable<string>;
  34017. /** @hidden */
  34018. _scene: Scene;
  34019. /** @hidden */
  34020. _cache: any;
  34021. private _parentNode;
  34022. private _children;
  34023. /** @hidden */
  34024. _worldMatrix: Matrix;
  34025. /** @hidden */
  34026. _worldMatrixDeterminant: number;
  34027. /** @hidden */
  34028. _worldMatrixDeterminantIsDirty: boolean;
  34029. /** @hidden */
  34030. private _sceneRootNodesIndex;
  34031. /**
  34032. * Gets a boolean indicating if the node has been disposed
  34033. * @returns true if the node was disposed
  34034. */
  34035. isDisposed(): boolean;
  34036. /**
  34037. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34038. * @see https://doc.babylonjs.com/how_to/parenting
  34039. */
  34040. set parent(parent: Nullable<Node>);
  34041. get parent(): Nullable<Node>;
  34042. /** @hidden */
  34043. _addToSceneRootNodes(): void;
  34044. /** @hidden */
  34045. _removeFromSceneRootNodes(): void;
  34046. private _animationPropertiesOverride;
  34047. /**
  34048. * Gets or sets the animation properties override
  34049. */
  34050. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34051. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34052. /**
  34053. * Gets a string idenfifying the name of the class
  34054. * @returns "Node" string
  34055. */
  34056. getClassName(): string;
  34057. /** @hidden */
  34058. readonly _isNode: boolean;
  34059. /**
  34060. * An event triggered when the mesh is disposed
  34061. */
  34062. onDisposeObservable: Observable<Node>;
  34063. private _onDisposeObserver;
  34064. /**
  34065. * Sets a callback that will be raised when the node will be disposed
  34066. */
  34067. set onDispose(callback: () => void);
  34068. /**
  34069. * Creates a new Node
  34070. * @param name the name and id to be given to this node
  34071. * @param scene the scene this node will be added to
  34072. */
  34073. constructor(name: string, scene?: Nullable<Scene>);
  34074. /**
  34075. * Gets the scene of the node
  34076. * @returns a scene
  34077. */
  34078. getScene(): Scene;
  34079. /**
  34080. * Gets the engine of the node
  34081. * @returns a Engine
  34082. */
  34083. getEngine(): Engine;
  34084. private _behaviors;
  34085. /**
  34086. * Attach a behavior to the node
  34087. * @see https://doc.babylonjs.com/features/behaviour
  34088. * @param behavior defines the behavior to attach
  34089. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34090. * @returns the current Node
  34091. */
  34092. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34093. /**
  34094. * Remove an attached behavior
  34095. * @see https://doc.babylonjs.com/features/behaviour
  34096. * @param behavior defines the behavior to attach
  34097. * @returns the current Node
  34098. */
  34099. removeBehavior(behavior: Behavior<Node>): Node;
  34100. /**
  34101. * Gets the list of attached behaviors
  34102. * @see https://doc.babylonjs.com/features/behaviour
  34103. */
  34104. get behaviors(): Behavior<Node>[];
  34105. /**
  34106. * Gets an attached behavior by name
  34107. * @param name defines the name of the behavior to look for
  34108. * @see https://doc.babylonjs.com/features/behaviour
  34109. * @returns null if behavior was not found else the requested behavior
  34110. */
  34111. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34112. /**
  34113. * Returns the latest update of the World matrix
  34114. * @returns a Matrix
  34115. */
  34116. getWorldMatrix(): Matrix;
  34117. /** @hidden */
  34118. _getWorldMatrixDeterminant(): number;
  34119. /**
  34120. * Returns directly the latest state of the mesh World matrix.
  34121. * A Matrix is returned.
  34122. */
  34123. get worldMatrixFromCache(): Matrix;
  34124. /** @hidden */
  34125. _initCache(): void;
  34126. /** @hidden */
  34127. updateCache(force?: boolean): void;
  34128. /** @hidden */
  34129. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34130. /** @hidden */
  34131. _updateCache(ignoreParentClass?: boolean): void;
  34132. /** @hidden */
  34133. _isSynchronized(): boolean;
  34134. /** @hidden */
  34135. _markSyncedWithParent(): void;
  34136. /** @hidden */
  34137. isSynchronizedWithParent(): boolean;
  34138. /** @hidden */
  34139. isSynchronized(): boolean;
  34140. /**
  34141. * Is this node ready to be used/rendered
  34142. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34143. * @return true if the node is ready
  34144. */
  34145. isReady(completeCheck?: boolean): boolean;
  34146. /**
  34147. * Is this node enabled?
  34148. * 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
  34149. * @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
  34150. * @return whether this node (and its parent) is enabled
  34151. */
  34152. isEnabled(checkAncestors?: boolean): boolean;
  34153. /** @hidden */
  34154. protected _syncParentEnabledState(): void;
  34155. /**
  34156. * Set the enabled state of this node
  34157. * @param value defines the new enabled state
  34158. */
  34159. setEnabled(value: boolean): void;
  34160. /**
  34161. * Is this node a descendant of the given node?
  34162. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34163. * @param ancestor defines the parent node to inspect
  34164. * @returns a boolean indicating if this node is a descendant of the given node
  34165. */
  34166. isDescendantOf(ancestor: Node): boolean;
  34167. /** @hidden */
  34168. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34169. /**
  34170. * Will return all nodes that have this node as ascendant
  34171. * @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
  34172. * @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
  34173. * @return all children nodes of all types
  34174. */
  34175. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34176. /**
  34177. * Get all child-meshes of this node
  34178. * @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)
  34179. * @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
  34180. * @returns an array of AbstractMesh
  34181. */
  34182. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34183. /**
  34184. * Get all direct children of this node
  34185. * @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
  34186. * @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)
  34187. * @returns an array of Node
  34188. */
  34189. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34190. /** @hidden */
  34191. _setReady(state: boolean): void;
  34192. /**
  34193. * Get an animation by name
  34194. * @param name defines the name of the animation to look for
  34195. * @returns null if not found else the requested animation
  34196. */
  34197. getAnimationByName(name: string): Nullable<Animation>;
  34198. /**
  34199. * Creates an animation range for this node
  34200. * @param name defines the name of the range
  34201. * @param from defines the starting key
  34202. * @param to defines the end key
  34203. */
  34204. createAnimationRange(name: string, from: number, to: number): void;
  34205. /**
  34206. * Delete a specific animation range
  34207. * @param name defines the name of the range to delete
  34208. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34209. */
  34210. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34211. /**
  34212. * Get an animation range by name
  34213. * @param name defines the name of the animation range to look for
  34214. * @returns null if not found else the requested animation range
  34215. */
  34216. getAnimationRange(name: string): Nullable<AnimationRange>;
  34217. /**
  34218. * Gets the list of all animation ranges defined on this node
  34219. * @returns an array
  34220. */
  34221. getAnimationRanges(): Nullable<AnimationRange>[];
  34222. /**
  34223. * Will start the animation sequence
  34224. * @param name defines the range frames for animation sequence
  34225. * @param loop defines if the animation should loop (false by default)
  34226. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34227. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34228. * @returns the object created for this animation. If range does not exist, it will return null
  34229. */
  34230. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34231. /**
  34232. * Serialize animation ranges into a JSON compatible object
  34233. * @returns serialization object
  34234. */
  34235. serializeAnimationRanges(): any;
  34236. /**
  34237. * Computes the world matrix of the node
  34238. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34239. * @returns the world matrix
  34240. */
  34241. computeWorldMatrix(force?: boolean): Matrix;
  34242. /**
  34243. * Releases resources associated with this node.
  34244. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34245. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34246. */
  34247. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34248. /**
  34249. * Parse animation range data from a serialization object and store them into a given node
  34250. * @param node defines where to store the animation ranges
  34251. * @param parsedNode defines the serialization object to read data from
  34252. * @param scene defines the hosting scene
  34253. */
  34254. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34255. /**
  34256. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34257. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34258. * @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
  34259. * @returns the new bounding vectors
  34260. */
  34261. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34262. min: Vector3;
  34263. max: Vector3;
  34264. };
  34265. }
  34266. }
  34267. declare module "babylonjs/Animations/animation" {
  34268. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34269. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34270. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34271. import { Nullable } from "babylonjs/types";
  34272. import { Scene } from "babylonjs/scene";
  34273. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34274. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34275. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34276. import { Node } from "babylonjs/node";
  34277. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34278. import { Size } from "babylonjs/Maths/math.size";
  34279. import { Animatable } from "babylonjs/Animations/animatable";
  34280. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34281. /**
  34282. * @hidden
  34283. */
  34284. export class _IAnimationState {
  34285. key: number;
  34286. repeatCount: number;
  34287. workValue?: any;
  34288. loopMode?: number;
  34289. offsetValue?: any;
  34290. highLimitValue?: any;
  34291. }
  34292. /**
  34293. * Class used to store any kind of animation
  34294. */
  34295. export class Animation {
  34296. /**Name of the animation */
  34297. name: string;
  34298. /**Property to animate */
  34299. targetProperty: string;
  34300. /**The frames per second of the animation */
  34301. framePerSecond: number;
  34302. /**The data type of the animation */
  34303. dataType: number;
  34304. /**The loop mode of the animation */
  34305. loopMode?: number | undefined;
  34306. /**Specifies if blending should be enabled */
  34307. enableBlending?: boolean | undefined;
  34308. /**
  34309. * Use matrix interpolation instead of using direct key value when animating matrices
  34310. */
  34311. static AllowMatricesInterpolation: boolean;
  34312. /**
  34313. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34314. */
  34315. static AllowMatrixDecomposeForInterpolation: boolean;
  34316. /** Define the Url to load snippets */
  34317. static SnippetUrl: string;
  34318. /** Snippet ID if the animation was created from the snippet server */
  34319. snippetId: string;
  34320. /**
  34321. * Stores the key frames of the animation
  34322. */
  34323. private _keys;
  34324. /**
  34325. * Stores the easing function of the animation
  34326. */
  34327. private _easingFunction;
  34328. /**
  34329. * @hidden Internal use only
  34330. */
  34331. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34332. /**
  34333. * The set of event that will be linked to this animation
  34334. */
  34335. private _events;
  34336. /**
  34337. * Stores an array of target property paths
  34338. */
  34339. targetPropertyPath: string[];
  34340. /**
  34341. * Stores the blending speed of the animation
  34342. */
  34343. blendingSpeed: number;
  34344. /**
  34345. * Stores the animation ranges for the animation
  34346. */
  34347. private _ranges;
  34348. /**
  34349. * @hidden Internal use
  34350. */
  34351. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34352. /**
  34353. * Sets up an animation
  34354. * @param property The property to animate
  34355. * @param animationType The animation type to apply
  34356. * @param framePerSecond The frames per second of the animation
  34357. * @param easingFunction The easing function used in the animation
  34358. * @returns The created animation
  34359. */
  34360. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34361. /**
  34362. * Create and start an animation on a node
  34363. * @param name defines the name of the global animation that will be run on all nodes
  34364. * @param node defines the root node where the animation will take place
  34365. * @param targetProperty defines property to animate
  34366. * @param framePerSecond defines the number of frame per second yo use
  34367. * @param totalFrame defines the number of frames in total
  34368. * @param from defines the initial value
  34369. * @param to defines the final value
  34370. * @param loopMode defines which loop mode you want to use (off by default)
  34371. * @param easingFunction defines the easing function to use (linear by default)
  34372. * @param onAnimationEnd defines the callback to call when animation end
  34373. * @returns the animatable created for this animation
  34374. */
  34375. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34376. /**
  34377. * Create and start an animation on a node and its descendants
  34378. * @param name defines the name of the global animation that will be run on all nodes
  34379. * @param node defines the root node where the animation will take place
  34380. * @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
  34381. * @param targetProperty defines property to animate
  34382. * @param framePerSecond defines the number of frame per second to use
  34383. * @param totalFrame defines the number of frames in total
  34384. * @param from defines the initial value
  34385. * @param to defines the final value
  34386. * @param loopMode defines which loop mode you want to use (off by default)
  34387. * @param easingFunction defines the easing function to use (linear by default)
  34388. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34389. * @returns the list of animatables created for all nodes
  34390. * @example https://www.babylonjs-playground.com/#MH0VLI
  34391. */
  34392. 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[]>;
  34393. /**
  34394. * Creates a new animation, merges it with the existing animations and starts it
  34395. * @param name Name of the animation
  34396. * @param node Node which contains the scene that begins the animations
  34397. * @param targetProperty Specifies which property to animate
  34398. * @param framePerSecond The frames per second of the animation
  34399. * @param totalFrame The total number of frames
  34400. * @param from The frame at the beginning of the animation
  34401. * @param to The frame at the end of the animation
  34402. * @param loopMode Specifies the loop mode of the animation
  34403. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34404. * @param onAnimationEnd Callback to run once the animation is complete
  34405. * @returns Nullable animation
  34406. */
  34407. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34408. /**
  34409. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34410. * @param sourceAnimation defines the Animation containing keyframes to convert
  34411. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34412. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34413. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34414. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34415. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34416. */
  34417. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34418. /**
  34419. * Transition property of an host to the target Value
  34420. * @param property The property to transition
  34421. * @param targetValue The target Value of the property
  34422. * @param host The object where the property to animate belongs
  34423. * @param scene Scene used to run the animation
  34424. * @param frameRate Framerate (in frame/s) to use
  34425. * @param transition The transition type we want to use
  34426. * @param duration The duration of the animation, in milliseconds
  34427. * @param onAnimationEnd Callback trigger at the end of the animation
  34428. * @returns Nullable animation
  34429. */
  34430. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34431. /**
  34432. * Return the array of runtime animations currently using this animation
  34433. */
  34434. get runtimeAnimations(): RuntimeAnimation[];
  34435. /**
  34436. * Specifies if any of the runtime animations are currently running
  34437. */
  34438. get hasRunningRuntimeAnimations(): boolean;
  34439. /**
  34440. * Initializes the animation
  34441. * @param name Name of the animation
  34442. * @param targetProperty Property to animate
  34443. * @param framePerSecond The frames per second of the animation
  34444. * @param dataType The data type of the animation
  34445. * @param loopMode The loop mode of the animation
  34446. * @param enableBlending Specifies if blending should be enabled
  34447. */
  34448. constructor(
  34449. /**Name of the animation */
  34450. name: string,
  34451. /**Property to animate */
  34452. targetProperty: string,
  34453. /**The frames per second of the animation */
  34454. framePerSecond: number,
  34455. /**The data type of the animation */
  34456. dataType: number,
  34457. /**The loop mode of the animation */
  34458. loopMode?: number | undefined,
  34459. /**Specifies if blending should be enabled */
  34460. enableBlending?: boolean | undefined);
  34461. /**
  34462. * Converts the animation to a string
  34463. * @param fullDetails support for multiple levels of logging within scene loading
  34464. * @returns String form of the animation
  34465. */
  34466. toString(fullDetails?: boolean): string;
  34467. /**
  34468. * Add an event to this animation
  34469. * @param event Event to add
  34470. */
  34471. addEvent(event: AnimationEvent): void;
  34472. /**
  34473. * Remove all events found at the given frame
  34474. * @param frame The frame to remove events from
  34475. */
  34476. removeEvents(frame: number): void;
  34477. /**
  34478. * Retrieves all the events from the animation
  34479. * @returns Events from the animation
  34480. */
  34481. getEvents(): AnimationEvent[];
  34482. /**
  34483. * Creates an animation range
  34484. * @param name Name of the animation range
  34485. * @param from Starting frame of the animation range
  34486. * @param to Ending frame of the animation
  34487. */
  34488. createRange(name: string, from: number, to: number): void;
  34489. /**
  34490. * Deletes an animation range by name
  34491. * @param name Name of the animation range to delete
  34492. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34493. */
  34494. deleteRange(name: string, deleteFrames?: boolean): void;
  34495. /**
  34496. * Gets the animation range by name, or null if not defined
  34497. * @param name Name of the animation range
  34498. * @returns Nullable animation range
  34499. */
  34500. getRange(name: string): Nullable<AnimationRange>;
  34501. /**
  34502. * Gets the key frames from the animation
  34503. * @returns The key frames of the animation
  34504. */
  34505. getKeys(): Array<IAnimationKey>;
  34506. /**
  34507. * Gets the highest frame rate of the animation
  34508. * @returns Highest frame rate of the animation
  34509. */
  34510. getHighestFrame(): number;
  34511. /**
  34512. * Gets the easing function of the animation
  34513. * @returns Easing function of the animation
  34514. */
  34515. getEasingFunction(): IEasingFunction;
  34516. /**
  34517. * Sets the easing function of the animation
  34518. * @param easingFunction A custom mathematical formula for animation
  34519. */
  34520. setEasingFunction(easingFunction: EasingFunction): void;
  34521. /**
  34522. * Interpolates a scalar linearly
  34523. * @param startValue Start value of the animation curve
  34524. * @param endValue End value of the animation curve
  34525. * @param gradient Scalar amount to interpolate
  34526. * @returns Interpolated scalar value
  34527. */
  34528. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34529. /**
  34530. * Interpolates a scalar cubically
  34531. * @param startValue Start value of the animation curve
  34532. * @param outTangent End tangent of the animation
  34533. * @param endValue End value of the animation curve
  34534. * @param inTangent Start tangent of the animation curve
  34535. * @param gradient Scalar amount to interpolate
  34536. * @returns Interpolated scalar value
  34537. */
  34538. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34539. /**
  34540. * Interpolates a quaternion using a spherical linear interpolation
  34541. * @param startValue Start value of the animation curve
  34542. * @param endValue End value of the animation curve
  34543. * @param gradient Scalar amount to interpolate
  34544. * @returns Interpolated quaternion value
  34545. */
  34546. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34547. /**
  34548. * Interpolates a quaternion cubically
  34549. * @param startValue Start value of the animation curve
  34550. * @param outTangent End tangent of the animation curve
  34551. * @param endValue End value of the animation curve
  34552. * @param inTangent Start tangent of the animation curve
  34553. * @param gradient Scalar amount to interpolate
  34554. * @returns Interpolated quaternion value
  34555. */
  34556. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34557. /**
  34558. * Interpolates a Vector3 linearl
  34559. * @param startValue Start value of the animation curve
  34560. * @param endValue End value of the animation curve
  34561. * @param gradient Scalar amount to interpolate
  34562. * @returns Interpolated scalar value
  34563. */
  34564. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34565. /**
  34566. * Interpolates a Vector3 cubically
  34567. * @param startValue Start value of the animation curve
  34568. * @param outTangent End tangent of the animation
  34569. * @param endValue End value of the animation curve
  34570. * @param inTangent Start tangent of the animation curve
  34571. * @param gradient Scalar amount to interpolate
  34572. * @returns InterpolatedVector3 value
  34573. */
  34574. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34575. /**
  34576. * Interpolates a Vector2 linearly
  34577. * @param startValue Start value of the animation curve
  34578. * @param endValue End value of the animation curve
  34579. * @param gradient Scalar amount to interpolate
  34580. * @returns Interpolated Vector2 value
  34581. */
  34582. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34583. /**
  34584. * Interpolates a Vector2 cubically
  34585. * @param startValue Start value of the animation curve
  34586. * @param outTangent End tangent of the animation
  34587. * @param endValue End value of the animation curve
  34588. * @param inTangent Start tangent of the animation curve
  34589. * @param gradient Scalar amount to interpolate
  34590. * @returns Interpolated Vector2 value
  34591. */
  34592. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34593. /**
  34594. * Interpolates a size linearly
  34595. * @param startValue Start value of the animation curve
  34596. * @param endValue End value of the animation curve
  34597. * @param gradient Scalar amount to interpolate
  34598. * @returns Interpolated Size value
  34599. */
  34600. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34601. /**
  34602. * Interpolates a Color3 linearly
  34603. * @param startValue Start value of the animation curve
  34604. * @param endValue End value of the animation curve
  34605. * @param gradient Scalar amount to interpolate
  34606. * @returns Interpolated Color3 value
  34607. */
  34608. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34609. /**
  34610. * Interpolates a Color4 linearly
  34611. * @param startValue Start value of the animation curve
  34612. * @param endValue End value of the animation curve
  34613. * @param gradient Scalar amount to interpolate
  34614. * @returns Interpolated Color3 value
  34615. */
  34616. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34617. /**
  34618. * @hidden Internal use only
  34619. */
  34620. _getKeyValue(value: any): any;
  34621. /**
  34622. * @hidden Internal use only
  34623. */
  34624. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34625. /**
  34626. * Defines the function to use to interpolate matrices
  34627. * @param startValue defines the start matrix
  34628. * @param endValue defines the end matrix
  34629. * @param gradient defines the gradient between both matrices
  34630. * @param result defines an optional target matrix where to store the interpolation
  34631. * @returns the interpolated matrix
  34632. */
  34633. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34634. /**
  34635. * Makes a copy of the animation
  34636. * @returns Cloned animation
  34637. */
  34638. clone(): Animation;
  34639. /**
  34640. * Sets the key frames of the animation
  34641. * @param values The animation key frames to set
  34642. */
  34643. setKeys(values: Array<IAnimationKey>): void;
  34644. /**
  34645. * Serializes the animation to an object
  34646. * @returns Serialized object
  34647. */
  34648. serialize(): any;
  34649. /**
  34650. * Float animation type
  34651. */
  34652. static readonly ANIMATIONTYPE_FLOAT: number;
  34653. /**
  34654. * Vector3 animation type
  34655. */
  34656. static readonly ANIMATIONTYPE_VECTOR3: number;
  34657. /**
  34658. * Quaternion animation type
  34659. */
  34660. static readonly ANIMATIONTYPE_QUATERNION: number;
  34661. /**
  34662. * Matrix animation type
  34663. */
  34664. static readonly ANIMATIONTYPE_MATRIX: number;
  34665. /**
  34666. * Color3 animation type
  34667. */
  34668. static readonly ANIMATIONTYPE_COLOR3: number;
  34669. /**
  34670. * Color3 animation type
  34671. */
  34672. static readonly ANIMATIONTYPE_COLOR4: number;
  34673. /**
  34674. * Vector2 animation type
  34675. */
  34676. static readonly ANIMATIONTYPE_VECTOR2: number;
  34677. /**
  34678. * Size animation type
  34679. */
  34680. static readonly ANIMATIONTYPE_SIZE: number;
  34681. /**
  34682. * Relative Loop Mode
  34683. */
  34684. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34685. /**
  34686. * Cycle Loop Mode
  34687. */
  34688. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34689. /**
  34690. * Constant Loop Mode
  34691. */
  34692. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34693. /** @hidden */
  34694. static _UniversalLerp(left: any, right: any, amount: number): any;
  34695. /**
  34696. * Parses an animation object and creates an animation
  34697. * @param parsedAnimation Parsed animation object
  34698. * @returns Animation object
  34699. */
  34700. static Parse(parsedAnimation: any): Animation;
  34701. /**
  34702. * Appends the serialized animations from the source animations
  34703. * @param source Source containing the animations
  34704. * @param destination Target to store the animations
  34705. */
  34706. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34707. /**
  34708. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34709. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34710. * @param url defines the url to load from
  34711. * @returns a promise that will resolve to the new animation or an array of animations
  34712. */
  34713. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34714. /**
  34715. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34716. * @param snippetId defines the snippet to load
  34717. * @returns a promise that will resolve to the new animation or a new array of animations
  34718. */
  34719. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34720. }
  34721. }
  34722. declare module "babylonjs/Animations/animatable.interface" {
  34723. import { Nullable } from "babylonjs/types";
  34724. import { Animation } from "babylonjs/Animations/animation";
  34725. /**
  34726. * Interface containing an array of animations
  34727. */
  34728. export interface IAnimatable {
  34729. /**
  34730. * Array of animations
  34731. */
  34732. animations: Nullable<Array<Animation>>;
  34733. }
  34734. }
  34735. declare module "babylonjs/Misc/decorators" {
  34736. import { Nullable } from "babylonjs/types";
  34737. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34738. import { Scene } from "babylonjs/scene";
  34739. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34740. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34741. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34742. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34743. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34744. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34745. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34746. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34747. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34748. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34749. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34750. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34751. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34752. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34753. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34754. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34755. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34756. /**
  34757. * Decorator used to define property that can be serialized as reference to a camera
  34758. * @param sourceName defines the name of the property to decorate
  34759. */
  34760. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34761. /**
  34762. * Class used to help serialization objects
  34763. */
  34764. export class SerializationHelper {
  34765. /** @hidden */
  34766. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34767. /** @hidden */
  34768. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34769. /** @hidden */
  34770. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34771. /** @hidden */
  34772. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34773. /**
  34774. * Appends the serialized animations from the source animations
  34775. * @param source Source containing the animations
  34776. * @param destination Target to store the animations
  34777. */
  34778. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34779. /**
  34780. * Static function used to serialized a specific entity
  34781. * @param entity defines the entity to serialize
  34782. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34783. * @returns a JSON compatible object representing the serialization of the entity
  34784. */
  34785. static Serialize<T>(entity: T, serializationObject?: any): any;
  34786. /**
  34787. * Creates a new entity from a serialization data object
  34788. * @param creationFunction defines a function used to instanciated the new entity
  34789. * @param source defines the source serialization data
  34790. * @param scene defines the hosting scene
  34791. * @param rootUrl defines the root url for resources
  34792. * @returns a new entity
  34793. */
  34794. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34795. /**
  34796. * Clones an object
  34797. * @param creationFunction defines the function used to instanciate the new object
  34798. * @param source defines the source object
  34799. * @returns the cloned object
  34800. */
  34801. static Clone<T>(creationFunction: () => T, source: T): T;
  34802. /**
  34803. * Instanciates a new object based on a source one (some data will be shared between both object)
  34804. * @param creationFunction defines the function used to instanciate the new object
  34805. * @param source defines the source object
  34806. * @returns the new object
  34807. */
  34808. static Instanciate<T>(creationFunction: () => T, source: T): T;
  34809. }
  34810. }
  34811. declare module "babylonjs/Materials/Textures/baseTexture" {
  34812. import { Observable } from "babylonjs/Misc/observable";
  34813. import { Nullable } from "babylonjs/types";
  34814. import { Scene } from "babylonjs/scene";
  34815. import { Matrix } from "babylonjs/Maths/math.vector";
  34816. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  34817. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34818. import { ISize } from "babylonjs/Maths/math.size";
  34819. import "babylonjs/Misc/fileTools";
  34820. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  34821. /**
  34822. * Base class of all the textures in babylon.
  34823. * It groups all the common properties the materials, post process, lights... might need
  34824. * in order to make a correct use of the texture.
  34825. */
  34826. export class BaseTexture implements IAnimatable {
  34827. /**
  34828. * Default anisotropic filtering level for the application.
  34829. * It is set to 4 as a good tradeoff between perf and quality.
  34830. */
  34831. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  34832. /**
  34833. * Gets or sets the unique id of the texture
  34834. */
  34835. uniqueId: number;
  34836. /**
  34837. * Define the name of the texture.
  34838. */
  34839. name: string;
  34840. /**
  34841. * Gets or sets an object used to store user defined information.
  34842. */
  34843. metadata: any;
  34844. /**
  34845. * For internal use only. Please do not use.
  34846. */
  34847. reservedDataStore: any;
  34848. private _hasAlpha;
  34849. /**
  34850. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  34851. */
  34852. set hasAlpha(value: boolean);
  34853. get hasAlpha(): boolean;
  34854. /**
  34855. * Defines if the alpha value should be determined via the rgb values.
  34856. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  34857. */
  34858. getAlphaFromRGB: boolean;
  34859. /**
  34860. * Intensity or strength of the texture.
  34861. * It is commonly used by materials to fine tune the intensity of the texture
  34862. */
  34863. level: number;
  34864. /**
  34865. * Define the UV chanel to use starting from 0 and defaulting to 0.
  34866. * This is part of the texture as textures usually maps to one uv set.
  34867. */
  34868. coordinatesIndex: number;
  34869. private _coordinatesMode;
  34870. /**
  34871. * How a texture is mapped.
  34872. *
  34873. * | Value | Type | Description |
  34874. * | ----- | ----------------------------------- | ----------- |
  34875. * | 0 | EXPLICIT_MODE | |
  34876. * | 1 | SPHERICAL_MODE | |
  34877. * | 2 | PLANAR_MODE | |
  34878. * | 3 | CUBIC_MODE | |
  34879. * | 4 | PROJECTION_MODE | |
  34880. * | 5 | SKYBOX_MODE | |
  34881. * | 6 | INVCUBIC_MODE | |
  34882. * | 7 | EQUIRECTANGULAR_MODE | |
  34883. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  34884. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  34885. */
  34886. set coordinatesMode(value: number);
  34887. get coordinatesMode(): number;
  34888. /**
  34889. * | Value | Type | Description |
  34890. * | ----- | ------------------ | ----------- |
  34891. * | 0 | CLAMP_ADDRESSMODE | |
  34892. * | 1 | WRAP_ADDRESSMODE | |
  34893. * | 2 | MIRROR_ADDRESSMODE | |
  34894. */
  34895. wrapU: number;
  34896. /**
  34897. * | Value | Type | Description |
  34898. * | ----- | ------------------ | ----------- |
  34899. * | 0 | CLAMP_ADDRESSMODE | |
  34900. * | 1 | WRAP_ADDRESSMODE | |
  34901. * | 2 | MIRROR_ADDRESSMODE | |
  34902. */
  34903. wrapV: number;
  34904. /**
  34905. * | Value | Type | Description |
  34906. * | ----- | ------------------ | ----------- |
  34907. * | 0 | CLAMP_ADDRESSMODE | |
  34908. * | 1 | WRAP_ADDRESSMODE | |
  34909. * | 2 | MIRROR_ADDRESSMODE | |
  34910. */
  34911. wrapR: number;
  34912. /**
  34913. * With compliant hardware and browser (supporting anisotropic filtering)
  34914. * this defines the level of anisotropic filtering in the texture.
  34915. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  34916. */
  34917. anisotropicFilteringLevel: number;
  34918. /**
  34919. * Define if the texture is a cube texture or if false a 2d texture.
  34920. */
  34921. get isCube(): boolean;
  34922. set isCube(value: boolean);
  34923. /**
  34924. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  34925. */
  34926. get is3D(): boolean;
  34927. set is3D(value: boolean);
  34928. /**
  34929. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  34930. */
  34931. get is2DArray(): boolean;
  34932. set is2DArray(value: boolean);
  34933. /**
  34934. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  34935. * HDR texture are usually stored in linear space.
  34936. * This only impacts the PBR and Background materials
  34937. */
  34938. gammaSpace: boolean;
  34939. /**
  34940. * Gets or sets whether or not the texture contains RGBD data.
  34941. */
  34942. get isRGBD(): boolean;
  34943. set isRGBD(value: boolean);
  34944. /**
  34945. * Is Z inverted in the texture (useful in a cube texture).
  34946. */
  34947. invertZ: boolean;
  34948. /**
  34949. * Are mip maps generated for this texture or not.
  34950. */
  34951. get noMipmap(): boolean;
  34952. /**
  34953. * @hidden
  34954. */
  34955. lodLevelInAlpha: boolean;
  34956. /**
  34957. * With prefiltered texture, defined the offset used during the prefiltering steps.
  34958. */
  34959. get lodGenerationOffset(): number;
  34960. set lodGenerationOffset(value: number);
  34961. /**
  34962. * With prefiltered texture, defined the scale used during the prefiltering steps.
  34963. */
  34964. get lodGenerationScale(): number;
  34965. set lodGenerationScale(value: number);
  34966. /**
  34967. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  34968. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  34969. * average roughness values.
  34970. */
  34971. get linearSpecularLOD(): boolean;
  34972. set linearSpecularLOD(value: boolean);
  34973. /**
  34974. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  34975. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  34976. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  34977. */
  34978. get irradianceTexture(): Nullable<BaseTexture>;
  34979. set irradianceTexture(value: Nullable<BaseTexture>);
  34980. /**
  34981. * Define if the texture is a render target.
  34982. */
  34983. isRenderTarget: boolean;
  34984. /**
  34985. * Define the unique id of the texture in the scene.
  34986. */
  34987. get uid(): string;
  34988. /** @hidden */
  34989. _prefiltered: boolean;
  34990. /**
  34991. * Return a string representation of the texture.
  34992. * @returns the texture as a string
  34993. */
  34994. toString(): string;
  34995. /**
  34996. * Get the class name of the texture.
  34997. * @returns "BaseTexture"
  34998. */
  34999. getClassName(): string;
  35000. /**
  35001. * Define the list of animation attached to the texture.
  35002. */
  35003. animations: import("babylonjs/Animations/animation").Animation[];
  35004. /**
  35005. * An event triggered when the texture is disposed.
  35006. */
  35007. onDisposeObservable: Observable<BaseTexture>;
  35008. private _onDisposeObserver;
  35009. /**
  35010. * Callback triggered when the texture has been disposed.
  35011. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35012. */
  35013. set onDispose(callback: () => void);
  35014. /**
  35015. * Define the current state of the loading sequence when in delayed load mode.
  35016. */
  35017. delayLoadState: number;
  35018. private _scene;
  35019. private _engine;
  35020. /** @hidden */
  35021. _texture: Nullable<InternalTexture>;
  35022. private _uid;
  35023. /**
  35024. * Define if the texture is preventinga material to render or not.
  35025. * If not and the texture is not ready, the engine will use a default black texture instead.
  35026. */
  35027. get isBlocking(): boolean;
  35028. /**
  35029. * Instantiates a new BaseTexture.
  35030. * Base class of all the textures in babylon.
  35031. * It groups all the common properties the materials, post process, lights... might need
  35032. * in order to make a correct use of the texture.
  35033. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35034. */
  35035. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35036. /**
  35037. * Get the scene the texture belongs to.
  35038. * @returns the scene or null if undefined
  35039. */
  35040. getScene(): Nullable<Scene>;
  35041. /** @hidden */
  35042. protected _getEngine(): Nullable<ThinEngine>;
  35043. /**
  35044. * Get the texture transform matrix used to offset tile the texture for istance.
  35045. * @returns the transformation matrix
  35046. */
  35047. getTextureMatrix(): Matrix;
  35048. /**
  35049. * Get the texture reflection matrix used to rotate/transform the reflection.
  35050. * @returns the reflection matrix
  35051. */
  35052. getReflectionTextureMatrix(): Matrix;
  35053. /**
  35054. * Get the underlying lower level texture from Babylon.
  35055. * @returns the insternal texture
  35056. */
  35057. getInternalTexture(): Nullable<InternalTexture>;
  35058. /**
  35059. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35060. * @returns true if ready or not blocking
  35061. */
  35062. isReadyOrNotBlocking(): boolean;
  35063. /**
  35064. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35065. * @returns true if fully ready
  35066. */
  35067. isReady(): boolean;
  35068. private _cachedSize;
  35069. /**
  35070. * Get the size of the texture.
  35071. * @returns the texture size.
  35072. */
  35073. getSize(): ISize;
  35074. /**
  35075. * Get the base size of the texture.
  35076. * It can be different from the size if the texture has been resized for POT for instance
  35077. * @returns the base size
  35078. */
  35079. getBaseSize(): ISize;
  35080. /**
  35081. * Update the sampling mode of the texture.
  35082. * Default is Trilinear mode.
  35083. *
  35084. * | Value | Type | Description |
  35085. * | ----- | ------------------ | ----------- |
  35086. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35087. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35088. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35089. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35090. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35091. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35092. * | 7 | NEAREST_LINEAR | |
  35093. * | 8 | NEAREST_NEAREST | |
  35094. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35095. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35096. * | 11 | LINEAR_LINEAR | |
  35097. * | 12 | LINEAR_NEAREST | |
  35098. *
  35099. * > _mag_: magnification filter (close to the viewer)
  35100. * > _min_: minification filter (far from the viewer)
  35101. * > _mip_: filter used between mip map levels
  35102. *@param samplingMode Define the new sampling mode of the texture
  35103. */
  35104. updateSamplingMode(samplingMode: number): void;
  35105. /**
  35106. * Scales the texture if is `canRescale()`
  35107. * @param ratio the resize factor we want to use to rescale
  35108. */
  35109. scale(ratio: number): void;
  35110. /**
  35111. * Get if the texture can rescale.
  35112. */
  35113. get canRescale(): boolean;
  35114. /** @hidden */
  35115. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35116. /** @hidden */
  35117. _rebuild(): void;
  35118. /**
  35119. * Triggers the load sequence in delayed load mode.
  35120. */
  35121. delayLoad(): void;
  35122. /**
  35123. * Clones the texture.
  35124. * @returns the cloned texture
  35125. */
  35126. clone(): Nullable<BaseTexture>;
  35127. /**
  35128. * Get the texture underlying type (INT, FLOAT...)
  35129. */
  35130. get textureType(): number;
  35131. /**
  35132. * Get the texture underlying format (RGB, RGBA...)
  35133. */
  35134. get textureFormat(): number;
  35135. /**
  35136. * Indicates that textures need to be re-calculated for all materials
  35137. */
  35138. protected _markAllSubMeshesAsTexturesDirty(): void;
  35139. /**
  35140. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35141. * This will returns an RGBA array buffer containing either in values (0-255) or
  35142. * float values (0-1) depending of the underlying buffer type.
  35143. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35144. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35145. * @param buffer defines a user defined buffer to fill with data (can be null)
  35146. * @returns The Array buffer containing the pixels data.
  35147. */
  35148. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35149. /**
  35150. * Release and destroy the underlying lower level texture aka internalTexture.
  35151. */
  35152. releaseInternalTexture(): void;
  35153. /** @hidden */
  35154. get _lodTextureHigh(): Nullable<BaseTexture>;
  35155. /** @hidden */
  35156. get _lodTextureMid(): Nullable<BaseTexture>;
  35157. /** @hidden */
  35158. get _lodTextureLow(): Nullable<BaseTexture>;
  35159. /**
  35160. * Dispose the texture and release its associated resources.
  35161. */
  35162. dispose(): void;
  35163. /**
  35164. * Serialize the texture into a JSON representation that can be parsed later on.
  35165. * @returns the JSON representation of the texture
  35166. */
  35167. serialize(): any;
  35168. /**
  35169. * Helper function to be called back once a list of texture contains only ready textures.
  35170. * @param textures Define the list of textures to wait for
  35171. * @param callback Define the callback triggered once the entire list will be ready
  35172. */
  35173. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35174. private static _isScene;
  35175. }
  35176. }
  35177. declare module "babylonjs/Materials/effect" {
  35178. import { Observable } from "babylonjs/Misc/observable";
  35179. import { Nullable } from "babylonjs/types";
  35180. import { IDisposable } from "babylonjs/scene";
  35181. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35182. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35183. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35184. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35185. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35186. import { Engine } from "babylonjs/Engines/engine";
  35187. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35188. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35189. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35190. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35191. /**
  35192. * Options to be used when creating an effect.
  35193. */
  35194. export interface IEffectCreationOptions {
  35195. /**
  35196. * Atrributes that will be used in the shader.
  35197. */
  35198. attributes: string[];
  35199. /**
  35200. * Uniform varible names that will be set in the shader.
  35201. */
  35202. uniformsNames: string[];
  35203. /**
  35204. * Uniform buffer variable names that will be set in the shader.
  35205. */
  35206. uniformBuffersNames: string[];
  35207. /**
  35208. * Sampler texture variable names that will be set in the shader.
  35209. */
  35210. samplers: string[];
  35211. /**
  35212. * Define statements that will be set in the shader.
  35213. */
  35214. defines: any;
  35215. /**
  35216. * Possible fallbacks for this effect to improve performance when needed.
  35217. */
  35218. fallbacks: Nullable<IEffectFallbacks>;
  35219. /**
  35220. * Callback that will be called when the shader is compiled.
  35221. */
  35222. onCompiled: Nullable<(effect: Effect) => void>;
  35223. /**
  35224. * Callback that will be called if an error occurs during shader compilation.
  35225. */
  35226. onError: Nullable<(effect: Effect, errors: string) => void>;
  35227. /**
  35228. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35229. */
  35230. indexParameters?: any;
  35231. /**
  35232. * Max number of lights that can be used in the shader.
  35233. */
  35234. maxSimultaneousLights?: number;
  35235. /**
  35236. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35237. */
  35238. transformFeedbackVaryings?: Nullable<string[]>;
  35239. /**
  35240. * 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
  35241. */
  35242. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35243. /**
  35244. * Is this effect rendering to several color attachments ?
  35245. */
  35246. multiTarget?: boolean;
  35247. }
  35248. /**
  35249. * Effect containing vertex and fragment shader that can be executed on an object.
  35250. */
  35251. export class Effect implements IDisposable {
  35252. /**
  35253. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35254. */
  35255. static ShadersRepository: string;
  35256. /**
  35257. * Enable logging of the shader code when a compilation error occurs
  35258. */
  35259. static LogShaderCodeOnCompilationError: boolean;
  35260. /**
  35261. * Name of the effect.
  35262. */
  35263. name: any;
  35264. /**
  35265. * String container all the define statements that should be set on the shader.
  35266. */
  35267. defines: string;
  35268. /**
  35269. * Callback that will be called when the shader is compiled.
  35270. */
  35271. onCompiled: Nullable<(effect: Effect) => void>;
  35272. /**
  35273. * Callback that will be called if an error occurs during shader compilation.
  35274. */
  35275. onError: Nullable<(effect: Effect, errors: string) => void>;
  35276. /**
  35277. * Callback that will be called when effect is bound.
  35278. */
  35279. onBind: Nullable<(effect: Effect) => void>;
  35280. /**
  35281. * Unique ID of the effect.
  35282. */
  35283. uniqueId: number;
  35284. /**
  35285. * Observable that will be called when the shader is compiled.
  35286. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35287. */
  35288. onCompileObservable: Observable<Effect>;
  35289. /**
  35290. * Observable that will be called if an error occurs during shader compilation.
  35291. */
  35292. onErrorObservable: Observable<Effect>;
  35293. /** @hidden */
  35294. _onBindObservable: Nullable<Observable<Effect>>;
  35295. /**
  35296. * @hidden
  35297. * Specifies if the effect was previously ready
  35298. */
  35299. _wasPreviouslyReady: boolean;
  35300. /**
  35301. * Observable that will be called when effect is bound.
  35302. */
  35303. get onBindObservable(): Observable<Effect>;
  35304. /** @hidden */
  35305. _bonesComputationForcedToCPU: boolean;
  35306. /** @hidden */
  35307. _multiTarget: boolean;
  35308. private static _uniqueIdSeed;
  35309. private _engine;
  35310. private _uniformBuffersNames;
  35311. private _uniformBuffersNamesList;
  35312. private _uniformsNames;
  35313. private _samplerList;
  35314. private _samplers;
  35315. private _isReady;
  35316. private _compilationError;
  35317. private _allFallbacksProcessed;
  35318. private _attributesNames;
  35319. private _attributes;
  35320. private _attributeLocationByName;
  35321. private _uniforms;
  35322. /**
  35323. * Key for the effect.
  35324. * @hidden
  35325. */
  35326. _key: string;
  35327. private _indexParameters;
  35328. private _fallbacks;
  35329. private _vertexSourceCode;
  35330. private _fragmentSourceCode;
  35331. private _vertexSourceCodeOverride;
  35332. private _fragmentSourceCodeOverride;
  35333. private _transformFeedbackVaryings;
  35334. /**
  35335. * Compiled shader to webGL program.
  35336. * @hidden
  35337. */
  35338. _pipelineContext: Nullable<IPipelineContext>;
  35339. private _valueCache;
  35340. private static _baseCache;
  35341. /**
  35342. * Instantiates an effect.
  35343. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35344. * @param baseName Name of the effect.
  35345. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35346. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35347. * @param samplers List of sampler variables that will be passed to the shader.
  35348. * @param engine Engine to be used to render the effect
  35349. * @param defines Define statements to be added to the shader.
  35350. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35351. * @param onCompiled Callback that will be called when the shader is compiled.
  35352. * @param onError Callback that will be called if an error occurs during shader compilation.
  35353. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35354. */
  35355. 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);
  35356. private _useFinalCode;
  35357. /**
  35358. * Unique key for this effect
  35359. */
  35360. get key(): string;
  35361. /**
  35362. * If the effect has been compiled and prepared.
  35363. * @returns if the effect is compiled and prepared.
  35364. */
  35365. isReady(): boolean;
  35366. private _isReadyInternal;
  35367. /**
  35368. * The engine the effect was initialized with.
  35369. * @returns the engine.
  35370. */
  35371. getEngine(): Engine;
  35372. /**
  35373. * The pipeline context for this effect
  35374. * @returns the associated pipeline context
  35375. */
  35376. getPipelineContext(): Nullable<IPipelineContext>;
  35377. /**
  35378. * The set of names of attribute variables for the shader.
  35379. * @returns An array of attribute names.
  35380. */
  35381. getAttributesNames(): string[];
  35382. /**
  35383. * Returns the attribute at the given index.
  35384. * @param index The index of the attribute.
  35385. * @returns The location of the attribute.
  35386. */
  35387. getAttributeLocation(index: number): number;
  35388. /**
  35389. * Returns the attribute based on the name of the variable.
  35390. * @param name of the attribute to look up.
  35391. * @returns the attribute location.
  35392. */
  35393. getAttributeLocationByName(name: string): number;
  35394. /**
  35395. * The number of attributes.
  35396. * @returns the numnber of attributes.
  35397. */
  35398. getAttributesCount(): number;
  35399. /**
  35400. * Gets the index of a uniform variable.
  35401. * @param uniformName of the uniform to look up.
  35402. * @returns the index.
  35403. */
  35404. getUniformIndex(uniformName: string): number;
  35405. /**
  35406. * Returns the attribute based on the name of the variable.
  35407. * @param uniformName of the uniform to look up.
  35408. * @returns the location of the uniform.
  35409. */
  35410. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35411. /**
  35412. * Returns an array of sampler variable names
  35413. * @returns The array of sampler variable names.
  35414. */
  35415. getSamplers(): string[];
  35416. /**
  35417. * Returns an array of uniform variable names
  35418. * @returns The array of uniform variable names.
  35419. */
  35420. getUniformNames(): string[];
  35421. /**
  35422. * Returns an array of uniform buffer variable names
  35423. * @returns The array of uniform buffer variable names.
  35424. */
  35425. getUniformBuffersNames(): string[];
  35426. /**
  35427. * Returns the index parameters used to create the effect
  35428. * @returns The index parameters object
  35429. */
  35430. getIndexParameters(): any;
  35431. /**
  35432. * The error from the last compilation.
  35433. * @returns the error string.
  35434. */
  35435. getCompilationError(): string;
  35436. /**
  35437. * Gets a boolean indicating that all fallbacks were used during compilation
  35438. * @returns true if all fallbacks were used
  35439. */
  35440. allFallbacksProcessed(): boolean;
  35441. /**
  35442. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35443. * @param func The callback to be used.
  35444. */
  35445. executeWhenCompiled(func: (effect: Effect) => void): void;
  35446. private _checkIsReady;
  35447. private _loadShader;
  35448. /**
  35449. * Gets the vertex shader source code of this effect
  35450. */
  35451. get vertexSourceCode(): string;
  35452. /**
  35453. * Gets the fragment shader source code of this effect
  35454. */
  35455. get fragmentSourceCode(): string;
  35456. /**
  35457. * Recompiles the webGL program
  35458. * @param vertexSourceCode The source code for the vertex shader.
  35459. * @param fragmentSourceCode The source code for the fragment shader.
  35460. * @param onCompiled Callback called when completed.
  35461. * @param onError Callback called on error.
  35462. * @hidden
  35463. */
  35464. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35465. /**
  35466. * Prepares the effect
  35467. * @hidden
  35468. */
  35469. _prepareEffect(): void;
  35470. private _getShaderCodeAndErrorLine;
  35471. private _processCompilationErrors;
  35472. /**
  35473. * Checks if the effect is supported. (Must be called after compilation)
  35474. */
  35475. get isSupported(): boolean;
  35476. /**
  35477. * Binds a texture to the engine to be used as output of the shader.
  35478. * @param channel Name of the output variable.
  35479. * @param texture Texture to bind.
  35480. * @hidden
  35481. */
  35482. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35483. /**
  35484. * Sets a texture on the engine to be used in the shader.
  35485. * @param channel Name of the sampler variable.
  35486. * @param texture Texture to set.
  35487. */
  35488. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35489. /**
  35490. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35491. * @param channel Name of the sampler variable.
  35492. * @param texture Texture to set.
  35493. */
  35494. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35495. /**
  35496. * Sets an array of textures on the engine to be used in the shader.
  35497. * @param channel Name of the variable.
  35498. * @param textures Textures to set.
  35499. */
  35500. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35501. /**
  35502. * 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)
  35503. * @param channel Name of the sampler variable.
  35504. * @param postProcess Post process to get the input texture from.
  35505. */
  35506. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35507. /**
  35508. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35509. * 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)
  35510. * @param channel Name of the sampler variable.
  35511. * @param postProcess Post process to get the output texture from.
  35512. */
  35513. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35514. /** @hidden */
  35515. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35516. /** @hidden */
  35517. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35518. /** @hidden */
  35519. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35520. /** @hidden */
  35521. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35522. /**
  35523. * Binds a buffer to a uniform.
  35524. * @param buffer Buffer to bind.
  35525. * @param name Name of the uniform variable to bind to.
  35526. */
  35527. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35528. /**
  35529. * Binds block to a uniform.
  35530. * @param blockName Name of the block to bind.
  35531. * @param index Index to bind.
  35532. */
  35533. bindUniformBlock(blockName: string, index: number): void;
  35534. /**
  35535. * Sets an interger value on a uniform variable.
  35536. * @param uniformName Name of the variable.
  35537. * @param value Value to be set.
  35538. * @returns this effect.
  35539. */
  35540. setInt(uniformName: string, value: number): Effect;
  35541. /**
  35542. * Sets an int array on a uniform variable.
  35543. * @param uniformName Name of the variable.
  35544. * @param array array to be set.
  35545. * @returns this effect.
  35546. */
  35547. setIntArray(uniformName: string, array: Int32Array): Effect;
  35548. /**
  35549. * 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)
  35550. * @param uniformName Name of the variable.
  35551. * @param array array to be set.
  35552. * @returns this effect.
  35553. */
  35554. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35555. /**
  35556. * 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)
  35557. * @param uniformName Name of the variable.
  35558. * @param array array to be set.
  35559. * @returns this effect.
  35560. */
  35561. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35562. /**
  35563. * 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)
  35564. * @param uniformName Name of the variable.
  35565. * @param array array to be set.
  35566. * @returns this effect.
  35567. */
  35568. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35569. /**
  35570. * Sets an float array on a uniform variable.
  35571. * @param uniformName Name of the variable.
  35572. * @param array array to be set.
  35573. * @returns this effect.
  35574. */
  35575. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35576. /**
  35577. * 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)
  35578. * @param uniformName Name of the variable.
  35579. * @param array array to be set.
  35580. * @returns this effect.
  35581. */
  35582. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35583. /**
  35584. * 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)
  35585. * @param uniformName Name of the variable.
  35586. * @param array array to be set.
  35587. * @returns this effect.
  35588. */
  35589. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35590. /**
  35591. * 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)
  35592. * @param uniformName Name of the variable.
  35593. * @param array array to be set.
  35594. * @returns this effect.
  35595. */
  35596. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35597. /**
  35598. * Sets an array on a uniform variable.
  35599. * @param uniformName Name of the variable.
  35600. * @param array array to be set.
  35601. * @returns this effect.
  35602. */
  35603. setArray(uniformName: string, array: number[]): Effect;
  35604. /**
  35605. * 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)
  35606. * @param uniformName Name of the variable.
  35607. * @param array array to be set.
  35608. * @returns this effect.
  35609. */
  35610. setArray2(uniformName: string, array: number[]): Effect;
  35611. /**
  35612. * 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)
  35613. * @param uniformName Name of the variable.
  35614. * @param array array to be set.
  35615. * @returns this effect.
  35616. */
  35617. setArray3(uniformName: string, array: number[]): Effect;
  35618. /**
  35619. * 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)
  35620. * @param uniformName Name of the variable.
  35621. * @param array array to be set.
  35622. * @returns this effect.
  35623. */
  35624. setArray4(uniformName: string, array: number[]): Effect;
  35625. /**
  35626. * Sets matrices on a uniform variable.
  35627. * @param uniformName Name of the variable.
  35628. * @param matrices matrices to be set.
  35629. * @returns this effect.
  35630. */
  35631. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35632. /**
  35633. * Sets matrix on a uniform variable.
  35634. * @param uniformName Name of the variable.
  35635. * @param matrix matrix to be set.
  35636. * @returns this effect.
  35637. */
  35638. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35639. /**
  35640. * 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)
  35641. * @param uniformName Name of the variable.
  35642. * @param matrix matrix to be set.
  35643. * @returns this effect.
  35644. */
  35645. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35646. /**
  35647. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35648. * @param uniformName Name of the variable.
  35649. * @param matrix matrix to be set.
  35650. * @returns this effect.
  35651. */
  35652. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35653. /**
  35654. * Sets a float on a uniform variable.
  35655. * @param uniformName Name of the variable.
  35656. * @param value value to be set.
  35657. * @returns this effect.
  35658. */
  35659. setFloat(uniformName: string, value: number): Effect;
  35660. /**
  35661. * Sets a boolean on a uniform variable.
  35662. * @param uniformName Name of the variable.
  35663. * @param bool value to be set.
  35664. * @returns this effect.
  35665. */
  35666. setBool(uniformName: string, bool: boolean): Effect;
  35667. /**
  35668. * Sets a Vector2 on a uniform variable.
  35669. * @param uniformName Name of the variable.
  35670. * @param vector2 vector2 to be set.
  35671. * @returns this effect.
  35672. */
  35673. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35674. /**
  35675. * Sets a float2 on a uniform variable.
  35676. * @param uniformName Name of the variable.
  35677. * @param x First float in float2.
  35678. * @param y Second float in float2.
  35679. * @returns this effect.
  35680. */
  35681. setFloat2(uniformName: string, x: number, y: number): Effect;
  35682. /**
  35683. * Sets a Vector3 on a uniform variable.
  35684. * @param uniformName Name of the variable.
  35685. * @param vector3 Value to be set.
  35686. * @returns this effect.
  35687. */
  35688. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35689. /**
  35690. * Sets a float3 on a uniform variable.
  35691. * @param uniformName Name of the variable.
  35692. * @param x First float in float3.
  35693. * @param y Second float in float3.
  35694. * @param z Third float in float3.
  35695. * @returns this effect.
  35696. */
  35697. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35698. /**
  35699. * Sets a Vector4 on a uniform variable.
  35700. * @param uniformName Name of the variable.
  35701. * @param vector4 Value to be set.
  35702. * @returns this effect.
  35703. */
  35704. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35705. /**
  35706. * Sets a float4 on a uniform variable.
  35707. * @param uniformName Name of the variable.
  35708. * @param x First float in float4.
  35709. * @param y Second float in float4.
  35710. * @param z Third float in float4.
  35711. * @param w Fourth float in float4.
  35712. * @returns this effect.
  35713. */
  35714. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35715. /**
  35716. * Sets a Color3 on a uniform variable.
  35717. * @param uniformName Name of the variable.
  35718. * @param color3 Value to be set.
  35719. * @returns this effect.
  35720. */
  35721. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35722. /**
  35723. * Sets a Color4 on a uniform variable.
  35724. * @param uniformName Name of the variable.
  35725. * @param color3 Value to be set.
  35726. * @param alpha Alpha value to be set.
  35727. * @returns this effect.
  35728. */
  35729. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35730. /**
  35731. * Sets a Color4 on a uniform variable
  35732. * @param uniformName defines the name of the variable
  35733. * @param color4 defines the value to be set
  35734. * @returns this effect.
  35735. */
  35736. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35737. /** Release all associated resources */
  35738. dispose(): void;
  35739. /**
  35740. * This function will add a new shader to the shader store
  35741. * @param name the name of the shader
  35742. * @param pixelShader optional pixel shader content
  35743. * @param vertexShader optional vertex shader content
  35744. */
  35745. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35746. /**
  35747. * Store of each shader (The can be looked up using effect.key)
  35748. */
  35749. static ShadersStore: {
  35750. [key: string]: string;
  35751. };
  35752. /**
  35753. * Store of each included file for a shader (The can be looked up using effect.key)
  35754. */
  35755. static IncludesShadersStore: {
  35756. [key: string]: string;
  35757. };
  35758. /**
  35759. * Resets the cache of effects.
  35760. */
  35761. static ResetCache(): void;
  35762. }
  35763. }
  35764. declare module "babylonjs/Engines/engineCapabilities" {
  35765. /**
  35766. * Interface used to describe the capabilities of the engine relatively to the current browser
  35767. */
  35768. export interface EngineCapabilities {
  35769. /** Maximum textures units per fragment shader */
  35770. maxTexturesImageUnits: number;
  35771. /** Maximum texture units per vertex shader */
  35772. maxVertexTextureImageUnits: number;
  35773. /** Maximum textures units in the entire pipeline */
  35774. maxCombinedTexturesImageUnits: number;
  35775. /** Maximum texture size */
  35776. maxTextureSize: number;
  35777. /** Maximum texture samples */
  35778. maxSamples?: number;
  35779. /** Maximum cube texture size */
  35780. maxCubemapTextureSize: number;
  35781. /** Maximum render texture size */
  35782. maxRenderTextureSize: number;
  35783. /** Maximum number of vertex attributes */
  35784. maxVertexAttribs: number;
  35785. /** Maximum number of varyings */
  35786. maxVaryingVectors: number;
  35787. /** Maximum number of uniforms per vertex shader */
  35788. maxVertexUniformVectors: number;
  35789. /** Maximum number of uniforms per fragment shader */
  35790. maxFragmentUniformVectors: number;
  35791. /** Defines if standard derivates (dx/dy) are supported */
  35792. standardDerivatives: boolean;
  35793. /** Defines if s3tc texture compression is supported */
  35794. s3tc?: WEBGL_compressed_texture_s3tc;
  35795. /** Defines if pvrtc texture compression is supported */
  35796. pvrtc: any;
  35797. /** Defines if etc1 texture compression is supported */
  35798. etc1: any;
  35799. /** Defines if etc2 texture compression is supported */
  35800. etc2: any;
  35801. /** Defines if astc texture compression is supported */
  35802. astc: any;
  35803. /** Defines if float textures are supported */
  35804. textureFloat: boolean;
  35805. /** Defines if vertex array objects are supported */
  35806. vertexArrayObject: boolean;
  35807. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  35808. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  35809. /** Gets the maximum level of anisotropy supported */
  35810. maxAnisotropy: number;
  35811. /** Defines if instancing is supported */
  35812. instancedArrays: boolean;
  35813. /** Defines if 32 bits indices are supported */
  35814. uintIndices: boolean;
  35815. /** Defines if high precision shaders are supported */
  35816. highPrecisionShaderSupported: boolean;
  35817. /** Defines if depth reading in the fragment shader is supported */
  35818. fragmentDepthSupported: boolean;
  35819. /** Defines if float texture linear filtering is supported*/
  35820. textureFloatLinearFiltering: boolean;
  35821. /** Defines if rendering to float textures is supported */
  35822. textureFloatRender: boolean;
  35823. /** Defines if half float textures are supported*/
  35824. textureHalfFloat: boolean;
  35825. /** Defines if half float texture linear filtering is supported*/
  35826. textureHalfFloatLinearFiltering: boolean;
  35827. /** Defines if rendering to half float textures is supported */
  35828. textureHalfFloatRender: boolean;
  35829. /** Defines if textureLOD shader command is supported */
  35830. textureLOD: boolean;
  35831. /** Defines if draw buffers extension is supported */
  35832. drawBuffersExtension: boolean;
  35833. /** Defines if depth textures are supported */
  35834. depthTextureExtension: boolean;
  35835. /** Defines if float color buffer are supported */
  35836. colorBufferFloat: boolean;
  35837. /** Gets disjoint timer query extension (null if not supported) */
  35838. timerQuery?: EXT_disjoint_timer_query;
  35839. /** Defines if timestamp can be used with timer query */
  35840. canUseTimestampForTimerQuery: boolean;
  35841. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  35842. multiview?: any;
  35843. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  35844. oculusMultiview?: any;
  35845. /** Function used to let the system compiles shaders in background */
  35846. parallelShaderCompile?: {
  35847. COMPLETION_STATUS_KHR: number;
  35848. };
  35849. /** Max number of texture samples for MSAA */
  35850. maxMSAASamples: number;
  35851. /** Defines if the blend min max extension is supported */
  35852. blendMinMax: boolean;
  35853. }
  35854. }
  35855. declare module "babylonjs/States/depthCullingState" {
  35856. import { Nullable } from "babylonjs/types";
  35857. /**
  35858. * @hidden
  35859. **/
  35860. export class DepthCullingState {
  35861. private _isDepthTestDirty;
  35862. private _isDepthMaskDirty;
  35863. private _isDepthFuncDirty;
  35864. private _isCullFaceDirty;
  35865. private _isCullDirty;
  35866. private _isZOffsetDirty;
  35867. private _isFrontFaceDirty;
  35868. private _depthTest;
  35869. private _depthMask;
  35870. private _depthFunc;
  35871. private _cull;
  35872. private _cullFace;
  35873. private _zOffset;
  35874. private _frontFace;
  35875. /**
  35876. * Initializes the state.
  35877. */
  35878. constructor();
  35879. get isDirty(): boolean;
  35880. get zOffset(): number;
  35881. set zOffset(value: number);
  35882. get cullFace(): Nullable<number>;
  35883. set cullFace(value: Nullable<number>);
  35884. get cull(): Nullable<boolean>;
  35885. set cull(value: Nullable<boolean>);
  35886. get depthFunc(): Nullable<number>;
  35887. set depthFunc(value: Nullable<number>);
  35888. get depthMask(): boolean;
  35889. set depthMask(value: boolean);
  35890. get depthTest(): boolean;
  35891. set depthTest(value: boolean);
  35892. get frontFace(): Nullable<number>;
  35893. set frontFace(value: Nullable<number>);
  35894. reset(): void;
  35895. apply(gl: WebGLRenderingContext): void;
  35896. }
  35897. }
  35898. declare module "babylonjs/States/stencilState" {
  35899. /**
  35900. * @hidden
  35901. **/
  35902. export class StencilState {
  35903. /** 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 */
  35904. static readonly ALWAYS: number;
  35905. /** Passed to stencilOperation to specify that stencil value must be kept */
  35906. static readonly KEEP: number;
  35907. /** Passed to stencilOperation to specify that stencil value must be replaced */
  35908. static readonly REPLACE: number;
  35909. private _isStencilTestDirty;
  35910. private _isStencilMaskDirty;
  35911. private _isStencilFuncDirty;
  35912. private _isStencilOpDirty;
  35913. private _stencilTest;
  35914. private _stencilMask;
  35915. private _stencilFunc;
  35916. private _stencilFuncRef;
  35917. private _stencilFuncMask;
  35918. private _stencilOpStencilFail;
  35919. private _stencilOpDepthFail;
  35920. private _stencilOpStencilDepthPass;
  35921. get isDirty(): boolean;
  35922. get stencilFunc(): number;
  35923. set stencilFunc(value: number);
  35924. get stencilFuncRef(): number;
  35925. set stencilFuncRef(value: number);
  35926. get stencilFuncMask(): number;
  35927. set stencilFuncMask(value: number);
  35928. get stencilOpStencilFail(): number;
  35929. set stencilOpStencilFail(value: number);
  35930. get stencilOpDepthFail(): number;
  35931. set stencilOpDepthFail(value: number);
  35932. get stencilOpStencilDepthPass(): number;
  35933. set stencilOpStencilDepthPass(value: number);
  35934. get stencilMask(): number;
  35935. set stencilMask(value: number);
  35936. get stencilTest(): boolean;
  35937. set stencilTest(value: boolean);
  35938. constructor();
  35939. reset(): void;
  35940. apply(gl: WebGLRenderingContext): void;
  35941. }
  35942. }
  35943. declare module "babylonjs/States/alphaCullingState" {
  35944. /**
  35945. * @hidden
  35946. **/
  35947. export class AlphaState {
  35948. private _isAlphaBlendDirty;
  35949. private _isBlendFunctionParametersDirty;
  35950. private _isBlendEquationParametersDirty;
  35951. private _isBlendConstantsDirty;
  35952. private _alphaBlend;
  35953. private _blendFunctionParameters;
  35954. private _blendEquationParameters;
  35955. private _blendConstants;
  35956. /**
  35957. * Initializes the state.
  35958. */
  35959. constructor();
  35960. get isDirty(): boolean;
  35961. get alphaBlend(): boolean;
  35962. set alphaBlend(value: boolean);
  35963. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  35964. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  35965. setAlphaEquationParameters(rgb: number, alpha: number): void;
  35966. reset(): void;
  35967. apply(gl: WebGLRenderingContext): void;
  35968. }
  35969. }
  35970. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  35971. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  35972. /** @hidden */
  35973. export class WebGL2ShaderProcessor implements IShaderProcessor {
  35974. attributeProcessor(attribute: string): string;
  35975. varyingProcessor(varying: string, isFragment: boolean): string;
  35976. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  35977. }
  35978. }
  35979. declare module "babylonjs/Engines/instancingAttributeInfo" {
  35980. /**
  35981. * Interface for attribute information associated with buffer instanciation
  35982. */
  35983. export interface InstancingAttributeInfo {
  35984. /**
  35985. * Name of the GLSL attribute
  35986. * if attribute index is not specified, this is used to retrieve the index from the effect
  35987. */
  35988. attributeName: string;
  35989. /**
  35990. * Index/offset of the attribute in the vertex shader
  35991. * if not specified, this will be computes from the name.
  35992. */
  35993. index?: number;
  35994. /**
  35995. * size of the attribute, 1, 2, 3 or 4
  35996. */
  35997. attributeSize: number;
  35998. /**
  35999. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36000. */
  36001. offset: number;
  36002. /**
  36003. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36004. * default to 1
  36005. */
  36006. divisor?: number;
  36007. /**
  36008. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36009. * default is FLOAT
  36010. */
  36011. attributeType?: number;
  36012. /**
  36013. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36014. */
  36015. normalized?: boolean;
  36016. }
  36017. }
  36018. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36019. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36020. import { Nullable } from "babylonjs/types";
  36021. module "babylonjs/Engines/thinEngine" {
  36022. interface ThinEngine {
  36023. /**
  36024. * Update a video texture
  36025. * @param texture defines the texture to update
  36026. * @param video defines the video element to use
  36027. * @param invertY defines if data must be stored with Y axis inverted
  36028. */
  36029. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36030. }
  36031. }
  36032. }
  36033. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36034. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36035. import { Nullable } from "babylonjs/types";
  36036. module "babylonjs/Engines/thinEngine" {
  36037. interface ThinEngine {
  36038. /**
  36039. * Creates a dynamic texture
  36040. * @param width defines the width of the texture
  36041. * @param height defines the height of the texture
  36042. * @param generateMipMaps defines if the engine should generate the mip levels
  36043. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36044. * @returns the dynamic texture inside an InternalTexture
  36045. */
  36046. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36047. /**
  36048. * Update the content of a dynamic texture
  36049. * @param texture defines the texture to update
  36050. * @param canvas defines the canvas containing the source
  36051. * @param invertY defines if data must be stored with Y axis inverted
  36052. * @param premulAlpha defines if alpha is stored as premultiplied
  36053. * @param format defines the format of the data
  36054. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36055. */
  36056. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36057. }
  36058. }
  36059. }
  36060. declare module "babylonjs/Materials/Textures/videoTexture" {
  36061. import { Observable } from "babylonjs/Misc/observable";
  36062. import { Nullable } from "babylonjs/types";
  36063. import { Scene } from "babylonjs/scene";
  36064. import { Texture } from "babylonjs/Materials/Textures/texture";
  36065. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36066. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36067. /**
  36068. * Settings for finer control over video usage
  36069. */
  36070. export interface VideoTextureSettings {
  36071. /**
  36072. * Applies `autoplay` to video, if specified
  36073. */
  36074. autoPlay?: boolean;
  36075. /**
  36076. * Applies `loop` to video, if specified
  36077. */
  36078. loop?: boolean;
  36079. /**
  36080. * Automatically updates internal texture from video at every frame in the render loop
  36081. */
  36082. autoUpdateTexture: boolean;
  36083. /**
  36084. * Image src displayed during the video loading or until the user interacts with the video.
  36085. */
  36086. poster?: string;
  36087. }
  36088. /**
  36089. * If you want to display a video in your scene, this is the special texture for that.
  36090. * This special texture works similar to other textures, with the exception of a few parameters.
  36091. * @see https://doc.babylonjs.com/how_to/video_texture
  36092. */
  36093. export class VideoTexture extends Texture {
  36094. /**
  36095. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36096. */
  36097. readonly autoUpdateTexture: boolean;
  36098. /**
  36099. * The video instance used by the texture internally
  36100. */
  36101. readonly video: HTMLVideoElement;
  36102. private _onUserActionRequestedObservable;
  36103. /**
  36104. * Event triggerd when a dom action is required by the user to play the video.
  36105. * This happens due to recent changes in browser policies preventing video to auto start.
  36106. */
  36107. get onUserActionRequestedObservable(): Observable<Texture>;
  36108. private _generateMipMaps;
  36109. private _stillImageCaptured;
  36110. private _displayingPosterTexture;
  36111. private _settings;
  36112. private _createInternalTextureOnEvent;
  36113. private _frameId;
  36114. private _currentSrc;
  36115. /**
  36116. * Creates a video texture.
  36117. * If you want to display a video in your scene, this is the special texture for that.
  36118. * This special texture works similar to other textures, with the exception of a few parameters.
  36119. * @see https://doc.babylonjs.com/how_to/video_texture
  36120. * @param name optional name, will detect from video source, if not defined
  36121. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36122. * @param scene is obviously the current scene.
  36123. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36124. * @param invertY is false by default but can be used to invert video on Y axis
  36125. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36126. * @param settings allows finer control over video usage
  36127. */
  36128. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36129. private _getName;
  36130. private _getVideo;
  36131. private _createInternalTexture;
  36132. private reset;
  36133. /**
  36134. * @hidden Internal method to initiate `update`.
  36135. */
  36136. _rebuild(): void;
  36137. /**
  36138. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36139. */
  36140. update(): void;
  36141. /**
  36142. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36143. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36144. */
  36145. updateTexture(isVisible: boolean): void;
  36146. protected _updateInternalTexture: () => void;
  36147. /**
  36148. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36149. * @param url New url.
  36150. */
  36151. updateURL(url: string): void;
  36152. /**
  36153. * Clones the texture.
  36154. * @returns the cloned texture
  36155. */
  36156. clone(): VideoTexture;
  36157. /**
  36158. * Dispose the texture and release its associated resources.
  36159. */
  36160. dispose(): void;
  36161. /**
  36162. * Creates a video texture straight from a stream.
  36163. * @param scene Define the scene the texture should be created in
  36164. * @param stream Define the stream the texture should be created from
  36165. * @returns The created video texture as a promise
  36166. */
  36167. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36168. /**
  36169. * Creates a video texture straight from your WebCam video feed.
  36170. * @param scene Define the scene the texture should be created in
  36171. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36172. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36173. * @returns The created video texture as a promise
  36174. */
  36175. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36176. minWidth: number;
  36177. maxWidth: number;
  36178. minHeight: number;
  36179. maxHeight: number;
  36180. deviceId: string;
  36181. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36182. /**
  36183. * Creates a video texture straight from your WebCam video feed.
  36184. * @param scene Define the scene the texture should be created in
  36185. * @param onReady Define a callback to triggered once the texture will be ready
  36186. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36187. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36188. */
  36189. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36190. minWidth: number;
  36191. maxWidth: number;
  36192. minHeight: number;
  36193. maxHeight: number;
  36194. deviceId: string;
  36195. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36196. }
  36197. }
  36198. declare module "babylonjs/Engines/thinEngine" {
  36199. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36200. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36201. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36202. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36203. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36204. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36205. import { Observable } from "babylonjs/Misc/observable";
  36206. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36207. import { StencilState } from "babylonjs/States/stencilState";
  36208. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36209. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36210. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36211. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36212. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36213. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36214. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36215. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36216. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36217. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36218. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36219. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36220. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36221. import { WebRequest } from "babylonjs/Misc/webRequest";
  36222. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36223. /**
  36224. * Defines the interface used by objects working like Scene
  36225. * @hidden
  36226. */
  36227. export interface ISceneLike {
  36228. _addPendingData(data: any): void;
  36229. _removePendingData(data: any): void;
  36230. offlineProvider: IOfflineProvider;
  36231. }
  36232. /** Interface defining initialization parameters for Engine class */
  36233. export interface EngineOptions extends WebGLContextAttributes {
  36234. /**
  36235. * Defines if the engine should no exceed a specified device ratio
  36236. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36237. */
  36238. limitDeviceRatio?: number;
  36239. /**
  36240. * Defines if webvr should be enabled automatically
  36241. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36242. */
  36243. autoEnableWebVR?: boolean;
  36244. /**
  36245. * Defines if webgl2 should be turned off even if supported
  36246. * @see https://doc.babylonjs.com/features/webgl2
  36247. */
  36248. disableWebGL2Support?: boolean;
  36249. /**
  36250. * Defines if webaudio should be initialized as well
  36251. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36252. */
  36253. audioEngine?: boolean;
  36254. /**
  36255. * Defines if animations should run using a deterministic lock step
  36256. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36257. */
  36258. deterministicLockstep?: boolean;
  36259. /** Defines the maximum steps to use with deterministic lock step mode */
  36260. lockstepMaxSteps?: number;
  36261. /** Defines the seconds between each deterministic lock step */
  36262. timeStep?: number;
  36263. /**
  36264. * Defines that engine should ignore context lost events
  36265. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36266. */
  36267. doNotHandleContextLost?: boolean;
  36268. /**
  36269. * Defines that engine should ignore modifying touch action attribute and style
  36270. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36271. */
  36272. doNotHandleTouchAction?: boolean;
  36273. /**
  36274. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36275. */
  36276. useHighPrecisionFloats?: boolean;
  36277. /**
  36278. * Make the canvas XR Compatible for XR sessions
  36279. */
  36280. xrCompatible?: boolean;
  36281. /**
  36282. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36283. */
  36284. useHighPrecisionMatrix?: boolean;
  36285. }
  36286. /**
  36287. * The base engine class (root of all engines)
  36288. */
  36289. export class ThinEngine {
  36290. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36291. static ExceptionList: ({
  36292. key: string;
  36293. capture: string;
  36294. captureConstraint: number;
  36295. targets: string[];
  36296. } | {
  36297. key: string;
  36298. capture: null;
  36299. captureConstraint: null;
  36300. targets: string[];
  36301. })[];
  36302. /** @hidden */
  36303. static _TextureLoaders: IInternalTextureLoader[];
  36304. /**
  36305. * Returns the current npm package of the sdk
  36306. */
  36307. static get NpmPackage(): string;
  36308. /**
  36309. * Returns the current version of the framework
  36310. */
  36311. static get Version(): string;
  36312. /**
  36313. * Returns a string describing the current engine
  36314. */
  36315. get description(): string;
  36316. /**
  36317. * Gets or sets the epsilon value used by collision engine
  36318. */
  36319. static CollisionsEpsilon: number;
  36320. /**
  36321. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36322. */
  36323. static get ShadersRepository(): string;
  36324. static set ShadersRepository(value: string);
  36325. /** @hidden */
  36326. _shaderProcessor: IShaderProcessor;
  36327. /**
  36328. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36329. */
  36330. forcePOTTextures: boolean;
  36331. /**
  36332. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36333. */
  36334. isFullscreen: boolean;
  36335. /**
  36336. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36337. */
  36338. cullBackFaces: boolean;
  36339. /**
  36340. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36341. */
  36342. renderEvenInBackground: boolean;
  36343. /**
  36344. * Gets or sets a boolean indicating that cache can be kept between frames
  36345. */
  36346. preventCacheWipeBetweenFrames: boolean;
  36347. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36348. validateShaderPrograms: boolean;
  36349. /**
  36350. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36351. * This can provide greater z depth for distant objects.
  36352. */
  36353. useReverseDepthBuffer: boolean;
  36354. /**
  36355. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36356. */
  36357. disableUniformBuffers: boolean;
  36358. /** @hidden */
  36359. _uniformBuffers: UniformBuffer[];
  36360. /**
  36361. * Gets a boolean indicating that the engine supports uniform buffers
  36362. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36363. */
  36364. get supportsUniformBuffers(): boolean;
  36365. /** @hidden */
  36366. _gl: WebGLRenderingContext;
  36367. /** @hidden */
  36368. _webGLVersion: number;
  36369. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36370. protected _windowIsBackground: boolean;
  36371. protected _creationOptions: EngineOptions;
  36372. protected _highPrecisionShadersAllowed: boolean;
  36373. /** @hidden */
  36374. get _shouldUseHighPrecisionShader(): boolean;
  36375. /**
  36376. * Gets a boolean indicating that only power of 2 textures are supported
  36377. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36378. */
  36379. get needPOTTextures(): boolean;
  36380. /** @hidden */
  36381. _badOS: boolean;
  36382. /** @hidden */
  36383. _badDesktopOS: boolean;
  36384. private _hardwareScalingLevel;
  36385. /** @hidden */
  36386. _caps: EngineCapabilities;
  36387. private _isStencilEnable;
  36388. private _glVersion;
  36389. private _glRenderer;
  36390. private _glVendor;
  36391. /** @hidden */
  36392. _videoTextureSupported: boolean;
  36393. protected _renderingQueueLaunched: boolean;
  36394. protected _activeRenderLoops: (() => void)[];
  36395. /**
  36396. * Observable signaled when a context lost event is raised
  36397. */
  36398. onContextLostObservable: Observable<ThinEngine>;
  36399. /**
  36400. * Observable signaled when a context restored event is raised
  36401. */
  36402. onContextRestoredObservable: Observable<ThinEngine>;
  36403. private _onContextLost;
  36404. private _onContextRestored;
  36405. protected _contextWasLost: boolean;
  36406. /** @hidden */
  36407. _doNotHandleContextLost: boolean;
  36408. /**
  36409. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36410. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36411. */
  36412. get doNotHandleContextLost(): boolean;
  36413. set doNotHandleContextLost(value: boolean);
  36414. /**
  36415. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36416. */
  36417. disableVertexArrayObjects: boolean;
  36418. /** @hidden */
  36419. protected _colorWrite: boolean;
  36420. /** @hidden */
  36421. protected _colorWriteChanged: boolean;
  36422. /** @hidden */
  36423. protected _depthCullingState: DepthCullingState;
  36424. /** @hidden */
  36425. protected _stencilState: StencilState;
  36426. /** @hidden */
  36427. _alphaState: AlphaState;
  36428. /** @hidden */
  36429. _alphaMode: number;
  36430. /** @hidden */
  36431. _alphaEquation: number;
  36432. /** @hidden */
  36433. _internalTexturesCache: InternalTexture[];
  36434. /** @hidden */
  36435. protected _activeChannel: number;
  36436. private _currentTextureChannel;
  36437. /** @hidden */
  36438. protected _boundTexturesCache: {
  36439. [key: string]: Nullable<InternalTexture>;
  36440. };
  36441. /** @hidden */
  36442. protected _currentEffect: Nullable<Effect>;
  36443. /** @hidden */
  36444. protected _currentProgram: Nullable<WebGLProgram>;
  36445. private _compiledEffects;
  36446. private _vertexAttribArraysEnabled;
  36447. /** @hidden */
  36448. protected _cachedViewport: Nullable<IViewportLike>;
  36449. private _cachedVertexArrayObject;
  36450. /** @hidden */
  36451. protected _cachedVertexBuffers: any;
  36452. /** @hidden */
  36453. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36454. /** @hidden */
  36455. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36456. /** @hidden */
  36457. _currentRenderTarget: Nullable<InternalTexture>;
  36458. private _uintIndicesCurrentlySet;
  36459. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36460. /** @hidden */
  36461. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36462. /** @hidden */
  36463. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36464. private _currentBufferPointers;
  36465. private _currentInstanceLocations;
  36466. private _currentInstanceBuffers;
  36467. private _textureUnits;
  36468. /** @hidden */
  36469. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36470. /** @hidden */
  36471. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36472. /** @hidden */
  36473. _boundRenderFunction: any;
  36474. private _vaoRecordInProgress;
  36475. private _mustWipeVertexAttributes;
  36476. private _emptyTexture;
  36477. private _emptyCubeTexture;
  36478. private _emptyTexture3D;
  36479. private _emptyTexture2DArray;
  36480. /** @hidden */
  36481. _frameHandler: number;
  36482. private _nextFreeTextureSlots;
  36483. private _maxSimultaneousTextures;
  36484. private _activeRequests;
  36485. /** @hidden */
  36486. _transformTextureUrl: Nullable<(url: string) => string>;
  36487. protected get _supportsHardwareTextureRescaling(): boolean;
  36488. private _framebufferDimensionsObject;
  36489. /**
  36490. * sets the object from which width and height will be taken from when getting render width and height
  36491. * Will fallback to the gl object
  36492. * @param dimensions the framebuffer width and height that will be used.
  36493. */
  36494. set framebufferDimensionsObject(dimensions: Nullable<{
  36495. framebufferWidth: number;
  36496. framebufferHeight: number;
  36497. }>);
  36498. /**
  36499. * Gets the current viewport
  36500. */
  36501. get currentViewport(): Nullable<IViewportLike>;
  36502. /**
  36503. * Gets the default empty texture
  36504. */
  36505. get emptyTexture(): InternalTexture;
  36506. /**
  36507. * Gets the default empty 3D texture
  36508. */
  36509. get emptyTexture3D(): InternalTexture;
  36510. /**
  36511. * Gets the default empty 2D array texture
  36512. */
  36513. get emptyTexture2DArray(): InternalTexture;
  36514. /**
  36515. * Gets the default empty cube texture
  36516. */
  36517. get emptyCubeTexture(): InternalTexture;
  36518. /**
  36519. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36520. */
  36521. readonly premultipliedAlpha: boolean;
  36522. /**
  36523. * Observable event triggered before each texture is initialized
  36524. */
  36525. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36526. /**
  36527. * Creates a new engine
  36528. * @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
  36529. * @param antialias defines enable antialiasing (default: false)
  36530. * @param options defines further options to be sent to the getContext() function
  36531. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36532. */
  36533. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36534. private _rebuildInternalTextures;
  36535. private _rebuildEffects;
  36536. /**
  36537. * Gets a boolean indicating if all created effects are ready
  36538. * @returns true if all effects are ready
  36539. */
  36540. areAllEffectsReady(): boolean;
  36541. protected _rebuildBuffers(): void;
  36542. protected _initGLContext(): void;
  36543. /**
  36544. * Gets version of the current webGL context
  36545. */
  36546. get webGLVersion(): number;
  36547. /**
  36548. * Gets a string idenfifying the name of the class
  36549. * @returns "Engine" string
  36550. */
  36551. getClassName(): string;
  36552. /**
  36553. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36554. */
  36555. get isStencilEnable(): boolean;
  36556. /** @hidden */
  36557. _prepareWorkingCanvas(): void;
  36558. /**
  36559. * Reset the texture cache to empty state
  36560. */
  36561. resetTextureCache(): void;
  36562. /**
  36563. * Gets an object containing information about the current webGL context
  36564. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36565. */
  36566. getGlInfo(): {
  36567. vendor: string;
  36568. renderer: string;
  36569. version: string;
  36570. };
  36571. /**
  36572. * Defines the hardware scaling level.
  36573. * By default the hardware scaling level is computed from the window device ratio.
  36574. * 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.
  36575. * @param level defines the level to use
  36576. */
  36577. setHardwareScalingLevel(level: number): void;
  36578. /**
  36579. * Gets the current hardware scaling level.
  36580. * By default the hardware scaling level is computed from the window device ratio.
  36581. * 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.
  36582. * @returns a number indicating the current hardware scaling level
  36583. */
  36584. getHardwareScalingLevel(): number;
  36585. /**
  36586. * Gets the list of loaded textures
  36587. * @returns an array containing all loaded textures
  36588. */
  36589. getLoadedTexturesCache(): InternalTexture[];
  36590. /**
  36591. * Gets the object containing all engine capabilities
  36592. * @returns the EngineCapabilities object
  36593. */
  36594. getCaps(): EngineCapabilities;
  36595. /**
  36596. * stop executing a render loop function and remove it from the execution array
  36597. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36598. */
  36599. stopRenderLoop(renderFunction?: () => void): void;
  36600. /** @hidden */
  36601. _renderLoop(): void;
  36602. /**
  36603. * Gets the HTML canvas attached with the current webGL context
  36604. * @returns a HTML canvas
  36605. */
  36606. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36607. /**
  36608. * Gets host window
  36609. * @returns the host window object
  36610. */
  36611. getHostWindow(): Nullable<Window>;
  36612. /**
  36613. * Gets the current render width
  36614. * @param useScreen defines if screen size must be used (or the current render target if any)
  36615. * @returns a number defining the current render width
  36616. */
  36617. getRenderWidth(useScreen?: boolean): number;
  36618. /**
  36619. * Gets the current render height
  36620. * @param useScreen defines if screen size must be used (or the current render target if any)
  36621. * @returns a number defining the current render height
  36622. */
  36623. getRenderHeight(useScreen?: boolean): number;
  36624. /**
  36625. * Can be used to override the current requestAnimationFrame requester.
  36626. * @hidden
  36627. */
  36628. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36629. /**
  36630. * Register and execute a render loop. The engine can have more than one render function
  36631. * @param renderFunction defines the function to continuously execute
  36632. */
  36633. runRenderLoop(renderFunction: () => void): void;
  36634. /**
  36635. * Clear the current render buffer or the current render target (if any is set up)
  36636. * @param color defines the color to use
  36637. * @param backBuffer defines if the back buffer must be cleared
  36638. * @param depth defines if the depth buffer must be cleared
  36639. * @param stencil defines if the stencil buffer must be cleared
  36640. */
  36641. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36642. private _viewportCached;
  36643. /** @hidden */
  36644. _viewport(x: number, y: number, width: number, height: number): void;
  36645. /**
  36646. * Set the WebGL's viewport
  36647. * @param viewport defines the viewport element to be used
  36648. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36649. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36650. */
  36651. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36652. /**
  36653. * Begin a new frame
  36654. */
  36655. beginFrame(): void;
  36656. /**
  36657. * Enf the current frame
  36658. */
  36659. endFrame(): void;
  36660. /**
  36661. * Resize the view according to the canvas' size
  36662. */
  36663. resize(): void;
  36664. /**
  36665. * Force a specific size of the canvas
  36666. * @param width defines the new canvas' width
  36667. * @param height defines the new canvas' height
  36668. * @returns true if the size was changed
  36669. */
  36670. setSize(width: number, height: number): boolean;
  36671. /**
  36672. * Binds the frame buffer to the specified texture.
  36673. * @param texture The texture to render to or null for the default canvas
  36674. * @param faceIndex The face of the texture to render to in case of cube texture
  36675. * @param requiredWidth The width of the target to render to
  36676. * @param requiredHeight The height of the target to render to
  36677. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36678. * @param lodLevel defines the lod level to bind to the frame buffer
  36679. * @param layer defines the 2d array index to bind to frame buffer to
  36680. */
  36681. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36682. /** @hidden */
  36683. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36684. /**
  36685. * Unbind the current render target texture from the webGL context
  36686. * @param texture defines the render target texture to unbind
  36687. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36688. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36689. */
  36690. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36691. /**
  36692. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36693. */
  36694. flushFramebuffer(): void;
  36695. /**
  36696. * Unbind the current render target and bind the default framebuffer
  36697. */
  36698. restoreDefaultFramebuffer(): void;
  36699. /** @hidden */
  36700. protected _resetVertexBufferBinding(): void;
  36701. /**
  36702. * Creates a vertex buffer
  36703. * @param data the data for the vertex buffer
  36704. * @returns the new WebGL static buffer
  36705. */
  36706. createVertexBuffer(data: DataArray): DataBuffer;
  36707. private _createVertexBuffer;
  36708. /**
  36709. * Creates a dynamic vertex buffer
  36710. * @param data the data for the dynamic vertex buffer
  36711. * @returns the new WebGL dynamic buffer
  36712. */
  36713. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36714. protected _resetIndexBufferBinding(): void;
  36715. /**
  36716. * Creates a new index buffer
  36717. * @param indices defines the content of the index buffer
  36718. * @param updatable defines if the index buffer must be updatable
  36719. * @returns a new webGL buffer
  36720. */
  36721. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36722. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36723. /**
  36724. * Bind a webGL buffer to the webGL context
  36725. * @param buffer defines the buffer to bind
  36726. */
  36727. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36728. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36729. private bindBuffer;
  36730. /**
  36731. * update the bound buffer with the given data
  36732. * @param data defines the data to update
  36733. */
  36734. updateArrayBuffer(data: Float32Array): void;
  36735. private _vertexAttribPointer;
  36736. /** @hidden */
  36737. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36738. private _bindVertexBuffersAttributes;
  36739. /**
  36740. * Records a vertex array object
  36741. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36742. * @param vertexBuffers defines the list of vertex buffers to store
  36743. * @param indexBuffer defines the index buffer to store
  36744. * @param effect defines the effect to store
  36745. * @returns the new vertex array object
  36746. */
  36747. recordVertexArrayObject(vertexBuffers: {
  36748. [key: string]: VertexBuffer;
  36749. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36750. /**
  36751. * Bind a specific vertex array object
  36752. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36753. * @param vertexArrayObject defines the vertex array object to bind
  36754. * @param indexBuffer defines the index buffer to bind
  36755. */
  36756. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36757. /**
  36758. * Bind webGl buffers directly to the webGL context
  36759. * @param vertexBuffer defines the vertex buffer to bind
  36760. * @param indexBuffer defines the index buffer to bind
  36761. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36762. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36763. * @param effect defines the effect associated with the vertex buffer
  36764. */
  36765. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36766. private _unbindVertexArrayObject;
  36767. /**
  36768. * Bind a list of vertex buffers to the webGL context
  36769. * @param vertexBuffers defines the list of vertex buffers to bind
  36770. * @param indexBuffer defines the index buffer to bind
  36771. * @param effect defines the effect associated with the vertex buffers
  36772. */
  36773. bindBuffers(vertexBuffers: {
  36774. [key: string]: Nullable<VertexBuffer>;
  36775. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36776. /**
  36777. * Unbind all instance attributes
  36778. */
  36779. unbindInstanceAttributes(): void;
  36780. /**
  36781. * Release and free the memory of a vertex array object
  36782. * @param vao defines the vertex array object to delete
  36783. */
  36784. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  36785. /** @hidden */
  36786. _releaseBuffer(buffer: DataBuffer): boolean;
  36787. protected _deleteBuffer(buffer: DataBuffer): void;
  36788. /**
  36789. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  36790. * @param instancesBuffer defines the webGL buffer to update and bind
  36791. * @param data defines the data to store in the buffer
  36792. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  36793. */
  36794. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  36795. /**
  36796. * Bind the content of a webGL buffer used with instantiation
  36797. * @param instancesBuffer defines the webGL buffer to bind
  36798. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  36799. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  36800. */
  36801. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  36802. /**
  36803. * Disable the instance attribute corresponding to the name in parameter
  36804. * @param name defines the name of the attribute to disable
  36805. */
  36806. disableInstanceAttributeByName(name: string): void;
  36807. /**
  36808. * Disable the instance attribute corresponding to the location in parameter
  36809. * @param attributeLocation defines the attribute location of the attribute to disable
  36810. */
  36811. disableInstanceAttribute(attributeLocation: number): void;
  36812. /**
  36813. * Disable the attribute corresponding to the location in parameter
  36814. * @param attributeLocation defines the attribute location of the attribute to disable
  36815. */
  36816. disableAttributeByIndex(attributeLocation: number): void;
  36817. /**
  36818. * Send a draw order
  36819. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  36820. * @param indexStart defines the starting index
  36821. * @param indexCount defines the number of index to draw
  36822. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36823. */
  36824. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  36825. /**
  36826. * Draw a list of points
  36827. * @param verticesStart defines the index of first vertex to draw
  36828. * @param verticesCount defines the count of vertices to draw
  36829. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36830. */
  36831. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36832. /**
  36833. * Draw a list of unindexed primitives
  36834. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  36835. * @param verticesStart defines the index of first vertex to draw
  36836. * @param verticesCount defines the count of vertices to draw
  36837. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36838. */
  36839. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36840. /**
  36841. * Draw a list of indexed primitives
  36842. * @param fillMode defines the primitive to use
  36843. * @param indexStart defines the starting index
  36844. * @param indexCount defines the number of index to draw
  36845. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36846. */
  36847. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  36848. /**
  36849. * Draw a list of unindexed primitives
  36850. * @param fillMode defines the primitive to use
  36851. * @param verticesStart defines the index of first vertex to draw
  36852. * @param verticesCount defines the count of vertices to draw
  36853. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36854. */
  36855. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36856. private _drawMode;
  36857. /** @hidden */
  36858. protected _reportDrawCall(): void;
  36859. /** @hidden */
  36860. _releaseEffect(effect: Effect): void;
  36861. /** @hidden */
  36862. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  36863. /**
  36864. * Create a new effect (used to store vertex/fragment shaders)
  36865. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  36866. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  36867. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  36868. * @param samplers defines an array of string used to represent textures
  36869. * @param defines defines the string containing the defines to use to compile the shaders
  36870. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  36871. * @param onCompiled defines a function to call when the effect creation is successful
  36872. * @param onError defines a function to call when the effect creation has failed
  36873. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  36874. * @returns the new Effect
  36875. */
  36876. 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;
  36877. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  36878. private _compileShader;
  36879. private _compileRawShader;
  36880. /** @hidden */
  36881. _getShaderSource(shader: WebGLShader): Nullable<string>;
  36882. /**
  36883. * Directly creates a webGL program
  36884. * @param pipelineContext defines the pipeline context to attach to
  36885. * @param vertexCode defines the vertex shader code to use
  36886. * @param fragmentCode defines the fragment shader code to use
  36887. * @param context defines the webGL context to use (if not set, the current one will be used)
  36888. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36889. * @returns the new webGL program
  36890. */
  36891. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36892. /**
  36893. * Creates a webGL program
  36894. * @param pipelineContext defines the pipeline context to attach to
  36895. * @param vertexCode defines the vertex shader code to use
  36896. * @param fragmentCode defines the fragment shader code to use
  36897. * @param defines defines the string containing the defines to use to compile the shaders
  36898. * @param context defines the webGL context to use (if not set, the current one will be used)
  36899. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36900. * @returns the new webGL program
  36901. */
  36902. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36903. /**
  36904. * Creates a new pipeline context
  36905. * @returns the new pipeline
  36906. */
  36907. createPipelineContext(): IPipelineContext;
  36908. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36909. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  36910. /** @hidden */
  36911. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  36912. /** @hidden */
  36913. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  36914. /** @hidden */
  36915. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  36916. /**
  36917. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  36918. * @param pipelineContext defines the pipeline context to use
  36919. * @param uniformsNames defines the list of uniform names
  36920. * @returns an array of webGL uniform locations
  36921. */
  36922. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  36923. /**
  36924. * Gets the lsit of active attributes for a given webGL program
  36925. * @param pipelineContext defines the pipeline context to use
  36926. * @param attributesNames defines the list of attribute names to get
  36927. * @returns an array of indices indicating the offset of each attribute
  36928. */
  36929. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  36930. /**
  36931. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  36932. * @param effect defines the effect to activate
  36933. */
  36934. enableEffect(effect: Nullable<Effect>): void;
  36935. /**
  36936. * Set the value of an uniform to a number (int)
  36937. * @param uniform defines the webGL uniform location where to store the value
  36938. * @param value defines the int number to store
  36939. */
  36940. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  36941. /**
  36942. * Set the value of an uniform to an array of int32
  36943. * @param uniform defines the webGL uniform location where to store the value
  36944. * @param array defines the array of int32 to store
  36945. */
  36946. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36947. /**
  36948. * Set the value of an uniform to an array of int32 (stored as vec2)
  36949. * @param uniform defines the webGL uniform location where to store the value
  36950. * @param array defines the array of int32 to store
  36951. */
  36952. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36953. /**
  36954. * Set the value of an uniform to an array of int32 (stored as vec3)
  36955. * @param uniform defines the webGL uniform location where to store the value
  36956. * @param array defines the array of int32 to store
  36957. */
  36958. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36959. /**
  36960. * Set the value of an uniform to an array of int32 (stored as vec4)
  36961. * @param uniform defines the webGL uniform location where to store the value
  36962. * @param array defines the array of int32 to store
  36963. */
  36964. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36965. /**
  36966. * Set the value of an uniform to an array of number
  36967. * @param uniform defines the webGL uniform location where to store the value
  36968. * @param array defines the array of number to store
  36969. */
  36970. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36971. /**
  36972. * Set the value of an uniform to an array of number (stored as vec2)
  36973. * @param uniform defines the webGL uniform location where to store the value
  36974. * @param array defines the array of number to store
  36975. */
  36976. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36977. /**
  36978. * Set the value of an uniform to an array of number (stored as vec3)
  36979. * @param uniform defines the webGL uniform location where to store the value
  36980. * @param array defines the array of number to store
  36981. */
  36982. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36983. /**
  36984. * Set the value of an uniform to an array of number (stored as vec4)
  36985. * @param uniform defines the webGL uniform location where to store the value
  36986. * @param array defines the array of number to store
  36987. */
  36988. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36989. /**
  36990. * Set the value of an uniform to an array of float32 (stored as matrices)
  36991. * @param uniform defines the webGL uniform location where to store the value
  36992. * @param matrices defines the array of float32 to store
  36993. */
  36994. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  36995. /**
  36996. * Set the value of an uniform to a matrix (3x3)
  36997. * @param uniform defines the webGL uniform location where to store the value
  36998. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  36999. */
  37000. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37001. /**
  37002. * Set the value of an uniform to a matrix (2x2)
  37003. * @param uniform defines the webGL uniform location where to store the value
  37004. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37005. */
  37006. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37007. /**
  37008. * Set the value of an uniform to a number (float)
  37009. * @param uniform defines the webGL uniform location where to store the value
  37010. * @param value defines the float number to store
  37011. */
  37012. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37013. /**
  37014. * Set the value of an uniform to a vec2
  37015. * @param uniform defines the webGL uniform location where to store the value
  37016. * @param x defines the 1st component of the value
  37017. * @param y defines the 2nd component of the value
  37018. */
  37019. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37020. /**
  37021. * Set the value of an uniform to a vec3
  37022. * @param uniform defines the webGL uniform location where to store the value
  37023. * @param x defines the 1st component of the value
  37024. * @param y defines the 2nd component of the value
  37025. * @param z defines the 3rd component of the value
  37026. */
  37027. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37028. /**
  37029. * Set the value of an uniform to a vec4
  37030. * @param uniform defines the webGL uniform location where to store the value
  37031. * @param x defines the 1st component of the value
  37032. * @param y defines the 2nd component of the value
  37033. * @param z defines the 3rd component of the value
  37034. * @param w defines the 4th component of the value
  37035. */
  37036. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37037. /**
  37038. * Apply all cached states (depth, culling, stencil and alpha)
  37039. */
  37040. applyStates(): void;
  37041. /**
  37042. * Enable or disable color writing
  37043. * @param enable defines the state to set
  37044. */
  37045. setColorWrite(enable: boolean): void;
  37046. /**
  37047. * Gets a boolean indicating if color writing is enabled
  37048. * @returns the current color writing state
  37049. */
  37050. getColorWrite(): boolean;
  37051. /**
  37052. * Gets the depth culling state manager
  37053. */
  37054. get depthCullingState(): DepthCullingState;
  37055. /**
  37056. * Gets the alpha state manager
  37057. */
  37058. get alphaState(): AlphaState;
  37059. /**
  37060. * Gets the stencil state manager
  37061. */
  37062. get stencilState(): StencilState;
  37063. /**
  37064. * Clears the list of texture accessible through engine.
  37065. * This can help preventing texture load conflict due to name collision.
  37066. */
  37067. clearInternalTexturesCache(): void;
  37068. /**
  37069. * Force the entire cache to be cleared
  37070. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37071. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37072. */
  37073. wipeCaches(bruteForce?: boolean): void;
  37074. /** @hidden */
  37075. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37076. min: number;
  37077. mag: number;
  37078. };
  37079. /** @hidden */
  37080. _createTexture(): WebGLTexture;
  37081. /**
  37082. * Usually called from Texture.ts.
  37083. * Passed information to create a WebGLTexture
  37084. * @param url defines a value which contains one of the following:
  37085. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37086. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37087. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37088. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37089. * @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)
  37090. * @param scene needed for loading to the correct scene
  37091. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37092. * @param onLoad optional callback to be called upon successful completion
  37093. * @param onError optional callback to be called upon failure
  37094. * @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
  37095. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37096. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37097. * @param forcedExtension defines the extension to use to pick the right loader
  37098. * @param mimeType defines an optional mime type
  37099. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37100. */
  37101. 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;
  37102. /**
  37103. * Loads an image as an HTMLImageElement.
  37104. * @param input url string, ArrayBuffer, or Blob to load
  37105. * @param onLoad callback called when the image successfully loads
  37106. * @param onError callback called when the image fails to load
  37107. * @param offlineProvider offline provider for caching
  37108. * @param mimeType optional mime type
  37109. * @returns the HTMLImageElement of the loaded image
  37110. * @hidden
  37111. */
  37112. 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>;
  37113. /**
  37114. * @hidden
  37115. */
  37116. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37117. private _unpackFlipYCached;
  37118. /**
  37119. * In case you are sharing the context with other applications, it might
  37120. * be interested to not cache the unpack flip y state to ensure a consistent
  37121. * value would be set.
  37122. */
  37123. enableUnpackFlipYCached: boolean;
  37124. /** @hidden */
  37125. _unpackFlipY(value: boolean): void;
  37126. /** @hidden */
  37127. _getUnpackAlignement(): number;
  37128. private _getTextureTarget;
  37129. /**
  37130. * Update the sampling mode of a given texture
  37131. * @param samplingMode defines the required sampling mode
  37132. * @param texture defines the texture to update
  37133. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37134. */
  37135. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37136. /**
  37137. * Update the sampling mode of a given texture
  37138. * @param texture defines the texture to update
  37139. * @param wrapU defines the texture wrap mode of the u coordinates
  37140. * @param wrapV defines the texture wrap mode of the v coordinates
  37141. * @param wrapR defines the texture wrap mode of the r coordinates
  37142. */
  37143. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37144. /** @hidden */
  37145. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37146. width: number;
  37147. height: number;
  37148. layers?: number;
  37149. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37150. /** @hidden */
  37151. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37152. /** @hidden */
  37153. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37154. /**
  37155. * Update a portion of an internal texture
  37156. * @param texture defines the texture to update
  37157. * @param imageData defines the data to store into the texture
  37158. * @param xOffset defines the x coordinates of the update rectangle
  37159. * @param yOffset defines the y coordinates of the update rectangle
  37160. * @param width defines the width of the update rectangle
  37161. * @param height defines the height of the update rectangle
  37162. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37163. * @param lod defines the lod level to update (0 by default)
  37164. */
  37165. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37166. /** @hidden */
  37167. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37168. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37169. private _prepareWebGLTexture;
  37170. /** @hidden */
  37171. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37172. private _getDepthStencilBuffer;
  37173. /** @hidden */
  37174. _releaseFramebufferObjects(texture: InternalTexture): void;
  37175. /** @hidden */
  37176. _releaseTexture(texture: InternalTexture): void;
  37177. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37178. protected _setProgram(program: WebGLProgram): void;
  37179. protected _boundUniforms: {
  37180. [key: number]: WebGLUniformLocation;
  37181. };
  37182. /**
  37183. * Binds an effect to the webGL context
  37184. * @param effect defines the effect to bind
  37185. */
  37186. bindSamplers(effect: Effect): void;
  37187. private _activateCurrentTexture;
  37188. /** @hidden */
  37189. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37190. /** @hidden */
  37191. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37192. /**
  37193. * Unbind all textures from the webGL context
  37194. */
  37195. unbindAllTextures(): void;
  37196. /**
  37197. * Sets a texture to the according uniform.
  37198. * @param channel The texture channel
  37199. * @param uniform The uniform to set
  37200. * @param texture The texture to apply
  37201. */
  37202. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37203. private _bindSamplerUniformToChannel;
  37204. private _getTextureWrapMode;
  37205. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37206. /**
  37207. * Sets an array of texture to the webGL context
  37208. * @param channel defines the channel where the texture array must be set
  37209. * @param uniform defines the associated uniform location
  37210. * @param textures defines the array of textures to bind
  37211. */
  37212. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37213. /** @hidden */
  37214. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37215. private _setTextureParameterFloat;
  37216. private _setTextureParameterInteger;
  37217. /**
  37218. * Unbind all vertex attributes from the webGL context
  37219. */
  37220. unbindAllAttributes(): void;
  37221. /**
  37222. * 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
  37223. */
  37224. releaseEffects(): void;
  37225. /**
  37226. * Dispose and release all associated resources
  37227. */
  37228. dispose(): void;
  37229. /**
  37230. * Attach a new callback raised when context lost event is fired
  37231. * @param callback defines the callback to call
  37232. */
  37233. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37234. /**
  37235. * Attach a new callback raised when context restored event is fired
  37236. * @param callback defines the callback to call
  37237. */
  37238. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37239. /**
  37240. * Get the current error code of the webGL context
  37241. * @returns the error code
  37242. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37243. */
  37244. getError(): number;
  37245. private _canRenderToFloatFramebuffer;
  37246. private _canRenderToHalfFloatFramebuffer;
  37247. private _canRenderToFramebuffer;
  37248. /** @hidden */
  37249. _getWebGLTextureType(type: number): number;
  37250. /** @hidden */
  37251. _getInternalFormat(format: number): number;
  37252. /** @hidden */
  37253. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37254. /** @hidden */
  37255. _getRGBAMultiSampleBufferFormat(type: number): number;
  37256. /** @hidden */
  37257. _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;
  37258. /**
  37259. * Loads a file from a url
  37260. * @param url url to load
  37261. * @param onSuccess callback called when the file successfully loads
  37262. * @param onProgress callback called while file is loading (if the server supports this mode)
  37263. * @param offlineProvider defines the offline provider for caching
  37264. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37265. * @param onError callback called when the file fails to load
  37266. * @returns a file request object
  37267. * @hidden
  37268. */
  37269. 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;
  37270. /**
  37271. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37272. * @param x defines the x coordinate of the rectangle where pixels must be read
  37273. * @param y defines the y coordinate of the rectangle where pixels must be read
  37274. * @param width defines the width of the rectangle where pixels must be read
  37275. * @param height defines the height of the rectangle where pixels must be read
  37276. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37277. * @returns a Uint8Array containing RGBA colors
  37278. */
  37279. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37280. private static _isSupported;
  37281. /**
  37282. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37283. * @returns true if the engine can be created
  37284. * @ignorenaming
  37285. */
  37286. static isSupported(): boolean;
  37287. /**
  37288. * Find the next highest power of two.
  37289. * @param x Number to start search from.
  37290. * @return Next highest power of two.
  37291. */
  37292. static CeilingPOT(x: number): number;
  37293. /**
  37294. * Find the next lowest power of two.
  37295. * @param x Number to start search from.
  37296. * @return Next lowest power of two.
  37297. */
  37298. static FloorPOT(x: number): number;
  37299. /**
  37300. * Find the nearest power of two.
  37301. * @param x Number to start search from.
  37302. * @return Next nearest power of two.
  37303. */
  37304. static NearestPOT(x: number): number;
  37305. /**
  37306. * Get the closest exponent of two
  37307. * @param value defines the value to approximate
  37308. * @param max defines the maximum value to return
  37309. * @param mode defines how to define the closest value
  37310. * @returns closest exponent of two of the given value
  37311. */
  37312. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37313. /**
  37314. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37315. * @param func - the function to be called
  37316. * @param requester - the object that will request the next frame. Falls back to window.
  37317. * @returns frame number
  37318. */
  37319. static QueueNewFrame(func: () => void, requester?: any): number;
  37320. /**
  37321. * Gets host document
  37322. * @returns the host document object
  37323. */
  37324. getHostDocument(): Nullable<Document>;
  37325. }
  37326. }
  37327. declare module "babylonjs/Maths/sphericalPolynomial" {
  37328. import { Vector3 } from "babylonjs/Maths/math.vector";
  37329. import { Color3 } from "babylonjs/Maths/math.color";
  37330. /**
  37331. * Class representing spherical harmonics coefficients to the 3rd degree
  37332. */
  37333. export class SphericalHarmonics {
  37334. /**
  37335. * Defines whether or not the harmonics have been prescaled for rendering.
  37336. */
  37337. preScaled: boolean;
  37338. /**
  37339. * The l0,0 coefficients of the spherical harmonics
  37340. */
  37341. l00: Vector3;
  37342. /**
  37343. * The l1,-1 coefficients of the spherical harmonics
  37344. */
  37345. l1_1: Vector3;
  37346. /**
  37347. * The l1,0 coefficients of the spherical harmonics
  37348. */
  37349. l10: Vector3;
  37350. /**
  37351. * The l1,1 coefficients of the spherical harmonics
  37352. */
  37353. l11: Vector3;
  37354. /**
  37355. * The l2,-2 coefficients of the spherical harmonics
  37356. */
  37357. l2_2: Vector3;
  37358. /**
  37359. * The l2,-1 coefficients of the spherical harmonics
  37360. */
  37361. l2_1: Vector3;
  37362. /**
  37363. * The l2,0 coefficients of the spherical harmonics
  37364. */
  37365. l20: Vector3;
  37366. /**
  37367. * The l2,1 coefficients of the spherical harmonics
  37368. */
  37369. l21: Vector3;
  37370. /**
  37371. * The l2,2 coefficients of the spherical harmonics
  37372. */
  37373. l22: Vector3;
  37374. /**
  37375. * Adds a light to the spherical harmonics
  37376. * @param direction the direction of the light
  37377. * @param color the color of the light
  37378. * @param deltaSolidAngle the delta solid angle of the light
  37379. */
  37380. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37381. /**
  37382. * Scales the spherical harmonics by the given amount
  37383. * @param scale the amount to scale
  37384. */
  37385. scaleInPlace(scale: number): void;
  37386. /**
  37387. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37388. *
  37389. * ```
  37390. * E_lm = A_l * L_lm
  37391. * ```
  37392. *
  37393. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37394. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37395. * the scaling factors are given in equation 9.
  37396. */
  37397. convertIncidentRadianceToIrradiance(): void;
  37398. /**
  37399. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37400. *
  37401. * ```
  37402. * L = (1/pi) * E * rho
  37403. * ```
  37404. *
  37405. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37406. */
  37407. convertIrradianceToLambertianRadiance(): void;
  37408. /**
  37409. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37410. * required operations at run time.
  37411. *
  37412. * This is simply done by scaling back the SH with Ylm constants parameter.
  37413. * The trigonometric part being applied by the shader at run time.
  37414. */
  37415. preScaleForRendering(): void;
  37416. /**
  37417. * Constructs a spherical harmonics from an array.
  37418. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37419. * @returns the spherical harmonics
  37420. */
  37421. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37422. /**
  37423. * Gets the spherical harmonics from polynomial
  37424. * @param polynomial the spherical polynomial
  37425. * @returns the spherical harmonics
  37426. */
  37427. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37428. }
  37429. /**
  37430. * Class representing spherical polynomial coefficients to the 3rd degree
  37431. */
  37432. export class SphericalPolynomial {
  37433. private _harmonics;
  37434. /**
  37435. * The spherical harmonics used to create the polynomials.
  37436. */
  37437. get preScaledHarmonics(): SphericalHarmonics;
  37438. /**
  37439. * The x coefficients of the spherical polynomial
  37440. */
  37441. x: Vector3;
  37442. /**
  37443. * The y coefficients of the spherical polynomial
  37444. */
  37445. y: Vector3;
  37446. /**
  37447. * The z coefficients of the spherical polynomial
  37448. */
  37449. z: Vector3;
  37450. /**
  37451. * The xx coefficients of the spherical polynomial
  37452. */
  37453. xx: Vector3;
  37454. /**
  37455. * The yy coefficients of the spherical polynomial
  37456. */
  37457. yy: Vector3;
  37458. /**
  37459. * The zz coefficients of the spherical polynomial
  37460. */
  37461. zz: Vector3;
  37462. /**
  37463. * The xy coefficients of the spherical polynomial
  37464. */
  37465. xy: Vector3;
  37466. /**
  37467. * The yz coefficients of the spherical polynomial
  37468. */
  37469. yz: Vector3;
  37470. /**
  37471. * The zx coefficients of the spherical polynomial
  37472. */
  37473. zx: Vector3;
  37474. /**
  37475. * Adds an ambient color to the spherical polynomial
  37476. * @param color the color to add
  37477. */
  37478. addAmbient(color: Color3): void;
  37479. /**
  37480. * Scales the spherical polynomial by the given amount
  37481. * @param scale the amount to scale
  37482. */
  37483. scaleInPlace(scale: number): void;
  37484. /**
  37485. * Gets the spherical polynomial from harmonics
  37486. * @param harmonics the spherical harmonics
  37487. * @returns the spherical polynomial
  37488. */
  37489. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37490. /**
  37491. * Constructs a spherical polynomial from an array.
  37492. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37493. * @returns the spherical polynomial
  37494. */
  37495. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37496. }
  37497. }
  37498. declare module "babylonjs/Materials/Textures/internalTexture" {
  37499. import { Observable } from "babylonjs/Misc/observable";
  37500. import { Nullable, int } from "babylonjs/types";
  37501. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37502. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37503. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37504. /**
  37505. * Defines the source of the internal texture
  37506. */
  37507. export enum InternalTextureSource {
  37508. /**
  37509. * The source of the texture data is unknown
  37510. */
  37511. Unknown = 0,
  37512. /**
  37513. * Texture data comes from an URL
  37514. */
  37515. Url = 1,
  37516. /**
  37517. * Texture data is only used for temporary storage
  37518. */
  37519. Temp = 2,
  37520. /**
  37521. * Texture data comes from raw data (ArrayBuffer)
  37522. */
  37523. Raw = 3,
  37524. /**
  37525. * Texture content is dynamic (video or dynamic texture)
  37526. */
  37527. Dynamic = 4,
  37528. /**
  37529. * Texture content is generated by rendering to it
  37530. */
  37531. RenderTarget = 5,
  37532. /**
  37533. * Texture content is part of a multi render target process
  37534. */
  37535. MultiRenderTarget = 6,
  37536. /**
  37537. * Texture data comes from a cube data file
  37538. */
  37539. Cube = 7,
  37540. /**
  37541. * Texture data comes from a raw cube data
  37542. */
  37543. CubeRaw = 8,
  37544. /**
  37545. * Texture data come from a prefiltered cube data file
  37546. */
  37547. CubePrefiltered = 9,
  37548. /**
  37549. * Texture content is raw 3D data
  37550. */
  37551. Raw3D = 10,
  37552. /**
  37553. * Texture content is raw 2D array data
  37554. */
  37555. Raw2DArray = 11,
  37556. /**
  37557. * Texture content is a depth texture
  37558. */
  37559. Depth = 12,
  37560. /**
  37561. * Texture data comes from a raw cube data encoded with RGBD
  37562. */
  37563. CubeRawRGBD = 13
  37564. }
  37565. /**
  37566. * Class used to store data associated with WebGL texture data for the engine
  37567. * This class should not be used directly
  37568. */
  37569. export class InternalTexture {
  37570. /** @hidden */
  37571. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37572. /**
  37573. * Defines if the texture is ready
  37574. */
  37575. isReady: boolean;
  37576. /**
  37577. * Defines if the texture is a cube texture
  37578. */
  37579. isCube: boolean;
  37580. /**
  37581. * Defines if the texture contains 3D data
  37582. */
  37583. is3D: boolean;
  37584. /**
  37585. * Defines if the texture contains 2D array data
  37586. */
  37587. is2DArray: boolean;
  37588. /**
  37589. * Defines if the texture contains multiview data
  37590. */
  37591. isMultiview: boolean;
  37592. /**
  37593. * Gets the URL used to load this texture
  37594. */
  37595. url: string;
  37596. /**
  37597. * Gets the sampling mode of the texture
  37598. */
  37599. samplingMode: number;
  37600. /**
  37601. * Gets a boolean indicating if the texture needs mipmaps generation
  37602. */
  37603. generateMipMaps: boolean;
  37604. /**
  37605. * Gets the number of samples used by the texture (WebGL2+ only)
  37606. */
  37607. samples: number;
  37608. /**
  37609. * Gets the type of the texture (int, float...)
  37610. */
  37611. type: number;
  37612. /**
  37613. * Gets the format of the texture (RGB, RGBA...)
  37614. */
  37615. format: number;
  37616. /**
  37617. * Observable called when the texture is loaded
  37618. */
  37619. onLoadedObservable: Observable<InternalTexture>;
  37620. /**
  37621. * Gets the width of the texture
  37622. */
  37623. width: number;
  37624. /**
  37625. * Gets the height of the texture
  37626. */
  37627. height: number;
  37628. /**
  37629. * Gets the depth of the texture
  37630. */
  37631. depth: number;
  37632. /**
  37633. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37634. */
  37635. baseWidth: number;
  37636. /**
  37637. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37638. */
  37639. baseHeight: number;
  37640. /**
  37641. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37642. */
  37643. baseDepth: number;
  37644. /**
  37645. * Gets a boolean indicating if the texture is inverted on Y axis
  37646. */
  37647. invertY: boolean;
  37648. /** @hidden */
  37649. _invertVScale: boolean;
  37650. /** @hidden */
  37651. _associatedChannel: number;
  37652. /** @hidden */
  37653. _source: InternalTextureSource;
  37654. /** @hidden */
  37655. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37656. /** @hidden */
  37657. _bufferView: Nullable<ArrayBufferView>;
  37658. /** @hidden */
  37659. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37660. /** @hidden */
  37661. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37662. /** @hidden */
  37663. _size: number;
  37664. /** @hidden */
  37665. _extension: string;
  37666. /** @hidden */
  37667. _files: Nullable<string[]>;
  37668. /** @hidden */
  37669. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37670. /** @hidden */
  37671. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37672. /** @hidden */
  37673. _framebuffer: Nullable<WebGLFramebuffer>;
  37674. /** @hidden */
  37675. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37676. /** @hidden */
  37677. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37678. /** @hidden */
  37679. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37680. /** @hidden */
  37681. _attachments: Nullable<number[]>;
  37682. /** @hidden */
  37683. _textureArray: Nullable<InternalTexture[]>;
  37684. /** @hidden */
  37685. _cachedCoordinatesMode: Nullable<number>;
  37686. /** @hidden */
  37687. _cachedWrapU: Nullable<number>;
  37688. /** @hidden */
  37689. _cachedWrapV: Nullable<number>;
  37690. /** @hidden */
  37691. _cachedWrapR: Nullable<number>;
  37692. /** @hidden */
  37693. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37694. /** @hidden */
  37695. _isDisabled: boolean;
  37696. /** @hidden */
  37697. _compression: Nullable<string>;
  37698. /** @hidden */
  37699. _generateStencilBuffer: boolean;
  37700. /** @hidden */
  37701. _generateDepthBuffer: boolean;
  37702. /** @hidden */
  37703. _comparisonFunction: number;
  37704. /** @hidden */
  37705. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37706. /** @hidden */
  37707. _lodGenerationScale: number;
  37708. /** @hidden */
  37709. _lodGenerationOffset: number;
  37710. /** @hidden */
  37711. _depthStencilTexture: Nullable<InternalTexture>;
  37712. /** @hidden */
  37713. _colorTextureArray: Nullable<WebGLTexture>;
  37714. /** @hidden */
  37715. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37716. /** @hidden */
  37717. _lodTextureHigh: Nullable<BaseTexture>;
  37718. /** @hidden */
  37719. _lodTextureMid: Nullable<BaseTexture>;
  37720. /** @hidden */
  37721. _lodTextureLow: Nullable<BaseTexture>;
  37722. /** @hidden */
  37723. _isRGBD: boolean;
  37724. /** @hidden */
  37725. _linearSpecularLOD: boolean;
  37726. /** @hidden */
  37727. _irradianceTexture: Nullable<BaseTexture>;
  37728. /** @hidden */
  37729. _webGLTexture: Nullable<WebGLTexture>;
  37730. /** @hidden */
  37731. _references: number;
  37732. private _engine;
  37733. /**
  37734. * Gets the Engine the texture belongs to.
  37735. * @returns The babylon engine
  37736. */
  37737. getEngine(): ThinEngine;
  37738. /**
  37739. * Gets the data source type of the texture
  37740. */
  37741. get source(): InternalTextureSource;
  37742. /**
  37743. * Creates a new InternalTexture
  37744. * @param engine defines the engine to use
  37745. * @param source defines the type of data that will be used
  37746. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37747. */
  37748. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37749. /**
  37750. * Increments the number of references (ie. the number of Texture that point to it)
  37751. */
  37752. incrementReferences(): void;
  37753. /**
  37754. * Change the size of the texture (not the size of the content)
  37755. * @param width defines the new width
  37756. * @param height defines the new height
  37757. * @param depth defines the new depth (1 by default)
  37758. */
  37759. updateSize(width: int, height: int, depth?: int): void;
  37760. /** @hidden */
  37761. _rebuild(): void;
  37762. /** @hidden */
  37763. _swapAndDie(target: InternalTexture): void;
  37764. /**
  37765. * Dispose the current allocated resources
  37766. */
  37767. dispose(): void;
  37768. }
  37769. }
  37770. declare module "babylonjs/Audio/analyser" {
  37771. import { Scene } from "babylonjs/scene";
  37772. /**
  37773. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37774. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37775. */
  37776. export class Analyser {
  37777. /**
  37778. * Gets or sets the smoothing
  37779. * @ignorenaming
  37780. */
  37781. SMOOTHING: number;
  37782. /**
  37783. * Gets or sets the FFT table size
  37784. * @ignorenaming
  37785. */
  37786. FFT_SIZE: number;
  37787. /**
  37788. * Gets or sets the bar graph amplitude
  37789. * @ignorenaming
  37790. */
  37791. BARGRAPHAMPLITUDE: number;
  37792. /**
  37793. * Gets or sets the position of the debug canvas
  37794. * @ignorenaming
  37795. */
  37796. DEBUGCANVASPOS: {
  37797. x: number;
  37798. y: number;
  37799. };
  37800. /**
  37801. * Gets or sets the debug canvas size
  37802. * @ignorenaming
  37803. */
  37804. DEBUGCANVASSIZE: {
  37805. width: number;
  37806. height: number;
  37807. };
  37808. private _byteFreqs;
  37809. private _byteTime;
  37810. private _floatFreqs;
  37811. private _webAudioAnalyser;
  37812. private _debugCanvas;
  37813. private _debugCanvasContext;
  37814. private _scene;
  37815. private _registerFunc;
  37816. private _audioEngine;
  37817. /**
  37818. * Creates a new analyser
  37819. * @param scene defines hosting scene
  37820. */
  37821. constructor(scene: Scene);
  37822. /**
  37823. * Get the number of data values you will have to play with for the visualization
  37824. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  37825. * @returns a number
  37826. */
  37827. getFrequencyBinCount(): number;
  37828. /**
  37829. * Gets the current frequency data as a byte array
  37830. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  37831. * @returns a Uint8Array
  37832. */
  37833. getByteFrequencyData(): Uint8Array;
  37834. /**
  37835. * Gets the current waveform as a byte array
  37836. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  37837. * @returns a Uint8Array
  37838. */
  37839. getByteTimeDomainData(): Uint8Array;
  37840. /**
  37841. * Gets the current frequency data as a float array
  37842. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  37843. * @returns a Float32Array
  37844. */
  37845. getFloatFrequencyData(): Float32Array;
  37846. /**
  37847. * Renders the debug canvas
  37848. */
  37849. drawDebugCanvas(): void;
  37850. /**
  37851. * Stops rendering the debug canvas and removes it
  37852. */
  37853. stopDebugCanvas(): void;
  37854. /**
  37855. * Connects two audio nodes
  37856. * @param inputAudioNode defines first node to connect
  37857. * @param outputAudioNode defines second node to connect
  37858. */
  37859. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  37860. /**
  37861. * Releases all associated resources
  37862. */
  37863. dispose(): void;
  37864. }
  37865. }
  37866. declare module "babylonjs/Audio/audioEngine" {
  37867. import { IDisposable } from "babylonjs/scene";
  37868. import { Analyser } from "babylonjs/Audio/analyser";
  37869. import { Nullable } from "babylonjs/types";
  37870. import { Observable } from "babylonjs/Misc/observable";
  37871. /**
  37872. * This represents an audio engine and it is responsible
  37873. * to play, synchronize and analyse sounds throughout the application.
  37874. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37875. */
  37876. export interface IAudioEngine extends IDisposable {
  37877. /**
  37878. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37879. */
  37880. readonly canUseWebAudio: boolean;
  37881. /**
  37882. * Gets the current AudioContext if available.
  37883. */
  37884. readonly audioContext: Nullable<AudioContext>;
  37885. /**
  37886. * The master gain node defines the global audio volume of your audio engine.
  37887. */
  37888. readonly masterGain: GainNode;
  37889. /**
  37890. * Gets whether or not mp3 are supported by your browser.
  37891. */
  37892. readonly isMP3supported: boolean;
  37893. /**
  37894. * Gets whether or not ogg are supported by your browser.
  37895. */
  37896. readonly isOGGsupported: boolean;
  37897. /**
  37898. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37899. * @ignoreNaming
  37900. */
  37901. WarnedWebAudioUnsupported: boolean;
  37902. /**
  37903. * Defines if the audio engine relies on a custom unlocked button.
  37904. * In this case, the embedded button will not be displayed.
  37905. */
  37906. useCustomUnlockedButton: boolean;
  37907. /**
  37908. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  37909. */
  37910. readonly unlocked: boolean;
  37911. /**
  37912. * Event raised when audio has been unlocked on the browser.
  37913. */
  37914. onAudioUnlockedObservable: Observable<AudioEngine>;
  37915. /**
  37916. * Event raised when audio has been locked on the browser.
  37917. */
  37918. onAudioLockedObservable: Observable<AudioEngine>;
  37919. /**
  37920. * Flags the audio engine in Locked state.
  37921. * This happens due to new browser policies preventing audio to autoplay.
  37922. */
  37923. lock(): void;
  37924. /**
  37925. * Unlocks the audio engine once a user action has been done on the dom.
  37926. * This is helpful to resume play once browser policies have been satisfied.
  37927. */
  37928. unlock(): void;
  37929. /**
  37930. * Gets the global volume sets on the master gain.
  37931. * @returns the global volume if set or -1 otherwise
  37932. */
  37933. getGlobalVolume(): number;
  37934. /**
  37935. * Sets the global volume of your experience (sets on the master gain).
  37936. * @param newVolume Defines the new global volume of the application
  37937. */
  37938. setGlobalVolume(newVolume: number): void;
  37939. /**
  37940. * Connect the audio engine to an audio analyser allowing some amazing
  37941. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37942. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37943. * @param analyser The analyser to connect to the engine
  37944. */
  37945. connectToAnalyser(analyser: Analyser): void;
  37946. }
  37947. /**
  37948. * This represents the default audio engine used in babylon.
  37949. * It is responsible to play, synchronize and analyse sounds throughout the application.
  37950. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37951. */
  37952. export class AudioEngine implements IAudioEngine {
  37953. private _audioContext;
  37954. private _audioContextInitialized;
  37955. private _muteButton;
  37956. private _hostElement;
  37957. /**
  37958. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37959. */
  37960. canUseWebAudio: boolean;
  37961. /**
  37962. * The master gain node defines the global audio volume of your audio engine.
  37963. */
  37964. masterGain: GainNode;
  37965. /**
  37966. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37967. * @ignoreNaming
  37968. */
  37969. WarnedWebAudioUnsupported: boolean;
  37970. /**
  37971. * Gets whether or not mp3 are supported by your browser.
  37972. */
  37973. isMP3supported: boolean;
  37974. /**
  37975. * Gets whether or not ogg are supported by your browser.
  37976. */
  37977. isOGGsupported: boolean;
  37978. /**
  37979. * Gets whether audio has been unlocked on the device.
  37980. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  37981. * a user interaction has happened.
  37982. */
  37983. unlocked: boolean;
  37984. /**
  37985. * Defines if the audio engine relies on a custom unlocked button.
  37986. * In this case, the embedded button will not be displayed.
  37987. */
  37988. useCustomUnlockedButton: boolean;
  37989. /**
  37990. * Event raised when audio has been unlocked on the browser.
  37991. */
  37992. onAudioUnlockedObservable: Observable<AudioEngine>;
  37993. /**
  37994. * Event raised when audio has been locked on the browser.
  37995. */
  37996. onAudioLockedObservable: Observable<AudioEngine>;
  37997. /**
  37998. * Gets the current AudioContext if available.
  37999. */
  38000. get audioContext(): Nullable<AudioContext>;
  38001. private _connectedAnalyser;
  38002. /**
  38003. * Instantiates a new audio engine.
  38004. *
  38005. * There should be only one per page as some browsers restrict the number
  38006. * of audio contexts you can create.
  38007. * @param hostElement defines the host element where to display the mute icon if necessary
  38008. */
  38009. constructor(hostElement?: Nullable<HTMLElement>);
  38010. /**
  38011. * Flags the audio engine in Locked state.
  38012. * This happens due to new browser policies preventing audio to autoplay.
  38013. */
  38014. lock(): void;
  38015. /**
  38016. * Unlocks the audio engine once a user action has been done on the dom.
  38017. * This is helpful to resume play once browser policies have been satisfied.
  38018. */
  38019. unlock(): void;
  38020. private _resumeAudioContext;
  38021. private _initializeAudioContext;
  38022. private _tryToRun;
  38023. private _triggerRunningState;
  38024. private _triggerSuspendedState;
  38025. private _displayMuteButton;
  38026. private _moveButtonToTopLeft;
  38027. private _onResize;
  38028. private _hideMuteButton;
  38029. /**
  38030. * Destroy and release the resources associated with the audio ccontext.
  38031. */
  38032. dispose(): void;
  38033. /**
  38034. * Gets the global volume sets on the master gain.
  38035. * @returns the global volume if set or -1 otherwise
  38036. */
  38037. getGlobalVolume(): number;
  38038. /**
  38039. * Sets the global volume of your experience (sets on the master gain).
  38040. * @param newVolume Defines the new global volume of the application
  38041. */
  38042. setGlobalVolume(newVolume: number): void;
  38043. /**
  38044. * Connect the audio engine to an audio analyser allowing some amazing
  38045. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38046. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38047. * @param analyser The analyser to connect to the engine
  38048. */
  38049. connectToAnalyser(analyser: Analyser): void;
  38050. }
  38051. }
  38052. declare module "babylonjs/Loading/loadingScreen" {
  38053. /**
  38054. * Interface used to present a loading screen while loading a scene
  38055. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38056. */
  38057. export interface ILoadingScreen {
  38058. /**
  38059. * Function called to display the loading screen
  38060. */
  38061. displayLoadingUI: () => void;
  38062. /**
  38063. * Function called to hide the loading screen
  38064. */
  38065. hideLoadingUI: () => void;
  38066. /**
  38067. * Gets or sets the color to use for the background
  38068. */
  38069. loadingUIBackgroundColor: string;
  38070. /**
  38071. * Gets or sets the text to display while loading
  38072. */
  38073. loadingUIText: string;
  38074. }
  38075. /**
  38076. * Class used for the default loading screen
  38077. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38078. */
  38079. export class DefaultLoadingScreen implements ILoadingScreen {
  38080. private _renderingCanvas;
  38081. private _loadingText;
  38082. private _loadingDivBackgroundColor;
  38083. private _loadingDiv;
  38084. private _loadingTextDiv;
  38085. /** Gets or sets the logo url to use for the default loading screen */
  38086. static DefaultLogoUrl: string;
  38087. /** Gets or sets the spinner url to use for the default loading screen */
  38088. static DefaultSpinnerUrl: string;
  38089. /**
  38090. * Creates a new default loading screen
  38091. * @param _renderingCanvas defines the canvas used to render the scene
  38092. * @param _loadingText defines the default text to display
  38093. * @param _loadingDivBackgroundColor defines the default background color
  38094. */
  38095. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38096. /**
  38097. * Function called to display the loading screen
  38098. */
  38099. displayLoadingUI(): void;
  38100. /**
  38101. * Function called to hide the loading screen
  38102. */
  38103. hideLoadingUI(): void;
  38104. /**
  38105. * Gets or sets the text to display while loading
  38106. */
  38107. set loadingUIText(text: string);
  38108. get loadingUIText(): string;
  38109. /**
  38110. * Gets or sets the color to use for the background
  38111. */
  38112. get loadingUIBackgroundColor(): string;
  38113. set loadingUIBackgroundColor(color: string);
  38114. private _resizeLoadingUI;
  38115. }
  38116. }
  38117. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38118. /**
  38119. * Interface for any object that can request an animation frame
  38120. */
  38121. export interface ICustomAnimationFrameRequester {
  38122. /**
  38123. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38124. */
  38125. renderFunction?: Function;
  38126. /**
  38127. * Called to request the next frame to render to
  38128. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38129. */
  38130. requestAnimationFrame: Function;
  38131. /**
  38132. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38133. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38134. */
  38135. requestID?: number;
  38136. }
  38137. }
  38138. declare module "babylonjs/Misc/performanceMonitor" {
  38139. /**
  38140. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38141. */
  38142. export class PerformanceMonitor {
  38143. private _enabled;
  38144. private _rollingFrameTime;
  38145. private _lastFrameTimeMs;
  38146. /**
  38147. * constructor
  38148. * @param frameSampleSize The number of samples required to saturate the sliding window
  38149. */
  38150. constructor(frameSampleSize?: number);
  38151. /**
  38152. * Samples current frame
  38153. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38154. */
  38155. sampleFrame(timeMs?: number): void;
  38156. /**
  38157. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38158. */
  38159. get averageFrameTime(): number;
  38160. /**
  38161. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38162. */
  38163. get averageFrameTimeVariance(): number;
  38164. /**
  38165. * Returns the frame time of the most recent frame
  38166. */
  38167. get instantaneousFrameTime(): number;
  38168. /**
  38169. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38170. */
  38171. get averageFPS(): number;
  38172. /**
  38173. * Returns the average framerate in frames per second using the most recent frame time
  38174. */
  38175. get instantaneousFPS(): number;
  38176. /**
  38177. * Returns true if enough samples have been taken to completely fill the sliding window
  38178. */
  38179. get isSaturated(): boolean;
  38180. /**
  38181. * Enables contributions to the sliding window sample set
  38182. */
  38183. enable(): void;
  38184. /**
  38185. * Disables contributions to the sliding window sample set
  38186. * Samples will not be interpolated over the disabled period
  38187. */
  38188. disable(): void;
  38189. /**
  38190. * Returns true if sampling is enabled
  38191. */
  38192. get isEnabled(): boolean;
  38193. /**
  38194. * Resets performance monitor
  38195. */
  38196. reset(): void;
  38197. }
  38198. /**
  38199. * RollingAverage
  38200. *
  38201. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38202. */
  38203. export class RollingAverage {
  38204. /**
  38205. * Current average
  38206. */
  38207. average: number;
  38208. /**
  38209. * Current variance
  38210. */
  38211. variance: number;
  38212. protected _samples: Array<number>;
  38213. protected _sampleCount: number;
  38214. protected _pos: number;
  38215. protected _m2: number;
  38216. /**
  38217. * constructor
  38218. * @param length The number of samples required to saturate the sliding window
  38219. */
  38220. constructor(length: number);
  38221. /**
  38222. * Adds a sample to the sample set
  38223. * @param v The sample value
  38224. */
  38225. add(v: number): void;
  38226. /**
  38227. * Returns previously added values or null if outside of history or outside the sliding window domain
  38228. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38229. * @return Value previously recorded with add() or null if outside of range
  38230. */
  38231. history(i: number): number;
  38232. /**
  38233. * Returns true if enough samples have been taken to completely fill the sliding window
  38234. * @return true if sample-set saturated
  38235. */
  38236. isSaturated(): boolean;
  38237. /**
  38238. * Resets the rolling average (equivalent to 0 samples taken so far)
  38239. */
  38240. reset(): void;
  38241. /**
  38242. * Wraps a value around the sample range boundaries
  38243. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38244. * @return Wrapped position in sample range
  38245. */
  38246. protected _wrapPosition(i: number): number;
  38247. }
  38248. }
  38249. declare module "babylonjs/Misc/perfCounter" {
  38250. /**
  38251. * This class is used to track a performance counter which is number based.
  38252. * The user has access to many properties which give statistics of different nature.
  38253. *
  38254. * The implementer can track two kinds of Performance Counter: time and count.
  38255. * 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.
  38256. * 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.
  38257. */
  38258. export class PerfCounter {
  38259. /**
  38260. * Gets or sets a global boolean to turn on and off all the counters
  38261. */
  38262. static Enabled: boolean;
  38263. /**
  38264. * Returns the smallest value ever
  38265. */
  38266. get min(): number;
  38267. /**
  38268. * Returns the biggest value ever
  38269. */
  38270. get max(): number;
  38271. /**
  38272. * Returns the average value since the performance counter is running
  38273. */
  38274. get average(): number;
  38275. /**
  38276. * Returns the average value of the last second the counter was monitored
  38277. */
  38278. get lastSecAverage(): number;
  38279. /**
  38280. * Returns the current value
  38281. */
  38282. get current(): number;
  38283. /**
  38284. * Gets the accumulated total
  38285. */
  38286. get total(): number;
  38287. /**
  38288. * Gets the total value count
  38289. */
  38290. get count(): number;
  38291. /**
  38292. * Creates a new counter
  38293. */
  38294. constructor();
  38295. /**
  38296. * Call this method to start monitoring a new frame.
  38297. * 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.
  38298. */
  38299. fetchNewFrame(): void;
  38300. /**
  38301. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38302. * @param newCount the count value to add to the monitored count
  38303. * @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.
  38304. */
  38305. addCount(newCount: number, fetchResult: boolean): void;
  38306. /**
  38307. * Start monitoring this performance counter
  38308. */
  38309. beginMonitoring(): void;
  38310. /**
  38311. * Compute the time lapsed since the previous beginMonitoring() call.
  38312. * @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
  38313. */
  38314. endMonitoring(newFrame?: boolean): void;
  38315. private _fetchResult;
  38316. private _startMonitoringTime;
  38317. private _min;
  38318. private _max;
  38319. private _average;
  38320. private _current;
  38321. private _totalValueCount;
  38322. private _totalAccumulated;
  38323. private _lastSecAverage;
  38324. private _lastSecAccumulated;
  38325. private _lastSecTime;
  38326. private _lastSecValueCount;
  38327. }
  38328. }
  38329. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  38330. module "babylonjs/Engines/thinEngine" {
  38331. interface ThinEngine {
  38332. /**
  38333. * Sets alpha constants used by some alpha blending modes
  38334. * @param r defines the red component
  38335. * @param g defines the green component
  38336. * @param b defines the blue component
  38337. * @param a defines the alpha component
  38338. */
  38339. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  38340. /**
  38341. * Sets the current alpha mode
  38342. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  38343. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  38344. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  38345. */
  38346. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  38347. /**
  38348. * Gets the current alpha mode
  38349. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  38350. * @returns the current alpha mode
  38351. */
  38352. getAlphaMode(): number;
  38353. /**
  38354. * Sets the current alpha equation
  38355. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  38356. */
  38357. setAlphaEquation(equation: number): void;
  38358. /**
  38359. * Gets the current alpha equation.
  38360. * @returns the current alpha equation
  38361. */
  38362. getAlphaEquation(): number;
  38363. }
  38364. }
  38365. }
  38366. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38367. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38368. import { Nullable } from "babylonjs/types";
  38369. module "babylonjs/Engines/thinEngine" {
  38370. interface ThinEngine {
  38371. /** @hidden */
  38372. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38373. }
  38374. }
  38375. }
  38376. declare module "babylonjs/Engines/engine" {
  38377. import { Observable } from "babylonjs/Misc/observable";
  38378. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  38379. import { Scene } from "babylonjs/scene";
  38380. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38381. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38382. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38383. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38384. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38385. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38386. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38387. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38388. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38389. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38390. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38391. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38392. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38393. import "babylonjs/Engines/Extensions/engine.alpha";
  38394. import "babylonjs/Engines/Extensions/engine.readTexture";
  38395. import { Material } from "babylonjs/Materials/material";
  38396. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38397. /**
  38398. * Defines the interface used by display changed events
  38399. */
  38400. export interface IDisplayChangedEventArgs {
  38401. /** Gets the vrDisplay object (if any) */
  38402. vrDisplay: Nullable<any>;
  38403. /** Gets a boolean indicating if webVR is supported */
  38404. vrSupported: boolean;
  38405. }
  38406. /**
  38407. * Defines the interface used by objects containing a viewport (like a camera)
  38408. */
  38409. interface IViewportOwnerLike {
  38410. /**
  38411. * Gets or sets the viewport
  38412. */
  38413. viewport: IViewportLike;
  38414. }
  38415. /**
  38416. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38417. */
  38418. export class Engine extends ThinEngine {
  38419. /** Defines that alpha blending is disabled */
  38420. static readonly ALPHA_DISABLE: number;
  38421. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38422. static readonly ALPHA_ADD: number;
  38423. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38424. static readonly ALPHA_COMBINE: number;
  38425. /** Defines that alpha blending to DEST - SRC * DEST */
  38426. static readonly ALPHA_SUBTRACT: number;
  38427. /** Defines that alpha blending to SRC * DEST */
  38428. static readonly ALPHA_MULTIPLY: number;
  38429. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38430. static readonly ALPHA_MAXIMIZED: number;
  38431. /** Defines that alpha blending to SRC + DEST */
  38432. static readonly ALPHA_ONEONE: number;
  38433. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38434. static readonly ALPHA_PREMULTIPLIED: number;
  38435. /**
  38436. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38437. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38438. */
  38439. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38440. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38441. static readonly ALPHA_INTERPOLATE: number;
  38442. /**
  38443. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38444. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38445. */
  38446. static readonly ALPHA_SCREENMODE: number;
  38447. /** Defines that the ressource is not delayed*/
  38448. static readonly DELAYLOADSTATE_NONE: number;
  38449. /** Defines that the ressource was successfully delay loaded */
  38450. static readonly DELAYLOADSTATE_LOADED: number;
  38451. /** Defines that the ressource is currently delay loading */
  38452. static readonly DELAYLOADSTATE_LOADING: number;
  38453. /** Defines that the ressource is delayed and has not started loading */
  38454. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38455. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38456. static readonly NEVER: number;
  38457. /** 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 */
  38458. static readonly ALWAYS: number;
  38459. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38460. static readonly LESS: number;
  38461. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38462. static readonly EQUAL: number;
  38463. /** 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 */
  38464. static readonly LEQUAL: number;
  38465. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38466. static readonly GREATER: number;
  38467. /** 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 */
  38468. static readonly GEQUAL: number;
  38469. /** 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 */
  38470. static readonly NOTEQUAL: number;
  38471. /** Passed to stencilOperation to specify that stencil value must be kept */
  38472. static readonly KEEP: number;
  38473. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38474. static readonly REPLACE: number;
  38475. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38476. static readonly INCR: number;
  38477. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38478. static readonly DECR: number;
  38479. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38480. static readonly INVERT: number;
  38481. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38482. static readonly INCR_WRAP: number;
  38483. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38484. static readonly DECR_WRAP: number;
  38485. /** Texture is not repeating outside of 0..1 UVs */
  38486. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38487. /** Texture is repeating outside of 0..1 UVs */
  38488. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38489. /** Texture is repeating and mirrored */
  38490. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38491. /** ALPHA */
  38492. static readonly TEXTUREFORMAT_ALPHA: number;
  38493. /** LUMINANCE */
  38494. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38495. /** LUMINANCE_ALPHA */
  38496. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38497. /** RGB */
  38498. static readonly TEXTUREFORMAT_RGB: number;
  38499. /** RGBA */
  38500. static readonly TEXTUREFORMAT_RGBA: number;
  38501. /** RED */
  38502. static readonly TEXTUREFORMAT_RED: number;
  38503. /** RED (2nd reference) */
  38504. static readonly TEXTUREFORMAT_R: number;
  38505. /** RG */
  38506. static readonly TEXTUREFORMAT_RG: number;
  38507. /** RED_INTEGER */
  38508. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38509. /** RED_INTEGER (2nd reference) */
  38510. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38511. /** RG_INTEGER */
  38512. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38513. /** RGB_INTEGER */
  38514. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38515. /** RGBA_INTEGER */
  38516. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38517. /** UNSIGNED_BYTE */
  38518. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38519. /** UNSIGNED_BYTE (2nd reference) */
  38520. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38521. /** FLOAT */
  38522. static readonly TEXTURETYPE_FLOAT: number;
  38523. /** HALF_FLOAT */
  38524. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38525. /** BYTE */
  38526. static readonly TEXTURETYPE_BYTE: number;
  38527. /** SHORT */
  38528. static readonly TEXTURETYPE_SHORT: number;
  38529. /** UNSIGNED_SHORT */
  38530. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38531. /** INT */
  38532. static readonly TEXTURETYPE_INT: number;
  38533. /** UNSIGNED_INT */
  38534. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38535. /** UNSIGNED_SHORT_4_4_4_4 */
  38536. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38537. /** UNSIGNED_SHORT_5_5_5_1 */
  38538. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38539. /** UNSIGNED_SHORT_5_6_5 */
  38540. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38541. /** UNSIGNED_INT_2_10_10_10_REV */
  38542. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38543. /** UNSIGNED_INT_24_8 */
  38544. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38545. /** UNSIGNED_INT_10F_11F_11F_REV */
  38546. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38547. /** UNSIGNED_INT_5_9_9_9_REV */
  38548. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38549. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38550. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38551. /** nearest is mag = nearest and min = nearest and mip = linear */
  38552. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38553. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38554. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38555. /** Trilinear is mag = linear and min = linear and mip = linear */
  38556. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38557. /** nearest is mag = nearest and min = nearest and mip = linear */
  38558. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38559. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38560. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38561. /** Trilinear is mag = linear and min = linear and mip = linear */
  38562. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38563. /** mag = nearest and min = nearest and mip = nearest */
  38564. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38565. /** mag = nearest and min = linear and mip = nearest */
  38566. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38567. /** mag = nearest and min = linear and mip = linear */
  38568. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38569. /** mag = nearest and min = linear and mip = none */
  38570. static readonly TEXTURE_NEAREST_LINEAR: number;
  38571. /** mag = nearest and min = nearest and mip = none */
  38572. static readonly TEXTURE_NEAREST_NEAREST: number;
  38573. /** mag = linear and min = nearest and mip = nearest */
  38574. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38575. /** mag = linear and min = nearest and mip = linear */
  38576. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38577. /** mag = linear and min = linear and mip = none */
  38578. static readonly TEXTURE_LINEAR_LINEAR: number;
  38579. /** mag = linear and min = nearest and mip = none */
  38580. static readonly TEXTURE_LINEAR_NEAREST: number;
  38581. /** Explicit coordinates mode */
  38582. static readonly TEXTURE_EXPLICIT_MODE: number;
  38583. /** Spherical coordinates mode */
  38584. static readonly TEXTURE_SPHERICAL_MODE: number;
  38585. /** Planar coordinates mode */
  38586. static readonly TEXTURE_PLANAR_MODE: number;
  38587. /** Cubic coordinates mode */
  38588. static readonly TEXTURE_CUBIC_MODE: number;
  38589. /** Projection coordinates mode */
  38590. static readonly TEXTURE_PROJECTION_MODE: number;
  38591. /** Skybox coordinates mode */
  38592. static readonly TEXTURE_SKYBOX_MODE: number;
  38593. /** Inverse Cubic coordinates mode */
  38594. static readonly TEXTURE_INVCUBIC_MODE: number;
  38595. /** Equirectangular coordinates mode */
  38596. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38597. /** Equirectangular Fixed coordinates mode */
  38598. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38599. /** Equirectangular Fixed Mirrored coordinates mode */
  38600. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38601. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38602. static readonly SCALEMODE_FLOOR: number;
  38603. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38604. static readonly SCALEMODE_NEAREST: number;
  38605. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38606. static readonly SCALEMODE_CEILING: number;
  38607. /**
  38608. * Returns the current npm package of the sdk
  38609. */
  38610. static get NpmPackage(): string;
  38611. /**
  38612. * Returns the current version of the framework
  38613. */
  38614. static get Version(): string;
  38615. /** Gets the list of created engines */
  38616. static get Instances(): Engine[];
  38617. /**
  38618. * Gets the latest created engine
  38619. */
  38620. static get LastCreatedEngine(): Nullable<Engine>;
  38621. /**
  38622. * Gets the latest created scene
  38623. */
  38624. static get LastCreatedScene(): Nullable<Scene>;
  38625. /**
  38626. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38627. * @param flag defines which part of the materials must be marked as dirty
  38628. * @param predicate defines a predicate used to filter which materials should be affected
  38629. */
  38630. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38631. /**
  38632. * Method called to create the default loading screen.
  38633. * This can be overriden in your own app.
  38634. * @param canvas The rendering canvas element
  38635. * @returns The loading screen
  38636. */
  38637. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38638. /**
  38639. * Method called to create the default rescale post process on each engine.
  38640. */
  38641. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38642. /**
  38643. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38644. **/
  38645. enableOfflineSupport: boolean;
  38646. /**
  38647. * 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)
  38648. **/
  38649. disableManifestCheck: boolean;
  38650. /**
  38651. * Gets the list of created scenes
  38652. */
  38653. scenes: Scene[];
  38654. /**
  38655. * Event raised when a new scene is created
  38656. */
  38657. onNewSceneAddedObservable: Observable<Scene>;
  38658. /**
  38659. * Gets the list of created postprocesses
  38660. */
  38661. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38662. /**
  38663. * Gets a boolean indicating if the pointer is currently locked
  38664. */
  38665. isPointerLock: boolean;
  38666. /**
  38667. * Observable event triggered each time the rendering canvas is resized
  38668. */
  38669. onResizeObservable: Observable<Engine>;
  38670. /**
  38671. * Observable event triggered each time the canvas loses focus
  38672. */
  38673. onCanvasBlurObservable: Observable<Engine>;
  38674. /**
  38675. * Observable event triggered each time the canvas gains focus
  38676. */
  38677. onCanvasFocusObservable: Observable<Engine>;
  38678. /**
  38679. * Observable event triggered each time the canvas receives pointerout event
  38680. */
  38681. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38682. /**
  38683. * Observable raised when the engine begins a new frame
  38684. */
  38685. onBeginFrameObservable: Observable<Engine>;
  38686. /**
  38687. * If set, will be used to request the next animation frame for the render loop
  38688. */
  38689. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38690. /**
  38691. * Observable raised when the engine ends the current frame
  38692. */
  38693. onEndFrameObservable: Observable<Engine>;
  38694. /**
  38695. * Observable raised when the engine is about to compile a shader
  38696. */
  38697. onBeforeShaderCompilationObservable: Observable<Engine>;
  38698. /**
  38699. * Observable raised when the engine has jsut compiled a shader
  38700. */
  38701. onAfterShaderCompilationObservable: Observable<Engine>;
  38702. /**
  38703. * Gets the audio engine
  38704. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38705. * @ignorenaming
  38706. */
  38707. static audioEngine: IAudioEngine;
  38708. /**
  38709. * Default AudioEngine factory responsible of creating the Audio Engine.
  38710. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38711. */
  38712. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38713. /**
  38714. * Default offline support factory responsible of creating a tool used to store data locally.
  38715. * By default, this will create a Database object if the workload has been embedded.
  38716. */
  38717. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38718. private _loadingScreen;
  38719. private _pointerLockRequested;
  38720. private _rescalePostProcess;
  38721. private _deterministicLockstep;
  38722. private _lockstepMaxSteps;
  38723. private _timeStep;
  38724. protected get _supportsHardwareTextureRescaling(): boolean;
  38725. private _fps;
  38726. private _deltaTime;
  38727. /** @hidden */
  38728. _drawCalls: PerfCounter;
  38729. /** 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 */
  38730. canvasTabIndex: number;
  38731. /**
  38732. * Turn this value on if you want to pause FPS computation when in background
  38733. */
  38734. disablePerformanceMonitorInBackground: boolean;
  38735. private _performanceMonitor;
  38736. /**
  38737. * Gets the performance monitor attached to this engine
  38738. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38739. */
  38740. get performanceMonitor(): PerformanceMonitor;
  38741. private _onFocus;
  38742. private _onBlur;
  38743. private _onCanvasPointerOut;
  38744. private _onCanvasBlur;
  38745. private _onCanvasFocus;
  38746. private _onFullscreenChange;
  38747. private _onPointerLockChange;
  38748. /**
  38749. * Gets the HTML element used to attach event listeners
  38750. * @returns a HTML element
  38751. */
  38752. getInputElement(): Nullable<HTMLElement>;
  38753. /**
  38754. * Creates a new engine
  38755. * @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
  38756. * @param antialias defines enable antialiasing (default: false)
  38757. * @param options defines further options to be sent to the getContext() function
  38758. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38759. */
  38760. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38761. /**
  38762. * Gets current aspect ratio
  38763. * @param viewportOwner defines the camera to use to get the aspect ratio
  38764. * @param useScreen defines if screen size must be used (or the current render target if any)
  38765. * @returns a number defining the aspect ratio
  38766. */
  38767. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38768. /**
  38769. * Gets current screen aspect ratio
  38770. * @returns a number defining the aspect ratio
  38771. */
  38772. getScreenAspectRatio(): number;
  38773. /**
  38774. * Gets the client rect of the HTML canvas attached with the current webGL context
  38775. * @returns a client rectanglee
  38776. */
  38777. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38778. /**
  38779. * Gets the client rect of the HTML element used for events
  38780. * @returns a client rectanglee
  38781. */
  38782. getInputElementClientRect(): Nullable<ClientRect>;
  38783. /**
  38784. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38785. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38786. * @returns true if engine is in deterministic lock step mode
  38787. */
  38788. isDeterministicLockStep(): boolean;
  38789. /**
  38790. * Gets the max steps when engine is running in deterministic lock step
  38791. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38792. * @returns the max steps
  38793. */
  38794. getLockstepMaxSteps(): number;
  38795. /**
  38796. * Returns the time in ms between steps when using deterministic lock step.
  38797. * @returns time step in (ms)
  38798. */
  38799. getTimeStep(): number;
  38800. /**
  38801. * Force the mipmap generation for the given render target texture
  38802. * @param texture defines the render target texture to use
  38803. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38804. */
  38805. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38806. /** States */
  38807. /**
  38808. * Set various states to the webGL context
  38809. * @param culling defines backface culling state
  38810. * @param zOffset defines the value to apply to zOffset (0 by default)
  38811. * @param force defines if states must be applied even if cache is up to date
  38812. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38813. */
  38814. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38815. /**
  38816. * Set the z offset to apply to current rendering
  38817. * @param value defines the offset to apply
  38818. */
  38819. setZOffset(value: number): void;
  38820. /**
  38821. * Gets the current value of the zOffset
  38822. * @returns the current zOffset state
  38823. */
  38824. getZOffset(): number;
  38825. /**
  38826. * Enable or disable depth buffering
  38827. * @param enable defines the state to set
  38828. */
  38829. setDepthBuffer(enable: boolean): void;
  38830. /**
  38831. * Gets a boolean indicating if depth writing is enabled
  38832. * @returns the current depth writing state
  38833. */
  38834. getDepthWrite(): boolean;
  38835. /**
  38836. * Enable or disable depth writing
  38837. * @param enable defines the state to set
  38838. */
  38839. setDepthWrite(enable: boolean): void;
  38840. /**
  38841. * Gets a boolean indicating if stencil buffer is enabled
  38842. * @returns the current stencil buffer state
  38843. */
  38844. getStencilBuffer(): boolean;
  38845. /**
  38846. * Enable or disable the stencil buffer
  38847. * @param enable defines if the stencil buffer must be enabled or disabled
  38848. */
  38849. setStencilBuffer(enable: boolean): void;
  38850. /**
  38851. * Gets the current stencil mask
  38852. * @returns a number defining the new stencil mask to use
  38853. */
  38854. getStencilMask(): number;
  38855. /**
  38856. * Sets the current stencil mask
  38857. * @param mask defines the new stencil mask to use
  38858. */
  38859. setStencilMask(mask: number): void;
  38860. /**
  38861. * Gets the current stencil function
  38862. * @returns a number defining the stencil function to use
  38863. */
  38864. getStencilFunction(): number;
  38865. /**
  38866. * Gets the current stencil reference value
  38867. * @returns a number defining the stencil reference value to use
  38868. */
  38869. getStencilFunctionReference(): number;
  38870. /**
  38871. * Gets the current stencil mask
  38872. * @returns a number defining the stencil mask to use
  38873. */
  38874. getStencilFunctionMask(): number;
  38875. /**
  38876. * Sets the current stencil function
  38877. * @param stencilFunc defines the new stencil function to use
  38878. */
  38879. setStencilFunction(stencilFunc: number): void;
  38880. /**
  38881. * Sets the current stencil reference
  38882. * @param reference defines the new stencil reference to use
  38883. */
  38884. setStencilFunctionReference(reference: number): void;
  38885. /**
  38886. * Sets the current stencil mask
  38887. * @param mask defines the new stencil mask to use
  38888. */
  38889. setStencilFunctionMask(mask: number): void;
  38890. /**
  38891. * Gets the current stencil operation when stencil fails
  38892. * @returns a number defining stencil operation to use when stencil fails
  38893. */
  38894. getStencilOperationFail(): number;
  38895. /**
  38896. * Gets the current stencil operation when depth fails
  38897. * @returns a number defining stencil operation to use when depth fails
  38898. */
  38899. getStencilOperationDepthFail(): number;
  38900. /**
  38901. * Gets the current stencil operation when stencil passes
  38902. * @returns a number defining stencil operation to use when stencil passes
  38903. */
  38904. getStencilOperationPass(): number;
  38905. /**
  38906. * Sets the stencil operation to use when stencil fails
  38907. * @param operation defines the stencil operation to use when stencil fails
  38908. */
  38909. setStencilOperationFail(operation: number): void;
  38910. /**
  38911. * Sets the stencil operation to use when depth fails
  38912. * @param operation defines the stencil operation to use when depth fails
  38913. */
  38914. setStencilOperationDepthFail(operation: number): void;
  38915. /**
  38916. * Sets the stencil operation to use when stencil passes
  38917. * @param operation defines the stencil operation to use when stencil passes
  38918. */
  38919. setStencilOperationPass(operation: number): void;
  38920. /**
  38921. * Sets a boolean indicating if the dithering state is enabled or disabled
  38922. * @param value defines the dithering state
  38923. */
  38924. setDitheringState(value: boolean): void;
  38925. /**
  38926. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  38927. * @param value defines the rasterizer state
  38928. */
  38929. setRasterizerState(value: boolean): void;
  38930. /**
  38931. * Gets the current depth function
  38932. * @returns a number defining the depth function
  38933. */
  38934. getDepthFunction(): Nullable<number>;
  38935. /**
  38936. * Sets the current depth function
  38937. * @param depthFunc defines the function to use
  38938. */
  38939. setDepthFunction(depthFunc: number): void;
  38940. /**
  38941. * Sets the current depth function to GREATER
  38942. */
  38943. setDepthFunctionToGreater(): void;
  38944. /**
  38945. * Sets the current depth function to GEQUAL
  38946. */
  38947. setDepthFunctionToGreaterOrEqual(): void;
  38948. /**
  38949. * Sets the current depth function to LESS
  38950. */
  38951. setDepthFunctionToLess(): void;
  38952. /**
  38953. * Sets the current depth function to LEQUAL
  38954. */
  38955. setDepthFunctionToLessOrEqual(): void;
  38956. private _cachedStencilBuffer;
  38957. private _cachedStencilFunction;
  38958. private _cachedStencilMask;
  38959. private _cachedStencilOperationPass;
  38960. private _cachedStencilOperationFail;
  38961. private _cachedStencilOperationDepthFail;
  38962. private _cachedStencilReference;
  38963. /**
  38964. * Caches the the state of the stencil buffer
  38965. */
  38966. cacheStencilState(): void;
  38967. /**
  38968. * Restores the state of the stencil buffer
  38969. */
  38970. restoreStencilState(): void;
  38971. /**
  38972. * Directly set the WebGL Viewport
  38973. * @param x defines the x coordinate of the viewport (in screen space)
  38974. * @param y defines the y coordinate of the viewport (in screen space)
  38975. * @param width defines the width of the viewport (in screen space)
  38976. * @param height defines the height of the viewport (in screen space)
  38977. * @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
  38978. */
  38979. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  38980. /**
  38981. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  38982. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38983. * @param y defines the y-coordinate of the corner of the clear rectangle
  38984. * @param width defines the width of the clear rectangle
  38985. * @param height defines the height of the clear rectangle
  38986. * @param clearColor defines the clear color
  38987. */
  38988. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  38989. /**
  38990. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  38991. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38992. * @param y defines the y-coordinate of the corner of the clear rectangle
  38993. * @param width defines the width of the clear rectangle
  38994. * @param height defines the height of the clear rectangle
  38995. */
  38996. enableScissor(x: number, y: number, width: number, height: number): void;
  38997. /**
  38998. * Disable previously set scissor test rectangle
  38999. */
  39000. disableScissor(): void;
  39001. protected _reportDrawCall(): void;
  39002. /**
  39003. * Initializes a webVR display and starts listening to display change events
  39004. * The onVRDisplayChangedObservable will be notified upon these changes
  39005. * @returns The onVRDisplayChangedObservable
  39006. */
  39007. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39008. /** @hidden */
  39009. _prepareVRComponent(): void;
  39010. /** @hidden */
  39011. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39012. /** @hidden */
  39013. _submitVRFrame(): void;
  39014. /**
  39015. * Call this function to leave webVR mode
  39016. * Will do nothing if webVR is not supported or if there is no webVR device
  39017. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39018. */
  39019. disableVR(): void;
  39020. /**
  39021. * Gets a boolean indicating that the system is in VR mode and is presenting
  39022. * @returns true if VR mode is engaged
  39023. */
  39024. isVRPresenting(): boolean;
  39025. /** @hidden */
  39026. _requestVRFrame(): void;
  39027. /** @hidden */
  39028. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39029. /**
  39030. * Gets the source code of the vertex shader associated with a specific webGL program
  39031. * @param program defines the program to use
  39032. * @returns a string containing the source code of the vertex shader associated with the program
  39033. */
  39034. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39035. /**
  39036. * Gets the source code of the fragment shader associated with a specific webGL program
  39037. * @param program defines the program to use
  39038. * @returns a string containing the source code of the fragment shader associated with the program
  39039. */
  39040. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39041. /**
  39042. * Sets a depth stencil texture from a render target to the according uniform.
  39043. * @param channel The texture channel
  39044. * @param uniform The uniform to set
  39045. * @param texture The render target texture containing the depth stencil texture to apply
  39046. */
  39047. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39048. /**
  39049. * Sets a texture to the webGL context from a postprocess
  39050. * @param channel defines the channel to use
  39051. * @param postProcess defines the source postprocess
  39052. */
  39053. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39054. /**
  39055. * Binds the output of the passed in post process to the texture channel specified
  39056. * @param channel The channel the texture should be bound to
  39057. * @param postProcess The post process which's output should be bound
  39058. */
  39059. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39060. protected _rebuildBuffers(): void;
  39061. /** @hidden */
  39062. _renderFrame(): void;
  39063. _renderLoop(): void;
  39064. /** @hidden */
  39065. _renderViews(): boolean;
  39066. /**
  39067. * Toggle full screen mode
  39068. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39069. */
  39070. switchFullscreen(requestPointerLock: boolean): void;
  39071. /**
  39072. * Enters full screen mode
  39073. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39074. */
  39075. enterFullscreen(requestPointerLock: boolean): void;
  39076. /**
  39077. * Exits full screen mode
  39078. */
  39079. exitFullscreen(): void;
  39080. /**
  39081. * Enters Pointerlock mode
  39082. */
  39083. enterPointerlock(): void;
  39084. /**
  39085. * Exits Pointerlock mode
  39086. */
  39087. exitPointerlock(): void;
  39088. /**
  39089. * Begin a new frame
  39090. */
  39091. beginFrame(): void;
  39092. /**
  39093. * Enf the current frame
  39094. */
  39095. endFrame(): void;
  39096. resize(): void;
  39097. /**
  39098. * Force a specific size of the canvas
  39099. * @param width defines the new canvas' width
  39100. * @param height defines the new canvas' height
  39101. * @returns true if the size was changed
  39102. */
  39103. setSize(width: number, height: number): boolean;
  39104. /**
  39105. * Updates a dynamic vertex buffer.
  39106. * @param vertexBuffer the vertex buffer to update
  39107. * @param data the data used to update the vertex buffer
  39108. * @param byteOffset the byte offset of the data
  39109. * @param byteLength the byte length of the data
  39110. */
  39111. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  39112. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39113. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39114. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39115. _releaseTexture(texture: InternalTexture): void;
  39116. /**
  39117. * @hidden
  39118. * Rescales a texture
  39119. * @param source input texutre
  39120. * @param destination destination texture
  39121. * @param scene scene to use to render the resize
  39122. * @param internalFormat format to use when resizing
  39123. * @param onComplete callback to be called when resize has completed
  39124. */
  39125. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39126. /**
  39127. * Gets the current framerate
  39128. * @returns a number representing the framerate
  39129. */
  39130. getFps(): number;
  39131. /**
  39132. * Gets the time spent between current and previous frame
  39133. * @returns a number representing the delta time in ms
  39134. */
  39135. getDeltaTime(): number;
  39136. private _measureFps;
  39137. /** @hidden */
  39138. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39139. /**
  39140. * Update a dynamic index buffer
  39141. * @param indexBuffer defines the target index buffer
  39142. * @param indices defines the data to update
  39143. * @param offset defines the offset in the target index buffer where update should start
  39144. */
  39145. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  39146. /**
  39147. * Updates the sample count of a render target texture
  39148. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39149. * @param texture defines the texture to update
  39150. * @param samples defines the sample count to set
  39151. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39152. */
  39153. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39154. /**
  39155. * Updates a depth texture Comparison Mode and Function.
  39156. * If the comparison Function is equal to 0, the mode will be set to none.
  39157. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39158. * @param texture The texture to set the comparison function for
  39159. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39160. */
  39161. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39162. /**
  39163. * Creates a webGL buffer to use with instanciation
  39164. * @param capacity defines the size of the buffer
  39165. * @returns the webGL buffer
  39166. */
  39167. createInstancesBuffer(capacity: number): DataBuffer;
  39168. /**
  39169. * Delete a webGL buffer used with instanciation
  39170. * @param buffer defines the webGL buffer to delete
  39171. */
  39172. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39173. private _clientWaitAsync;
  39174. /** @hidden */
  39175. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39176. dispose(): void;
  39177. private _disableTouchAction;
  39178. /**
  39179. * Display the loading screen
  39180. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39181. */
  39182. displayLoadingUI(): void;
  39183. /**
  39184. * Hide the loading screen
  39185. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39186. */
  39187. hideLoadingUI(): void;
  39188. /**
  39189. * Gets the current loading screen object
  39190. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39191. */
  39192. get loadingScreen(): ILoadingScreen;
  39193. /**
  39194. * Sets the current loading screen object
  39195. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39196. */
  39197. set loadingScreen(loadingScreen: ILoadingScreen);
  39198. /**
  39199. * Sets the current loading screen text
  39200. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39201. */
  39202. set loadingUIText(text: string);
  39203. /**
  39204. * Sets the current loading screen background color
  39205. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39206. */
  39207. set loadingUIBackgroundColor(color: string);
  39208. /** Pointerlock and fullscreen */
  39209. /**
  39210. * Ask the browser to promote the current element to pointerlock mode
  39211. * @param element defines the DOM element to promote
  39212. */
  39213. static _RequestPointerlock(element: HTMLElement): void;
  39214. /**
  39215. * Asks the browser to exit pointerlock mode
  39216. */
  39217. static _ExitPointerlock(): void;
  39218. /**
  39219. * Ask the browser to promote the current element to fullscreen rendering mode
  39220. * @param element defines the DOM element to promote
  39221. */
  39222. static _RequestFullscreen(element: HTMLElement): void;
  39223. /**
  39224. * Asks the browser to exit fullscreen mode
  39225. */
  39226. static _ExitFullscreen(): void;
  39227. }
  39228. }
  39229. declare module "babylonjs/Engines/engineStore" {
  39230. import { Nullable } from "babylonjs/types";
  39231. import { Engine } from "babylonjs/Engines/engine";
  39232. import { Scene } from "babylonjs/scene";
  39233. /**
  39234. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39235. * during the life time of the application.
  39236. */
  39237. export class EngineStore {
  39238. /** Gets the list of created engines */
  39239. static Instances: import("babylonjs/Engines/engine").Engine[];
  39240. /** @hidden */
  39241. static _LastCreatedScene: Nullable<Scene>;
  39242. /**
  39243. * Gets the latest created engine
  39244. */
  39245. static get LastCreatedEngine(): Nullable<Engine>;
  39246. /**
  39247. * Gets the latest created scene
  39248. */
  39249. static get LastCreatedScene(): Nullable<Scene>;
  39250. /**
  39251. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39252. * @ignorenaming
  39253. */
  39254. static UseFallbackTexture: boolean;
  39255. /**
  39256. * Texture content used if a texture cannot loaded
  39257. * @ignorenaming
  39258. */
  39259. static FallbackTexture: string;
  39260. }
  39261. }
  39262. declare module "babylonjs/Misc/promise" {
  39263. /**
  39264. * Helper class that provides a small promise polyfill
  39265. */
  39266. export class PromisePolyfill {
  39267. /**
  39268. * Static function used to check if the polyfill is required
  39269. * If this is the case then the function will inject the polyfill to window.Promise
  39270. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39271. */
  39272. static Apply(force?: boolean): void;
  39273. }
  39274. }
  39275. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39276. /**
  39277. * Interface for screenshot methods with describe argument called `size` as object with options
  39278. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39279. */
  39280. export interface IScreenshotSize {
  39281. /**
  39282. * number in pixels for canvas height
  39283. */
  39284. height?: number;
  39285. /**
  39286. * multiplier allowing render at a higher or lower resolution
  39287. * If value is defined then height and width will be ignored and taken from camera
  39288. */
  39289. precision?: number;
  39290. /**
  39291. * number in pixels for canvas width
  39292. */
  39293. width?: number;
  39294. }
  39295. }
  39296. declare module "babylonjs/Misc/tools" {
  39297. import { Nullable, float } from "babylonjs/types";
  39298. import { DomManagement } from "babylonjs/Misc/domManagement";
  39299. import { WebRequest } from "babylonjs/Misc/webRequest";
  39300. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39301. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39302. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39303. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39304. import { Camera } from "babylonjs/Cameras/camera";
  39305. import { Engine } from "babylonjs/Engines/engine";
  39306. interface IColor4Like {
  39307. r: float;
  39308. g: float;
  39309. b: float;
  39310. a: float;
  39311. }
  39312. /**
  39313. * Class containing a set of static utilities functions
  39314. */
  39315. export class Tools {
  39316. /**
  39317. * Gets or sets the base URL to use to load assets
  39318. */
  39319. static get BaseUrl(): string;
  39320. static set BaseUrl(value: string);
  39321. /**
  39322. * Enable/Disable Custom HTTP Request Headers globally.
  39323. * default = false
  39324. * @see CustomRequestHeaders
  39325. */
  39326. static UseCustomRequestHeaders: boolean;
  39327. /**
  39328. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39329. * i.e. when loading files, where the server/service expects an Authorization header
  39330. */
  39331. static CustomRequestHeaders: {
  39332. [key: string]: string;
  39333. };
  39334. /**
  39335. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39336. */
  39337. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39338. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39339. /**
  39340. * Default behaviour for cors in the application.
  39341. * It can be a string if the expected behavior is identical in the entire app.
  39342. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39343. */
  39344. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39345. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39346. /**
  39347. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39348. * @ignorenaming
  39349. */
  39350. static get UseFallbackTexture(): boolean;
  39351. static set UseFallbackTexture(value: boolean);
  39352. /**
  39353. * Use this object to register external classes like custom textures or material
  39354. * to allow the laoders to instantiate them
  39355. */
  39356. static get RegisteredExternalClasses(): {
  39357. [key: string]: Object;
  39358. };
  39359. static set RegisteredExternalClasses(classes: {
  39360. [key: string]: Object;
  39361. });
  39362. /**
  39363. * Texture content used if a texture cannot loaded
  39364. * @ignorenaming
  39365. */
  39366. static get fallbackTexture(): string;
  39367. static set fallbackTexture(value: string);
  39368. /**
  39369. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39370. * @param u defines the coordinate on X axis
  39371. * @param v defines the coordinate on Y axis
  39372. * @param width defines the width of the source data
  39373. * @param height defines the height of the source data
  39374. * @param pixels defines the source byte array
  39375. * @param color defines the output color
  39376. */
  39377. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39378. /**
  39379. * Interpolates between a and b via alpha
  39380. * @param a The lower value (returned when alpha = 0)
  39381. * @param b The upper value (returned when alpha = 1)
  39382. * @param alpha The interpolation-factor
  39383. * @return The mixed value
  39384. */
  39385. static Mix(a: number, b: number, alpha: number): number;
  39386. /**
  39387. * Tries to instantiate a new object from a given class name
  39388. * @param className defines the class name to instantiate
  39389. * @returns the new object or null if the system was not able to do the instantiation
  39390. */
  39391. static Instantiate(className: string): any;
  39392. /**
  39393. * Provides a slice function that will work even on IE
  39394. * @param data defines the array to slice
  39395. * @param start defines the start of the data (optional)
  39396. * @param end defines the end of the data (optional)
  39397. * @returns the new sliced array
  39398. */
  39399. static Slice<T>(data: T, start?: number, end?: number): T;
  39400. /**
  39401. * Polyfill for setImmediate
  39402. * @param action defines the action to execute after the current execution block
  39403. */
  39404. static SetImmediate(action: () => void): void;
  39405. /**
  39406. * Function indicating if a number is an exponent of 2
  39407. * @param value defines the value to test
  39408. * @returns true if the value is an exponent of 2
  39409. */
  39410. static IsExponentOfTwo(value: number): boolean;
  39411. private static _tmpFloatArray;
  39412. /**
  39413. * Returns the nearest 32-bit single precision float representation of a Number
  39414. * @param value A Number. If the parameter is of a different type, it will get converted
  39415. * to a number or to NaN if it cannot be converted
  39416. * @returns number
  39417. */
  39418. static FloatRound(value: number): number;
  39419. /**
  39420. * Extracts the filename from a path
  39421. * @param path defines the path to use
  39422. * @returns the filename
  39423. */
  39424. static GetFilename(path: string): string;
  39425. /**
  39426. * Extracts the "folder" part of a path (everything before the filename).
  39427. * @param uri The URI to extract the info from
  39428. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39429. * @returns The "folder" part of the path
  39430. */
  39431. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39432. /**
  39433. * Extracts text content from a DOM element hierarchy
  39434. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39435. */
  39436. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39437. /**
  39438. * Convert an angle in radians to degrees
  39439. * @param angle defines the angle to convert
  39440. * @returns the angle in degrees
  39441. */
  39442. static ToDegrees(angle: number): number;
  39443. /**
  39444. * Convert an angle in degrees to radians
  39445. * @param angle defines the angle to convert
  39446. * @returns the angle in radians
  39447. */
  39448. static ToRadians(angle: number): number;
  39449. /**
  39450. * Returns an array if obj is not an array
  39451. * @param obj defines the object to evaluate as an array
  39452. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39453. * @returns either obj directly if obj is an array or a new array containing obj
  39454. */
  39455. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39456. /**
  39457. * Gets the pointer prefix to use
  39458. * @param engine defines the engine we are finding the prefix for
  39459. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39460. */
  39461. static GetPointerPrefix(engine: Engine): string;
  39462. /**
  39463. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39464. * @param url define the url we are trying
  39465. * @param element define the dom element where to configure the cors policy
  39466. */
  39467. static SetCorsBehavior(url: string | string[], element: {
  39468. crossOrigin: string | null;
  39469. }): void;
  39470. /**
  39471. * Removes unwanted characters from an url
  39472. * @param url defines the url to clean
  39473. * @returns the cleaned url
  39474. */
  39475. static CleanUrl(url: string): string;
  39476. /**
  39477. * Gets or sets a function used to pre-process url before using them to load assets
  39478. */
  39479. static get PreprocessUrl(): (url: string) => string;
  39480. static set PreprocessUrl(processor: (url: string) => string);
  39481. /**
  39482. * Loads an image as an HTMLImageElement.
  39483. * @param input url string, ArrayBuffer, or Blob to load
  39484. * @param onLoad callback called when the image successfully loads
  39485. * @param onError callback called when the image fails to load
  39486. * @param offlineProvider offline provider for caching
  39487. * @param mimeType optional mime type
  39488. * @returns the HTMLImageElement of the loaded image
  39489. */
  39490. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39491. /**
  39492. * Loads a file from a url
  39493. * @param url url string, ArrayBuffer, or Blob to load
  39494. * @param onSuccess callback called when the file successfully loads
  39495. * @param onProgress callback called while file is loading (if the server supports this mode)
  39496. * @param offlineProvider defines the offline provider for caching
  39497. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39498. * @param onError callback called when the file fails to load
  39499. * @returns a file request object
  39500. */
  39501. 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;
  39502. /**
  39503. * Loads a file from a url
  39504. * @param url the file url to load
  39505. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39506. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39507. */
  39508. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39509. /**
  39510. * Load a script (identified by an url). When the url returns, the
  39511. * content of this file is added into a new script element, attached to the DOM (body element)
  39512. * @param scriptUrl defines the url of the script to laod
  39513. * @param onSuccess defines the callback called when the script is loaded
  39514. * @param onError defines the callback to call if an error occurs
  39515. * @param scriptId defines the id of the script element
  39516. */
  39517. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39518. /**
  39519. * Load an asynchronous script (identified by an url). When the url returns, the
  39520. * content of this file is added into a new script element, attached to the DOM (body element)
  39521. * @param scriptUrl defines the url of the script to laod
  39522. * @param scriptId defines the id of the script element
  39523. * @returns a promise request object
  39524. */
  39525. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39526. /**
  39527. * Loads a file from a blob
  39528. * @param fileToLoad defines the blob to use
  39529. * @param callback defines the callback to call when data is loaded
  39530. * @param progressCallback defines the callback to call during loading process
  39531. * @returns a file request object
  39532. */
  39533. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39534. /**
  39535. * Reads a file from a File object
  39536. * @param file defines the file to load
  39537. * @param onSuccess defines the callback to call when data is loaded
  39538. * @param onProgress defines the callback to call during loading process
  39539. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39540. * @param onError defines the callback to call when an error occurs
  39541. * @returns a file request object
  39542. */
  39543. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39544. /**
  39545. * Creates a data url from a given string content
  39546. * @param content defines the content to convert
  39547. * @returns the new data url link
  39548. */
  39549. static FileAsURL(content: string): string;
  39550. /**
  39551. * Format the given number to a specific decimal format
  39552. * @param value defines the number to format
  39553. * @param decimals defines the number of decimals to use
  39554. * @returns the formatted string
  39555. */
  39556. static Format(value: number, decimals?: number): string;
  39557. /**
  39558. * Tries to copy an object by duplicating every property
  39559. * @param source defines the source object
  39560. * @param destination defines the target object
  39561. * @param doNotCopyList defines a list of properties to avoid
  39562. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39563. */
  39564. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39565. /**
  39566. * Gets a boolean indicating if the given object has no own property
  39567. * @param obj defines the object to test
  39568. * @returns true if object has no own property
  39569. */
  39570. static IsEmpty(obj: any): boolean;
  39571. /**
  39572. * Function used to register events at window level
  39573. * @param windowElement defines the Window object to use
  39574. * @param events defines the events to register
  39575. */
  39576. static RegisterTopRootEvents(windowElement: Window, events: {
  39577. name: string;
  39578. handler: Nullable<(e: FocusEvent) => any>;
  39579. }[]): void;
  39580. /**
  39581. * Function used to unregister events from window level
  39582. * @param windowElement defines the Window object to use
  39583. * @param events defines the events to unregister
  39584. */
  39585. static UnregisterTopRootEvents(windowElement: Window, events: {
  39586. name: string;
  39587. handler: Nullable<(e: FocusEvent) => any>;
  39588. }[]): void;
  39589. /**
  39590. * @ignore
  39591. */
  39592. static _ScreenshotCanvas: HTMLCanvasElement;
  39593. /**
  39594. * Dumps the current bound framebuffer
  39595. * @param width defines the rendering width
  39596. * @param height defines the rendering height
  39597. * @param engine defines the hosting engine
  39598. * @param successCallback defines the callback triggered once the data are available
  39599. * @param mimeType defines the mime type of the result
  39600. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39601. */
  39602. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39603. /**
  39604. * Converts the canvas data to blob.
  39605. * This acts as a polyfill for browsers not supporting the to blob function.
  39606. * @param canvas Defines the canvas to extract the data from
  39607. * @param successCallback Defines the callback triggered once the data are available
  39608. * @param mimeType Defines the mime type of the result
  39609. */
  39610. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39611. /**
  39612. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39613. * @param successCallback defines the callback triggered once the data are available
  39614. * @param mimeType defines the mime type of the result
  39615. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39616. */
  39617. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39618. /**
  39619. * Downloads a blob in the browser
  39620. * @param blob defines the blob to download
  39621. * @param fileName defines the name of the downloaded file
  39622. */
  39623. static Download(blob: Blob, fileName: string): void;
  39624. /**
  39625. * Captures a screenshot of the current rendering
  39626. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39627. * @param engine defines the rendering engine
  39628. * @param camera defines the source camera
  39629. * @param size This parameter can be set to a single number or to an object with the
  39630. * following (optional) properties: precision, width, height. If a single number is passed,
  39631. * it will be used for both width and height. If an object is passed, the screenshot size
  39632. * will be derived from the parameters. The precision property is a multiplier allowing
  39633. * rendering at a higher or lower resolution
  39634. * @param successCallback defines the callback receives a single parameter which contains the
  39635. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39636. * src parameter of an <img> to display it
  39637. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39638. * Check your browser for supported MIME types
  39639. */
  39640. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39641. /**
  39642. * Captures a screenshot of the current rendering
  39643. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39644. * @param engine defines the rendering engine
  39645. * @param camera defines the source camera
  39646. * @param size This parameter can be set to a single number or to an object with the
  39647. * following (optional) properties: precision, width, height. If a single number is passed,
  39648. * it will be used for both width and height. If an object is passed, the screenshot size
  39649. * will be derived from the parameters. The precision property is a multiplier allowing
  39650. * rendering at a higher or lower resolution
  39651. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39652. * Check your browser for supported MIME types
  39653. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39654. * to the src parameter of an <img> to display it
  39655. */
  39656. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39657. /**
  39658. * Generates an image screenshot from the specified camera.
  39659. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39660. * @param engine The engine to use for rendering
  39661. * @param camera The camera to use for rendering
  39662. * @param size This parameter can be set to a single number or to an object with the
  39663. * following (optional) properties: precision, width, height. If a single number is passed,
  39664. * it will be used for both width and height. If an object is passed, the screenshot size
  39665. * will be derived from the parameters. The precision property is a multiplier allowing
  39666. * rendering at a higher or lower resolution
  39667. * @param successCallback The callback receives a single parameter which contains the
  39668. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39669. * src parameter of an <img> to display it
  39670. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39671. * Check your browser for supported MIME types
  39672. * @param samples Texture samples (default: 1)
  39673. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39674. * @param fileName A name for for the downloaded file.
  39675. */
  39676. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39677. /**
  39678. * Generates an image screenshot from the specified camera.
  39679. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39680. * @param engine The engine to use for rendering
  39681. * @param camera The camera to use for rendering
  39682. * @param size This parameter can be set to a single number or to an object with the
  39683. * following (optional) properties: precision, width, height. If a single number is passed,
  39684. * it will be used for both width and height. If an object is passed, the screenshot size
  39685. * will be derived from the parameters. The precision property is a multiplier allowing
  39686. * rendering at a higher or lower resolution
  39687. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39688. * Check your browser for supported MIME types
  39689. * @param samples Texture samples (default: 1)
  39690. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39691. * @param fileName A name for for the downloaded file.
  39692. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39693. * to the src parameter of an <img> to display it
  39694. */
  39695. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39696. /**
  39697. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39698. * Be aware Math.random() could cause collisions, but:
  39699. * "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"
  39700. * @returns a pseudo random id
  39701. */
  39702. static RandomId(): string;
  39703. /**
  39704. * Test if the given uri is a base64 string
  39705. * @param uri The uri to test
  39706. * @return True if the uri is a base64 string or false otherwise
  39707. */
  39708. static IsBase64(uri: string): boolean;
  39709. /**
  39710. * Decode the given base64 uri.
  39711. * @param uri The uri to decode
  39712. * @return The decoded base64 data.
  39713. */
  39714. static DecodeBase64(uri: string): ArrayBuffer;
  39715. /**
  39716. * Gets the absolute url.
  39717. * @param url the input url
  39718. * @return the absolute url
  39719. */
  39720. static GetAbsoluteUrl(url: string): string;
  39721. /**
  39722. * No log
  39723. */
  39724. static readonly NoneLogLevel: number;
  39725. /**
  39726. * Only message logs
  39727. */
  39728. static readonly MessageLogLevel: number;
  39729. /**
  39730. * Only warning logs
  39731. */
  39732. static readonly WarningLogLevel: number;
  39733. /**
  39734. * Only error logs
  39735. */
  39736. static readonly ErrorLogLevel: number;
  39737. /**
  39738. * All logs
  39739. */
  39740. static readonly AllLogLevel: number;
  39741. /**
  39742. * Gets a value indicating the number of loading errors
  39743. * @ignorenaming
  39744. */
  39745. static get errorsCount(): number;
  39746. /**
  39747. * Callback called when a new log is added
  39748. */
  39749. static OnNewCacheEntry: (entry: string) => void;
  39750. /**
  39751. * Log a message to the console
  39752. * @param message defines the message to log
  39753. */
  39754. static Log(message: string): void;
  39755. /**
  39756. * Write a warning message to the console
  39757. * @param message defines the message to log
  39758. */
  39759. static Warn(message: string): void;
  39760. /**
  39761. * Write an error message to the console
  39762. * @param message defines the message to log
  39763. */
  39764. static Error(message: string): void;
  39765. /**
  39766. * Gets current log cache (list of logs)
  39767. */
  39768. static get LogCache(): string;
  39769. /**
  39770. * Clears the log cache
  39771. */
  39772. static ClearLogCache(): void;
  39773. /**
  39774. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39775. */
  39776. static set LogLevels(level: number);
  39777. /**
  39778. * Checks if the window object exists
  39779. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39780. */
  39781. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39782. /**
  39783. * No performance log
  39784. */
  39785. static readonly PerformanceNoneLogLevel: number;
  39786. /**
  39787. * Use user marks to log performance
  39788. */
  39789. static readonly PerformanceUserMarkLogLevel: number;
  39790. /**
  39791. * Log performance to the console
  39792. */
  39793. static readonly PerformanceConsoleLogLevel: number;
  39794. private static _performance;
  39795. /**
  39796. * Sets the current performance log level
  39797. */
  39798. static set PerformanceLogLevel(level: number);
  39799. private static _StartPerformanceCounterDisabled;
  39800. private static _EndPerformanceCounterDisabled;
  39801. private static _StartUserMark;
  39802. private static _EndUserMark;
  39803. private static _StartPerformanceConsole;
  39804. private static _EndPerformanceConsole;
  39805. /**
  39806. * Starts a performance counter
  39807. */
  39808. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39809. /**
  39810. * Ends a specific performance coutner
  39811. */
  39812. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39813. /**
  39814. * Gets either window.performance.now() if supported or Date.now() else
  39815. */
  39816. static get Now(): number;
  39817. /**
  39818. * This method will return the name of the class used to create the instance of the given object.
  39819. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39820. * @param object the object to get the class name from
  39821. * @param isType defines if the object is actually a type
  39822. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39823. */
  39824. static GetClassName(object: any, isType?: boolean): string;
  39825. /**
  39826. * Gets the first element of an array satisfying a given predicate
  39827. * @param array defines the array to browse
  39828. * @param predicate defines the predicate to use
  39829. * @returns null if not found or the element
  39830. */
  39831. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39832. /**
  39833. * This method will return the name of the full name of the class, including its owning module (if any).
  39834. * 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).
  39835. * @param object the object to get the class name from
  39836. * @param isType defines if the object is actually a type
  39837. * @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.
  39838. * @ignorenaming
  39839. */
  39840. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  39841. /**
  39842. * Returns a promise that resolves after the given amount of time.
  39843. * @param delay Number of milliseconds to delay
  39844. * @returns Promise that resolves after the given amount of time
  39845. */
  39846. static DelayAsync(delay: number): Promise<void>;
  39847. /**
  39848. * Utility function to detect if the current user agent is Safari
  39849. * @returns whether or not the current user agent is safari
  39850. */
  39851. static IsSafari(): boolean;
  39852. }
  39853. /**
  39854. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  39855. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  39856. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  39857. * @param name The name of the class, case should be preserved
  39858. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  39859. */
  39860. export function className(name: string, module?: string): (target: Object) => void;
  39861. /**
  39862. * An implementation of a loop for asynchronous functions.
  39863. */
  39864. export class AsyncLoop {
  39865. /**
  39866. * Defines the number of iterations for the loop
  39867. */
  39868. iterations: number;
  39869. /**
  39870. * Defines the current index of the loop.
  39871. */
  39872. index: number;
  39873. private _done;
  39874. private _fn;
  39875. private _successCallback;
  39876. /**
  39877. * Constructor.
  39878. * @param iterations the number of iterations.
  39879. * @param func the function to run each iteration
  39880. * @param successCallback the callback that will be called upon succesful execution
  39881. * @param offset starting offset.
  39882. */
  39883. constructor(
  39884. /**
  39885. * Defines the number of iterations for the loop
  39886. */
  39887. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  39888. /**
  39889. * Execute the next iteration. Must be called after the last iteration was finished.
  39890. */
  39891. executeNext(): void;
  39892. /**
  39893. * Break the loop and run the success callback.
  39894. */
  39895. breakLoop(): void;
  39896. /**
  39897. * Create and run an async loop.
  39898. * @param iterations the number of iterations.
  39899. * @param fn the function to run each iteration
  39900. * @param successCallback the callback that will be called upon succesful execution
  39901. * @param offset starting offset.
  39902. * @returns the created async loop object
  39903. */
  39904. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  39905. /**
  39906. * A for-loop that will run a given number of iterations synchronous and the rest async.
  39907. * @param iterations total number of iterations
  39908. * @param syncedIterations number of synchronous iterations in each async iteration.
  39909. * @param fn the function to call each iteration.
  39910. * @param callback a success call back that will be called when iterating stops.
  39911. * @param breakFunction a break condition (optional)
  39912. * @param timeout timeout settings for the setTimeout function. default - 0.
  39913. * @returns the created async loop object
  39914. */
  39915. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  39916. }
  39917. }
  39918. declare module "babylonjs/Misc/stringDictionary" {
  39919. import { Nullable } from "babylonjs/types";
  39920. /**
  39921. * This class implement a typical dictionary using a string as key and the generic type T as value.
  39922. * The underlying implementation relies on an associative array to ensure the best performances.
  39923. * The value can be anything including 'null' but except 'undefined'
  39924. */
  39925. export class StringDictionary<T> {
  39926. /**
  39927. * This will clear this dictionary and copy the content from the 'source' one.
  39928. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  39929. * @param source the dictionary to take the content from and copy to this dictionary
  39930. */
  39931. copyFrom(source: StringDictionary<T>): void;
  39932. /**
  39933. * Get a value based from its key
  39934. * @param key the given key to get the matching value from
  39935. * @return the value if found, otherwise undefined is returned
  39936. */
  39937. get(key: string): T | undefined;
  39938. /**
  39939. * Get a value from its key or add it if it doesn't exist.
  39940. * This method will ensure you that a given key/data will be present in the dictionary.
  39941. * @param key the given key to get the matching value from
  39942. * @param factory the factory that will create the value if the key is not present in the dictionary.
  39943. * The factory will only be invoked if there's no data for the given key.
  39944. * @return the value corresponding to the key.
  39945. */
  39946. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  39947. /**
  39948. * Get a value from its key if present in the dictionary otherwise add it
  39949. * @param key the key to get the value from
  39950. * @param val if there's no such key/value pair in the dictionary add it with this value
  39951. * @return the value corresponding to the key
  39952. */
  39953. getOrAdd(key: string, val: T): T;
  39954. /**
  39955. * Check if there's a given key in the dictionary
  39956. * @param key the key to check for
  39957. * @return true if the key is present, false otherwise
  39958. */
  39959. contains(key: string): boolean;
  39960. /**
  39961. * Add a new key and its corresponding value
  39962. * @param key the key to add
  39963. * @param value the value corresponding to the key
  39964. * @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
  39965. */
  39966. add(key: string, value: T): boolean;
  39967. /**
  39968. * Update a specific value associated to a key
  39969. * @param key defines the key to use
  39970. * @param value defines the value to store
  39971. * @returns true if the value was updated (or false if the key was not found)
  39972. */
  39973. set(key: string, value: T): boolean;
  39974. /**
  39975. * Get the element of the given key and remove it from the dictionary
  39976. * @param key defines the key to search
  39977. * @returns the value associated with the key or null if not found
  39978. */
  39979. getAndRemove(key: string): Nullable<T>;
  39980. /**
  39981. * Remove a key/value from the dictionary.
  39982. * @param key the key to remove
  39983. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  39984. */
  39985. remove(key: string): boolean;
  39986. /**
  39987. * Clear the whole content of the dictionary
  39988. */
  39989. clear(): void;
  39990. /**
  39991. * Gets the current count
  39992. */
  39993. get count(): number;
  39994. /**
  39995. * Execute a callback on each key/val of the dictionary.
  39996. * Note that you can remove any element in this dictionary in the callback implementation
  39997. * @param callback the callback to execute on a given key/value pair
  39998. */
  39999. forEach(callback: (key: string, val: T) => void): void;
  40000. /**
  40001. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40002. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40003. * Note that you can remove any element in this dictionary in the callback implementation
  40004. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40005. * @returns the first item
  40006. */
  40007. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40008. private _count;
  40009. private _data;
  40010. }
  40011. }
  40012. declare module "babylonjs/Collisions/collisionCoordinator" {
  40013. import { Nullable } from "babylonjs/types";
  40014. import { Scene } from "babylonjs/scene";
  40015. import { Vector3 } from "babylonjs/Maths/math.vector";
  40016. import { Collider } from "babylonjs/Collisions/collider";
  40017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40018. /** @hidden */
  40019. export interface ICollisionCoordinator {
  40020. createCollider(): Collider;
  40021. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40022. init(scene: Scene): void;
  40023. }
  40024. /** @hidden */
  40025. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40026. private _scene;
  40027. private _scaledPosition;
  40028. private _scaledVelocity;
  40029. private _finalPosition;
  40030. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40031. createCollider(): Collider;
  40032. init(scene: Scene): void;
  40033. private _collideWithWorld;
  40034. }
  40035. }
  40036. declare module "babylonjs/Inputs/scene.inputManager" {
  40037. import { Nullable } from "babylonjs/types";
  40038. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40039. import { Vector2 } from "babylonjs/Maths/math.vector";
  40040. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40041. import { Scene } from "babylonjs/scene";
  40042. /**
  40043. * Class used to manage all inputs for the scene.
  40044. */
  40045. export class InputManager {
  40046. /** The distance in pixel that you have to move to prevent some events */
  40047. static DragMovementThreshold: number;
  40048. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40049. static LongPressDelay: number;
  40050. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40051. static DoubleClickDelay: number;
  40052. /** If you need to check double click without raising a single click at first click, enable this flag */
  40053. static ExclusiveDoubleClickMode: boolean;
  40054. private _wheelEventName;
  40055. private _onPointerMove;
  40056. private _onPointerDown;
  40057. private _onPointerUp;
  40058. private _initClickEvent;
  40059. private _initActionManager;
  40060. private _delayedSimpleClick;
  40061. private _delayedSimpleClickTimeout;
  40062. private _previousDelayedSimpleClickTimeout;
  40063. private _meshPickProceed;
  40064. private _previousButtonPressed;
  40065. private _currentPickResult;
  40066. private _previousPickResult;
  40067. private _totalPointersPressed;
  40068. private _doubleClickOccured;
  40069. private _pointerOverMesh;
  40070. private _pickedDownMesh;
  40071. private _pickedUpMesh;
  40072. private _pointerX;
  40073. private _pointerY;
  40074. private _unTranslatedPointerX;
  40075. private _unTranslatedPointerY;
  40076. private _startingPointerPosition;
  40077. private _previousStartingPointerPosition;
  40078. private _startingPointerTime;
  40079. private _previousStartingPointerTime;
  40080. private _pointerCaptures;
  40081. private _onKeyDown;
  40082. private _onKeyUp;
  40083. private _onCanvasFocusObserver;
  40084. private _onCanvasBlurObserver;
  40085. private _scene;
  40086. /**
  40087. * Creates a new InputManager
  40088. * @param scene defines the hosting scene
  40089. */
  40090. constructor(scene: Scene);
  40091. /**
  40092. * Gets the mesh that is currently under the pointer
  40093. */
  40094. get meshUnderPointer(): Nullable<AbstractMesh>;
  40095. /**
  40096. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40097. */
  40098. get unTranslatedPointer(): Vector2;
  40099. /**
  40100. * Gets or sets the current on-screen X position of the pointer
  40101. */
  40102. get pointerX(): number;
  40103. set pointerX(value: number);
  40104. /**
  40105. * Gets or sets the current on-screen Y position of the pointer
  40106. */
  40107. get pointerY(): number;
  40108. set pointerY(value: number);
  40109. private _updatePointerPosition;
  40110. private _processPointerMove;
  40111. private _setRayOnPointerInfo;
  40112. private _checkPrePointerObservable;
  40113. /**
  40114. * Use this method to simulate a pointer move on a mesh
  40115. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40116. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40117. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40118. */
  40119. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40120. /**
  40121. * Use this method to simulate a pointer down on a mesh
  40122. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40123. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40124. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40125. */
  40126. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40127. private _processPointerDown;
  40128. /** @hidden */
  40129. _isPointerSwiping(): boolean;
  40130. /**
  40131. * Use this method to simulate a pointer up on a mesh
  40132. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40133. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40134. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40135. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40136. */
  40137. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40138. private _processPointerUp;
  40139. /**
  40140. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40141. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40142. * @returns true if the pointer was captured
  40143. */
  40144. isPointerCaptured(pointerId?: number): boolean;
  40145. /**
  40146. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40147. * @param attachUp defines if you want to attach events to pointerup
  40148. * @param attachDown defines if you want to attach events to pointerdown
  40149. * @param attachMove defines if you want to attach events to pointermove
  40150. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40151. */
  40152. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40153. /**
  40154. * Detaches all event handlers
  40155. */
  40156. detachControl(): void;
  40157. /**
  40158. * Force the value of meshUnderPointer
  40159. * @param mesh defines the mesh to use
  40160. */
  40161. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40162. /**
  40163. * Gets the mesh under the pointer
  40164. * @returns a Mesh or null if no mesh is under the pointer
  40165. */
  40166. getPointerOverMesh(): Nullable<AbstractMesh>;
  40167. }
  40168. }
  40169. declare module "babylonjs/Animations/animationGroup" {
  40170. import { Animatable } from "babylonjs/Animations/animatable";
  40171. import { Animation } from "babylonjs/Animations/animation";
  40172. import { Scene, IDisposable } from "babylonjs/scene";
  40173. import { Observable } from "babylonjs/Misc/observable";
  40174. import { Nullable } from "babylonjs/types";
  40175. import "babylonjs/Animations/animatable";
  40176. /**
  40177. * This class defines the direct association between an animation and a target
  40178. */
  40179. export class TargetedAnimation {
  40180. /**
  40181. * Animation to perform
  40182. */
  40183. animation: Animation;
  40184. /**
  40185. * Target to animate
  40186. */
  40187. target: any;
  40188. /**
  40189. * Returns the string "TargetedAnimation"
  40190. * @returns "TargetedAnimation"
  40191. */
  40192. getClassName(): string;
  40193. /**
  40194. * Serialize the object
  40195. * @returns the JSON object representing the current entity
  40196. */
  40197. serialize(): any;
  40198. }
  40199. /**
  40200. * Use this class to create coordinated animations on multiple targets
  40201. */
  40202. export class AnimationGroup implements IDisposable {
  40203. /** The name of the animation group */
  40204. name: string;
  40205. private _scene;
  40206. private _targetedAnimations;
  40207. private _animatables;
  40208. private _from;
  40209. private _to;
  40210. private _isStarted;
  40211. private _isPaused;
  40212. private _speedRatio;
  40213. private _loopAnimation;
  40214. private _isAdditive;
  40215. /**
  40216. * Gets or sets the unique id of the node
  40217. */
  40218. uniqueId: number;
  40219. /**
  40220. * This observable will notify when one animation have ended
  40221. */
  40222. onAnimationEndObservable: Observable<TargetedAnimation>;
  40223. /**
  40224. * Observer raised when one animation loops
  40225. */
  40226. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40227. /**
  40228. * Observer raised when all animations have looped
  40229. */
  40230. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40231. /**
  40232. * This observable will notify when all animations have ended.
  40233. */
  40234. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40235. /**
  40236. * This observable will notify when all animations have paused.
  40237. */
  40238. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40239. /**
  40240. * This observable will notify when all animations are playing.
  40241. */
  40242. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40243. /**
  40244. * Gets the first frame
  40245. */
  40246. get from(): number;
  40247. /**
  40248. * Gets the last frame
  40249. */
  40250. get to(): number;
  40251. /**
  40252. * Define if the animations are started
  40253. */
  40254. get isStarted(): boolean;
  40255. /**
  40256. * Gets a value indicating that the current group is playing
  40257. */
  40258. get isPlaying(): boolean;
  40259. /**
  40260. * Gets or sets the speed ratio to use for all animations
  40261. */
  40262. get speedRatio(): number;
  40263. /**
  40264. * Gets or sets the speed ratio to use for all animations
  40265. */
  40266. set speedRatio(value: number);
  40267. /**
  40268. * Gets or sets if all animations should loop or not
  40269. */
  40270. get loopAnimation(): boolean;
  40271. set loopAnimation(value: boolean);
  40272. /**
  40273. * Gets or sets if all animations should be evaluated additively
  40274. */
  40275. get isAdditive(): boolean;
  40276. set isAdditive(value: boolean);
  40277. /**
  40278. * Gets the targeted animations for this animation group
  40279. */
  40280. get targetedAnimations(): Array<TargetedAnimation>;
  40281. /**
  40282. * returning the list of animatables controlled by this animation group.
  40283. */
  40284. get animatables(): Array<Animatable>;
  40285. /**
  40286. * Gets the list of target animations
  40287. */
  40288. get children(): TargetedAnimation[];
  40289. /**
  40290. * Instantiates a new Animation Group.
  40291. * This helps managing several animations at once.
  40292. * @see https://doc.babylonjs.com/how_to/group
  40293. * @param name Defines the name of the group
  40294. * @param scene Defines the scene the group belongs to
  40295. */
  40296. constructor(
  40297. /** The name of the animation group */
  40298. name: string, scene?: Nullable<Scene>);
  40299. /**
  40300. * Add an animation (with its target) in the group
  40301. * @param animation defines the animation we want to add
  40302. * @param target defines the target of the animation
  40303. * @returns the TargetedAnimation object
  40304. */
  40305. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40306. /**
  40307. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40308. * It can add constant keys at begin or end
  40309. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40310. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40311. * @returns the animation group
  40312. */
  40313. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40314. private _animationLoopCount;
  40315. private _animationLoopFlags;
  40316. private _processLoop;
  40317. /**
  40318. * Start all animations on given targets
  40319. * @param loop defines if animations must loop
  40320. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40321. * @param from defines the from key (optional)
  40322. * @param to defines the to key (optional)
  40323. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40324. * @returns the current animation group
  40325. */
  40326. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40327. /**
  40328. * Pause all animations
  40329. * @returns the animation group
  40330. */
  40331. pause(): AnimationGroup;
  40332. /**
  40333. * Play all animations to initial state
  40334. * This function will start() the animations if they were not started or will restart() them if they were paused
  40335. * @param loop defines if animations must loop
  40336. * @returns the animation group
  40337. */
  40338. play(loop?: boolean): AnimationGroup;
  40339. /**
  40340. * Reset all animations to initial state
  40341. * @returns the animation group
  40342. */
  40343. reset(): AnimationGroup;
  40344. /**
  40345. * Restart animations from key 0
  40346. * @returns the animation group
  40347. */
  40348. restart(): AnimationGroup;
  40349. /**
  40350. * Stop all animations
  40351. * @returns the animation group
  40352. */
  40353. stop(): AnimationGroup;
  40354. /**
  40355. * Set animation weight for all animatables
  40356. * @param weight defines the weight to use
  40357. * @return the animationGroup
  40358. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40359. */
  40360. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40361. /**
  40362. * Synchronize and normalize all animatables with a source animatable
  40363. * @param root defines the root animatable to synchronize with
  40364. * @return the animationGroup
  40365. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40366. */
  40367. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40368. /**
  40369. * Goes to a specific frame in this animation group
  40370. * @param frame the frame number to go to
  40371. * @return the animationGroup
  40372. */
  40373. goToFrame(frame: number): AnimationGroup;
  40374. /**
  40375. * Dispose all associated resources
  40376. */
  40377. dispose(): void;
  40378. private _checkAnimationGroupEnded;
  40379. /**
  40380. * Clone the current animation group and returns a copy
  40381. * @param newName defines the name of the new group
  40382. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40383. * @returns the new aniamtion group
  40384. */
  40385. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40386. /**
  40387. * Serializes the animationGroup to an object
  40388. * @returns Serialized object
  40389. */
  40390. serialize(): any;
  40391. /**
  40392. * Returns a new AnimationGroup object parsed from the source provided.
  40393. * @param parsedAnimationGroup defines the source
  40394. * @param scene defines the scene that will receive the animationGroup
  40395. * @returns a new AnimationGroup
  40396. */
  40397. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40398. /**
  40399. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40400. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40401. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40402. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40403. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40404. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40405. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40406. */
  40407. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40408. /**
  40409. * Returns the string "AnimationGroup"
  40410. * @returns "AnimationGroup"
  40411. */
  40412. getClassName(): string;
  40413. /**
  40414. * Creates a detailled string about the object
  40415. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40416. * @returns a string representing the object
  40417. */
  40418. toString(fullDetails?: boolean): string;
  40419. }
  40420. }
  40421. declare module "babylonjs/scene" {
  40422. import { Nullable } from "babylonjs/types";
  40423. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40424. import { Observable } from "babylonjs/Misc/observable";
  40425. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40426. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40427. import { Geometry } from "babylonjs/Meshes/geometry";
  40428. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40429. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40430. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40431. import { Mesh } from "babylonjs/Meshes/mesh";
  40432. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40433. import { Bone } from "babylonjs/Bones/bone";
  40434. import { Skeleton } from "babylonjs/Bones/skeleton";
  40435. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40436. import { Camera } from "babylonjs/Cameras/camera";
  40437. import { AbstractScene } from "babylonjs/abstractScene";
  40438. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40439. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40440. import { Material } from "babylonjs/Materials/material";
  40441. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40442. import { Effect } from "babylonjs/Materials/effect";
  40443. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40444. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40445. import { Light } from "babylonjs/Lights/light";
  40446. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40447. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40448. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40449. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40450. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40451. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40452. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40453. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40454. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40455. import { Engine } from "babylonjs/Engines/engine";
  40456. import { Node } from "babylonjs/node";
  40457. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40458. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40459. import { WebRequest } from "babylonjs/Misc/webRequest";
  40460. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40461. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40462. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40463. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40464. import { Plane } from "babylonjs/Maths/math.plane";
  40465. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40466. import { Ray } from "babylonjs/Culling/ray";
  40467. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40468. import { Animation } from "babylonjs/Animations/animation";
  40469. import { Animatable } from "babylonjs/Animations/animatable";
  40470. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40471. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40472. import { Collider } from "babylonjs/Collisions/collider";
  40473. /**
  40474. * Define an interface for all classes that will hold resources
  40475. */
  40476. export interface IDisposable {
  40477. /**
  40478. * Releases all held resources
  40479. */
  40480. dispose(): void;
  40481. }
  40482. /** Interface defining initialization parameters for Scene class */
  40483. export interface SceneOptions {
  40484. /**
  40485. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40486. * It will improve performance when the number of geometries becomes important.
  40487. */
  40488. useGeometryUniqueIdsMap?: boolean;
  40489. /**
  40490. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40491. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40492. */
  40493. useMaterialMeshMap?: boolean;
  40494. /**
  40495. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40496. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40497. */
  40498. useClonedMeshMap?: boolean;
  40499. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40500. virtual?: boolean;
  40501. }
  40502. /**
  40503. * Represents a scene to be rendered by the engine.
  40504. * @see https://doc.babylonjs.com/features/scene
  40505. */
  40506. export class Scene extends AbstractScene implements IAnimatable {
  40507. /** The fog is deactivated */
  40508. static readonly FOGMODE_NONE: number;
  40509. /** The fog density is following an exponential function */
  40510. static readonly FOGMODE_EXP: number;
  40511. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40512. static readonly FOGMODE_EXP2: number;
  40513. /** The fog density is following a linear function. */
  40514. static readonly FOGMODE_LINEAR: number;
  40515. /**
  40516. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40517. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40518. */
  40519. static MinDeltaTime: number;
  40520. /**
  40521. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40522. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40523. */
  40524. static MaxDeltaTime: number;
  40525. /**
  40526. * Factory used to create the default material.
  40527. * @param name The name of the material to create
  40528. * @param scene The scene to create the material for
  40529. * @returns The default material
  40530. */
  40531. static DefaultMaterialFactory(scene: Scene): Material;
  40532. /**
  40533. * Factory used to create the a collision coordinator.
  40534. * @returns The collision coordinator
  40535. */
  40536. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40537. /** @hidden */
  40538. _inputManager: InputManager;
  40539. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40540. cameraToUseForPointers: Nullable<Camera>;
  40541. /** @hidden */
  40542. readonly _isScene: boolean;
  40543. /** @hidden */
  40544. _blockEntityCollection: boolean;
  40545. /**
  40546. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40547. */
  40548. autoClear: boolean;
  40549. /**
  40550. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40551. */
  40552. autoClearDepthAndStencil: boolean;
  40553. /**
  40554. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40555. */
  40556. clearColor: Color4;
  40557. /**
  40558. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40559. */
  40560. ambientColor: Color3;
  40561. /**
  40562. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40563. * It should only be one of the following (if not the default embedded one):
  40564. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40565. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40566. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40567. * The material properties need to be setup according to the type of texture in use.
  40568. */
  40569. environmentBRDFTexture: BaseTexture;
  40570. /** @hidden */
  40571. protected _environmentTexture: Nullable<BaseTexture>;
  40572. /**
  40573. * Texture used in all pbr material as the reflection texture.
  40574. * As in the majority of the scene they are the same (exception for multi room and so on),
  40575. * this is easier to reference from here than from all the materials.
  40576. */
  40577. get environmentTexture(): Nullable<BaseTexture>;
  40578. /**
  40579. * Texture used in all pbr material as the reflection texture.
  40580. * As in the majority of the scene they are the same (exception for multi room and so on),
  40581. * this is easier to set here than in all the materials.
  40582. */
  40583. set environmentTexture(value: Nullable<BaseTexture>);
  40584. /** @hidden */
  40585. protected _environmentIntensity: number;
  40586. /**
  40587. * Intensity of the environment in all pbr material.
  40588. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40589. * As in the majority of the scene they are the same (exception for multi room and so on),
  40590. * this is easier to reference from here than from all the materials.
  40591. */
  40592. get environmentIntensity(): number;
  40593. /**
  40594. * Intensity of the environment in all pbr material.
  40595. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40596. * As in the majority of the scene they are the same (exception for multi room and so on),
  40597. * this is easier to set here than in all the materials.
  40598. */
  40599. set environmentIntensity(value: number);
  40600. /** @hidden */
  40601. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40602. /**
  40603. * Default image processing configuration used either in the rendering
  40604. * Forward main pass or through the imageProcessingPostProcess if present.
  40605. * As in the majority of the scene they are the same (exception for multi camera),
  40606. * this is easier to reference from here than from all the materials and post process.
  40607. *
  40608. * No setter as we it is a shared configuration, you can set the values instead.
  40609. */
  40610. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40611. private _forceWireframe;
  40612. /**
  40613. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40614. */
  40615. set forceWireframe(value: boolean);
  40616. get forceWireframe(): boolean;
  40617. private _skipFrustumClipping;
  40618. /**
  40619. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40620. */
  40621. set skipFrustumClipping(value: boolean);
  40622. get skipFrustumClipping(): boolean;
  40623. private _forcePointsCloud;
  40624. /**
  40625. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40626. */
  40627. set forcePointsCloud(value: boolean);
  40628. get forcePointsCloud(): boolean;
  40629. /**
  40630. * Gets or sets the active clipplane 1
  40631. */
  40632. clipPlane: Nullable<Plane>;
  40633. /**
  40634. * Gets or sets the active clipplane 2
  40635. */
  40636. clipPlane2: Nullable<Plane>;
  40637. /**
  40638. * Gets or sets the active clipplane 3
  40639. */
  40640. clipPlane3: Nullable<Plane>;
  40641. /**
  40642. * Gets or sets the active clipplane 4
  40643. */
  40644. clipPlane4: Nullable<Plane>;
  40645. /**
  40646. * Gets or sets the active clipplane 5
  40647. */
  40648. clipPlane5: Nullable<Plane>;
  40649. /**
  40650. * Gets or sets the active clipplane 6
  40651. */
  40652. clipPlane6: Nullable<Plane>;
  40653. /**
  40654. * Gets or sets a boolean indicating if animations are enabled
  40655. */
  40656. animationsEnabled: boolean;
  40657. private _animationPropertiesOverride;
  40658. /**
  40659. * Gets or sets the animation properties override
  40660. */
  40661. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40662. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40663. /**
  40664. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40665. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40666. */
  40667. useConstantAnimationDeltaTime: boolean;
  40668. /**
  40669. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40670. * Please note that it requires to run a ray cast through the scene on every frame
  40671. */
  40672. constantlyUpdateMeshUnderPointer: boolean;
  40673. /**
  40674. * Defines the HTML cursor to use when hovering over interactive elements
  40675. */
  40676. hoverCursor: string;
  40677. /**
  40678. * Defines the HTML default cursor to use (empty by default)
  40679. */
  40680. defaultCursor: string;
  40681. /**
  40682. * Defines whether cursors are handled by the scene.
  40683. */
  40684. doNotHandleCursors: boolean;
  40685. /**
  40686. * This is used to call preventDefault() on pointer down
  40687. * in order to block unwanted artifacts like system double clicks
  40688. */
  40689. preventDefaultOnPointerDown: boolean;
  40690. /**
  40691. * This is used to call preventDefault() on pointer up
  40692. * in order to block unwanted artifacts like system double clicks
  40693. */
  40694. preventDefaultOnPointerUp: boolean;
  40695. /**
  40696. * Gets or sets user defined metadata
  40697. */
  40698. metadata: any;
  40699. /**
  40700. * For internal use only. Please do not use.
  40701. */
  40702. reservedDataStore: any;
  40703. /**
  40704. * Gets the name of the plugin used to load this scene (null by default)
  40705. */
  40706. loadingPluginName: string;
  40707. /**
  40708. * Use this array to add regular expressions used to disable offline support for specific urls
  40709. */
  40710. disableOfflineSupportExceptionRules: RegExp[];
  40711. /**
  40712. * An event triggered when the scene is disposed.
  40713. */
  40714. onDisposeObservable: Observable<Scene>;
  40715. private _onDisposeObserver;
  40716. /** Sets a function to be executed when this scene is disposed. */
  40717. set onDispose(callback: () => void);
  40718. /**
  40719. * An event triggered before rendering the scene (right after animations and physics)
  40720. */
  40721. onBeforeRenderObservable: Observable<Scene>;
  40722. private _onBeforeRenderObserver;
  40723. /** Sets a function to be executed before rendering this scene */
  40724. set beforeRender(callback: Nullable<() => void>);
  40725. /**
  40726. * An event triggered after rendering the scene
  40727. */
  40728. onAfterRenderObservable: Observable<Scene>;
  40729. /**
  40730. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40731. */
  40732. onAfterRenderCameraObservable: Observable<Camera>;
  40733. private _onAfterRenderObserver;
  40734. /** Sets a function to be executed after rendering this scene */
  40735. set afterRender(callback: Nullable<() => void>);
  40736. /**
  40737. * An event triggered before animating the scene
  40738. */
  40739. onBeforeAnimationsObservable: Observable<Scene>;
  40740. /**
  40741. * An event triggered after animations processing
  40742. */
  40743. onAfterAnimationsObservable: Observable<Scene>;
  40744. /**
  40745. * An event triggered before draw calls are ready to be sent
  40746. */
  40747. onBeforeDrawPhaseObservable: Observable<Scene>;
  40748. /**
  40749. * An event triggered after draw calls have been sent
  40750. */
  40751. onAfterDrawPhaseObservable: Observable<Scene>;
  40752. /**
  40753. * An event triggered when the scene is ready
  40754. */
  40755. onReadyObservable: Observable<Scene>;
  40756. /**
  40757. * An event triggered before rendering a camera
  40758. */
  40759. onBeforeCameraRenderObservable: Observable<Camera>;
  40760. private _onBeforeCameraRenderObserver;
  40761. /** Sets a function to be executed before rendering a camera*/
  40762. set beforeCameraRender(callback: () => void);
  40763. /**
  40764. * An event triggered after rendering a camera
  40765. */
  40766. onAfterCameraRenderObservable: Observable<Camera>;
  40767. private _onAfterCameraRenderObserver;
  40768. /** Sets a function to be executed after rendering a camera*/
  40769. set afterCameraRender(callback: () => void);
  40770. /**
  40771. * An event triggered when active meshes evaluation is about to start
  40772. */
  40773. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40774. /**
  40775. * An event triggered when active meshes evaluation is done
  40776. */
  40777. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40778. /**
  40779. * An event triggered when particles rendering is about to start
  40780. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40781. */
  40782. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40783. /**
  40784. * An event triggered when particles rendering is done
  40785. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40786. */
  40787. onAfterParticlesRenderingObservable: Observable<Scene>;
  40788. /**
  40789. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40790. */
  40791. onDataLoadedObservable: Observable<Scene>;
  40792. /**
  40793. * An event triggered when a camera is created
  40794. */
  40795. onNewCameraAddedObservable: Observable<Camera>;
  40796. /**
  40797. * An event triggered when a camera is removed
  40798. */
  40799. onCameraRemovedObservable: Observable<Camera>;
  40800. /**
  40801. * An event triggered when a light is created
  40802. */
  40803. onNewLightAddedObservable: Observable<Light>;
  40804. /**
  40805. * An event triggered when a light is removed
  40806. */
  40807. onLightRemovedObservable: Observable<Light>;
  40808. /**
  40809. * An event triggered when a geometry is created
  40810. */
  40811. onNewGeometryAddedObservable: Observable<Geometry>;
  40812. /**
  40813. * An event triggered when a geometry is removed
  40814. */
  40815. onGeometryRemovedObservable: Observable<Geometry>;
  40816. /**
  40817. * An event triggered when a transform node is created
  40818. */
  40819. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40820. /**
  40821. * An event triggered when a transform node is removed
  40822. */
  40823. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40824. /**
  40825. * An event triggered when a mesh is created
  40826. */
  40827. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40828. /**
  40829. * An event triggered when a mesh is removed
  40830. */
  40831. onMeshRemovedObservable: Observable<AbstractMesh>;
  40832. /**
  40833. * An event triggered when a skeleton is created
  40834. */
  40835. onNewSkeletonAddedObservable: Observable<Skeleton>;
  40836. /**
  40837. * An event triggered when a skeleton is removed
  40838. */
  40839. onSkeletonRemovedObservable: Observable<Skeleton>;
  40840. /**
  40841. * An event triggered when a material is created
  40842. */
  40843. onNewMaterialAddedObservable: Observable<Material>;
  40844. /**
  40845. * An event triggered when a material is removed
  40846. */
  40847. onMaterialRemovedObservable: Observable<Material>;
  40848. /**
  40849. * An event triggered when a texture is created
  40850. */
  40851. onNewTextureAddedObservable: Observable<BaseTexture>;
  40852. /**
  40853. * An event triggered when a texture is removed
  40854. */
  40855. onTextureRemovedObservable: Observable<BaseTexture>;
  40856. /**
  40857. * An event triggered when render targets are about to be rendered
  40858. * Can happen multiple times per frame.
  40859. */
  40860. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  40861. /**
  40862. * An event triggered when render targets were rendered.
  40863. * Can happen multiple times per frame.
  40864. */
  40865. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  40866. /**
  40867. * An event triggered before calculating deterministic simulation step
  40868. */
  40869. onBeforeStepObservable: Observable<Scene>;
  40870. /**
  40871. * An event triggered after calculating deterministic simulation step
  40872. */
  40873. onAfterStepObservable: Observable<Scene>;
  40874. /**
  40875. * An event triggered when the activeCamera property is updated
  40876. */
  40877. onActiveCameraChanged: Observable<Scene>;
  40878. /**
  40879. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  40880. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40881. * 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)
  40882. */
  40883. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40884. /**
  40885. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  40886. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40887. * 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)
  40888. */
  40889. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40890. /**
  40891. * This Observable will when a mesh has been imported into the scene.
  40892. */
  40893. onMeshImportedObservable: Observable<AbstractMesh>;
  40894. /**
  40895. * This Observable will when an animation file has been imported into the scene.
  40896. */
  40897. onAnimationFileImportedObservable: Observable<Scene>;
  40898. /**
  40899. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  40900. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  40901. */
  40902. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  40903. /** @hidden */
  40904. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  40905. /**
  40906. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  40907. */
  40908. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  40909. /**
  40910. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  40911. */
  40912. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  40913. /**
  40914. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  40915. */
  40916. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  40917. /** Callback called when a pointer move is detected */
  40918. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40919. /** Callback called when a pointer down is detected */
  40920. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40921. /** Callback called when a pointer up is detected */
  40922. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  40923. /** Callback called when a pointer pick is detected */
  40924. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  40925. /**
  40926. * 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).
  40927. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  40928. */
  40929. onPrePointerObservable: Observable<PointerInfoPre>;
  40930. /**
  40931. * Observable event triggered each time an input event is received from the rendering canvas
  40932. */
  40933. onPointerObservable: Observable<PointerInfo>;
  40934. /**
  40935. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  40936. */
  40937. get unTranslatedPointer(): Vector2;
  40938. /**
  40939. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  40940. */
  40941. static get DragMovementThreshold(): number;
  40942. static set DragMovementThreshold(value: number);
  40943. /**
  40944. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  40945. */
  40946. static get LongPressDelay(): number;
  40947. static set LongPressDelay(value: number);
  40948. /**
  40949. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  40950. */
  40951. static get DoubleClickDelay(): number;
  40952. static set DoubleClickDelay(value: number);
  40953. /** If you need to check double click without raising a single click at first click, enable this flag */
  40954. static get ExclusiveDoubleClickMode(): boolean;
  40955. static set ExclusiveDoubleClickMode(value: boolean);
  40956. /** @hidden */
  40957. _mirroredCameraPosition: Nullable<Vector3>;
  40958. /**
  40959. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  40960. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  40961. */
  40962. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  40963. /**
  40964. * Observable event triggered each time an keyboard event is received from the hosting window
  40965. */
  40966. onKeyboardObservable: Observable<KeyboardInfo>;
  40967. private _useRightHandedSystem;
  40968. /**
  40969. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  40970. */
  40971. set useRightHandedSystem(value: boolean);
  40972. get useRightHandedSystem(): boolean;
  40973. private _timeAccumulator;
  40974. private _currentStepId;
  40975. private _currentInternalStep;
  40976. /**
  40977. * Sets the step Id used by deterministic lock step
  40978. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40979. * @param newStepId defines the step Id
  40980. */
  40981. setStepId(newStepId: number): void;
  40982. /**
  40983. * Gets the step Id used by deterministic lock step
  40984. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40985. * @returns the step Id
  40986. */
  40987. getStepId(): number;
  40988. /**
  40989. * Gets the internal step used by deterministic lock step
  40990. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40991. * @returns the internal step
  40992. */
  40993. getInternalStep(): number;
  40994. private _fogEnabled;
  40995. /**
  40996. * Gets or sets a boolean indicating if fog is enabled on this scene
  40997. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40998. * (Default is true)
  40999. */
  41000. set fogEnabled(value: boolean);
  41001. get fogEnabled(): boolean;
  41002. private _fogMode;
  41003. /**
  41004. * Gets or sets the fog mode to use
  41005. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41006. * | mode | value |
  41007. * | --- | --- |
  41008. * | FOGMODE_NONE | 0 |
  41009. * | FOGMODE_EXP | 1 |
  41010. * | FOGMODE_EXP2 | 2 |
  41011. * | FOGMODE_LINEAR | 3 |
  41012. */
  41013. set fogMode(value: number);
  41014. get fogMode(): number;
  41015. /**
  41016. * Gets or sets the fog color to use
  41017. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41018. * (Default is Color3(0.2, 0.2, 0.3))
  41019. */
  41020. fogColor: Color3;
  41021. /**
  41022. * Gets or sets the fog density to use
  41023. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41024. * (Default is 0.1)
  41025. */
  41026. fogDensity: number;
  41027. /**
  41028. * Gets or sets the fog start distance to use
  41029. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41030. * (Default is 0)
  41031. */
  41032. fogStart: number;
  41033. /**
  41034. * Gets or sets the fog end distance to use
  41035. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41036. * (Default is 1000)
  41037. */
  41038. fogEnd: number;
  41039. /**
  41040. * Flag indicating that the frame buffer binding is handled by another component
  41041. */
  41042. prePass: boolean;
  41043. private _shadowsEnabled;
  41044. /**
  41045. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41046. */
  41047. set shadowsEnabled(value: boolean);
  41048. get shadowsEnabled(): boolean;
  41049. private _lightsEnabled;
  41050. /**
  41051. * Gets or sets a boolean indicating if lights are enabled on this scene
  41052. */
  41053. set lightsEnabled(value: boolean);
  41054. get lightsEnabled(): boolean;
  41055. /** All of the active cameras added to this scene. */
  41056. activeCameras: Camera[];
  41057. /** @hidden */
  41058. _activeCamera: Nullable<Camera>;
  41059. /** Gets or sets the current active camera */
  41060. get activeCamera(): Nullable<Camera>;
  41061. set activeCamera(value: Nullable<Camera>);
  41062. private _defaultMaterial;
  41063. /** The default material used on meshes when no material is affected */
  41064. get defaultMaterial(): Material;
  41065. /** The default material used on meshes when no material is affected */
  41066. set defaultMaterial(value: Material);
  41067. private _texturesEnabled;
  41068. /**
  41069. * Gets or sets a boolean indicating if textures are enabled on this scene
  41070. */
  41071. set texturesEnabled(value: boolean);
  41072. get texturesEnabled(): boolean;
  41073. /**
  41074. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41075. */
  41076. physicsEnabled: boolean;
  41077. /**
  41078. * Gets or sets a boolean indicating if particles are enabled on this scene
  41079. */
  41080. particlesEnabled: boolean;
  41081. /**
  41082. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41083. */
  41084. spritesEnabled: boolean;
  41085. private _skeletonsEnabled;
  41086. /**
  41087. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41088. */
  41089. set skeletonsEnabled(value: boolean);
  41090. get skeletonsEnabled(): boolean;
  41091. /**
  41092. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41093. */
  41094. lensFlaresEnabled: boolean;
  41095. /**
  41096. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41097. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41098. */
  41099. collisionsEnabled: boolean;
  41100. private _collisionCoordinator;
  41101. /** @hidden */
  41102. get collisionCoordinator(): ICollisionCoordinator;
  41103. /**
  41104. * Defines the gravity applied to this scene (used only for collisions)
  41105. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41106. */
  41107. gravity: Vector3;
  41108. /**
  41109. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41110. */
  41111. postProcessesEnabled: boolean;
  41112. /**
  41113. * The list of postprocesses added to the scene
  41114. */
  41115. postProcesses: PostProcess[];
  41116. /**
  41117. * Gets the current postprocess manager
  41118. */
  41119. postProcessManager: PostProcessManager;
  41120. /**
  41121. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41122. */
  41123. renderTargetsEnabled: boolean;
  41124. /**
  41125. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41126. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41127. */
  41128. dumpNextRenderTargets: boolean;
  41129. /**
  41130. * The list of user defined render targets added to the scene
  41131. */
  41132. customRenderTargets: RenderTargetTexture[];
  41133. /**
  41134. * Defines if texture loading must be delayed
  41135. * If true, textures will only be loaded when they need to be rendered
  41136. */
  41137. useDelayedTextureLoading: boolean;
  41138. /**
  41139. * Gets the list of meshes imported to the scene through SceneLoader
  41140. */
  41141. importedMeshesFiles: String[];
  41142. /**
  41143. * Gets or sets a boolean indicating if probes are enabled on this scene
  41144. */
  41145. probesEnabled: boolean;
  41146. /**
  41147. * Gets or sets the current offline provider to use to store scene data
  41148. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41149. */
  41150. offlineProvider: IOfflineProvider;
  41151. /**
  41152. * Gets or sets the action manager associated with the scene
  41153. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41154. */
  41155. actionManager: AbstractActionManager;
  41156. private _meshesForIntersections;
  41157. /**
  41158. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41159. */
  41160. proceduralTexturesEnabled: boolean;
  41161. private _engine;
  41162. private _totalVertices;
  41163. /** @hidden */
  41164. _activeIndices: PerfCounter;
  41165. /** @hidden */
  41166. _activeParticles: PerfCounter;
  41167. /** @hidden */
  41168. _activeBones: PerfCounter;
  41169. private _animationRatio;
  41170. /** @hidden */
  41171. _animationTimeLast: number;
  41172. /** @hidden */
  41173. _animationTime: number;
  41174. /**
  41175. * Gets or sets a general scale for animation speed
  41176. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41177. */
  41178. animationTimeScale: number;
  41179. /** @hidden */
  41180. _cachedMaterial: Nullable<Material>;
  41181. /** @hidden */
  41182. _cachedEffect: Nullable<Effect>;
  41183. /** @hidden */
  41184. _cachedVisibility: Nullable<number>;
  41185. private _renderId;
  41186. private _frameId;
  41187. private _executeWhenReadyTimeoutId;
  41188. private _intermediateRendering;
  41189. private _viewUpdateFlag;
  41190. private _projectionUpdateFlag;
  41191. /** @hidden */
  41192. _toBeDisposed: Nullable<IDisposable>[];
  41193. private _activeRequests;
  41194. /** @hidden */
  41195. _pendingData: any[];
  41196. private _isDisposed;
  41197. /**
  41198. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41199. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41200. */
  41201. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41202. private _activeMeshes;
  41203. private _processedMaterials;
  41204. private _renderTargets;
  41205. /** @hidden */
  41206. _activeParticleSystems: SmartArray<IParticleSystem>;
  41207. private _activeSkeletons;
  41208. private _softwareSkinnedMeshes;
  41209. private _renderingManager;
  41210. /** @hidden */
  41211. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41212. private _transformMatrix;
  41213. private _sceneUbo;
  41214. /** @hidden */
  41215. _viewMatrix: Matrix;
  41216. private _projectionMatrix;
  41217. /** @hidden */
  41218. _forcedViewPosition: Nullable<Vector3>;
  41219. /** @hidden */
  41220. _frustumPlanes: Plane[];
  41221. /**
  41222. * Gets the list of frustum planes (built from the active camera)
  41223. */
  41224. get frustumPlanes(): Plane[];
  41225. /**
  41226. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41227. * This is useful if there are more lights that the maximum simulteanous authorized
  41228. */
  41229. requireLightSorting: boolean;
  41230. /** @hidden */
  41231. readonly useMaterialMeshMap: boolean;
  41232. /** @hidden */
  41233. readonly useClonedMeshMap: boolean;
  41234. private _externalData;
  41235. private _uid;
  41236. /**
  41237. * @hidden
  41238. * Backing store of defined scene components.
  41239. */
  41240. _components: ISceneComponent[];
  41241. /**
  41242. * @hidden
  41243. * Backing store of defined scene components.
  41244. */
  41245. _serializableComponents: ISceneSerializableComponent[];
  41246. /**
  41247. * List of components to register on the next registration step.
  41248. */
  41249. private _transientComponents;
  41250. /**
  41251. * Registers the transient components if needed.
  41252. */
  41253. private _registerTransientComponents;
  41254. /**
  41255. * @hidden
  41256. * Add a component to the scene.
  41257. * Note that the ccomponent could be registered on th next frame if this is called after
  41258. * the register component stage.
  41259. * @param component Defines the component to add to the scene
  41260. */
  41261. _addComponent(component: ISceneComponent): void;
  41262. /**
  41263. * @hidden
  41264. * Gets a component from the scene.
  41265. * @param name defines the name of the component to retrieve
  41266. * @returns the component or null if not present
  41267. */
  41268. _getComponent(name: string): Nullable<ISceneComponent>;
  41269. /**
  41270. * @hidden
  41271. * Defines the actions happening before camera updates.
  41272. */
  41273. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41274. /**
  41275. * @hidden
  41276. * Defines the actions happening before clear the canvas.
  41277. */
  41278. _beforeClearStage: Stage<SimpleStageAction>;
  41279. /**
  41280. * @hidden
  41281. * Defines the actions when collecting render targets for the frame.
  41282. */
  41283. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41284. /**
  41285. * @hidden
  41286. * Defines the actions happening for one camera in the frame.
  41287. */
  41288. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41289. /**
  41290. * @hidden
  41291. * Defines the actions happening during the per mesh ready checks.
  41292. */
  41293. _isReadyForMeshStage: Stage<MeshStageAction>;
  41294. /**
  41295. * @hidden
  41296. * Defines the actions happening before evaluate active mesh checks.
  41297. */
  41298. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41299. /**
  41300. * @hidden
  41301. * Defines the actions happening during the evaluate sub mesh checks.
  41302. */
  41303. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41304. /**
  41305. * @hidden
  41306. * Defines the actions happening during the active mesh stage.
  41307. */
  41308. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41309. /**
  41310. * @hidden
  41311. * Defines the actions happening during the per camera render target step.
  41312. */
  41313. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41314. /**
  41315. * @hidden
  41316. * Defines the actions happening just before the active camera is drawing.
  41317. */
  41318. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41319. /**
  41320. * @hidden
  41321. * Defines the actions happening just before a render target is drawing.
  41322. */
  41323. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41324. /**
  41325. * @hidden
  41326. * Defines the actions happening just before a rendering group is drawing.
  41327. */
  41328. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41329. /**
  41330. * @hidden
  41331. * Defines the actions happening just before a mesh is drawing.
  41332. */
  41333. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41334. /**
  41335. * @hidden
  41336. * Defines the actions happening just after a mesh has been drawn.
  41337. */
  41338. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41339. /**
  41340. * @hidden
  41341. * Defines the actions happening just after a rendering group has been drawn.
  41342. */
  41343. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41344. /**
  41345. * @hidden
  41346. * Defines the actions happening just after the active camera has been drawn.
  41347. */
  41348. _afterCameraDrawStage: Stage<CameraStageAction>;
  41349. /**
  41350. * @hidden
  41351. * Defines the actions happening just after a render target has been drawn.
  41352. */
  41353. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41354. /**
  41355. * @hidden
  41356. * Defines the actions happening just after rendering all cameras and computing intersections.
  41357. */
  41358. _afterRenderStage: Stage<SimpleStageAction>;
  41359. /**
  41360. * @hidden
  41361. * Defines the actions happening when a pointer move event happens.
  41362. */
  41363. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41364. /**
  41365. * @hidden
  41366. * Defines the actions happening when a pointer down event happens.
  41367. */
  41368. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41369. /**
  41370. * @hidden
  41371. * Defines the actions happening when a pointer up event happens.
  41372. */
  41373. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41374. /**
  41375. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41376. */
  41377. private geometriesByUniqueId;
  41378. /**
  41379. * Creates a new Scene
  41380. * @param engine defines the engine to use to render this scene
  41381. * @param options defines the scene options
  41382. */
  41383. constructor(engine: Engine, options?: SceneOptions);
  41384. /**
  41385. * Gets a string idenfifying the name of the class
  41386. * @returns "Scene" string
  41387. */
  41388. getClassName(): string;
  41389. private _defaultMeshCandidates;
  41390. /**
  41391. * @hidden
  41392. */
  41393. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41394. private _defaultSubMeshCandidates;
  41395. /**
  41396. * @hidden
  41397. */
  41398. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41399. /**
  41400. * Sets the default candidate providers for the scene.
  41401. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41402. * and getCollidingSubMeshCandidates to their default function
  41403. */
  41404. setDefaultCandidateProviders(): void;
  41405. /**
  41406. * Gets the mesh that is currently under the pointer
  41407. */
  41408. get meshUnderPointer(): Nullable<AbstractMesh>;
  41409. /**
  41410. * Gets or sets the current on-screen X position of the pointer
  41411. */
  41412. get pointerX(): number;
  41413. set pointerX(value: number);
  41414. /**
  41415. * Gets or sets the current on-screen Y position of the pointer
  41416. */
  41417. get pointerY(): number;
  41418. set pointerY(value: number);
  41419. /**
  41420. * Gets the cached material (ie. the latest rendered one)
  41421. * @returns the cached material
  41422. */
  41423. getCachedMaterial(): Nullable<Material>;
  41424. /**
  41425. * Gets the cached effect (ie. the latest rendered one)
  41426. * @returns the cached effect
  41427. */
  41428. getCachedEffect(): Nullable<Effect>;
  41429. /**
  41430. * Gets the cached visibility state (ie. the latest rendered one)
  41431. * @returns the cached visibility state
  41432. */
  41433. getCachedVisibility(): Nullable<number>;
  41434. /**
  41435. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41436. * @param material defines the current material
  41437. * @param effect defines the current effect
  41438. * @param visibility defines the current visibility state
  41439. * @returns true if one parameter is not cached
  41440. */
  41441. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41442. /**
  41443. * Gets the engine associated with the scene
  41444. * @returns an Engine
  41445. */
  41446. getEngine(): Engine;
  41447. /**
  41448. * Gets the total number of vertices rendered per frame
  41449. * @returns the total number of vertices rendered per frame
  41450. */
  41451. getTotalVertices(): number;
  41452. /**
  41453. * Gets the performance counter for total vertices
  41454. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41455. */
  41456. get totalVerticesPerfCounter(): PerfCounter;
  41457. /**
  41458. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41459. * @returns the total number of active indices rendered per frame
  41460. */
  41461. getActiveIndices(): number;
  41462. /**
  41463. * Gets the performance counter for active indices
  41464. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41465. */
  41466. get totalActiveIndicesPerfCounter(): PerfCounter;
  41467. /**
  41468. * Gets the total number of active particles rendered per frame
  41469. * @returns the total number of active particles rendered per frame
  41470. */
  41471. getActiveParticles(): number;
  41472. /**
  41473. * Gets the performance counter for active particles
  41474. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41475. */
  41476. get activeParticlesPerfCounter(): PerfCounter;
  41477. /**
  41478. * Gets the total number of active bones rendered per frame
  41479. * @returns the total number of active bones rendered per frame
  41480. */
  41481. getActiveBones(): number;
  41482. /**
  41483. * Gets the performance counter for active bones
  41484. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41485. */
  41486. get activeBonesPerfCounter(): PerfCounter;
  41487. /**
  41488. * Gets the array of active meshes
  41489. * @returns an array of AbstractMesh
  41490. */
  41491. getActiveMeshes(): SmartArray<AbstractMesh>;
  41492. /**
  41493. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41494. * @returns a number
  41495. */
  41496. getAnimationRatio(): number;
  41497. /**
  41498. * Gets an unique Id for the current render phase
  41499. * @returns a number
  41500. */
  41501. getRenderId(): number;
  41502. /**
  41503. * Gets an unique Id for the current frame
  41504. * @returns a number
  41505. */
  41506. getFrameId(): number;
  41507. /** Call this function if you want to manually increment the render Id*/
  41508. incrementRenderId(): void;
  41509. private _createUbo;
  41510. /**
  41511. * Use this method to simulate a pointer move on a mesh
  41512. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41513. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41514. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41515. * @returns the current scene
  41516. */
  41517. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41518. /**
  41519. * Use this method to simulate a pointer down on a mesh
  41520. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41521. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41522. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41523. * @returns the current scene
  41524. */
  41525. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41526. /**
  41527. * Use this method to simulate a pointer up on a mesh
  41528. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41529. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41530. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41531. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41532. * @returns the current scene
  41533. */
  41534. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41535. /**
  41536. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41537. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41538. * @returns true if the pointer was captured
  41539. */
  41540. isPointerCaptured(pointerId?: number): boolean;
  41541. /**
  41542. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41543. * @param attachUp defines if you want to attach events to pointerup
  41544. * @param attachDown defines if you want to attach events to pointerdown
  41545. * @param attachMove defines if you want to attach events to pointermove
  41546. */
  41547. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41548. /** Detaches all event handlers*/
  41549. detachControl(): void;
  41550. /**
  41551. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41552. * Delay loaded resources are not taking in account
  41553. * @return true if all required resources are ready
  41554. */
  41555. isReady(): boolean;
  41556. /** Resets all cached information relative to material (including effect and visibility) */
  41557. resetCachedMaterial(): void;
  41558. /**
  41559. * Registers a function to be called before every frame render
  41560. * @param func defines the function to register
  41561. */
  41562. registerBeforeRender(func: () => void): void;
  41563. /**
  41564. * Unregisters a function called before every frame render
  41565. * @param func defines the function to unregister
  41566. */
  41567. unregisterBeforeRender(func: () => void): void;
  41568. /**
  41569. * Registers a function to be called after every frame render
  41570. * @param func defines the function to register
  41571. */
  41572. registerAfterRender(func: () => void): void;
  41573. /**
  41574. * Unregisters a function called after every frame render
  41575. * @param func defines the function to unregister
  41576. */
  41577. unregisterAfterRender(func: () => void): void;
  41578. private _executeOnceBeforeRender;
  41579. /**
  41580. * The provided function will run before render once and will be disposed afterwards.
  41581. * A timeout delay can be provided so that the function will be executed in N ms.
  41582. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41583. * @param func The function to be executed.
  41584. * @param timeout optional delay in ms
  41585. */
  41586. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41587. /** @hidden */
  41588. _addPendingData(data: any): void;
  41589. /** @hidden */
  41590. _removePendingData(data: any): void;
  41591. /**
  41592. * Returns the number of items waiting to be loaded
  41593. * @returns the number of items waiting to be loaded
  41594. */
  41595. getWaitingItemsCount(): number;
  41596. /**
  41597. * Returns a boolean indicating if the scene is still loading data
  41598. */
  41599. get isLoading(): boolean;
  41600. /**
  41601. * Registers a function to be executed when the scene is ready
  41602. * @param {Function} func - the function to be executed
  41603. */
  41604. executeWhenReady(func: () => void): void;
  41605. /**
  41606. * Returns a promise that resolves when the scene is ready
  41607. * @returns A promise that resolves when the scene is ready
  41608. */
  41609. whenReadyAsync(): Promise<void>;
  41610. /** @hidden */
  41611. _checkIsReady(): void;
  41612. /**
  41613. * Gets all animatable attached to the scene
  41614. */
  41615. get animatables(): Animatable[];
  41616. /**
  41617. * Resets the last animation time frame.
  41618. * Useful to override when animations start running when loading a scene for the first time.
  41619. */
  41620. resetLastAnimationTimeFrame(): void;
  41621. /**
  41622. * Gets the current view matrix
  41623. * @returns a Matrix
  41624. */
  41625. getViewMatrix(): Matrix;
  41626. /**
  41627. * Gets the current projection matrix
  41628. * @returns a Matrix
  41629. */
  41630. getProjectionMatrix(): Matrix;
  41631. /**
  41632. * Gets the current transform matrix
  41633. * @returns a Matrix made of View * Projection
  41634. */
  41635. getTransformMatrix(): Matrix;
  41636. /**
  41637. * Sets the current transform matrix
  41638. * @param viewL defines the View matrix to use
  41639. * @param projectionL defines the Projection matrix to use
  41640. * @param viewR defines the right View matrix to use (if provided)
  41641. * @param projectionR defines the right Projection matrix to use (if provided)
  41642. */
  41643. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41644. /**
  41645. * Gets the uniform buffer used to store scene data
  41646. * @returns a UniformBuffer
  41647. */
  41648. getSceneUniformBuffer(): UniformBuffer;
  41649. /**
  41650. * Gets an unique (relatively to the current scene) Id
  41651. * @returns an unique number for the scene
  41652. */
  41653. getUniqueId(): number;
  41654. /**
  41655. * Add a mesh to the list of scene's meshes
  41656. * @param newMesh defines the mesh to add
  41657. * @param recursive if all child meshes should also be added to the scene
  41658. */
  41659. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41660. /**
  41661. * Remove a mesh for the list of scene's meshes
  41662. * @param toRemove defines the mesh to remove
  41663. * @param recursive if all child meshes should also be removed from the scene
  41664. * @returns the index where the mesh was in the mesh list
  41665. */
  41666. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41667. /**
  41668. * Add a transform node to the list of scene's transform nodes
  41669. * @param newTransformNode defines the transform node to add
  41670. */
  41671. addTransformNode(newTransformNode: TransformNode): void;
  41672. /**
  41673. * Remove a transform node for the list of scene's transform nodes
  41674. * @param toRemove defines the transform node to remove
  41675. * @returns the index where the transform node was in the transform node list
  41676. */
  41677. removeTransformNode(toRemove: TransformNode): number;
  41678. /**
  41679. * Remove a skeleton for the list of scene's skeletons
  41680. * @param toRemove defines the skeleton to remove
  41681. * @returns the index where the skeleton was in the skeleton list
  41682. */
  41683. removeSkeleton(toRemove: Skeleton): number;
  41684. /**
  41685. * Remove a morph target for the list of scene's morph targets
  41686. * @param toRemove defines the morph target to remove
  41687. * @returns the index where the morph target was in the morph target list
  41688. */
  41689. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41690. /**
  41691. * Remove a light for the list of scene's lights
  41692. * @param toRemove defines the light to remove
  41693. * @returns the index where the light was in the light list
  41694. */
  41695. removeLight(toRemove: Light): number;
  41696. /**
  41697. * Remove a camera for the list of scene's cameras
  41698. * @param toRemove defines the camera to remove
  41699. * @returns the index where the camera was in the camera list
  41700. */
  41701. removeCamera(toRemove: Camera): number;
  41702. /**
  41703. * Remove a particle system for the list of scene's particle systems
  41704. * @param toRemove defines the particle system to remove
  41705. * @returns the index where the particle system was in the particle system list
  41706. */
  41707. removeParticleSystem(toRemove: IParticleSystem): number;
  41708. /**
  41709. * Remove a animation for the list of scene's animations
  41710. * @param toRemove defines the animation to remove
  41711. * @returns the index where the animation was in the animation list
  41712. */
  41713. removeAnimation(toRemove: Animation): number;
  41714. /**
  41715. * Will stop the animation of the given target
  41716. * @param target - the target
  41717. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41718. * @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)
  41719. */
  41720. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41721. /**
  41722. * Removes the given animation group from this scene.
  41723. * @param toRemove The animation group to remove
  41724. * @returns The index of the removed animation group
  41725. */
  41726. removeAnimationGroup(toRemove: AnimationGroup): number;
  41727. /**
  41728. * Removes the given multi-material from this scene.
  41729. * @param toRemove The multi-material to remove
  41730. * @returns The index of the removed multi-material
  41731. */
  41732. removeMultiMaterial(toRemove: MultiMaterial): number;
  41733. /**
  41734. * Removes the given material from this scene.
  41735. * @param toRemove The material to remove
  41736. * @returns The index of the removed material
  41737. */
  41738. removeMaterial(toRemove: Material): number;
  41739. /**
  41740. * Removes the given action manager from this scene.
  41741. * @param toRemove The action manager to remove
  41742. * @returns The index of the removed action manager
  41743. */
  41744. removeActionManager(toRemove: AbstractActionManager): number;
  41745. /**
  41746. * Removes the given texture from this scene.
  41747. * @param toRemove The texture to remove
  41748. * @returns The index of the removed texture
  41749. */
  41750. removeTexture(toRemove: BaseTexture): number;
  41751. /**
  41752. * Adds the given light to this scene
  41753. * @param newLight The light to add
  41754. */
  41755. addLight(newLight: Light): void;
  41756. /**
  41757. * Sorts the list list based on light priorities
  41758. */
  41759. sortLightsByPriority(): void;
  41760. /**
  41761. * Adds the given camera to this scene
  41762. * @param newCamera The camera to add
  41763. */
  41764. addCamera(newCamera: Camera): void;
  41765. /**
  41766. * Adds the given skeleton to this scene
  41767. * @param newSkeleton The skeleton to add
  41768. */
  41769. addSkeleton(newSkeleton: Skeleton): void;
  41770. /**
  41771. * Adds the given particle system to this scene
  41772. * @param newParticleSystem The particle system to add
  41773. */
  41774. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41775. /**
  41776. * Adds the given animation to this scene
  41777. * @param newAnimation The animation to add
  41778. */
  41779. addAnimation(newAnimation: Animation): void;
  41780. /**
  41781. * Adds the given animation group to this scene.
  41782. * @param newAnimationGroup The animation group to add
  41783. */
  41784. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41785. /**
  41786. * Adds the given multi-material to this scene
  41787. * @param newMultiMaterial The multi-material to add
  41788. */
  41789. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41790. /**
  41791. * Adds the given material to this scene
  41792. * @param newMaterial The material to add
  41793. */
  41794. addMaterial(newMaterial: Material): void;
  41795. /**
  41796. * Adds the given morph target to this scene
  41797. * @param newMorphTargetManager The morph target to add
  41798. */
  41799. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41800. /**
  41801. * Adds the given geometry to this scene
  41802. * @param newGeometry The geometry to add
  41803. */
  41804. addGeometry(newGeometry: Geometry): void;
  41805. /**
  41806. * Adds the given action manager to this scene
  41807. * @param newActionManager The action manager to add
  41808. */
  41809. addActionManager(newActionManager: AbstractActionManager): void;
  41810. /**
  41811. * Adds the given texture to this scene.
  41812. * @param newTexture The texture to add
  41813. */
  41814. addTexture(newTexture: BaseTexture): void;
  41815. /**
  41816. * Switch active camera
  41817. * @param newCamera defines the new active camera
  41818. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41819. */
  41820. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41821. /**
  41822. * sets the active camera of the scene using its ID
  41823. * @param id defines the camera's ID
  41824. * @return the new active camera or null if none found.
  41825. */
  41826. setActiveCameraByID(id: string): Nullable<Camera>;
  41827. /**
  41828. * sets the active camera of the scene using its name
  41829. * @param name defines the camera's name
  41830. * @returns the new active camera or null if none found.
  41831. */
  41832. setActiveCameraByName(name: string): Nullable<Camera>;
  41833. /**
  41834. * get an animation group using its name
  41835. * @param name defines the material's name
  41836. * @return the animation group or null if none found.
  41837. */
  41838. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  41839. /**
  41840. * Get a material using its unique id
  41841. * @param uniqueId defines the material's unique id
  41842. * @return the material or null if none found.
  41843. */
  41844. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  41845. /**
  41846. * get a material using its id
  41847. * @param id defines the material's ID
  41848. * @return the material or null if none found.
  41849. */
  41850. getMaterialByID(id: string): Nullable<Material>;
  41851. /**
  41852. * Gets a the last added material using a given id
  41853. * @param id defines the material's ID
  41854. * @return the last material with the given id or null if none found.
  41855. */
  41856. getLastMaterialByID(id: string): Nullable<Material>;
  41857. /**
  41858. * Gets a material using its name
  41859. * @param name defines the material's name
  41860. * @return the material or null if none found.
  41861. */
  41862. getMaterialByName(name: string): Nullable<Material>;
  41863. /**
  41864. * Get a texture using its unique id
  41865. * @param uniqueId defines the texture's unique id
  41866. * @return the texture or null if none found.
  41867. */
  41868. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  41869. /**
  41870. * Gets a camera using its id
  41871. * @param id defines the id to look for
  41872. * @returns the camera or null if not found
  41873. */
  41874. getCameraByID(id: string): Nullable<Camera>;
  41875. /**
  41876. * Gets a camera using its unique id
  41877. * @param uniqueId defines the unique id to look for
  41878. * @returns the camera or null if not found
  41879. */
  41880. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  41881. /**
  41882. * Gets a camera using its name
  41883. * @param name defines the camera's name
  41884. * @return the camera or null if none found.
  41885. */
  41886. getCameraByName(name: string): Nullable<Camera>;
  41887. /**
  41888. * Gets a bone using its id
  41889. * @param id defines the bone's id
  41890. * @return the bone or null if not found
  41891. */
  41892. getBoneByID(id: string): Nullable<Bone>;
  41893. /**
  41894. * Gets a bone using its id
  41895. * @param name defines the bone's name
  41896. * @return the bone or null if not found
  41897. */
  41898. getBoneByName(name: string): Nullable<Bone>;
  41899. /**
  41900. * Gets a light node using its name
  41901. * @param name defines the the light's name
  41902. * @return the light or null if none found.
  41903. */
  41904. getLightByName(name: string): Nullable<Light>;
  41905. /**
  41906. * Gets a light node using its id
  41907. * @param id defines the light's id
  41908. * @return the light or null if none found.
  41909. */
  41910. getLightByID(id: string): Nullable<Light>;
  41911. /**
  41912. * Gets a light node using its scene-generated unique ID
  41913. * @param uniqueId defines the light's unique id
  41914. * @return the light or null if none found.
  41915. */
  41916. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  41917. /**
  41918. * Gets a particle system by id
  41919. * @param id defines the particle system id
  41920. * @return the corresponding system or null if none found
  41921. */
  41922. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  41923. /**
  41924. * Gets a geometry using its ID
  41925. * @param id defines the geometry's id
  41926. * @return the geometry or null if none found.
  41927. */
  41928. getGeometryByID(id: string): Nullable<Geometry>;
  41929. private _getGeometryByUniqueID;
  41930. /**
  41931. * Add a new geometry to this scene
  41932. * @param geometry defines the geometry to be added to the scene.
  41933. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  41934. * @return a boolean defining if the geometry was added or not
  41935. */
  41936. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  41937. /**
  41938. * Removes an existing geometry
  41939. * @param geometry defines the geometry to be removed from the scene
  41940. * @return a boolean defining if the geometry was removed or not
  41941. */
  41942. removeGeometry(geometry: Geometry): boolean;
  41943. /**
  41944. * Gets the list of geometries attached to the scene
  41945. * @returns an array of Geometry
  41946. */
  41947. getGeometries(): Geometry[];
  41948. /**
  41949. * Gets the first added mesh found of a given ID
  41950. * @param id defines the id to search for
  41951. * @return the mesh found or null if not found at all
  41952. */
  41953. getMeshByID(id: string): Nullable<AbstractMesh>;
  41954. /**
  41955. * Gets a list of meshes using their id
  41956. * @param id defines the id to search for
  41957. * @returns a list of meshes
  41958. */
  41959. getMeshesByID(id: string): Array<AbstractMesh>;
  41960. /**
  41961. * Gets the first added transform node found of a given ID
  41962. * @param id defines the id to search for
  41963. * @return the found transform node or null if not found at all.
  41964. */
  41965. getTransformNodeByID(id: string): Nullable<TransformNode>;
  41966. /**
  41967. * Gets a transform node with its auto-generated unique id
  41968. * @param uniqueId efines the unique id to search for
  41969. * @return the found transform node or null if not found at all.
  41970. */
  41971. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  41972. /**
  41973. * Gets a list of transform nodes using their id
  41974. * @param id defines the id to search for
  41975. * @returns a list of transform nodes
  41976. */
  41977. getTransformNodesByID(id: string): Array<TransformNode>;
  41978. /**
  41979. * Gets a mesh with its auto-generated unique id
  41980. * @param uniqueId defines the unique id to search for
  41981. * @return the found mesh or null if not found at all.
  41982. */
  41983. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  41984. /**
  41985. * Gets a the last added mesh using a given id
  41986. * @param id defines the id to search for
  41987. * @return the found mesh or null if not found at all.
  41988. */
  41989. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  41990. /**
  41991. * Gets a the last added node (Mesh, Camera, Light) using a given id
  41992. * @param id defines the id to search for
  41993. * @return the found node or null if not found at all
  41994. */
  41995. getLastEntryByID(id: string): Nullable<Node>;
  41996. /**
  41997. * Gets a node (Mesh, Camera, Light) using a given id
  41998. * @param id defines the id to search for
  41999. * @return the found node or null if not found at all
  42000. */
  42001. getNodeByID(id: string): Nullable<Node>;
  42002. /**
  42003. * Gets a node (Mesh, Camera, Light) using a given name
  42004. * @param name defines the name to search for
  42005. * @return the found node or null if not found at all.
  42006. */
  42007. getNodeByName(name: string): Nullable<Node>;
  42008. /**
  42009. * Gets a mesh using a given name
  42010. * @param name defines the name to search for
  42011. * @return the found mesh or null if not found at all.
  42012. */
  42013. getMeshByName(name: string): Nullable<AbstractMesh>;
  42014. /**
  42015. * Gets a transform node using a given name
  42016. * @param name defines the name to search for
  42017. * @return the found transform node or null if not found at all.
  42018. */
  42019. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42020. /**
  42021. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42022. * @param id defines the id to search for
  42023. * @return the found skeleton or null if not found at all.
  42024. */
  42025. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42026. /**
  42027. * Gets a skeleton using a given auto generated unique id
  42028. * @param uniqueId defines the unique id to search for
  42029. * @return the found skeleton or null if not found at all.
  42030. */
  42031. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42032. /**
  42033. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42034. * @param id defines the id to search for
  42035. * @return the found skeleton or null if not found at all.
  42036. */
  42037. getSkeletonById(id: string): Nullable<Skeleton>;
  42038. /**
  42039. * Gets a skeleton using a given name
  42040. * @param name defines the name to search for
  42041. * @return the found skeleton or null if not found at all.
  42042. */
  42043. getSkeletonByName(name: string): Nullable<Skeleton>;
  42044. /**
  42045. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42046. * @param id defines the id to search for
  42047. * @return the found morph target manager or null if not found at all.
  42048. */
  42049. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42050. /**
  42051. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42052. * @param id defines the id to search for
  42053. * @return the found morph target or null if not found at all.
  42054. */
  42055. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42056. /**
  42057. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42058. * @param name defines the name to search for
  42059. * @return the found morph target or null if not found at all.
  42060. */
  42061. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42062. /**
  42063. * Gets a boolean indicating if the given mesh is active
  42064. * @param mesh defines the mesh to look for
  42065. * @returns true if the mesh is in the active list
  42066. */
  42067. isActiveMesh(mesh: AbstractMesh): boolean;
  42068. /**
  42069. * Return a unique id as a string which can serve as an identifier for the scene
  42070. */
  42071. get uid(): string;
  42072. /**
  42073. * Add an externaly attached data from its key.
  42074. * This method call will fail and return false, if such key already exists.
  42075. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42076. * @param key the unique key that identifies the data
  42077. * @param data the data object to associate to the key for this Engine instance
  42078. * @return true if no such key were already present and the data was added successfully, false otherwise
  42079. */
  42080. addExternalData<T>(key: string, data: T): boolean;
  42081. /**
  42082. * Get an externaly attached data from its key
  42083. * @param key the unique key that identifies the data
  42084. * @return the associated data, if present (can be null), or undefined if not present
  42085. */
  42086. getExternalData<T>(key: string): Nullable<T>;
  42087. /**
  42088. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42089. * @param key the unique key that identifies the data
  42090. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42091. * @return the associated data, can be null if the factory returned null.
  42092. */
  42093. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42094. /**
  42095. * Remove an externaly attached data from the Engine instance
  42096. * @param key the unique key that identifies the data
  42097. * @return true if the data was successfully removed, false if it doesn't exist
  42098. */
  42099. removeExternalData(key: string): boolean;
  42100. private _evaluateSubMesh;
  42101. /**
  42102. * Clear the processed materials smart array preventing retention point in material dispose.
  42103. */
  42104. freeProcessedMaterials(): void;
  42105. private _preventFreeActiveMeshesAndRenderingGroups;
  42106. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42107. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42108. * when disposing several meshes in a row or a hierarchy of meshes.
  42109. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42110. */
  42111. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42112. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42113. /**
  42114. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42115. */
  42116. freeActiveMeshes(): void;
  42117. /**
  42118. * Clear the info related to rendering groups preventing retention points during dispose.
  42119. */
  42120. freeRenderingGroups(): void;
  42121. /** @hidden */
  42122. _isInIntermediateRendering(): boolean;
  42123. /**
  42124. * Lambda returning the list of potentially active meshes.
  42125. */
  42126. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42127. /**
  42128. * Lambda returning the list of potentially active sub meshes.
  42129. */
  42130. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42131. /**
  42132. * Lambda returning the list of potentially intersecting sub meshes.
  42133. */
  42134. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42135. /**
  42136. * Lambda returning the list of potentially colliding sub meshes.
  42137. */
  42138. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42139. private _activeMeshesFrozen;
  42140. private _skipEvaluateActiveMeshesCompletely;
  42141. /**
  42142. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42143. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42144. * @returns the current scene
  42145. */
  42146. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42147. /**
  42148. * Use this function to restart evaluating active meshes on every frame
  42149. * @returns the current scene
  42150. */
  42151. unfreezeActiveMeshes(): Scene;
  42152. private _evaluateActiveMeshes;
  42153. private _activeMesh;
  42154. /**
  42155. * Update the transform matrix to update from the current active camera
  42156. * @param force defines a boolean used to force the update even if cache is up to date
  42157. */
  42158. updateTransformMatrix(force?: boolean): void;
  42159. private _bindFrameBuffer;
  42160. /** @hidden */
  42161. _allowPostProcessClearColor: boolean;
  42162. /** @hidden */
  42163. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42164. private _processSubCameras;
  42165. private _checkIntersections;
  42166. /** @hidden */
  42167. _advancePhysicsEngineStep(step: number): void;
  42168. /**
  42169. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42170. */
  42171. getDeterministicFrameTime: () => number;
  42172. /** @hidden */
  42173. _animate(): void;
  42174. /** Execute all animations (for a frame) */
  42175. animate(): void;
  42176. /**
  42177. * Render the scene
  42178. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42179. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42180. */
  42181. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42182. /**
  42183. * Freeze all materials
  42184. * A frozen material will not be updatable but should be faster to render
  42185. */
  42186. freezeMaterials(): void;
  42187. /**
  42188. * Unfreeze all materials
  42189. * A frozen material will not be updatable but should be faster to render
  42190. */
  42191. unfreezeMaterials(): void;
  42192. /**
  42193. * Releases all held ressources
  42194. */
  42195. dispose(): void;
  42196. /**
  42197. * Gets if the scene is already disposed
  42198. */
  42199. get isDisposed(): boolean;
  42200. /**
  42201. * Call this function to reduce memory footprint of the scene.
  42202. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42203. */
  42204. clearCachedVertexData(): void;
  42205. /**
  42206. * This function will remove the local cached buffer data from texture.
  42207. * It will save memory but will prevent the texture from being rebuilt
  42208. */
  42209. cleanCachedTextureBuffer(): void;
  42210. /**
  42211. * Get the world extend vectors with an optional filter
  42212. *
  42213. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42214. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42215. */
  42216. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42217. min: Vector3;
  42218. max: Vector3;
  42219. };
  42220. /**
  42221. * Creates a ray that can be used to pick in the scene
  42222. * @param x defines the x coordinate of the origin (on-screen)
  42223. * @param y defines the y coordinate of the origin (on-screen)
  42224. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42225. * @param camera defines the camera to use for the picking
  42226. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42227. * @returns a Ray
  42228. */
  42229. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42230. /**
  42231. * Creates a ray that can be used to pick in the scene
  42232. * @param x defines the x coordinate of the origin (on-screen)
  42233. * @param y defines the y coordinate of the origin (on-screen)
  42234. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42235. * @param result defines the ray where to store the picking ray
  42236. * @param camera defines the camera to use for the picking
  42237. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42238. * @returns the current scene
  42239. */
  42240. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42241. /**
  42242. * Creates a ray that can be used to pick in the scene
  42243. * @param x defines the x coordinate of the origin (on-screen)
  42244. * @param y defines the y coordinate of the origin (on-screen)
  42245. * @param camera defines the camera to use for the picking
  42246. * @returns a Ray
  42247. */
  42248. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42249. /**
  42250. * Creates a ray that can be used to pick in the scene
  42251. * @param x defines the x coordinate of the origin (on-screen)
  42252. * @param y defines the y coordinate of the origin (on-screen)
  42253. * @param result defines the ray where to store the picking ray
  42254. * @param camera defines the camera to use for the picking
  42255. * @returns the current scene
  42256. */
  42257. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42258. /** Launch a ray to try to pick a mesh in the scene
  42259. * @param x position on screen
  42260. * @param y position on screen
  42261. * @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
  42262. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42263. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42264. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42265. * @returns a PickingInfo
  42266. */
  42267. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42268. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42269. * @param x position on screen
  42270. * @param y position on screen
  42271. * @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
  42272. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42273. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42274. * @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)
  42275. */
  42276. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42277. /** Use the given ray to pick a mesh in the scene
  42278. * @param ray The ray to use to pick meshes
  42279. * @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
  42280. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42281. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42282. * @returns a PickingInfo
  42283. */
  42284. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42285. /**
  42286. * Launch a ray to try to pick a mesh in the scene
  42287. * @param x X position on screen
  42288. * @param y Y position on screen
  42289. * @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
  42290. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42291. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42292. * @returns an array of PickingInfo
  42293. */
  42294. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42295. /**
  42296. * Launch a ray to try to pick a mesh in the scene
  42297. * @param ray Ray to use
  42298. * @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
  42299. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42300. * @returns an array of PickingInfo
  42301. */
  42302. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42303. /**
  42304. * Force the value of meshUnderPointer
  42305. * @param mesh defines the mesh to use
  42306. */
  42307. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42308. /**
  42309. * Gets the mesh under the pointer
  42310. * @returns a Mesh or null if no mesh is under the pointer
  42311. */
  42312. getPointerOverMesh(): Nullable<AbstractMesh>;
  42313. /** @hidden */
  42314. _rebuildGeometries(): void;
  42315. /** @hidden */
  42316. _rebuildTextures(): void;
  42317. private _getByTags;
  42318. /**
  42319. * Get a list of meshes by tags
  42320. * @param tagsQuery defines the tags query to use
  42321. * @param forEach defines a predicate used to filter results
  42322. * @returns an array of Mesh
  42323. */
  42324. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42325. /**
  42326. * Get a list of cameras by tags
  42327. * @param tagsQuery defines the tags query to use
  42328. * @param forEach defines a predicate used to filter results
  42329. * @returns an array of Camera
  42330. */
  42331. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42332. /**
  42333. * Get a list of lights by tags
  42334. * @param tagsQuery defines the tags query to use
  42335. * @param forEach defines a predicate used to filter results
  42336. * @returns an array of Light
  42337. */
  42338. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42339. /**
  42340. * Get a list of materials by tags
  42341. * @param tagsQuery defines the tags query to use
  42342. * @param forEach defines a predicate used to filter results
  42343. * @returns an array of Material
  42344. */
  42345. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42346. /**
  42347. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42348. * This allowed control for front to back rendering or reversly depending of the special needs.
  42349. *
  42350. * @param renderingGroupId The rendering group id corresponding to its index
  42351. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42352. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42353. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42354. */
  42355. 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;
  42356. /**
  42357. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42358. *
  42359. * @param renderingGroupId The rendering group id corresponding to its index
  42360. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42361. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42362. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42363. */
  42364. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42365. /**
  42366. * Gets the current auto clear configuration for one rendering group of the rendering
  42367. * manager.
  42368. * @param index the rendering group index to get the information for
  42369. * @returns The auto clear setup for the requested rendering group
  42370. */
  42371. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42372. private _blockMaterialDirtyMechanism;
  42373. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42374. get blockMaterialDirtyMechanism(): boolean;
  42375. set blockMaterialDirtyMechanism(value: boolean);
  42376. /**
  42377. * Will flag all materials as dirty to trigger new shader compilation
  42378. * @param flag defines the flag used to specify which material part must be marked as dirty
  42379. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42380. */
  42381. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42382. /** @hidden */
  42383. _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;
  42384. /** @hidden */
  42385. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42386. /** @hidden */
  42387. _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;
  42388. /** @hidden */
  42389. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42390. /** @hidden */
  42391. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42392. /** @hidden */
  42393. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42394. }
  42395. }
  42396. declare module "babylonjs/assetContainer" {
  42397. import { AbstractScene } from "babylonjs/abstractScene";
  42398. import { Scene } from "babylonjs/scene";
  42399. import { Mesh } from "babylonjs/Meshes/mesh";
  42400. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42401. import { Skeleton } from "babylonjs/Bones/skeleton";
  42402. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42403. import { Animatable } from "babylonjs/Animations/animatable";
  42404. import { Nullable } from "babylonjs/types";
  42405. import { Node } from "babylonjs/node";
  42406. /**
  42407. * Set of assets to keep when moving a scene into an asset container.
  42408. */
  42409. export class KeepAssets extends AbstractScene {
  42410. }
  42411. /**
  42412. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42413. */
  42414. export class InstantiatedEntries {
  42415. /**
  42416. * List of new root nodes (eg. nodes with no parent)
  42417. */
  42418. rootNodes: TransformNode[];
  42419. /**
  42420. * List of new skeletons
  42421. */
  42422. skeletons: Skeleton[];
  42423. /**
  42424. * List of new animation groups
  42425. */
  42426. animationGroups: AnimationGroup[];
  42427. }
  42428. /**
  42429. * Container with a set of assets that can be added or removed from a scene.
  42430. */
  42431. export class AssetContainer extends AbstractScene {
  42432. private _wasAddedToScene;
  42433. /**
  42434. * The scene the AssetContainer belongs to.
  42435. */
  42436. scene: Scene;
  42437. /**
  42438. * Instantiates an AssetContainer.
  42439. * @param scene The scene the AssetContainer belongs to.
  42440. */
  42441. constructor(scene: Scene);
  42442. /**
  42443. * Instantiate or clone all meshes and add the new ones to the scene.
  42444. * Skeletons and animation groups will all be cloned
  42445. * @param nameFunction defines an optional function used to get new names for clones
  42446. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42447. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42448. */
  42449. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42450. /**
  42451. * Adds all the assets from the container to the scene.
  42452. */
  42453. addAllToScene(): void;
  42454. /**
  42455. * Removes all the assets in the container from the scene
  42456. */
  42457. removeAllFromScene(): void;
  42458. /**
  42459. * Disposes all the assets in the container
  42460. */
  42461. dispose(): void;
  42462. private _moveAssets;
  42463. /**
  42464. * Removes all the assets contained in the scene and adds them to the container.
  42465. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42466. */
  42467. moveAllFromScene(keepAssets?: KeepAssets): void;
  42468. /**
  42469. * 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.
  42470. * @returns the root mesh
  42471. */
  42472. createRootMesh(): Mesh;
  42473. /**
  42474. * Merge animations (direct and animation groups) from this asset container into a scene
  42475. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42476. * @param animatables set of animatables to retarget to a node from the scene
  42477. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42478. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42479. */
  42480. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42481. }
  42482. }
  42483. declare module "babylonjs/abstractScene" {
  42484. import { Scene } from "babylonjs/scene";
  42485. import { Nullable } from "babylonjs/types";
  42486. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42487. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42488. import { Geometry } from "babylonjs/Meshes/geometry";
  42489. import { Skeleton } from "babylonjs/Bones/skeleton";
  42490. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42491. import { AssetContainer } from "babylonjs/assetContainer";
  42492. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42493. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42494. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42495. import { Material } from "babylonjs/Materials/material";
  42496. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42497. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42498. import { Camera } from "babylonjs/Cameras/camera";
  42499. import { Light } from "babylonjs/Lights/light";
  42500. import { Node } from "babylonjs/node";
  42501. import { Animation } from "babylonjs/Animations/animation";
  42502. /**
  42503. * Defines how the parser contract is defined.
  42504. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42505. */
  42506. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42507. /**
  42508. * Defines how the individual parser contract is defined.
  42509. * These parser can parse an individual asset
  42510. */
  42511. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42512. /**
  42513. * Base class of the scene acting as a container for the different elements composing a scene.
  42514. * This class is dynamically extended by the different components of the scene increasing
  42515. * flexibility and reducing coupling
  42516. */
  42517. export abstract class AbstractScene {
  42518. /**
  42519. * Stores the list of available parsers in the application.
  42520. */
  42521. private static _BabylonFileParsers;
  42522. /**
  42523. * Stores the list of available individual parsers in the application.
  42524. */
  42525. private static _IndividualBabylonFileParsers;
  42526. /**
  42527. * Adds a parser in the list of available ones
  42528. * @param name Defines the name of the parser
  42529. * @param parser Defines the parser to add
  42530. */
  42531. static AddParser(name: string, parser: BabylonFileParser): void;
  42532. /**
  42533. * Gets a general parser from the list of avaialble ones
  42534. * @param name Defines the name of the parser
  42535. * @returns the requested parser or null
  42536. */
  42537. static GetParser(name: string): Nullable<BabylonFileParser>;
  42538. /**
  42539. * Adds n individual parser in the list of available ones
  42540. * @param name Defines the name of the parser
  42541. * @param parser Defines the parser to add
  42542. */
  42543. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42544. /**
  42545. * Gets an individual parser from the list of avaialble ones
  42546. * @param name Defines the name of the parser
  42547. * @returns the requested parser or null
  42548. */
  42549. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42550. /**
  42551. * Parser json data and populate both a scene and its associated container object
  42552. * @param jsonData Defines the data to parse
  42553. * @param scene Defines the scene to parse the data for
  42554. * @param container Defines the container attached to the parsing sequence
  42555. * @param rootUrl Defines the root url of the data
  42556. */
  42557. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42558. /**
  42559. * Gets the list of root nodes (ie. nodes with no parent)
  42560. */
  42561. rootNodes: Node[];
  42562. /** All of the cameras added to this scene
  42563. * @see https://doc.babylonjs.com/babylon101/cameras
  42564. */
  42565. cameras: Camera[];
  42566. /**
  42567. * All of the lights added to this scene
  42568. * @see https://doc.babylonjs.com/babylon101/lights
  42569. */
  42570. lights: Light[];
  42571. /**
  42572. * All of the (abstract) meshes added to this scene
  42573. */
  42574. meshes: AbstractMesh[];
  42575. /**
  42576. * The list of skeletons added to the scene
  42577. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42578. */
  42579. skeletons: Skeleton[];
  42580. /**
  42581. * All of the particle systems added to this scene
  42582. * @see https://doc.babylonjs.com/babylon101/particles
  42583. */
  42584. particleSystems: IParticleSystem[];
  42585. /**
  42586. * Gets a list of Animations associated with the scene
  42587. */
  42588. animations: Animation[];
  42589. /**
  42590. * All of the animation groups added to this scene
  42591. * @see https://doc.babylonjs.com/how_to/group
  42592. */
  42593. animationGroups: AnimationGroup[];
  42594. /**
  42595. * All of the multi-materials added to this scene
  42596. * @see https://doc.babylonjs.com/how_to/multi_materials
  42597. */
  42598. multiMaterials: MultiMaterial[];
  42599. /**
  42600. * All of the materials added to this scene
  42601. * In the context of a Scene, it is not supposed to be modified manually.
  42602. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42603. * Note also that the order of the Material within the array is not significant and might change.
  42604. * @see https://doc.babylonjs.com/babylon101/materials
  42605. */
  42606. materials: Material[];
  42607. /**
  42608. * The list of morph target managers added to the scene
  42609. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42610. */
  42611. morphTargetManagers: MorphTargetManager[];
  42612. /**
  42613. * The list of geometries used in the scene.
  42614. */
  42615. geometries: Geometry[];
  42616. /**
  42617. * All of the tranform nodes added to this scene
  42618. * In the context of a Scene, it is not supposed to be modified manually.
  42619. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42620. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42621. * @see https://doc.babylonjs.com/how_to/transformnode
  42622. */
  42623. transformNodes: TransformNode[];
  42624. /**
  42625. * ActionManagers available on the scene.
  42626. */
  42627. actionManagers: AbstractActionManager[];
  42628. /**
  42629. * Textures to keep.
  42630. */
  42631. textures: BaseTexture[];
  42632. /**
  42633. * Environment texture for the scene
  42634. */
  42635. environmentTexture: Nullable<BaseTexture>;
  42636. /**
  42637. * @returns all meshes, lights, cameras, transformNodes and bones
  42638. */
  42639. getNodes(): Array<Node>;
  42640. }
  42641. }
  42642. declare module "babylonjs/Audio/sound" {
  42643. import { Observable } from "babylonjs/Misc/observable";
  42644. import { Vector3 } from "babylonjs/Maths/math.vector";
  42645. import { Nullable } from "babylonjs/types";
  42646. import { Scene } from "babylonjs/scene";
  42647. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42648. /**
  42649. * Interface used to define options for Sound class
  42650. */
  42651. export interface ISoundOptions {
  42652. /**
  42653. * Does the sound autoplay once loaded.
  42654. */
  42655. autoplay?: boolean;
  42656. /**
  42657. * Does the sound loop after it finishes playing once.
  42658. */
  42659. loop?: boolean;
  42660. /**
  42661. * Sound's volume
  42662. */
  42663. volume?: number;
  42664. /**
  42665. * Is it a spatial sound?
  42666. */
  42667. spatialSound?: boolean;
  42668. /**
  42669. * Maximum distance to hear that sound
  42670. */
  42671. maxDistance?: number;
  42672. /**
  42673. * Uses user defined attenuation function
  42674. */
  42675. useCustomAttenuation?: boolean;
  42676. /**
  42677. * Define the roll off factor of spatial sounds.
  42678. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42679. */
  42680. rolloffFactor?: number;
  42681. /**
  42682. * Define the reference distance the sound should be heard perfectly.
  42683. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42684. */
  42685. refDistance?: number;
  42686. /**
  42687. * Define the distance attenuation model the sound will follow.
  42688. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42689. */
  42690. distanceModel?: string;
  42691. /**
  42692. * Defines the playback speed (1 by default)
  42693. */
  42694. playbackRate?: number;
  42695. /**
  42696. * Defines if the sound is from a streaming source
  42697. */
  42698. streaming?: boolean;
  42699. /**
  42700. * Defines an optional length (in seconds) inside the sound file
  42701. */
  42702. length?: number;
  42703. /**
  42704. * Defines an optional offset (in seconds) inside the sound file
  42705. */
  42706. offset?: number;
  42707. /**
  42708. * If true, URLs will not be required to state the audio file codec to use.
  42709. */
  42710. skipCodecCheck?: boolean;
  42711. }
  42712. /**
  42713. * Defines a sound that can be played in the application.
  42714. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42715. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42716. */
  42717. export class Sound {
  42718. /**
  42719. * The name of the sound in the scene.
  42720. */
  42721. name: string;
  42722. /**
  42723. * Does the sound autoplay once loaded.
  42724. */
  42725. autoplay: boolean;
  42726. /**
  42727. * Does the sound loop after it finishes playing once.
  42728. */
  42729. loop: boolean;
  42730. /**
  42731. * Does the sound use a custom attenuation curve to simulate the falloff
  42732. * happening when the source gets further away from the camera.
  42733. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42734. */
  42735. useCustomAttenuation: boolean;
  42736. /**
  42737. * The sound track id this sound belongs to.
  42738. */
  42739. soundTrackId: number;
  42740. /**
  42741. * Is this sound currently played.
  42742. */
  42743. isPlaying: boolean;
  42744. /**
  42745. * Is this sound currently paused.
  42746. */
  42747. isPaused: boolean;
  42748. /**
  42749. * Does this sound enables spatial sound.
  42750. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42751. */
  42752. spatialSound: boolean;
  42753. /**
  42754. * Define the reference distance the sound should be heard perfectly.
  42755. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42756. */
  42757. refDistance: number;
  42758. /**
  42759. * Define the roll off factor of spatial sounds.
  42760. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42761. */
  42762. rolloffFactor: number;
  42763. /**
  42764. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42765. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42766. */
  42767. maxDistance: number;
  42768. /**
  42769. * Define the distance attenuation model the sound will follow.
  42770. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42771. */
  42772. distanceModel: string;
  42773. /**
  42774. * @hidden
  42775. * Back Compat
  42776. **/
  42777. onended: () => any;
  42778. /**
  42779. * Gets or sets an object used to store user defined information for the sound.
  42780. */
  42781. metadata: any;
  42782. /**
  42783. * Observable event when the current playing sound finishes.
  42784. */
  42785. onEndedObservable: Observable<Sound>;
  42786. private _panningModel;
  42787. private _playbackRate;
  42788. private _streaming;
  42789. private _startTime;
  42790. private _startOffset;
  42791. private _position;
  42792. /** @hidden */
  42793. _positionInEmitterSpace: boolean;
  42794. private _localDirection;
  42795. private _volume;
  42796. private _isReadyToPlay;
  42797. private _isDirectional;
  42798. private _readyToPlayCallback;
  42799. private _audioBuffer;
  42800. private _soundSource;
  42801. private _streamingSource;
  42802. private _soundPanner;
  42803. private _soundGain;
  42804. private _inputAudioNode;
  42805. private _outputAudioNode;
  42806. private _coneInnerAngle;
  42807. private _coneOuterAngle;
  42808. private _coneOuterGain;
  42809. private _scene;
  42810. private _connectedTransformNode;
  42811. private _customAttenuationFunction;
  42812. private _registerFunc;
  42813. private _isOutputConnected;
  42814. private _htmlAudioElement;
  42815. private _urlType;
  42816. private _length?;
  42817. private _offset?;
  42818. /** @hidden */
  42819. static _SceneComponentInitialization: (scene: Scene) => void;
  42820. /**
  42821. * Create a sound and attach it to a scene
  42822. * @param name Name of your sound
  42823. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  42824. * @param scene defines the scene the sound belongs to
  42825. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  42826. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  42827. */
  42828. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  42829. /**
  42830. * Release the sound and its associated resources
  42831. */
  42832. dispose(): void;
  42833. /**
  42834. * Gets if the sounds is ready to be played or not.
  42835. * @returns true if ready, otherwise false
  42836. */
  42837. isReady(): boolean;
  42838. private _soundLoaded;
  42839. /**
  42840. * Sets the data of the sound from an audiobuffer
  42841. * @param audioBuffer The audioBuffer containing the data
  42842. */
  42843. setAudioBuffer(audioBuffer: AudioBuffer): void;
  42844. /**
  42845. * Updates the current sounds options such as maxdistance, loop...
  42846. * @param options A JSON object containing values named as the object properties
  42847. */
  42848. updateOptions(options: ISoundOptions): void;
  42849. private _createSpatialParameters;
  42850. private _updateSpatialParameters;
  42851. /**
  42852. * Switch the panning model to HRTF:
  42853. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  42854. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42855. */
  42856. switchPanningModelToHRTF(): void;
  42857. /**
  42858. * Switch the panning model to Equal Power:
  42859. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  42860. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42861. */
  42862. switchPanningModelToEqualPower(): void;
  42863. private _switchPanningModel;
  42864. /**
  42865. * Connect this sound to a sound track audio node like gain...
  42866. * @param soundTrackAudioNode the sound track audio node to connect to
  42867. */
  42868. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  42869. /**
  42870. * Transform this sound into a directional source
  42871. * @param coneInnerAngle Size of the inner cone in degree
  42872. * @param coneOuterAngle Size of the outer cone in degree
  42873. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  42874. */
  42875. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  42876. /**
  42877. * Gets or sets the inner angle for the directional cone.
  42878. */
  42879. get directionalConeInnerAngle(): number;
  42880. /**
  42881. * Gets or sets the inner angle for the directional cone.
  42882. */
  42883. set directionalConeInnerAngle(value: number);
  42884. /**
  42885. * Gets or sets the outer angle for the directional cone.
  42886. */
  42887. get directionalConeOuterAngle(): number;
  42888. /**
  42889. * Gets or sets the outer angle for the directional cone.
  42890. */
  42891. set directionalConeOuterAngle(value: number);
  42892. /**
  42893. * Sets the position of the emitter if spatial sound is enabled
  42894. * @param newPosition Defines the new posisiton
  42895. */
  42896. setPosition(newPosition: Vector3): void;
  42897. /**
  42898. * Sets the local direction of the emitter if spatial sound is enabled
  42899. * @param newLocalDirection Defines the new local direction
  42900. */
  42901. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  42902. private _updateDirection;
  42903. /** @hidden */
  42904. updateDistanceFromListener(): void;
  42905. /**
  42906. * Sets a new custom attenuation function for the sound.
  42907. * @param callback Defines the function used for the attenuation
  42908. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42909. */
  42910. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  42911. /**
  42912. * Play the sound
  42913. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  42914. * @param offset (optional) Start the sound at a specific time in seconds
  42915. * @param length (optional) Sound duration (in seconds)
  42916. */
  42917. play(time?: number, offset?: number, length?: number): void;
  42918. private _onended;
  42919. /**
  42920. * Stop the sound
  42921. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  42922. */
  42923. stop(time?: number): void;
  42924. /**
  42925. * Put the sound in pause
  42926. */
  42927. pause(): void;
  42928. /**
  42929. * Sets a dedicated volume for this sounds
  42930. * @param newVolume Define the new volume of the sound
  42931. * @param time Define time for gradual change to new volume
  42932. */
  42933. setVolume(newVolume: number, time?: number): void;
  42934. /**
  42935. * Set the sound play back rate
  42936. * @param newPlaybackRate Define the playback rate the sound should be played at
  42937. */
  42938. setPlaybackRate(newPlaybackRate: number): void;
  42939. /**
  42940. * Gets the volume of the sound.
  42941. * @returns the volume of the sound
  42942. */
  42943. getVolume(): number;
  42944. /**
  42945. * Attach the sound to a dedicated mesh
  42946. * @param transformNode The transform node to connect the sound with
  42947. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42948. */
  42949. attachToMesh(transformNode: TransformNode): void;
  42950. /**
  42951. * Detach the sound from the previously attached mesh
  42952. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42953. */
  42954. detachFromMesh(): void;
  42955. private _onRegisterAfterWorldMatrixUpdate;
  42956. /**
  42957. * Clone the current sound in the scene.
  42958. * @returns the new sound clone
  42959. */
  42960. clone(): Nullable<Sound>;
  42961. /**
  42962. * Gets the current underlying audio buffer containing the data
  42963. * @returns the audio buffer
  42964. */
  42965. getAudioBuffer(): Nullable<AudioBuffer>;
  42966. /**
  42967. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  42968. * @returns the source node
  42969. */
  42970. getSoundSource(): Nullable<AudioBufferSourceNode>;
  42971. /**
  42972. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  42973. * @returns the gain node
  42974. */
  42975. getSoundGain(): Nullable<GainNode>;
  42976. /**
  42977. * Serializes the Sound in a JSON representation
  42978. * @returns the JSON representation of the sound
  42979. */
  42980. serialize(): any;
  42981. /**
  42982. * Parse a JSON representation of a sound to innstantiate in a given scene
  42983. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  42984. * @param scene Define the scene the new parsed sound should be created in
  42985. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  42986. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  42987. * @returns the newly parsed sound
  42988. */
  42989. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  42990. }
  42991. }
  42992. declare module "babylonjs/Actions/directAudioActions" {
  42993. import { Action } from "babylonjs/Actions/action";
  42994. import { Condition } from "babylonjs/Actions/condition";
  42995. import { Sound } from "babylonjs/Audio/sound";
  42996. /**
  42997. * This defines an action helpful to play a defined sound on a triggered action.
  42998. */
  42999. export class PlaySoundAction extends Action {
  43000. private _sound;
  43001. /**
  43002. * Instantiate the action
  43003. * @param triggerOptions defines the trigger options
  43004. * @param sound defines the sound to play
  43005. * @param condition defines the trigger related conditions
  43006. */
  43007. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43008. /** @hidden */
  43009. _prepare(): void;
  43010. /**
  43011. * Execute the action and play the sound.
  43012. */
  43013. execute(): void;
  43014. /**
  43015. * Serializes the actions and its related information.
  43016. * @param parent defines the object to serialize in
  43017. * @returns the serialized object
  43018. */
  43019. serialize(parent: any): any;
  43020. }
  43021. /**
  43022. * This defines an action helpful to stop a defined sound on a triggered action.
  43023. */
  43024. export class StopSoundAction extends Action {
  43025. private _sound;
  43026. /**
  43027. * Instantiate the action
  43028. * @param triggerOptions defines the trigger options
  43029. * @param sound defines the sound to stop
  43030. * @param condition defines the trigger related conditions
  43031. */
  43032. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43033. /** @hidden */
  43034. _prepare(): void;
  43035. /**
  43036. * Execute the action and stop the sound.
  43037. */
  43038. execute(): void;
  43039. /**
  43040. * Serializes the actions and its related information.
  43041. * @param parent defines the object to serialize in
  43042. * @returns the serialized object
  43043. */
  43044. serialize(parent: any): any;
  43045. }
  43046. }
  43047. declare module "babylonjs/Actions/interpolateValueAction" {
  43048. import { Action } from "babylonjs/Actions/action";
  43049. import { Condition } from "babylonjs/Actions/condition";
  43050. import { Observable } from "babylonjs/Misc/observable";
  43051. /**
  43052. * This defines an action responsible to change the value of a property
  43053. * by interpolating between its current value and the newly set one once triggered.
  43054. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43055. */
  43056. export class InterpolateValueAction extends Action {
  43057. /**
  43058. * Defines the path of the property where the value should be interpolated
  43059. */
  43060. propertyPath: string;
  43061. /**
  43062. * Defines the target value at the end of the interpolation.
  43063. */
  43064. value: any;
  43065. /**
  43066. * Defines the time it will take for the property to interpolate to the value.
  43067. */
  43068. duration: number;
  43069. /**
  43070. * Defines if the other scene animations should be stopped when the action has been triggered
  43071. */
  43072. stopOtherAnimations?: boolean;
  43073. /**
  43074. * Defines a callback raised once the interpolation animation has been done.
  43075. */
  43076. onInterpolationDone?: () => void;
  43077. /**
  43078. * Observable triggered once the interpolation animation has been done.
  43079. */
  43080. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43081. private _target;
  43082. private _effectiveTarget;
  43083. private _property;
  43084. /**
  43085. * Instantiate the action
  43086. * @param triggerOptions defines the trigger options
  43087. * @param target defines the object containing the value to interpolate
  43088. * @param propertyPath defines the path to the property in the target object
  43089. * @param value defines the target value at the end of the interpolation
  43090. * @param duration deines the time it will take for the property to interpolate to the value.
  43091. * @param condition defines the trigger related conditions
  43092. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43093. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43094. */
  43095. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43096. /** @hidden */
  43097. _prepare(): void;
  43098. /**
  43099. * Execute the action starts the value interpolation.
  43100. */
  43101. execute(): void;
  43102. /**
  43103. * Serializes the actions and its related information.
  43104. * @param parent defines the object to serialize in
  43105. * @returns the serialized object
  43106. */
  43107. serialize(parent: any): any;
  43108. }
  43109. }
  43110. declare module "babylonjs/Actions/index" {
  43111. export * from "babylonjs/Actions/abstractActionManager";
  43112. export * from "babylonjs/Actions/action";
  43113. export * from "babylonjs/Actions/actionEvent";
  43114. export * from "babylonjs/Actions/actionManager";
  43115. export * from "babylonjs/Actions/condition";
  43116. export * from "babylonjs/Actions/directActions";
  43117. export * from "babylonjs/Actions/directAudioActions";
  43118. export * from "babylonjs/Actions/interpolateValueAction";
  43119. }
  43120. declare module "babylonjs/Animations/index" {
  43121. export * from "babylonjs/Animations/animatable";
  43122. export * from "babylonjs/Animations/animation";
  43123. export * from "babylonjs/Animations/animationGroup";
  43124. export * from "babylonjs/Animations/animationPropertiesOverride";
  43125. export * from "babylonjs/Animations/easing";
  43126. export * from "babylonjs/Animations/runtimeAnimation";
  43127. export * from "babylonjs/Animations/animationEvent";
  43128. export * from "babylonjs/Animations/animationGroup";
  43129. export * from "babylonjs/Animations/animationKey";
  43130. export * from "babylonjs/Animations/animationRange";
  43131. export * from "babylonjs/Animations/animatable.interface";
  43132. }
  43133. declare module "babylonjs/Audio/soundTrack" {
  43134. import { Sound } from "babylonjs/Audio/sound";
  43135. import { Analyser } from "babylonjs/Audio/analyser";
  43136. import { Scene } from "babylonjs/scene";
  43137. /**
  43138. * Options allowed during the creation of a sound track.
  43139. */
  43140. export interface ISoundTrackOptions {
  43141. /**
  43142. * The volume the sound track should take during creation
  43143. */
  43144. volume?: number;
  43145. /**
  43146. * Define if the sound track is the main sound track of the scene
  43147. */
  43148. mainTrack?: boolean;
  43149. }
  43150. /**
  43151. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43152. * It will be also used in a future release to apply effects on a specific track.
  43153. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43154. */
  43155. export class SoundTrack {
  43156. /**
  43157. * The unique identifier of the sound track in the scene.
  43158. */
  43159. id: number;
  43160. /**
  43161. * The list of sounds included in the sound track.
  43162. */
  43163. soundCollection: Array<Sound>;
  43164. private _outputAudioNode;
  43165. private _scene;
  43166. private _connectedAnalyser;
  43167. private _options;
  43168. private _isInitialized;
  43169. /**
  43170. * Creates a new sound track.
  43171. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43172. * @param scene Define the scene the sound track belongs to
  43173. * @param options
  43174. */
  43175. constructor(scene: Scene, options?: ISoundTrackOptions);
  43176. private _initializeSoundTrackAudioGraph;
  43177. /**
  43178. * Release the sound track and its associated resources
  43179. */
  43180. dispose(): void;
  43181. /**
  43182. * Adds a sound to this sound track
  43183. * @param sound define the cound to add
  43184. * @ignoreNaming
  43185. */
  43186. AddSound(sound: Sound): void;
  43187. /**
  43188. * Removes a sound to this sound track
  43189. * @param sound define the cound to remove
  43190. * @ignoreNaming
  43191. */
  43192. RemoveSound(sound: Sound): void;
  43193. /**
  43194. * Set a global volume for the full sound track.
  43195. * @param newVolume Define the new volume of the sound track
  43196. */
  43197. setVolume(newVolume: number): void;
  43198. /**
  43199. * Switch the panning model to HRTF:
  43200. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43201. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43202. */
  43203. switchPanningModelToHRTF(): void;
  43204. /**
  43205. * Switch the panning model to Equal Power:
  43206. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43207. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43208. */
  43209. switchPanningModelToEqualPower(): void;
  43210. /**
  43211. * Connect the sound track to an audio analyser allowing some amazing
  43212. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43213. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43214. * @param analyser The analyser to connect to the engine
  43215. */
  43216. connectToAnalyser(analyser: Analyser): void;
  43217. }
  43218. }
  43219. declare module "babylonjs/Audio/audioSceneComponent" {
  43220. import { Sound } from "babylonjs/Audio/sound";
  43221. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43222. import { Nullable } from "babylonjs/types";
  43223. import { Vector3 } from "babylonjs/Maths/math.vector";
  43224. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43225. import { Scene } from "babylonjs/scene";
  43226. import { AbstractScene } from "babylonjs/abstractScene";
  43227. import "babylonjs/Audio/audioEngine";
  43228. module "babylonjs/abstractScene" {
  43229. interface AbstractScene {
  43230. /**
  43231. * The list of sounds used in the scene.
  43232. */
  43233. sounds: Nullable<Array<Sound>>;
  43234. }
  43235. }
  43236. module "babylonjs/scene" {
  43237. interface Scene {
  43238. /**
  43239. * @hidden
  43240. * Backing field
  43241. */
  43242. _mainSoundTrack: SoundTrack;
  43243. /**
  43244. * The main sound track played by the scene.
  43245. * It cotains your primary collection of sounds.
  43246. */
  43247. mainSoundTrack: SoundTrack;
  43248. /**
  43249. * The list of sound tracks added to the scene
  43250. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43251. */
  43252. soundTracks: Nullable<Array<SoundTrack>>;
  43253. /**
  43254. * Gets a sound using a given name
  43255. * @param name defines the name to search for
  43256. * @return the found sound or null if not found at all.
  43257. */
  43258. getSoundByName(name: string): Nullable<Sound>;
  43259. /**
  43260. * Gets or sets if audio support is enabled
  43261. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43262. */
  43263. audioEnabled: boolean;
  43264. /**
  43265. * Gets or sets if audio will be output to headphones
  43266. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43267. */
  43268. headphone: boolean;
  43269. /**
  43270. * Gets or sets custom audio listener position provider
  43271. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43272. */
  43273. audioListenerPositionProvider: Nullable<() => Vector3>;
  43274. /**
  43275. * Gets or sets a refresh rate when using 3D audio positioning
  43276. */
  43277. audioPositioningRefreshRate: number;
  43278. }
  43279. }
  43280. /**
  43281. * Defines the sound scene component responsible to manage any sounds
  43282. * in a given scene.
  43283. */
  43284. export class AudioSceneComponent implements ISceneSerializableComponent {
  43285. /**
  43286. * The component name helpfull to identify the component in the list of scene components.
  43287. */
  43288. readonly name: string;
  43289. /**
  43290. * The scene the component belongs to.
  43291. */
  43292. scene: Scene;
  43293. private _audioEnabled;
  43294. /**
  43295. * Gets whether audio is enabled or not.
  43296. * Please use related enable/disable method to switch state.
  43297. */
  43298. get audioEnabled(): boolean;
  43299. private _headphone;
  43300. /**
  43301. * Gets whether audio is outputing to headphone or not.
  43302. * Please use the according Switch methods to change output.
  43303. */
  43304. get headphone(): boolean;
  43305. /**
  43306. * Gets or sets a refresh rate when using 3D audio positioning
  43307. */
  43308. audioPositioningRefreshRate: number;
  43309. private _audioListenerPositionProvider;
  43310. /**
  43311. * Gets the current audio listener position provider
  43312. */
  43313. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43314. /**
  43315. * Sets a custom listener position for all sounds in the scene
  43316. * By default, this is the position of the first active camera
  43317. */
  43318. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43319. /**
  43320. * Creates a new instance of the component for the given scene
  43321. * @param scene Defines the scene to register the component in
  43322. */
  43323. constructor(scene: Scene);
  43324. /**
  43325. * Registers the component in a given scene
  43326. */
  43327. register(): void;
  43328. /**
  43329. * Rebuilds the elements related to this component in case of
  43330. * context lost for instance.
  43331. */
  43332. rebuild(): void;
  43333. /**
  43334. * Serializes the component data to the specified json object
  43335. * @param serializationObject The object to serialize to
  43336. */
  43337. serialize(serializationObject: any): void;
  43338. /**
  43339. * Adds all the elements from the container to the scene
  43340. * @param container the container holding the elements
  43341. */
  43342. addFromContainer(container: AbstractScene): void;
  43343. /**
  43344. * Removes all the elements in the container from the scene
  43345. * @param container contains the elements to remove
  43346. * @param dispose if the removed element should be disposed (default: false)
  43347. */
  43348. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43349. /**
  43350. * Disposes the component and the associated ressources.
  43351. */
  43352. dispose(): void;
  43353. /**
  43354. * Disables audio in the associated scene.
  43355. */
  43356. disableAudio(): void;
  43357. /**
  43358. * Enables audio in the associated scene.
  43359. */
  43360. enableAudio(): void;
  43361. /**
  43362. * Switch audio to headphone output.
  43363. */
  43364. switchAudioModeForHeadphones(): void;
  43365. /**
  43366. * Switch audio to normal speakers.
  43367. */
  43368. switchAudioModeForNormalSpeakers(): void;
  43369. private _cachedCameraDirection;
  43370. private _cachedCameraPosition;
  43371. private _lastCheck;
  43372. private _afterRender;
  43373. }
  43374. }
  43375. declare module "babylonjs/Audio/weightedsound" {
  43376. import { Sound } from "babylonjs/Audio/sound";
  43377. /**
  43378. * Wraps one or more Sound objects and selects one with random weight for playback.
  43379. */
  43380. export class WeightedSound {
  43381. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43382. loop: boolean;
  43383. private _coneInnerAngle;
  43384. private _coneOuterAngle;
  43385. private _volume;
  43386. /** A Sound is currently playing. */
  43387. isPlaying: boolean;
  43388. /** A Sound is currently paused. */
  43389. isPaused: boolean;
  43390. private _sounds;
  43391. private _weights;
  43392. private _currentIndex?;
  43393. /**
  43394. * Creates a new WeightedSound from the list of sounds given.
  43395. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43396. * @param sounds Array of Sounds that will be selected from.
  43397. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43398. */
  43399. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43400. /**
  43401. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43402. */
  43403. get directionalConeInnerAngle(): number;
  43404. /**
  43405. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43406. */
  43407. set directionalConeInnerAngle(value: number);
  43408. /**
  43409. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43410. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43411. */
  43412. get directionalConeOuterAngle(): number;
  43413. /**
  43414. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43415. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43416. */
  43417. set directionalConeOuterAngle(value: number);
  43418. /**
  43419. * Playback volume.
  43420. */
  43421. get volume(): number;
  43422. /**
  43423. * Playback volume.
  43424. */
  43425. set volume(value: number);
  43426. private _onended;
  43427. /**
  43428. * Suspend playback
  43429. */
  43430. pause(): void;
  43431. /**
  43432. * Stop playback
  43433. */
  43434. stop(): void;
  43435. /**
  43436. * Start playback.
  43437. * @param startOffset Position the clip head at a specific time in seconds.
  43438. */
  43439. play(startOffset?: number): void;
  43440. }
  43441. }
  43442. declare module "babylonjs/Audio/index" {
  43443. export * from "babylonjs/Audio/analyser";
  43444. export * from "babylonjs/Audio/audioEngine";
  43445. export * from "babylonjs/Audio/audioSceneComponent";
  43446. export * from "babylonjs/Audio/sound";
  43447. export * from "babylonjs/Audio/soundTrack";
  43448. export * from "babylonjs/Audio/weightedsound";
  43449. }
  43450. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43451. import { Behavior } from "babylonjs/Behaviors/behavior";
  43452. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43453. import { BackEase } from "babylonjs/Animations/easing";
  43454. /**
  43455. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43456. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43457. */
  43458. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43459. /**
  43460. * Gets the name of the behavior.
  43461. */
  43462. get name(): string;
  43463. /**
  43464. * The easing function used by animations
  43465. */
  43466. static EasingFunction: BackEase;
  43467. /**
  43468. * The easing mode used by animations
  43469. */
  43470. static EasingMode: number;
  43471. /**
  43472. * The duration of the animation, in milliseconds
  43473. */
  43474. transitionDuration: number;
  43475. /**
  43476. * Length of the distance animated by the transition when lower radius is reached
  43477. */
  43478. lowerRadiusTransitionRange: number;
  43479. /**
  43480. * Length of the distance animated by the transition when upper radius is reached
  43481. */
  43482. upperRadiusTransitionRange: number;
  43483. private _autoTransitionRange;
  43484. /**
  43485. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43486. */
  43487. get autoTransitionRange(): boolean;
  43488. /**
  43489. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43490. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43491. */
  43492. set autoTransitionRange(value: boolean);
  43493. private _attachedCamera;
  43494. private _onAfterCheckInputsObserver;
  43495. private _onMeshTargetChangedObserver;
  43496. /**
  43497. * Initializes the behavior.
  43498. */
  43499. init(): void;
  43500. /**
  43501. * Attaches the behavior to its arc rotate camera.
  43502. * @param camera Defines the camera to attach the behavior to
  43503. */
  43504. attach(camera: ArcRotateCamera): void;
  43505. /**
  43506. * Detaches the behavior from its current arc rotate camera.
  43507. */
  43508. detach(): void;
  43509. private _radiusIsAnimating;
  43510. private _radiusBounceTransition;
  43511. private _animatables;
  43512. private _cachedWheelPrecision;
  43513. /**
  43514. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43515. * @param radiusLimit The limit to check against.
  43516. * @return Bool to indicate if at limit.
  43517. */
  43518. private _isRadiusAtLimit;
  43519. /**
  43520. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43521. * @param radiusDelta The delta by which to animate to. Can be negative.
  43522. */
  43523. private _applyBoundRadiusAnimation;
  43524. /**
  43525. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43526. */
  43527. protected _clearAnimationLocks(): void;
  43528. /**
  43529. * Stops and removes all animations that have been applied to the camera
  43530. */
  43531. stopAllAnimations(): void;
  43532. }
  43533. }
  43534. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43535. import { Behavior } from "babylonjs/Behaviors/behavior";
  43536. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43537. import { ExponentialEase } from "babylonjs/Animations/easing";
  43538. import { Nullable } from "babylonjs/types";
  43539. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43540. import { Vector3 } from "babylonjs/Maths/math.vector";
  43541. /**
  43542. * 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.
  43543. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43544. */
  43545. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43546. /**
  43547. * Gets the name of the behavior.
  43548. */
  43549. get name(): string;
  43550. private _mode;
  43551. private _radiusScale;
  43552. private _positionScale;
  43553. private _defaultElevation;
  43554. private _elevationReturnTime;
  43555. private _elevationReturnWaitTime;
  43556. private _zoomStopsAnimation;
  43557. private _framingTime;
  43558. /**
  43559. * The easing function used by animations
  43560. */
  43561. static EasingFunction: ExponentialEase;
  43562. /**
  43563. * The easing mode used by animations
  43564. */
  43565. static EasingMode: number;
  43566. /**
  43567. * Sets the current mode used by the behavior
  43568. */
  43569. set mode(mode: number);
  43570. /**
  43571. * Gets current mode used by the behavior.
  43572. */
  43573. get mode(): number;
  43574. /**
  43575. * Sets the scale applied to the radius (1 by default)
  43576. */
  43577. set radiusScale(radius: number);
  43578. /**
  43579. * Gets the scale applied to the radius
  43580. */
  43581. get radiusScale(): number;
  43582. /**
  43583. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43584. */
  43585. set positionScale(scale: number);
  43586. /**
  43587. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43588. */
  43589. get positionScale(): number;
  43590. /**
  43591. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43592. * behaviour is triggered, in radians.
  43593. */
  43594. set defaultElevation(elevation: number);
  43595. /**
  43596. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43597. * behaviour is triggered, in radians.
  43598. */
  43599. get defaultElevation(): number;
  43600. /**
  43601. * Sets the time (in milliseconds) taken to return to the default beta position.
  43602. * Negative value indicates camera should not return to default.
  43603. */
  43604. set elevationReturnTime(speed: number);
  43605. /**
  43606. * Gets the time (in milliseconds) taken to return to the default beta position.
  43607. * Negative value indicates camera should not return to default.
  43608. */
  43609. get elevationReturnTime(): number;
  43610. /**
  43611. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43612. */
  43613. set elevationReturnWaitTime(time: number);
  43614. /**
  43615. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43616. */
  43617. get elevationReturnWaitTime(): number;
  43618. /**
  43619. * Sets the flag that indicates if user zooming should stop animation.
  43620. */
  43621. set zoomStopsAnimation(flag: boolean);
  43622. /**
  43623. * Gets the flag that indicates if user zooming should stop animation.
  43624. */
  43625. get zoomStopsAnimation(): boolean;
  43626. /**
  43627. * Sets the transition time when framing the mesh, in milliseconds
  43628. */
  43629. set framingTime(time: number);
  43630. /**
  43631. * Gets the transition time when framing the mesh, in milliseconds
  43632. */
  43633. get framingTime(): number;
  43634. /**
  43635. * Define if the behavior should automatically change the configured
  43636. * camera limits and sensibilities.
  43637. */
  43638. autoCorrectCameraLimitsAndSensibility: boolean;
  43639. private _onPrePointerObservableObserver;
  43640. private _onAfterCheckInputsObserver;
  43641. private _onMeshTargetChangedObserver;
  43642. private _attachedCamera;
  43643. private _isPointerDown;
  43644. private _lastInteractionTime;
  43645. /**
  43646. * Initializes the behavior.
  43647. */
  43648. init(): void;
  43649. /**
  43650. * Attaches the behavior to its arc rotate camera.
  43651. * @param camera Defines the camera to attach the behavior to
  43652. */
  43653. attach(camera: ArcRotateCamera): void;
  43654. /**
  43655. * Detaches the behavior from its current arc rotate camera.
  43656. */
  43657. detach(): void;
  43658. private _animatables;
  43659. private _betaIsAnimating;
  43660. private _betaTransition;
  43661. private _radiusTransition;
  43662. private _vectorTransition;
  43663. /**
  43664. * Targets the given mesh and updates zoom level accordingly.
  43665. * @param mesh The mesh to target.
  43666. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43667. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43668. */
  43669. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43670. /**
  43671. * Targets the given mesh with its children and updates zoom level accordingly.
  43672. * @param mesh The mesh to target.
  43673. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43674. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43675. */
  43676. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43677. /**
  43678. * Targets the given meshes with their children and updates zoom level accordingly.
  43679. * @param meshes The mesh to target.
  43680. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43681. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43682. */
  43683. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43684. /**
  43685. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43686. * @param minimumWorld Determines the smaller position of the bounding box extend
  43687. * @param maximumWorld Determines the bigger position of the bounding box extend
  43688. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43689. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43690. */
  43691. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43692. /**
  43693. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43694. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43695. * frustum width.
  43696. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43697. * to fully enclose the mesh in the viewing frustum.
  43698. */
  43699. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43700. /**
  43701. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43702. * is automatically returned to its default position (expected to be above ground plane).
  43703. */
  43704. private _maintainCameraAboveGround;
  43705. /**
  43706. * Returns the frustum slope based on the canvas ratio and camera FOV
  43707. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43708. */
  43709. private _getFrustumSlope;
  43710. /**
  43711. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43712. */
  43713. private _clearAnimationLocks;
  43714. /**
  43715. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43716. */
  43717. private _applyUserInteraction;
  43718. /**
  43719. * Stops and removes all animations that have been applied to the camera
  43720. */
  43721. stopAllAnimations(): void;
  43722. /**
  43723. * Gets a value indicating if the user is moving the camera
  43724. */
  43725. get isUserIsMoving(): boolean;
  43726. /**
  43727. * The camera can move all the way towards the mesh.
  43728. */
  43729. static IgnoreBoundsSizeMode: number;
  43730. /**
  43731. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43732. */
  43733. static FitFrustumSidesMode: number;
  43734. }
  43735. }
  43736. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43737. import { Nullable } from "babylonjs/types";
  43738. import { Camera } from "babylonjs/Cameras/camera";
  43739. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43740. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43741. /**
  43742. * Base class for Camera Pointer Inputs.
  43743. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43744. * for example usage.
  43745. */
  43746. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43747. /**
  43748. * Defines the camera the input is attached to.
  43749. */
  43750. abstract camera: Camera;
  43751. /**
  43752. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43753. */
  43754. protected _altKey: boolean;
  43755. protected _ctrlKey: boolean;
  43756. protected _metaKey: boolean;
  43757. protected _shiftKey: boolean;
  43758. /**
  43759. * Which mouse buttons were pressed at time of last mouse event.
  43760. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43761. */
  43762. protected _buttonsPressed: number;
  43763. /**
  43764. * Defines the buttons associated with the input to handle camera move.
  43765. */
  43766. buttons: number[];
  43767. /**
  43768. * Attach the input controls to a specific dom element to get the input from.
  43769. * @param element Defines the element the controls should be listened from
  43770. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43771. */
  43772. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43773. /**
  43774. * Detach the current controls from the specified dom element.
  43775. * @param element Defines the element to stop listening the inputs from
  43776. */
  43777. detachControl(element: Nullable<HTMLElement>): void;
  43778. /**
  43779. * Gets the class name of the current input.
  43780. * @returns the class name
  43781. */
  43782. getClassName(): string;
  43783. /**
  43784. * Get the friendly name associated with the input class.
  43785. * @returns the input friendly name
  43786. */
  43787. getSimpleName(): string;
  43788. /**
  43789. * Called on pointer POINTERDOUBLETAP event.
  43790. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43791. */
  43792. protected onDoubleTap(type: string): void;
  43793. /**
  43794. * Called on pointer POINTERMOVE event if only a single touch is active.
  43795. * Override this method to provide functionality.
  43796. */
  43797. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43798. /**
  43799. * Called on pointer POINTERMOVE event if multiple touches are active.
  43800. * Override this method to provide functionality.
  43801. */
  43802. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43803. /**
  43804. * Called on JS contextmenu event.
  43805. * Override this method to provide functionality.
  43806. */
  43807. protected onContextMenu(evt: PointerEvent): void;
  43808. /**
  43809. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43810. * press.
  43811. * Override this method to provide functionality.
  43812. */
  43813. protected onButtonDown(evt: PointerEvent): void;
  43814. /**
  43815. * Called each time a new POINTERUP event occurs. Ie, for each button
  43816. * release.
  43817. * Override this method to provide functionality.
  43818. */
  43819. protected onButtonUp(evt: PointerEvent): void;
  43820. /**
  43821. * Called when window becomes inactive.
  43822. * Override this method to provide functionality.
  43823. */
  43824. protected onLostFocus(): void;
  43825. private _pointerInput;
  43826. private _observer;
  43827. private _onLostFocus;
  43828. private pointA;
  43829. private pointB;
  43830. }
  43831. }
  43832. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  43833. import { Nullable } from "babylonjs/types";
  43834. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43835. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  43836. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43837. /**
  43838. * Manage the pointers inputs to control an arc rotate camera.
  43839. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  43840. */
  43841. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  43842. /**
  43843. * Defines the camera the input is attached to.
  43844. */
  43845. camera: ArcRotateCamera;
  43846. /**
  43847. * Gets the class name of the current input.
  43848. * @returns the class name
  43849. */
  43850. getClassName(): string;
  43851. /**
  43852. * Defines the buttons associated with the input to handle camera move.
  43853. */
  43854. buttons: number[];
  43855. /**
  43856. * Defines the pointer angular sensibility along the X axis or how fast is
  43857. * the camera rotating.
  43858. */
  43859. angularSensibilityX: number;
  43860. /**
  43861. * Defines the pointer angular sensibility along the Y axis or how fast is
  43862. * the camera rotating.
  43863. */
  43864. angularSensibilityY: number;
  43865. /**
  43866. * Defines the pointer pinch precision or how fast is the camera zooming.
  43867. */
  43868. pinchPrecision: number;
  43869. /**
  43870. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  43871. * from 0.
  43872. * It defines the percentage of current camera.radius to use as delta when
  43873. * pinch zoom is used.
  43874. */
  43875. pinchDeltaPercentage: number;
  43876. /**
  43877. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  43878. * that any object in the plane at the camera's target point will scale
  43879. * perfectly with finger motion.
  43880. * Overrides pinchDeltaPercentage and pinchPrecision.
  43881. */
  43882. useNaturalPinchZoom: boolean;
  43883. /**
  43884. * Defines the pointer panning sensibility or how fast is the camera moving.
  43885. */
  43886. panningSensibility: number;
  43887. /**
  43888. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  43889. */
  43890. multiTouchPanning: boolean;
  43891. /**
  43892. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  43893. * zoom (pinch) through multitouch.
  43894. */
  43895. multiTouchPanAndZoom: boolean;
  43896. /**
  43897. * Revers pinch action direction.
  43898. */
  43899. pinchInwards: boolean;
  43900. private _isPanClick;
  43901. private _twoFingerActivityCount;
  43902. private _isPinching;
  43903. /**
  43904. * Called on pointer POINTERMOVE event if only a single touch is active.
  43905. */
  43906. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43907. /**
  43908. * Called on pointer POINTERDOUBLETAP event.
  43909. */
  43910. protected onDoubleTap(type: string): void;
  43911. /**
  43912. * Called on pointer POINTERMOVE event if multiple touches are active.
  43913. */
  43914. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43915. /**
  43916. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43917. * press.
  43918. */
  43919. protected onButtonDown(evt: PointerEvent): void;
  43920. /**
  43921. * Called each time a new POINTERUP event occurs. Ie, for each button
  43922. * release.
  43923. */
  43924. protected onButtonUp(evt: PointerEvent): void;
  43925. /**
  43926. * Called when window becomes inactive.
  43927. */
  43928. protected onLostFocus(): void;
  43929. }
  43930. }
  43931. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  43932. import { Nullable } from "babylonjs/types";
  43933. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43934. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43935. /**
  43936. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  43937. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  43938. */
  43939. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  43940. /**
  43941. * Defines the camera the input is attached to.
  43942. */
  43943. camera: ArcRotateCamera;
  43944. /**
  43945. * Defines the list of key codes associated with the up action (increase alpha)
  43946. */
  43947. keysUp: number[];
  43948. /**
  43949. * Defines the list of key codes associated with the down action (decrease alpha)
  43950. */
  43951. keysDown: number[];
  43952. /**
  43953. * Defines the list of key codes associated with the left action (increase beta)
  43954. */
  43955. keysLeft: number[];
  43956. /**
  43957. * Defines the list of key codes associated with the right action (decrease beta)
  43958. */
  43959. keysRight: number[];
  43960. /**
  43961. * Defines the list of key codes associated with the reset action.
  43962. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  43963. */
  43964. keysReset: number[];
  43965. /**
  43966. * Defines the panning sensibility of the inputs.
  43967. * (How fast is the camera panning)
  43968. */
  43969. panningSensibility: number;
  43970. /**
  43971. * Defines the zooming sensibility of the inputs.
  43972. * (How fast is the camera zooming)
  43973. */
  43974. zoomingSensibility: number;
  43975. /**
  43976. * Defines whether maintaining the alt key down switch the movement mode from
  43977. * orientation to zoom.
  43978. */
  43979. useAltToZoom: boolean;
  43980. /**
  43981. * Rotation speed of the camera
  43982. */
  43983. angularSpeed: number;
  43984. private _keys;
  43985. private _ctrlPressed;
  43986. private _altPressed;
  43987. private _onCanvasBlurObserver;
  43988. private _onKeyboardObserver;
  43989. private _engine;
  43990. private _scene;
  43991. /**
  43992. * Attach the input controls to a specific dom element to get the input from.
  43993. * @param element Defines the element the controls should be listened from
  43994. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43995. */
  43996. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43997. /**
  43998. * Detach the current controls from the specified dom element.
  43999. * @param element Defines the element to stop listening the inputs from
  44000. */
  44001. detachControl(element: Nullable<HTMLElement>): void;
  44002. /**
  44003. * Update the current camera state depending on the inputs that have been used this frame.
  44004. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44005. */
  44006. checkInputs(): void;
  44007. /**
  44008. * Gets the class name of the current intput.
  44009. * @returns the class name
  44010. */
  44011. getClassName(): string;
  44012. /**
  44013. * Get the friendly name associated with the input class.
  44014. * @returns the input friendly name
  44015. */
  44016. getSimpleName(): string;
  44017. }
  44018. }
  44019. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44020. import { Nullable } from "babylonjs/types";
  44021. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44022. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44023. /**
  44024. * Manage the mouse wheel inputs to control an arc rotate camera.
  44025. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44026. */
  44027. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44028. /**
  44029. * Defines the camera the input is attached to.
  44030. */
  44031. camera: ArcRotateCamera;
  44032. /**
  44033. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44034. */
  44035. wheelPrecision: number;
  44036. /**
  44037. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44038. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44039. */
  44040. wheelDeltaPercentage: number;
  44041. private _wheel;
  44042. private _observer;
  44043. private computeDeltaFromMouseWheelLegacyEvent;
  44044. /**
  44045. * Attach the input controls to a specific dom element to get the input from.
  44046. * @param element Defines the element the controls should be listened from
  44047. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44048. */
  44049. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44050. /**
  44051. * Detach the current controls from the specified dom element.
  44052. * @param element Defines the element to stop listening the inputs from
  44053. */
  44054. detachControl(element: Nullable<HTMLElement>): void;
  44055. /**
  44056. * Gets the class name of the current intput.
  44057. * @returns the class name
  44058. */
  44059. getClassName(): string;
  44060. /**
  44061. * Get the friendly name associated with the input class.
  44062. * @returns the input friendly name
  44063. */
  44064. getSimpleName(): string;
  44065. }
  44066. }
  44067. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44068. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44069. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44070. /**
  44071. * Default Inputs manager for the ArcRotateCamera.
  44072. * It groups all the default supported inputs for ease of use.
  44073. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44074. */
  44075. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44076. /**
  44077. * Instantiates a new ArcRotateCameraInputsManager.
  44078. * @param camera Defines the camera the inputs belong to
  44079. */
  44080. constructor(camera: ArcRotateCamera);
  44081. /**
  44082. * Add mouse wheel input support to the input manager.
  44083. * @returns the current input manager
  44084. */
  44085. addMouseWheel(): ArcRotateCameraInputsManager;
  44086. /**
  44087. * Add pointers input support to the input manager.
  44088. * @returns the current input manager
  44089. */
  44090. addPointers(): ArcRotateCameraInputsManager;
  44091. /**
  44092. * Add keyboard input support to the input manager.
  44093. * @returns the current input manager
  44094. */
  44095. addKeyboard(): ArcRotateCameraInputsManager;
  44096. }
  44097. }
  44098. declare module "babylonjs/Cameras/arcRotateCamera" {
  44099. import { Observable } from "babylonjs/Misc/observable";
  44100. import { Nullable } from "babylonjs/types";
  44101. import { Scene } from "babylonjs/scene";
  44102. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44103. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44104. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44105. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44106. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44107. import { Camera } from "babylonjs/Cameras/camera";
  44108. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44109. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44110. import { Collider } from "babylonjs/Collisions/collider";
  44111. /**
  44112. * This represents an orbital type of camera.
  44113. *
  44114. * 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.
  44115. * 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.
  44116. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44117. */
  44118. export class ArcRotateCamera extends TargetCamera {
  44119. /**
  44120. * Defines the rotation angle of the camera along the longitudinal axis.
  44121. */
  44122. alpha: number;
  44123. /**
  44124. * Defines the rotation angle of the camera along the latitudinal axis.
  44125. */
  44126. beta: number;
  44127. /**
  44128. * Defines the radius of the camera from it s target point.
  44129. */
  44130. radius: number;
  44131. protected _target: Vector3;
  44132. protected _targetHost: Nullable<AbstractMesh>;
  44133. /**
  44134. * Defines the target point of the camera.
  44135. * The camera looks towards it form the radius distance.
  44136. */
  44137. get target(): Vector3;
  44138. set target(value: Vector3);
  44139. /**
  44140. * Define the current local position of the camera in the scene
  44141. */
  44142. get position(): Vector3;
  44143. set position(newPosition: Vector3);
  44144. protected _upVector: Vector3;
  44145. protected _upToYMatrix: Matrix;
  44146. protected _YToUpMatrix: Matrix;
  44147. /**
  44148. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44149. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44150. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44151. */
  44152. set upVector(vec: Vector3);
  44153. get upVector(): Vector3;
  44154. /**
  44155. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44156. */
  44157. setMatUp(): void;
  44158. /**
  44159. * Current inertia value on the longitudinal axis.
  44160. * The bigger this number the longer it will take for the camera to stop.
  44161. */
  44162. inertialAlphaOffset: number;
  44163. /**
  44164. * Current inertia value on the latitudinal axis.
  44165. * The bigger this number the longer it will take for the camera to stop.
  44166. */
  44167. inertialBetaOffset: number;
  44168. /**
  44169. * Current inertia value on the radius axis.
  44170. * The bigger this number the longer it will take for the camera to stop.
  44171. */
  44172. inertialRadiusOffset: number;
  44173. /**
  44174. * Minimum allowed angle on the longitudinal axis.
  44175. * This can help limiting how the Camera is able to move in the scene.
  44176. */
  44177. lowerAlphaLimit: Nullable<number>;
  44178. /**
  44179. * Maximum allowed angle on the longitudinal axis.
  44180. * This can help limiting how the Camera is able to move in the scene.
  44181. */
  44182. upperAlphaLimit: Nullable<number>;
  44183. /**
  44184. * Minimum allowed angle on the latitudinal axis.
  44185. * This can help limiting how the Camera is able to move in the scene.
  44186. */
  44187. lowerBetaLimit: number;
  44188. /**
  44189. * Maximum allowed angle on the latitudinal axis.
  44190. * This can help limiting how the Camera is able to move in the scene.
  44191. */
  44192. upperBetaLimit: number;
  44193. /**
  44194. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44195. * This can help limiting how the Camera is able to move in the scene.
  44196. */
  44197. lowerRadiusLimit: Nullable<number>;
  44198. /**
  44199. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44200. * This can help limiting how the Camera is able to move in the scene.
  44201. */
  44202. upperRadiusLimit: Nullable<number>;
  44203. /**
  44204. * Defines the current inertia value used during panning of the camera along the X axis.
  44205. */
  44206. inertialPanningX: number;
  44207. /**
  44208. * Defines the current inertia value used during panning of the camera along the Y axis.
  44209. */
  44210. inertialPanningY: number;
  44211. /**
  44212. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44213. * Basically if your fingers moves away from more than this distance you will be considered
  44214. * in pinch mode.
  44215. */
  44216. pinchToPanMaxDistance: number;
  44217. /**
  44218. * Defines the maximum distance the camera can pan.
  44219. * This could help keeping the cammera always in your scene.
  44220. */
  44221. panningDistanceLimit: Nullable<number>;
  44222. /**
  44223. * Defines the target of the camera before paning.
  44224. */
  44225. panningOriginTarget: Vector3;
  44226. /**
  44227. * Defines the value of the inertia used during panning.
  44228. * 0 would mean stop inertia and one would mean no decelleration at all.
  44229. */
  44230. panningInertia: number;
  44231. /**
  44232. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44233. */
  44234. get angularSensibilityX(): number;
  44235. set angularSensibilityX(value: number);
  44236. /**
  44237. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44238. */
  44239. get angularSensibilityY(): number;
  44240. set angularSensibilityY(value: number);
  44241. /**
  44242. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44243. */
  44244. get pinchPrecision(): number;
  44245. set pinchPrecision(value: number);
  44246. /**
  44247. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44248. * It will be used instead of pinchDeltaPrecision if different from 0.
  44249. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44250. */
  44251. get pinchDeltaPercentage(): number;
  44252. set pinchDeltaPercentage(value: number);
  44253. /**
  44254. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44255. * and pinch delta percentage.
  44256. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44257. * that any object in the plane at the camera's target point will scale
  44258. * perfectly with finger motion.
  44259. */
  44260. get useNaturalPinchZoom(): boolean;
  44261. set useNaturalPinchZoom(value: boolean);
  44262. /**
  44263. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44264. */
  44265. get panningSensibility(): number;
  44266. set panningSensibility(value: number);
  44267. /**
  44268. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44269. */
  44270. get keysUp(): number[];
  44271. set keysUp(value: number[]);
  44272. /**
  44273. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44274. */
  44275. get keysDown(): number[];
  44276. set keysDown(value: number[]);
  44277. /**
  44278. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44279. */
  44280. get keysLeft(): number[];
  44281. set keysLeft(value: number[]);
  44282. /**
  44283. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44284. */
  44285. get keysRight(): number[];
  44286. set keysRight(value: number[]);
  44287. /**
  44288. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44289. */
  44290. get wheelPrecision(): number;
  44291. set wheelPrecision(value: number);
  44292. /**
  44293. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44294. * It will be used instead of pinchDeltaPrecision if different from 0.
  44295. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44296. */
  44297. get wheelDeltaPercentage(): number;
  44298. set wheelDeltaPercentage(value: number);
  44299. /**
  44300. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44301. */
  44302. zoomOnFactor: number;
  44303. /**
  44304. * Defines a screen offset for the camera position.
  44305. */
  44306. targetScreenOffset: Vector2;
  44307. /**
  44308. * Allows the camera to be completely reversed.
  44309. * If false the camera can not arrive upside down.
  44310. */
  44311. allowUpsideDown: boolean;
  44312. /**
  44313. * Define if double tap/click is used to restore the previously saved state of the camera.
  44314. */
  44315. useInputToRestoreState: boolean;
  44316. /** @hidden */
  44317. _viewMatrix: Matrix;
  44318. /** @hidden */
  44319. _useCtrlForPanning: boolean;
  44320. /** @hidden */
  44321. _panningMouseButton: number;
  44322. /**
  44323. * Defines the input associated to the camera.
  44324. */
  44325. inputs: ArcRotateCameraInputsManager;
  44326. /** @hidden */
  44327. _reset: () => void;
  44328. /**
  44329. * Defines the allowed panning axis.
  44330. */
  44331. panningAxis: Vector3;
  44332. protected _localDirection: Vector3;
  44333. protected _transformedDirection: Vector3;
  44334. private _bouncingBehavior;
  44335. /**
  44336. * Gets the bouncing behavior of the camera if it has been enabled.
  44337. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44338. */
  44339. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44340. /**
  44341. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44342. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44343. */
  44344. get useBouncingBehavior(): boolean;
  44345. set useBouncingBehavior(value: boolean);
  44346. private _framingBehavior;
  44347. /**
  44348. * Gets the framing behavior of the camera if it has been enabled.
  44349. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44350. */
  44351. get framingBehavior(): Nullable<FramingBehavior>;
  44352. /**
  44353. * Defines if the framing behavior of the camera is enabled on the camera.
  44354. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44355. */
  44356. get useFramingBehavior(): boolean;
  44357. set useFramingBehavior(value: boolean);
  44358. private _autoRotationBehavior;
  44359. /**
  44360. * Gets the auto rotation behavior of the camera if it has been enabled.
  44361. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44362. */
  44363. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44364. /**
  44365. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44366. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44367. */
  44368. get useAutoRotationBehavior(): boolean;
  44369. set useAutoRotationBehavior(value: boolean);
  44370. /**
  44371. * Observable triggered when the mesh target has been changed on the camera.
  44372. */
  44373. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44374. /**
  44375. * Event raised when the camera is colliding with a mesh.
  44376. */
  44377. onCollide: (collidedMesh: AbstractMesh) => void;
  44378. /**
  44379. * Defines whether the camera should check collision with the objects oh the scene.
  44380. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44381. */
  44382. checkCollisions: boolean;
  44383. /**
  44384. * Defines the collision radius of the camera.
  44385. * This simulates a sphere around the camera.
  44386. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44387. */
  44388. collisionRadius: Vector3;
  44389. protected _collider: Collider;
  44390. protected _previousPosition: Vector3;
  44391. protected _collisionVelocity: Vector3;
  44392. protected _newPosition: Vector3;
  44393. protected _previousAlpha: number;
  44394. protected _previousBeta: number;
  44395. protected _previousRadius: number;
  44396. protected _collisionTriggered: boolean;
  44397. protected _targetBoundingCenter: Nullable<Vector3>;
  44398. private _computationVector;
  44399. /**
  44400. * Instantiates a new ArcRotateCamera in a given scene
  44401. * @param name Defines the name of the camera
  44402. * @param alpha Defines the camera rotation along the logitudinal axis
  44403. * @param beta Defines the camera rotation along the latitudinal axis
  44404. * @param radius Defines the camera distance from its target
  44405. * @param target Defines the camera target
  44406. * @param scene Defines the scene the camera belongs to
  44407. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44408. */
  44409. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44410. /** @hidden */
  44411. _initCache(): void;
  44412. /** @hidden */
  44413. _updateCache(ignoreParentClass?: boolean): void;
  44414. protected _getTargetPosition(): Vector3;
  44415. private _storedAlpha;
  44416. private _storedBeta;
  44417. private _storedRadius;
  44418. private _storedTarget;
  44419. private _storedTargetScreenOffset;
  44420. /**
  44421. * Stores the current state of the camera (alpha, beta, radius and target)
  44422. * @returns the camera itself
  44423. */
  44424. storeState(): Camera;
  44425. /**
  44426. * @hidden
  44427. * Restored camera state. You must call storeState() first
  44428. */
  44429. _restoreStateValues(): boolean;
  44430. /** @hidden */
  44431. _isSynchronizedViewMatrix(): boolean;
  44432. /**
  44433. * Attached controls to the current camera.
  44434. * @param element Defines the element the controls should be listened from
  44435. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44436. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44437. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44438. */
  44439. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44440. /**
  44441. * Detach the current controls from the camera.
  44442. * The camera will stop reacting to inputs.
  44443. * @param element Defines the element to stop listening the inputs from
  44444. */
  44445. detachControl(element: HTMLElement): void;
  44446. /** @hidden */
  44447. _checkInputs(): void;
  44448. protected _checkLimits(): void;
  44449. /**
  44450. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44451. */
  44452. rebuildAnglesAndRadius(): void;
  44453. /**
  44454. * Use a position to define the current camera related information like alpha, beta and radius
  44455. * @param position Defines the position to set the camera at
  44456. */
  44457. setPosition(position: Vector3): void;
  44458. /**
  44459. * Defines the target the camera should look at.
  44460. * This will automatically adapt alpha beta and radius to fit within the new target.
  44461. * @param target Defines the new target as a Vector or a mesh
  44462. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44463. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44464. */
  44465. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44466. /** @hidden */
  44467. _getViewMatrix(): Matrix;
  44468. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44469. /**
  44470. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44471. * @param meshes Defines the mesh to zoom on
  44472. * @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)
  44473. */
  44474. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44475. /**
  44476. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44477. * The target will be changed but the radius
  44478. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44479. * @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)
  44480. */
  44481. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44482. min: Vector3;
  44483. max: Vector3;
  44484. distance: number;
  44485. }, doNotUpdateMaxZ?: boolean): void;
  44486. /**
  44487. * @override
  44488. * Override Camera.createRigCamera
  44489. */
  44490. createRigCamera(name: string, cameraIndex: number): Camera;
  44491. /**
  44492. * @hidden
  44493. * @override
  44494. * Override Camera._updateRigCameras
  44495. */
  44496. _updateRigCameras(): void;
  44497. /**
  44498. * Destroy the camera and release the current resources hold by it.
  44499. */
  44500. dispose(): void;
  44501. /**
  44502. * Gets the current object class name.
  44503. * @return the class name
  44504. */
  44505. getClassName(): string;
  44506. }
  44507. }
  44508. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44509. import { Behavior } from "babylonjs/Behaviors/behavior";
  44510. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44511. /**
  44512. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44513. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44514. */
  44515. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44516. /**
  44517. * Gets the name of the behavior.
  44518. */
  44519. get name(): string;
  44520. private _zoomStopsAnimation;
  44521. private _idleRotationSpeed;
  44522. private _idleRotationWaitTime;
  44523. private _idleRotationSpinupTime;
  44524. /**
  44525. * Sets the flag that indicates if user zooming should stop animation.
  44526. */
  44527. set zoomStopsAnimation(flag: boolean);
  44528. /**
  44529. * Gets the flag that indicates if user zooming should stop animation.
  44530. */
  44531. get zoomStopsAnimation(): boolean;
  44532. /**
  44533. * Sets the default speed at which the camera rotates around the model.
  44534. */
  44535. set idleRotationSpeed(speed: number);
  44536. /**
  44537. * Gets the default speed at which the camera rotates around the model.
  44538. */
  44539. get idleRotationSpeed(): number;
  44540. /**
  44541. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44542. */
  44543. set idleRotationWaitTime(time: number);
  44544. /**
  44545. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44546. */
  44547. get idleRotationWaitTime(): number;
  44548. /**
  44549. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44550. */
  44551. set idleRotationSpinupTime(time: number);
  44552. /**
  44553. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44554. */
  44555. get idleRotationSpinupTime(): number;
  44556. /**
  44557. * Gets a value indicating if the camera is currently rotating because of this behavior
  44558. */
  44559. get rotationInProgress(): boolean;
  44560. private _onPrePointerObservableObserver;
  44561. private _onAfterCheckInputsObserver;
  44562. private _attachedCamera;
  44563. private _isPointerDown;
  44564. private _lastFrameTime;
  44565. private _lastInteractionTime;
  44566. private _cameraRotationSpeed;
  44567. /**
  44568. * Initializes the behavior.
  44569. */
  44570. init(): void;
  44571. /**
  44572. * Attaches the behavior to its arc rotate camera.
  44573. * @param camera Defines the camera to attach the behavior to
  44574. */
  44575. attach(camera: ArcRotateCamera): void;
  44576. /**
  44577. * Detaches the behavior from its current arc rotate camera.
  44578. */
  44579. detach(): void;
  44580. /**
  44581. * Returns true if user is scrolling.
  44582. * @return true if user is scrolling.
  44583. */
  44584. private _userIsZooming;
  44585. private _lastFrameRadius;
  44586. private _shouldAnimationStopForInteraction;
  44587. /**
  44588. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44589. */
  44590. private _applyUserInteraction;
  44591. private _userIsMoving;
  44592. }
  44593. }
  44594. declare module "babylonjs/Behaviors/Cameras/index" {
  44595. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44596. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44597. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44598. }
  44599. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44600. import { Mesh } from "babylonjs/Meshes/mesh";
  44601. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44602. import { Behavior } from "babylonjs/Behaviors/behavior";
  44603. /**
  44604. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44605. */
  44606. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44607. private ui;
  44608. /**
  44609. * The name of the behavior
  44610. */
  44611. name: string;
  44612. /**
  44613. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44614. */
  44615. distanceAwayFromFace: number;
  44616. /**
  44617. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44618. */
  44619. distanceAwayFromBottomOfFace: number;
  44620. private _faceVectors;
  44621. private _target;
  44622. private _scene;
  44623. private _onRenderObserver;
  44624. private _tmpMatrix;
  44625. private _tmpVector;
  44626. /**
  44627. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44628. * @param ui The transform node that should be attched to the mesh
  44629. */
  44630. constructor(ui: TransformNode);
  44631. /**
  44632. * Initializes the behavior
  44633. */
  44634. init(): void;
  44635. private _closestFace;
  44636. private _zeroVector;
  44637. private _lookAtTmpMatrix;
  44638. private _lookAtToRef;
  44639. /**
  44640. * Attaches the AttachToBoxBehavior to the passed in mesh
  44641. * @param target The mesh that the specified node will be attached to
  44642. */
  44643. attach(target: Mesh): void;
  44644. /**
  44645. * Detaches the behavior from the mesh
  44646. */
  44647. detach(): void;
  44648. }
  44649. }
  44650. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44651. import { Behavior } from "babylonjs/Behaviors/behavior";
  44652. import { Mesh } from "babylonjs/Meshes/mesh";
  44653. /**
  44654. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44655. */
  44656. export class FadeInOutBehavior implements Behavior<Mesh> {
  44657. /**
  44658. * Time in milliseconds to delay before fading in (Default: 0)
  44659. */
  44660. delay: number;
  44661. /**
  44662. * Time in milliseconds for the mesh to fade in (Default: 300)
  44663. */
  44664. fadeInTime: number;
  44665. private _millisecondsPerFrame;
  44666. private _hovered;
  44667. private _hoverValue;
  44668. private _ownerNode;
  44669. /**
  44670. * Instatiates the FadeInOutBehavior
  44671. */
  44672. constructor();
  44673. /**
  44674. * The name of the behavior
  44675. */
  44676. get name(): string;
  44677. /**
  44678. * Initializes the behavior
  44679. */
  44680. init(): void;
  44681. /**
  44682. * Attaches the fade behavior on the passed in mesh
  44683. * @param ownerNode The mesh that will be faded in/out once attached
  44684. */
  44685. attach(ownerNode: Mesh): void;
  44686. /**
  44687. * Detaches the behavior from the mesh
  44688. */
  44689. detach(): void;
  44690. /**
  44691. * Triggers the mesh to begin fading in or out
  44692. * @param value if the object should fade in or out (true to fade in)
  44693. */
  44694. fadeIn(value: boolean): void;
  44695. private _update;
  44696. private _setAllVisibility;
  44697. }
  44698. }
  44699. declare module "babylonjs/Misc/pivotTools" {
  44700. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44701. /**
  44702. * Class containing a set of static utilities functions for managing Pivots
  44703. * @hidden
  44704. */
  44705. export class PivotTools {
  44706. private static _PivotCached;
  44707. private static _OldPivotPoint;
  44708. private static _PivotTranslation;
  44709. private static _PivotTmpVector;
  44710. /** @hidden */
  44711. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44712. /** @hidden */
  44713. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44714. }
  44715. }
  44716. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44717. import { Scene } from "babylonjs/scene";
  44718. import { Vector4 } from "babylonjs/Maths/math.vector";
  44719. import { Mesh } from "babylonjs/Meshes/mesh";
  44720. import { Nullable } from "babylonjs/types";
  44721. import { Plane } from "babylonjs/Maths/math.plane";
  44722. /**
  44723. * Class containing static functions to help procedurally build meshes
  44724. */
  44725. export class PlaneBuilder {
  44726. /**
  44727. * Creates a plane mesh
  44728. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44729. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44730. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44731. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44732. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44733. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44734. * @param name defines the name of the mesh
  44735. * @param options defines the options used to create the mesh
  44736. * @param scene defines the hosting scene
  44737. * @returns the plane mesh
  44738. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44739. */
  44740. static CreatePlane(name: string, options: {
  44741. size?: number;
  44742. width?: number;
  44743. height?: number;
  44744. sideOrientation?: number;
  44745. frontUVs?: Vector4;
  44746. backUVs?: Vector4;
  44747. updatable?: boolean;
  44748. sourcePlane?: Plane;
  44749. }, scene?: Nullable<Scene>): Mesh;
  44750. }
  44751. }
  44752. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44753. import { Behavior } from "babylonjs/Behaviors/behavior";
  44754. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44755. import { Observable } from "babylonjs/Misc/observable";
  44756. import { Vector3 } from "babylonjs/Maths/math.vector";
  44757. import { Ray } from "babylonjs/Culling/ray";
  44758. import "babylonjs/Meshes/Builders/planeBuilder";
  44759. /**
  44760. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44761. */
  44762. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44763. private static _AnyMouseID;
  44764. /**
  44765. * Abstract mesh the behavior is set on
  44766. */
  44767. attachedNode: AbstractMesh;
  44768. private _dragPlane;
  44769. private _scene;
  44770. private _pointerObserver;
  44771. private _beforeRenderObserver;
  44772. private static _planeScene;
  44773. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44774. /**
  44775. * 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)
  44776. */
  44777. maxDragAngle: number;
  44778. /**
  44779. * @hidden
  44780. */
  44781. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44782. /**
  44783. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44784. */
  44785. currentDraggingPointerID: number;
  44786. /**
  44787. * The last position where the pointer hit the drag plane in world space
  44788. */
  44789. lastDragPosition: Vector3;
  44790. /**
  44791. * If the behavior is currently in a dragging state
  44792. */
  44793. dragging: boolean;
  44794. /**
  44795. * 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)
  44796. */
  44797. dragDeltaRatio: number;
  44798. /**
  44799. * If the drag plane orientation should be updated during the dragging (Default: true)
  44800. */
  44801. updateDragPlane: boolean;
  44802. private _debugMode;
  44803. private _moving;
  44804. /**
  44805. * Fires each time the attached mesh is dragged with the pointer
  44806. * * delta between last drag position and current drag position in world space
  44807. * * dragDistance along the drag axis
  44808. * * dragPlaneNormal normal of the current drag plane used during the drag
  44809. * * dragPlanePoint in world space where the drag intersects the drag plane
  44810. */
  44811. onDragObservable: Observable<{
  44812. delta: Vector3;
  44813. dragPlanePoint: Vector3;
  44814. dragPlaneNormal: Vector3;
  44815. dragDistance: number;
  44816. pointerId: number;
  44817. }>;
  44818. /**
  44819. * Fires each time a drag begins (eg. mouse down on mesh)
  44820. */
  44821. onDragStartObservable: Observable<{
  44822. dragPlanePoint: Vector3;
  44823. pointerId: number;
  44824. }>;
  44825. /**
  44826. * Fires each time a drag ends (eg. mouse release after drag)
  44827. */
  44828. onDragEndObservable: Observable<{
  44829. dragPlanePoint: Vector3;
  44830. pointerId: number;
  44831. }>;
  44832. /**
  44833. * If the attached mesh should be moved when dragged
  44834. */
  44835. moveAttached: boolean;
  44836. /**
  44837. * If the drag behavior will react to drag events (Default: true)
  44838. */
  44839. enabled: boolean;
  44840. /**
  44841. * If pointer events should start and release the drag (Default: true)
  44842. */
  44843. startAndReleaseDragOnPointerEvents: boolean;
  44844. /**
  44845. * If camera controls should be detached during the drag
  44846. */
  44847. detachCameraControls: boolean;
  44848. /**
  44849. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  44850. */
  44851. useObjectOrientationForDragging: boolean;
  44852. private _options;
  44853. /**
  44854. * Gets the options used by the behavior
  44855. */
  44856. get options(): {
  44857. dragAxis?: Vector3;
  44858. dragPlaneNormal?: Vector3;
  44859. };
  44860. /**
  44861. * Sets the options used by the behavior
  44862. */
  44863. set options(options: {
  44864. dragAxis?: Vector3;
  44865. dragPlaneNormal?: Vector3;
  44866. });
  44867. /**
  44868. * Creates a pointer drag behavior that can be attached to a mesh
  44869. * @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)
  44870. */
  44871. constructor(options?: {
  44872. dragAxis?: Vector3;
  44873. dragPlaneNormal?: Vector3;
  44874. });
  44875. /**
  44876. * Predicate to determine if it is valid to move the object to a new position when it is moved
  44877. */
  44878. validateDrag: (targetPosition: Vector3) => boolean;
  44879. /**
  44880. * The name of the behavior
  44881. */
  44882. get name(): string;
  44883. /**
  44884. * Initializes the behavior
  44885. */
  44886. init(): void;
  44887. private _tmpVector;
  44888. private _alternatePickedPoint;
  44889. private _worldDragAxis;
  44890. private _targetPosition;
  44891. private _attachedElement;
  44892. /**
  44893. * Attaches the drag behavior the passed in mesh
  44894. * @param ownerNode The mesh that will be dragged around once attached
  44895. * @param predicate Predicate to use for pick filtering
  44896. */
  44897. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  44898. /**
  44899. * Force relase the drag action by code.
  44900. */
  44901. releaseDrag(): void;
  44902. private _startDragRay;
  44903. private _lastPointerRay;
  44904. /**
  44905. * Simulates the start of a pointer drag event on the behavior
  44906. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  44907. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  44908. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  44909. */
  44910. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  44911. private _startDrag;
  44912. private _dragDelta;
  44913. private _moveDrag;
  44914. private _pickWithRayOnDragPlane;
  44915. private _pointA;
  44916. private _pointC;
  44917. private _localAxis;
  44918. private _lookAt;
  44919. private _updateDragPlanePosition;
  44920. /**
  44921. * Detaches the behavior from the mesh
  44922. */
  44923. detach(): void;
  44924. }
  44925. }
  44926. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  44927. import { Mesh } from "babylonjs/Meshes/mesh";
  44928. import { Behavior } from "babylonjs/Behaviors/behavior";
  44929. /**
  44930. * A behavior that when attached to a mesh will allow the mesh to be scaled
  44931. */
  44932. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  44933. private _dragBehaviorA;
  44934. private _dragBehaviorB;
  44935. private _startDistance;
  44936. private _initialScale;
  44937. private _targetScale;
  44938. private _ownerNode;
  44939. private _sceneRenderObserver;
  44940. /**
  44941. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  44942. */
  44943. constructor();
  44944. /**
  44945. * The name of the behavior
  44946. */
  44947. get name(): string;
  44948. /**
  44949. * Initializes the behavior
  44950. */
  44951. init(): void;
  44952. private _getCurrentDistance;
  44953. /**
  44954. * Attaches the scale behavior the passed in mesh
  44955. * @param ownerNode The mesh that will be scaled around once attached
  44956. */
  44957. attach(ownerNode: Mesh): void;
  44958. /**
  44959. * Detaches the behavior from the mesh
  44960. */
  44961. detach(): void;
  44962. }
  44963. }
  44964. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  44965. import { Behavior } from "babylonjs/Behaviors/behavior";
  44966. import { Mesh } from "babylonjs/Meshes/mesh";
  44967. import { Observable } from "babylonjs/Misc/observable";
  44968. /**
  44969. * 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
  44970. */
  44971. export class SixDofDragBehavior implements Behavior<Mesh> {
  44972. private static _virtualScene;
  44973. private _ownerNode;
  44974. private _sceneRenderObserver;
  44975. private _scene;
  44976. private _targetPosition;
  44977. private _virtualOriginMesh;
  44978. private _virtualDragMesh;
  44979. private _pointerObserver;
  44980. private _moving;
  44981. private _startingOrientation;
  44982. private _attachedElement;
  44983. /**
  44984. * 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)
  44985. */
  44986. private zDragFactor;
  44987. /**
  44988. * If the object should rotate to face the drag origin
  44989. */
  44990. rotateDraggedObject: boolean;
  44991. /**
  44992. * If the behavior is currently in a dragging state
  44993. */
  44994. dragging: boolean;
  44995. /**
  44996. * 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)
  44997. */
  44998. dragDeltaRatio: number;
  44999. /**
  45000. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45001. */
  45002. currentDraggingPointerID: number;
  45003. /**
  45004. * If camera controls should be detached during the drag
  45005. */
  45006. detachCameraControls: boolean;
  45007. /**
  45008. * Fires each time a drag starts
  45009. */
  45010. onDragStartObservable: Observable<{}>;
  45011. /**
  45012. * Fires each time a drag ends (eg. mouse release after drag)
  45013. */
  45014. onDragEndObservable: Observable<{}>;
  45015. /**
  45016. * 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
  45017. */
  45018. constructor();
  45019. /**
  45020. * The name of the behavior
  45021. */
  45022. get name(): string;
  45023. /**
  45024. * Initializes the behavior
  45025. */
  45026. init(): void;
  45027. /**
  45028. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45029. */
  45030. private get _pointerCamera();
  45031. /**
  45032. * Attaches the scale behavior the passed in mesh
  45033. * @param ownerNode The mesh that will be scaled around once attached
  45034. */
  45035. attach(ownerNode: Mesh): void;
  45036. /**
  45037. * Detaches the behavior from the mesh
  45038. */
  45039. detach(): void;
  45040. }
  45041. }
  45042. declare module "babylonjs/Behaviors/Meshes/index" {
  45043. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45044. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45045. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45046. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45047. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45048. }
  45049. declare module "babylonjs/Behaviors/index" {
  45050. export * from "babylonjs/Behaviors/behavior";
  45051. export * from "babylonjs/Behaviors/Cameras/index";
  45052. export * from "babylonjs/Behaviors/Meshes/index";
  45053. }
  45054. declare module "babylonjs/Bones/boneIKController" {
  45055. import { Bone } from "babylonjs/Bones/bone";
  45056. import { Vector3 } from "babylonjs/Maths/math.vector";
  45057. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45058. import { Nullable } from "babylonjs/types";
  45059. /**
  45060. * Class used to apply inverse kinematics to bones
  45061. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45062. */
  45063. export class BoneIKController {
  45064. private static _tmpVecs;
  45065. private static _tmpQuat;
  45066. private static _tmpMats;
  45067. /**
  45068. * Gets or sets the target mesh
  45069. */
  45070. targetMesh: AbstractMesh;
  45071. /** Gets or sets the mesh used as pole */
  45072. poleTargetMesh: AbstractMesh;
  45073. /**
  45074. * Gets or sets the bone used as pole
  45075. */
  45076. poleTargetBone: Nullable<Bone>;
  45077. /**
  45078. * Gets or sets the target position
  45079. */
  45080. targetPosition: Vector3;
  45081. /**
  45082. * Gets or sets the pole target position
  45083. */
  45084. poleTargetPosition: Vector3;
  45085. /**
  45086. * Gets or sets the pole target local offset
  45087. */
  45088. poleTargetLocalOffset: Vector3;
  45089. /**
  45090. * Gets or sets the pole angle
  45091. */
  45092. poleAngle: number;
  45093. /**
  45094. * Gets or sets the mesh associated with the controller
  45095. */
  45096. mesh: AbstractMesh;
  45097. /**
  45098. * 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)
  45099. */
  45100. slerpAmount: number;
  45101. private _bone1Quat;
  45102. private _bone1Mat;
  45103. private _bone2Ang;
  45104. private _bone1;
  45105. private _bone2;
  45106. private _bone1Length;
  45107. private _bone2Length;
  45108. private _maxAngle;
  45109. private _maxReach;
  45110. private _rightHandedSystem;
  45111. private _bendAxis;
  45112. private _slerping;
  45113. private _adjustRoll;
  45114. /**
  45115. * Gets or sets maximum allowed angle
  45116. */
  45117. get maxAngle(): number;
  45118. set maxAngle(value: number);
  45119. /**
  45120. * Creates a new BoneIKController
  45121. * @param mesh defines the mesh to control
  45122. * @param bone defines the bone to control
  45123. * @param options defines options to set up the controller
  45124. */
  45125. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45126. targetMesh?: AbstractMesh;
  45127. poleTargetMesh?: AbstractMesh;
  45128. poleTargetBone?: Bone;
  45129. poleTargetLocalOffset?: Vector3;
  45130. poleAngle?: number;
  45131. bendAxis?: Vector3;
  45132. maxAngle?: number;
  45133. slerpAmount?: number;
  45134. });
  45135. private _setMaxAngle;
  45136. /**
  45137. * Force the controller to update the bones
  45138. */
  45139. update(): void;
  45140. }
  45141. }
  45142. declare module "babylonjs/Bones/boneLookController" {
  45143. import { Vector3 } from "babylonjs/Maths/math.vector";
  45144. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45145. import { Bone } from "babylonjs/Bones/bone";
  45146. import { Space } from "babylonjs/Maths/math.axis";
  45147. /**
  45148. * Class used to make a bone look toward a point in space
  45149. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45150. */
  45151. export class BoneLookController {
  45152. private static _tmpVecs;
  45153. private static _tmpQuat;
  45154. private static _tmpMats;
  45155. /**
  45156. * The target Vector3 that the bone will look at
  45157. */
  45158. target: Vector3;
  45159. /**
  45160. * The mesh that the bone is attached to
  45161. */
  45162. mesh: AbstractMesh;
  45163. /**
  45164. * The bone that will be looking to the target
  45165. */
  45166. bone: Bone;
  45167. /**
  45168. * The up axis of the coordinate system that is used when the bone is rotated
  45169. */
  45170. upAxis: Vector3;
  45171. /**
  45172. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45173. */
  45174. upAxisSpace: Space;
  45175. /**
  45176. * Used to make an adjustment to the yaw of the bone
  45177. */
  45178. adjustYaw: number;
  45179. /**
  45180. * Used to make an adjustment to the pitch of the bone
  45181. */
  45182. adjustPitch: number;
  45183. /**
  45184. * Used to make an adjustment to the roll of the bone
  45185. */
  45186. adjustRoll: number;
  45187. /**
  45188. * 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)
  45189. */
  45190. slerpAmount: number;
  45191. private _minYaw;
  45192. private _maxYaw;
  45193. private _minPitch;
  45194. private _maxPitch;
  45195. private _minYawSin;
  45196. private _minYawCos;
  45197. private _maxYawSin;
  45198. private _maxYawCos;
  45199. private _midYawConstraint;
  45200. private _minPitchTan;
  45201. private _maxPitchTan;
  45202. private _boneQuat;
  45203. private _slerping;
  45204. private _transformYawPitch;
  45205. private _transformYawPitchInv;
  45206. private _firstFrameSkipped;
  45207. private _yawRange;
  45208. private _fowardAxis;
  45209. /**
  45210. * Gets or sets the minimum yaw angle that the bone can look to
  45211. */
  45212. get minYaw(): number;
  45213. set minYaw(value: number);
  45214. /**
  45215. * Gets or sets the maximum yaw angle that the bone can look to
  45216. */
  45217. get maxYaw(): number;
  45218. set maxYaw(value: number);
  45219. /**
  45220. * Gets or sets the minimum pitch angle that the bone can look to
  45221. */
  45222. get minPitch(): number;
  45223. set minPitch(value: number);
  45224. /**
  45225. * Gets or sets the maximum pitch angle that the bone can look to
  45226. */
  45227. get maxPitch(): number;
  45228. set maxPitch(value: number);
  45229. /**
  45230. * Create a BoneLookController
  45231. * @param mesh the mesh that the bone belongs to
  45232. * @param bone the bone that will be looking to the target
  45233. * @param target the target Vector3 to look at
  45234. * @param options optional settings:
  45235. * * maxYaw: the maximum angle the bone will yaw to
  45236. * * minYaw: the minimum angle the bone will yaw to
  45237. * * maxPitch: the maximum angle the bone will pitch to
  45238. * * minPitch: the minimum angle the bone will yaw to
  45239. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45240. * * upAxis: the up axis of the coordinate system
  45241. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45242. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45243. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45244. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45245. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45246. * * adjustRoll: used to make an adjustment to the roll of the bone
  45247. **/
  45248. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45249. maxYaw?: number;
  45250. minYaw?: number;
  45251. maxPitch?: number;
  45252. minPitch?: number;
  45253. slerpAmount?: number;
  45254. upAxis?: Vector3;
  45255. upAxisSpace?: Space;
  45256. yawAxis?: Vector3;
  45257. pitchAxis?: Vector3;
  45258. adjustYaw?: number;
  45259. adjustPitch?: number;
  45260. adjustRoll?: number;
  45261. });
  45262. /**
  45263. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45264. */
  45265. update(): void;
  45266. private _getAngleDiff;
  45267. private _getAngleBetween;
  45268. private _isAngleBetween;
  45269. }
  45270. }
  45271. declare module "babylonjs/Bones/index" {
  45272. export * from "babylonjs/Bones/bone";
  45273. export * from "babylonjs/Bones/boneIKController";
  45274. export * from "babylonjs/Bones/boneLookController";
  45275. export * from "babylonjs/Bones/skeleton";
  45276. }
  45277. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45278. import { Nullable } from "babylonjs/types";
  45279. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45280. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45281. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45282. /**
  45283. * Manage the gamepad inputs to control an arc rotate camera.
  45284. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45285. */
  45286. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45287. /**
  45288. * Defines the camera the input is attached to.
  45289. */
  45290. camera: ArcRotateCamera;
  45291. /**
  45292. * Defines the gamepad the input is gathering event from.
  45293. */
  45294. gamepad: Nullable<Gamepad>;
  45295. /**
  45296. * Defines the gamepad rotation sensiblity.
  45297. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45298. */
  45299. gamepadRotationSensibility: number;
  45300. /**
  45301. * Defines the gamepad move sensiblity.
  45302. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45303. */
  45304. gamepadMoveSensibility: number;
  45305. private _yAxisScale;
  45306. /**
  45307. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45308. */
  45309. get invertYAxis(): boolean;
  45310. set invertYAxis(value: boolean);
  45311. private _onGamepadConnectedObserver;
  45312. private _onGamepadDisconnectedObserver;
  45313. /**
  45314. * Attach the input controls to a specific dom element to get the input from.
  45315. * @param element Defines the element the controls should be listened from
  45316. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45317. */
  45318. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45319. /**
  45320. * Detach the current controls from the specified dom element.
  45321. * @param element Defines the element to stop listening the inputs from
  45322. */
  45323. detachControl(element: Nullable<HTMLElement>): void;
  45324. /**
  45325. * Update the current camera state depending on the inputs that have been used this frame.
  45326. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45327. */
  45328. checkInputs(): void;
  45329. /**
  45330. * Gets the class name of the current intput.
  45331. * @returns the class name
  45332. */
  45333. getClassName(): string;
  45334. /**
  45335. * Get the friendly name associated with the input class.
  45336. * @returns the input friendly name
  45337. */
  45338. getSimpleName(): string;
  45339. }
  45340. }
  45341. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45342. import { Nullable } from "babylonjs/types";
  45343. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45344. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45345. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45346. interface ArcRotateCameraInputsManager {
  45347. /**
  45348. * Add orientation input support to the input manager.
  45349. * @returns the current input manager
  45350. */
  45351. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45352. }
  45353. }
  45354. /**
  45355. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45356. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45357. */
  45358. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45359. /**
  45360. * Defines the camera the input is attached to.
  45361. */
  45362. camera: ArcRotateCamera;
  45363. /**
  45364. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45365. */
  45366. alphaCorrection: number;
  45367. /**
  45368. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45369. */
  45370. gammaCorrection: number;
  45371. private _alpha;
  45372. private _gamma;
  45373. private _dirty;
  45374. private _deviceOrientationHandler;
  45375. /**
  45376. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45377. */
  45378. constructor();
  45379. /**
  45380. * Attach the input controls to a specific dom element to get the input from.
  45381. * @param element Defines the element the controls should be listened from
  45382. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45383. */
  45384. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45385. /** @hidden */
  45386. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45387. /**
  45388. * Update the current camera state depending on the inputs that have been used this frame.
  45389. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45390. */
  45391. checkInputs(): void;
  45392. /**
  45393. * Detach the current controls from the specified dom element.
  45394. * @param element Defines the element to stop listening the inputs from
  45395. */
  45396. detachControl(element: Nullable<HTMLElement>): void;
  45397. /**
  45398. * Gets the class name of the current intput.
  45399. * @returns the class name
  45400. */
  45401. getClassName(): string;
  45402. /**
  45403. * Get the friendly name associated with the input class.
  45404. * @returns the input friendly name
  45405. */
  45406. getSimpleName(): string;
  45407. }
  45408. }
  45409. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45410. import { Nullable } from "babylonjs/types";
  45411. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45412. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45413. /**
  45414. * Listen to mouse events to control the camera.
  45415. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45416. */
  45417. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45418. /**
  45419. * Defines the camera the input is attached to.
  45420. */
  45421. camera: FlyCamera;
  45422. /**
  45423. * Defines if touch is enabled. (Default is true.)
  45424. */
  45425. touchEnabled: boolean;
  45426. /**
  45427. * Defines the buttons associated with the input to handle camera rotation.
  45428. */
  45429. buttons: number[];
  45430. /**
  45431. * Assign buttons for Yaw control.
  45432. */
  45433. buttonsYaw: number[];
  45434. /**
  45435. * Assign buttons for Pitch control.
  45436. */
  45437. buttonsPitch: number[];
  45438. /**
  45439. * Assign buttons for Roll control.
  45440. */
  45441. buttonsRoll: number[];
  45442. /**
  45443. * Detect if any button is being pressed while mouse is moved.
  45444. * -1 = Mouse locked.
  45445. * 0 = Left button.
  45446. * 1 = Middle Button.
  45447. * 2 = Right Button.
  45448. */
  45449. activeButton: number;
  45450. /**
  45451. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45452. * Higher values reduce its sensitivity.
  45453. */
  45454. angularSensibility: number;
  45455. private _mousemoveCallback;
  45456. private _observer;
  45457. private _rollObserver;
  45458. private previousPosition;
  45459. private noPreventDefault;
  45460. private element;
  45461. /**
  45462. * Listen to mouse events to control the camera.
  45463. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45464. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45465. */
  45466. constructor(touchEnabled?: boolean);
  45467. /**
  45468. * Attach the mouse control to the HTML DOM element.
  45469. * @param element Defines the element that listens to the input events.
  45470. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45471. */
  45472. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45473. /**
  45474. * Detach the current controls from the specified dom element.
  45475. * @param element Defines the element to stop listening the inputs from
  45476. */
  45477. detachControl(element: Nullable<HTMLElement>): void;
  45478. /**
  45479. * Gets the class name of the current input.
  45480. * @returns the class name.
  45481. */
  45482. getClassName(): string;
  45483. /**
  45484. * Get the friendly name associated with the input class.
  45485. * @returns the input's friendly name.
  45486. */
  45487. getSimpleName(): string;
  45488. private _pointerInput;
  45489. private _onMouseMove;
  45490. /**
  45491. * Rotate camera by mouse offset.
  45492. */
  45493. private rotateCamera;
  45494. }
  45495. }
  45496. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45497. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45498. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45499. /**
  45500. * Default Inputs manager for the FlyCamera.
  45501. * It groups all the default supported inputs for ease of use.
  45502. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45503. */
  45504. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45505. /**
  45506. * Instantiates a new FlyCameraInputsManager.
  45507. * @param camera Defines the camera the inputs belong to.
  45508. */
  45509. constructor(camera: FlyCamera);
  45510. /**
  45511. * Add keyboard input support to the input manager.
  45512. * @returns the new FlyCameraKeyboardMoveInput().
  45513. */
  45514. addKeyboard(): FlyCameraInputsManager;
  45515. /**
  45516. * Add mouse input support to the input manager.
  45517. * @param touchEnabled Enable touch screen support.
  45518. * @returns the new FlyCameraMouseInput().
  45519. */
  45520. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45521. }
  45522. }
  45523. declare module "babylonjs/Cameras/flyCamera" {
  45524. import { Scene } from "babylonjs/scene";
  45525. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45526. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45527. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45528. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45529. /**
  45530. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45531. * such as in a 3D Space Shooter or a Flight Simulator.
  45532. */
  45533. export class FlyCamera extends TargetCamera {
  45534. /**
  45535. * Define the collision ellipsoid of the camera.
  45536. * This is helpful for simulating a camera body, like a player's body.
  45537. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45538. */
  45539. ellipsoid: Vector3;
  45540. /**
  45541. * Define an offset for the position of the ellipsoid around the camera.
  45542. * This can be helpful if the camera is attached away from the player's body center,
  45543. * such as at its head.
  45544. */
  45545. ellipsoidOffset: Vector3;
  45546. /**
  45547. * Enable or disable collisions of the camera with the rest of the scene objects.
  45548. */
  45549. checkCollisions: boolean;
  45550. /**
  45551. * Enable or disable gravity on the camera.
  45552. */
  45553. applyGravity: boolean;
  45554. /**
  45555. * Define the current direction the camera is moving to.
  45556. */
  45557. cameraDirection: Vector3;
  45558. /**
  45559. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45560. * This overrides and empties cameraRotation.
  45561. */
  45562. rotationQuaternion: Quaternion;
  45563. /**
  45564. * Track Roll to maintain the wanted Rolling when looking around.
  45565. */
  45566. _trackRoll: number;
  45567. /**
  45568. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45569. */
  45570. rollCorrect: number;
  45571. /**
  45572. * Mimic a banked turn, Rolling the camera when Yawing.
  45573. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45574. */
  45575. bankedTurn: boolean;
  45576. /**
  45577. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45578. */
  45579. bankedTurnLimit: number;
  45580. /**
  45581. * Value of 0 disables the banked Roll.
  45582. * Value of 1 is equal to the Yaw angle in radians.
  45583. */
  45584. bankedTurnMultiplier: number;
  45585. /**
  45586. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45587. */
  45588. inputs: FlyCameraInputsManager;
  45589. /**
  45590. * Gets the input sensibility for mouse input.
  45591. * Higher values reduce sensitivity.
  45592. */
  45593. get angularSensibility(): number;
  45594. /**
  45595. * Sets the input sensibility for a mouse input.
  45596. * Higher values reduce sensitivity.
  45597. */
  45598. set angularSensibility(value: number);
  45599. /**
  45600. * Get the keys for camera movement forward.
  45601. */
  45602. get keysForward(): number[];
  45603. /**
  45604. * Set the keys for camera movement forward.
  45605. */
  45606. set keysForward(value: number[]);
  45607. /**
  45608. * Get the keys for camera movement backward.
  45609. */
  45610. get keysBackward(): number[];
  45611. set keysBackward(value: number[]);
  45612. /**
  45613. * Get the keys for camera movement up.
  45614. */
  45615. get keysUp(): number[];
  45616. /**
  45617. * Set the keys for camera movement up.
  45618. */
  45619. set keysUp(value: number[]);
  45620. /**
  45621. * Get the keys for camera movement down.
  45622. */
  45623. get keysDown(): number[];
  45624. /**
  45625. * Set the keys for camera movement down.
  45626. */
  45627. set keysDown(value: number[]);
  45628. /**
  45629. * Get the keys for camera movement left.
  45630. */
  45631. get keysLeft(): number[];
  45632. /**
  45633. * Set the keys for camera movement left.
  45634. */
  45635. set keysLeft(value: number[]);
  45636. /**
  45637. * Set the keys for camera movement right.
  45638. */
  45639. get keysRight(): number[];
  45640. /**
  45641. * Set the keys for camera movement right.
  45642. */
  45643. set keysRight(value: number[]);
  45644. /**
  45645. * Event raised when the camera collides with a mesh in the scene.
  45646. */
  45647. onCollide: (collidedMesh: AbstractMesh) => void;
  45648. private _collider;
  45649. private _needMoveForGravity;
  45650. private _oldPosition;
  45651. private _diffPosition;
  45652. private _newPosition;
  45653. /** @hidden */
  45654. _localDirection: Vector3;
  45655. /** @hidden */
  45656. _transformedDirection: Vector3;
  45657. /**
  45658. * Instantiates a FlyCamera.
  45659. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45660. * such as in a 3D Space Shooter or a Flight Simulator.
  45661. * @param name Define the name of the camera in the scene.
  45662. * @param position Define the starting position of the camera in the scene.
  45663. * @param scene Define the scene the camera belongs to.
  45664. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45665. */
  45666. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45667. /**
  45668. * Attach a control to the HTML DOM element.
  45669. * @param element Defines the element that listens to the input events.
  45670. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45671. */
  45672. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45673. /**
  45674. * Detach a control from the HTML DOM element.
  45675. * The camera will stop reacting to that input.
  45676. * @param element Defines the element that listens to the input events.
  45677. */
  45678. detachControl(element: HTMLElement): void;
  45679. private _collisionMask;
  45680. /**
  45681. * Get the mask that the camera ignores in collision events.
  45682. */
  45683. get collisionMask(): number;
  45684. /**
  45685. * Set the mask that the camera ignores in collision events.
  45686. */
  45687. set collisionMask(mask: number);
  45688. /** @hidden */
  45689. _collideWithWorld(displacement: Vector3): void;
  45690. /** @hidden */
  45691. private _onCollisionPositionChange;
  45692. /** @hidden */
  45693. _checkInputs(): void;
  45694. /** @hidden */
  45695. _decideIfNeedsToMove(): boolean;
  45696. /** @hidden */
  45697. _updatePosition(): void;
  45698. /**
  45699. * Restore the Roll to its target value at the rate specified.
  45700. * @param rate - Higher means slower restoring.
  45701. * @hidden
  45702. */
  45703. restoreRoll(rate: number): void;
  45704. /**
  45705. * Destroy the camera and release the current resources held by it.
  45706. */
  45707. dispose(): void;
  45708. /**
  45709. * Get the current object class name.
  45710. * @returns the class name.
  45711. */
  45712. getClassName(): string;
  45713. }
  45714. }
  45715. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45716. import { Nullable } from "babylonjs/types";
  45717. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45718. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45719. /**
  45720. * Listen to keyboard events to control the camera.
  45721. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45722. */
  45723. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45724. /**
  45725. * Defines the camera the input is attached to.
  45726. */
  45727. camera: FlyCamera;
  45728. /**
  45729. * The list of keyboard keys used to control the forward move of the camera.
  45730. */
  45731. keysForward: number[];
  45732. /**
  45733. * The list of keyboard keys used to control the backward move of the camera.
  45734. */
  45735. keysBackward: number[];
  45736. /**
  45737. * The list of keyboard keys used to control the forward move of the camera.
  45738. */
  45739. keysUp: number[];
  45740. /**
  45741. * The list of keyboard keys used to control the backward move of the camera.
  45742. */
  45743. keysDown: number[];
  45744. /**
  45745. * The list of keyboard keys used to control the right strafe move of the camera.
  45746. */
  45747. keysRight: number[];
  45748. /**
  45749. * The list of keyboard keys used to control the left strafe move of the camera.
  45750. */
  45751. keysLeft: number[];
  45752. private _keys;
  45753. private _onCanvasBlurObserver;
  45754. private _onKeyboardObserver;
  45755. private _engine;
  45756. private _scene;
  45757. /**
  45758. * Attach the input controls to a specific dom element to get the input from.
  45759. * @param element Defines the element the controls should be listened from
  45760. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45761. */
  45762. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45763. /**
  45764. * Detach the current controls from the specified dom element.
  45765. * @param element Defines the element to stop listening the inputs from
  45766. */
  45767. detachControl(element: Nullable<HTMLElement>): void;
  45768. /**
  45769. * Gets the class name of the current intput.
  45770. * @returns the class name
  45771. */
  45772. getClassName(): string;
  45773. /** @hidden */
  45774. _onLostFocus(e: FocusEvent): void;
  45775. /**
  45776. * Get the friendly name associated with the input class.
  45777. * @returns the input friendly name
  45778. */
  45779. getSimpleName(): string;
  45780. /**
  45781. * Update the current camera state depending on the inputs that have been used this frame.
  45782. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45783. */
  45784. checkInputs(): void;
  45785. }
  45786. }
  45787. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45788. import { Nullable } from "babylonjs/types";
  45789. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45790. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45791. /**
  45792. * Manage the mouse wheel inputs to control a follow camera.
  45793. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45794. */
  45795. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45796. /**
  45797. * Defines the camera the input is attached to.
  45798. */
  45799. camera: FollowCamera;
  45800. /**
  45801. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45802. */
  45803. axisControlRadius: boolean;
  45804. /**
  45805. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45806. */
  45807. axisControlHeight: boolean;
  45808. /**
  45809. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45810. */
  45811. axisControlRotation: boolean;
  45812. /**
  45813. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  45814. * relation to mouseWheel events.
  45815. */
  45816. wheelPrecision: number;
  45817. /**
  45818. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  45819. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  45820. */
  45821. wheelDeltaPercentage: number;
  45822. private _wheel;
  45823. private _observer;
  45824. /**
  45825. * Attach the input controls to a specific dom element to get the input from.
  45826. * @param element Defines the element the controls should be listened from
  45827. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45828. */
  45829. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45830. /**
  45831. * Detach the current controls from the specified dom element.
  45832. * @param element Defines the element to stop listening the inputs from
  45833. */
  45834. detachControl(element: Nullable<HTMLElement>): void;
  45835. /**
  45836. * Gets the class name of the current intput.
  45837. * @returns the class name
  45838. */
  45839. getClassName(): string;
  45840. /**
  45841. * Get the friendly name associated with the input class.
  45842. * @returns the input friendly name
  45843. */
  45844. getSimpleName(): string;
  45845. }
  45846. }
  45847. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  45848. import { Nullable } from "babylonjs/types";
  45849. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45850. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  45851. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  45852. /**
  45853. * Manage the pointers inputs to control an follow camera.
  45854. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45855. */
  45856. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  45857. /**
  45858. * Defines the camera the input is attached to.
  45859. */
  45860. camera: FollowCamera;
  45861. /**
  45862. * Gets the class name of the current input.
  45863. * @returns the class name
  45864. */
  45865. getClassName(): string;
  45866. /**
  45867. * Defines the pointer angular sensibility along the X axis or how fast is
  45868. * the camera rotating.
  45869. * A negative number will reverse the axis direction.
  45870. */
  45871. angularSensibilityX: number;
  45872. /**
  45873. * Defines the pointer angular sensibility along the Y axis or how fast is
  45874. * the camera rotating.
  45875. * A negative number will reverse the axis direction.
  45876. */
  45877. angularSensibilityY: number;
  45878. /**
  45879. * Defines the pointer pinch precision or how fast is the camera zooming.
  45880. * A negative number will reverse the axis direction.
  45881. */
  45882. pinchPrecision: number;
  45883. /**
  45884. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  45885. * from 0.
  45886. * It defines the percentage of current camera.radius to use as delta when
  45887. * pinch zoom is used.
  45888. */
  45889. pinchDeltaPercentage: number;
  45890. /**
  45891. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  45892. */
  45893. axisXControlRadius: boolean;
  45894. /**
  45895. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  45896. */
  45897. axisXControlHeight: boolean;
  45898. /**
  45899. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  45900. */
  45901. axisXControlRotation: boolean;
  45902. /**
  45903. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  45904. */
  45905. axisYControlRadius: boolean;
  45906. /**
  45907. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  45908. */
  45909. axisYControlHeight: boolean;
  45910. /**
  45911. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  45912. */
  45913. axisYControlRotation: boolean;
  45914. /**
  45915. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  45916. */
  45917. axisPinchControlRadius: boolean;
  45918. /**
  45919. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  45920. */
  45921. axisPinchControlHeight: boolean;
  45922. /**
  45923. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  45924. */
  45925. axisPinchControlRotation: boolean;
  45926. /**
  45927. * Log error messages if basic misconfiguration has occurred.
  45928. */
  45929. warningEnable: boolean;
  45930. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  45931. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  45932. private _warningCounter;
  45933. private _warning;
  45934. }
  45935. }
  45936. declare module "babylonjs/Cameras/followCameraInputsManager" {
  45937. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45938. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45939. /**
  45940. * Default Inputs manager for the FollowCamera.
  45941. * It groups all the default supported inputs for ease of use.
  45942. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45943. */
  45944. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  45945. /**
  45946. * Instantiates a new FollowCameraInputsManager.
  45947. * @param camera Defines the camera the inputs belong to
  45948. */
  45949. constructor(camera: FollowCamera);
  45950. /**
  45951. * Add keyboard input support to the input manager.
  45952. * @returns the current input manager
  45953. */
  45954. addKeyboard(): FollowCameraInputsManager;
  45955. /**
  45956. * Add mouse wheel input support to the input manager.
  45957. * @returns the current input manager
  45958. */
  45959. addMouseWheel(): FollowCameraInputsManager;
  45960. /**
  45961. * Add pointers input support to the input manager.
  45962. * @returns the current input manager
  45963. */
  45964. addPointers(): FollowCameraInputsManager;
  45965. /**
  45966. * Add orientation input support to the input manager.
  45967. * @returns the current input manager
  45968. */
  45969. addVRDeviceOrientation(): FollowCameraInputsManager;
  45970. }
  45971. }
  45972. declare module "babylonjs/Cameras/followCamera" {
  45973. import { Nullable } from "babylonjs/types";
  45974. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45975. import { Scene } from "babylonjs/scene";
  45976. import { Vector3 } from "babylonjs/Maths/math.vector";
  45977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45978. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  45979. /**
  45980. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  45981. * an arc rotate version arcFollowCamera are available.
  45982. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  45983. */
  45984. export class FollowCamera extends TargetCamera {
  45985. /**
  45986. * Distance the follow camera should follow an object at
  45987. */
  45988. radius: number;
  45989. /**
  45990. * Minimum allowed distance of the camera to the axis of rotation
  45991. * (The camera can not get closer).
  45992. * This can help limiting how the Camera is able to move in the scene.
  45993. */
  45994. lowerRadiusLimit: Nullable<number>;
  45995. /**
  45996. * Maximum allowed distance of the camera to the axis of rotation
  45997. * (The camera can not get further).
  45998. * This can help limiting how the Camera is able to move in the scene.
  45999. */
  46000. upperRadiusLimit: Nullable<number>;
  46001. /**
  46002. * Define a rotation offset between the camera and the object it follows
  46003. */
  46004. rotationOffset: number;
  46005. /**
  46006. * Minimum allowed angle to camera position relative to target object.
  46007. * This can help limiting how the Camera is able to move in the scene.
  46008. */
  46009. lowerRotationOffsetLimit: Nullable<number>;
  46010. /**
  46011. * Maximum allowed angle to camera position relative to target object.
  46012. * This can help limiting how the Camera is able to move in the scene.
  46013. */
  46014. upperRotationOffsetLimit: Nullable<number>;
  46015. /**
  46016. * Define a height offset between the camera and the object it follows.
  46017. * It can help following an object from the top (like a car chaing a plane)
  46018. */
  46019. heightOffset: number;
  46020. /**
  46021. * Minimum allowed height of camera position relative to target object.
  46022. * This can help limiting how the Camera is able to move in the scene.
  46023. */
  46024. lowerHeightOffsetLimit: Nullable<number>;
  46025. /**
  46026. * Maximum allowed height of camera position relative to target object.
  46027. * This can help limiting how the Camera is able to move in the scene.
  46028. */
  46029. upperHeightOffsetLimit: Nullable<number>;
  46030. /**
  46031. * Define how fast the camera can accelerate to follow it s target.
  46032. */
  46033. cameraAcceleration: number;
  46034. /**
  46035. * Define the speed limit of the camera following an object.
  46036. */
  46037. maxCameraSpeed: number;
  46038. /**
  46039. * Define the target of the camera.
  46040. */
  46041. lockedTarget: Nullable<AbstractMesh>;
  46042. /**
  46043. * Defines the input associated with the camera.
  46044. */
  46045. inputs: FollowCameraInputsManager;
  46046. /**
  46047. * Instantiates the follow camera.
  46048. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46049. * @param name Define the name of the camera in the scene
  46050. * @param position Define the position of the camera
  46051. * @param scene Define the scene the camera belong to
  46052. * @param lockedTarget Define the target of the camera
  46053. */
  46054. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46055. private _follow;
  46056. /**
  46057. * Attached controls to the current camera.
  46058. * @param element Defines the element the controls should be listened from
  46059. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46060. */
  46061. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46062. /**
  46063. * Detach the current controls from the camera.
  46064. * The camera will stop reacting to inputs.
  46065. * @param element Defines the element to stop listening the inputs from
  46066. */
  46067. detachControl(element: HTMLElement): void;
  46068. /** @hidden */
  46069. _checkInputs(): void;
  46070. private _checkLimits;
  46071. /**
  46072. * Gets the camera class name.
  46073. * @returns the class name
  46074. */
  46075. getClassName(): string;
  46076. }
  46077. /**
  46078. * Arc Rotate version of the follow camera.
  46079. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46080. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46081. */
  46082. export class ArcFollowCamera extends TargetCamera {
  46083. /** The longitudinal angle of the camera */
  46084. alpha: number;
  46085. /** The latitudinal angle of the camera */
  46086. beta: number;
  46087. /** The radius of the camera from its target */
  46088. radius: number;
  46089. /** Define the camera target (the mesh it should follow) */
  46090. target: Nullable<AbstractMesh>;
  46091. private _cartesianCoordinates;
  46092. /**
  46093. * Instantiates a new ArcFollowCamera
  46094. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46095. * @param name Define the name of the camera
  46096. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46097. * @param beta Define the rotation angle of the camera around the elevation axis
  46098. * @param radius Define the radius of the camera from its target point
  46099. * @param target Define the target of the camera
  46100. * @param scene Define the scene the camera belongs to
  46101. */
  46102. constructor(name: string,
  46103. /** The longitudinal angle of the camera */
  46104. alpha: number,
  46105. /** The latitudinal angle of the camera */
  46106. beta: number,
  46107. /** The radius of the camera from its target */
  46108. radius: number,
  46109. /** Define the camera target (the mesh it should follow) */
  46110. target: Nullable<AbstractMesh>, scene: Scene);
  46111. private _follow;
  46112. /** @hidden */
  46113. _checkInputs(): void;
  46114. /**
  46115. * Returns the class name of the object.
  46116. * It is mostly used internally for serialization purposes.
  46117. */
  46118. getClassName(): string;
  46119. }
  46120. }
  46121. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46122. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46123. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46124. import { Nullable } from "babylonjs/types";
  46125. /**
  46126. * Manage the keyboard inputs to control the movement of a follow camera.
  46127. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46128. */
  46129. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46130. /**
  46131. * Defines the camera the input is attached to.
  46132. */
  46133. camera: FollowCamera;
  46134. /**
  46135. * Defines the list of key codes associated with the up action (increase heightOffset)
  46136. */
  46137. keysHeightOffsetIncr: number[];
  46138. /**
  46139. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46140. */
  46141. keysHeightOffsetDecr: number[];
  46142. /**
  46143. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46144. */
  46145. keysHeightOffsetModifierAlt: boolean;
  46146. /**
  46147. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46148. */
  46149. keysHeightOffsetModifierCtrl: boolean;
  46150. /**
  46151. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46152. */
  46153. keysHeightOffsetModifierShift: boolean;
  46154. /**
  46155. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46156. */
  46157. keysRotationOffsetIncr: number[];
  46158. /**
  46159. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46160. */
  46161. keysRotationOffsetDecr: number[];
  46162. /**
  46163. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46164. */
  46165. keysRotationOffsetModifierAlt: boolean;
  46166. /**
  46167. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46168. */
  46169. keysRotationOffsetModifierCtrl: boolean;
  46170. /**
  46171. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46172. */
  46173. keysRotationOffsetModifierShift: boolean;
  46174. /**
  46175. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46176. */
  46177. keysRadiusIncr: number[];
  46178. /**
  46179. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46180. */
  46181. keysRadiusDecr: number[];
  46182. /**
  46183. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46184. */
  46185. keysRadiusModifierAlt: boolean;
  46186. /**
  46187. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46188. */
  46189. keysRadiusModifierCtrl: boolean;
  46190. /**
  46191. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46192. */
  46193. keysRadiusModifierShift: boolean;
  46194. /**
  46195. * Defines the rate of change of heightOffset.
  46196. */
  46197. heightSensibility: number;
  46198. /**
  46199. * Defines the rate of change of rotationOffset.
  46200. */
  46201. rotationSensibility: number;
  46202. /**
  46203. * Defines the rate of change of radius.
  46204. */
  46205. radiusSensibility: number;
  46206. private _keys;
  46207. private _ctrlPressed;
  46208. private _altPressed;
  46209. private _shiftPressed;
  46210. private _onCanvasBlurObserver;
  46211. private _onKeyboardObserver;
  46212. private _engine;
  46213. private _scene;
  46214. /**
  46215. * Attach the input controls to a specific dom element to get the input from.
  46216. * @param element Defines the element the controls should be listened from
  46217. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46218. */
  46219. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46220. /**
  46221. * Detach the current controls from the specified dom element.
  46222. * @param element Defines the element to stop listening the inputs from
  46223. */
  46224. detachControl(element: Nullable<HTMLElement>): void;
  46225. /**
  46226. * Update the current camera state depending on the inputs that have been used this frame.
  46227. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46228. */
  46229. checkInputs(): void;
  46230. /**
  46231. * Gets the class name of the current input.
  46232. * @returns the class name
  46233. */
  46234. getClassName(): string;
  46235. /**
  46236. * Get the friendly name associated with the input class.
  46237. * @returns the input friendly name
  46238. */
  46239. getSimpleName(): string;
  46240. /**
  46241. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46242. * allow modification of the heightOffset value.
  46243. */
  46244. private _modifierHeightOffset;
  46245. /**
  46246. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46247. * allow modification of the rotationOffset value.
  46248. */
  46249. private _modifierRotationOffset;
  46250. /**
  46251. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46252. * allow modification of the radius value.
  46253. */
  46254. private _modifierRadius;
  46255. }
  46256. }
  46257. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46258. import { Nullable } from "babylonjs/types";
  46259. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46260. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46261. import { Observable } from "babylonjs/Misc/observable";
  46262. module "babylonjs/Cameras/freeCameraInputsManager" {
  46263. interface FreeCameraInputsManager {
  46264. /**
  46265. * @hidden
  46266. */
  46267. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46268. /**
  46269. * Add orientation input support to the input manager.
  46270. * @returns the current input manager
  46271. */
  46272. addDeviceOrientation(): FreeCameraInputsManager;
  46273. }
  46274. }
  46275. /**
  46276. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46277. * Screen rotation is taken into account.
  46278. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46279. */
  46280. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46281. private _camera;
  46282. private _screenOrientationAngle;
  46283. private _constantTranform;
  46284. private _screenQuaternion;
  46285. private _alpha;
  46286. private _beta;
  46287. private _gamma;
  46288. /**
  46289. * Can be used to detect if a device orientation sensor is available on a device
  46290. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46291. * @returns a promise that will resolve on orientation change
  46292. */
  46293. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46294. /**
  46295. * @hidden
  46296. */
  46297. _onDeviceOrientationChangedObservable: Observable<void>;
  46298. /**
  46299. * Instantiates a new input
  46300. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46301. */
  46302. constructor();
  46303. /**
  46304. * Define the camera controlled by the input.
  46305. */
  46306. get camera(): FreeCamera;
  46307. set camera(camera: FreeCamera);
  46308. /**
  46309. * Attach the input controls to a specific dom element to get the input from.
  46310. * @param element Defines the element the controls should be listened from
  46311. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46312. */
  46313. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46314. private _orientationChanged;
  46315. private _deviceOrientation;
  46316. /**
  46317. * Detach the current controls from the specified dom element.
  46318. * @param element Defines the element to stop listening the inputs from
  46319. */
  46320. detachControl(element: Nullable<HTMLElement>): void;
  46321. /**
  46322. * Update the current camera state depending on the inputs that have been used this frame.
  46323. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46324. */
  46325. checkInputs(): void;
  46326. /**
  46327. * Gets the class name of the current intput.
  46328. * @returns the class name
  46329. */
  46330. getClassName(): string;
  46331. /**
  46332. * Get the friendly name associated with the input class.
  46333. * @returns the input friendly name
  46334. */
  46335. getSimpleName(): string;
  46336. }
  46337. }
  46338. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46339. import { Nullable } from "babylonjs/types";
  46340. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46341. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46342. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46343. /**
  46344. * Manage the gamepad inputs to control a free camera.
  46345. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46346. */
  46347. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46348. /**
  46349. * Define the camera the input is attached to.
  46350. */
  46351. camera: FreeCamera;
  46352. /**
  46353. * Define the Gamepad controlling the input
  46354. */
  46355. gamepad: Nullable<Gamepad>;
  46356. /**
  46357. * Defines the gamepad rotation sensiblity.
  46358. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46359. */
  46360. gamepadAngularSensibility: number;
  46361. /**
  46362. * Defines the gamepad move sensiblity.
  46363. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46364. */
  46365. gamepadMoveSensibility: number;
  46366. private _yAxisScale;
  46367. /**
  46368. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46369. */
  46370. get invertYAxis(): boolean;
  46371. set invertYAxis(value: boolean);
  46372. private _onGamepadConnectedObserver;
  46373. private _onGamepadDisconnectedObserver;
  46374. private _cameraTransform;
  46375. private _deltaTransform;
  46376. private _vector3;
  46377. private _vector2;
  46378. /**
  46379. * Attach the input controls to a specific dom element to get the input from.
  46380. * @param element Defines the element the controls should be listened from
  46381. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46382. */
  46383. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46384. /**
  46385. * Detach the current controls from the specified dom element.
  46386. * @param element Defines the element to stop listening the inputs from
  46387. */
  46388. detachControl(element: Nullable<HTMLElement>): void;
  46389. /**
  46390. * Update the current camera state depending on the inputs that have been used this frame.
  46391. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46392. */
  46393. checkInputs(): void;
  46394. /**
  46395. * Gets the class name of the current intput.
  46396. * @returns the class name
  46397. */
  46398. getClassName(): string;
  46399. /**
  46400. * Get the friendly name associated with the input class.
  46401. * @returns the input friendly name
  46402. */
  46403. getSimpleName(): string;
  46404. }
  46405. }
  46406. declare module "babylonjs/Misc/virtualJoystick" {
  46407. import { Nullable } from "babylonjs/types";
  46408. import { Vector3 } from "babylonjs/Maths/math.vector";
  46409. /**
  46410. * Defines the potential axis of a Joystick
  46411. */
  46412. export enum JoystickAxis {
  46413. /** X axis */
  46414. X = 0,
  46415. /** Y axis */
  46416. Y = 1,
  46417. /** Z axis */
  46418. Z = 2
  46419. }
  46420. /**
  46421. * Represents the different customization options available
  46422. * for VirtualJoystick
  46423. */
  46424. interface VirtualJoystickCustomizations {
  46425. /**
  46426. * Size of the joystick's puck
  46427. */
  46428. puckSize: number;
  46429. /**
  46430. * Size of the joystick's container
  46431. */
  46432. containerSize: number;
  46433. /**
  46434. * Color of the joystick && puck
  46435. */
  46436. color: string;
  46437. /**
  46438. * Image URL for the joystick's puck
  46439. */
  46440. puckImage?: string;
  46441. /**
  46442. * Image URL for the joystick's container
  46443. */
  46444. containerImage?: string;
  46445. /**
  46446. * Defines the unmoving position of the joystick container
  46447. */
  46448. position?: {
  46449. x: number;
  46450. y: number;
  46451. };
  46452. /**
  46453. * Defines whether or not the joystick container is always visible
  46454. */
  46455. alwaysVisible: boolean;
  46456. /**
  46457. * Defines whether or not to limit the movement of the puck to the joystick's container
  46458. */
  46459. limitToContainer: boolean;
  46460. }
  46461. /**
  46462. * Class used to define virtual joystick (used in touch mode)
  46463. */
  46464. export class VirtualJoystick {
  46465. /**
  46466. * Gets or sets a boolean indicating that left and right values must be inverted
  46467. */
  46468. reverseLeftRight: boolean;
  46469. /**
  46470. * Gets or sets a boolean indicating that up and down values must be inverted
  46471. */
  46472. reverseUpDown: boolean;
  46473. /**
  46474. * Gets the offset value for the position (ie. the change of the position value)
  46475. */
  46476. deltaPosition: Vector3;
  46477. /**
  46478. * Gets a boolean indicating if the virtual joystick was pressed
  46479. */
  46480. pressed: boolean;
  46481. /**
  46482. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46483. */
  46484. static Canvas: Nullable<HTMLCanvasElement>;
  46485. /**
  46486. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46487. */
  46488. limitToContainer: boolean;
  46489. private static _globalJoystickIndex;
  46490. private static _alwaysVisibleSticks;
  46491. private static vjCanvasContext;
  46492. private static vjCanvasWidth;
  46493. private static vjCanvasHeight;
  46494. private static halfWidth;
  46495. private static _GetDefaultOptions;
  46496. private _action;
  46497. private _axisTargetedByLeftAndRight;
  46498. private _axisTargetedByUpAndDown;
  46499. private _joystickSensibility;
  46500. private _inversedSensibility;
  46501. private _joystickPointerID;
  46502. private _joystickColor;
  46503. private _joystickPointerPos;
  46504. private _joystickPreviousPointerPos;
  46505. private _joystickPointerStartPos;
  46506. private _deltaJoystickVector;
  46507. private _leftJoystick;
  46508. private _touches;
  46509. private _joystickPosition;
  46510. private _alwaysVisible;
  46511. private _puckImage;
  46512. private _containerImage;
  46513. private _joystickPuckSize;
  46514. private _joystickContainerSize;
  46515. private _clearPuckSize;
  46516. private _clearContainerSize;
  46517. private _clearPuckSizeOffset;
  46518. private _clearContainerSizeOffset;
  46519. private _onPointerDownHandlerRef;
  46520. private _onPointerMoveHandlerRef;
  46521. private _onPointerUpHandlerRef;
  46522. private _onResize;
  46523. /**
  46524. * Creates a new virtual joystick
  46525. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46526. * @param customizations Defines the options we want to customize the VirtualJoystick
  46527. */
  46528. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46529. /**
  46530. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46531. * @param newJoystickSensibility defines the new sensibility
  46532. */
  46533. setJoystickSensibility(newJoystickSensibility: number): void;
  46534. private _onPointerDown;
  46535. private _onPointerMove;
  46536. private _onPointerUp;
  46537. /**
  46538. * Change the color of the virtual joystick
  46539. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46540. */
  46541. setJoystickColor(newColor: string): void;
  46542. /**
  46543. * Size of the joystick's container
  46544. */
  46545. set containerSize(newSize: number);
  46546. get containerSize(): number;
  46547. /**
  46548. * Size of the joystick's puck
  46549. */
  46550. set puckSize(newSize: number);
  46551. get puckSize(): number;
  46552. /**
  46553. * Clears the set position of the joystick
  46554. */
  46555. clearPosition(): void;
  46556. /**
  46557. * Defines whether or not the joystick container is always visible
  46558. */
  46559. set alwaysVisible(value: boolean);
  46560. get alwaysVisible(): boolean;
  46561. /**
  46562. * Sets the constant position of the Joystick container
  46563. * @param x X axis coordinate
  46564. * @param y Y axis coordinate
  46565. */
  46566. setPosition(x: number, y: number): void;
  46567. /**
  46568. * Defines a callback to call when the joystick is touched
  46569. * @param action defines the callback
  46570. */
  46571. setActionOnTouch(action: () => any): void;
  46572. /**
  46573. * Defines which axis you'd like to control for left & right
  46574. * @param axis defines the axis to use
  46575. */
  46576. setAxisForLeftRight(axis: JoystickAxis): void;
  46577. /**
  46578. * Defines which axis you'd like to control for up & down
  46579. * @param axis defines the axis to use
  46580. */
  46581. setAxisForUpDown(axis: JoystickAxis): void;
  46582. /**
  46583. * Clears the canvas from the previous puck / container draw
  46584. */
  46585. private _clearPreviousDraw;
  46586. /**
  46587. * Loads `urlPath` to be used for the container's image
  46588. * @param urlPath defines the urlPath of an image to use
  46589. */
  46590. setContainerImage(urlPath: string): void;
  46591. /**
  46592. * Loads `urlPath` to be used for the puck's image
  46593. * @param urlPath defines the urlPath of an image to use
  46594. */
  46595. setPuckImage(urlPath: string): void;
  46596. /**
  46597. * Draws the Virtual Joystick's container
  46598. */
  46599. private _drawContainer;
  46600. /**
  46601. * Draws the Virtual Joystick's puck
  46602. */
  46603. private _drawPuck;
  46604. private _drawVirtualJoystick;
  46605. /**
  46606. * Release internal HTML canvas
  46607. */
  46608. releaseCanvas(): void;
  46609. }
  46610. }
  46611. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46612. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46613. import { Nullable } from "babylonjs/types";
  46614. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46615. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46616. module "babylonjs/Cameras/freeCameraInputsManager" {
  46617. interface FreeCameraInputsManager {
  46618. /**
  46619. * Add virtual joystick input support to the input manager.
  46620. * @returns the current input manager
  46621. */
  46622. addVirtualJoystick(): FreeCameraInputsManager;
  46623. }
  46624. }
  46625. /**
  46626. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46627. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46628. */
  46629. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46630. /**
  46631. * Defines the camera the input is attached to.
  46632. */
  46633. camera: FreeCamera;
  46634. private _leftjoystick;
  46635. private _rightjoystick;
  46636. /**
  46637. * Gets the left stick of the virtual joystick.
  46638. * @returns The virtual Joystick
  46639. */
  46640. getLeftJoystick(): VirtualJoystick;
  46641. /**
  46642. * Gets the right stick of the virtual joystick.
  46643. * @returns The virtual Joystick
  46644. */
  46645. getRightJoystick(): VirtualJoystick;
  46646. /**
  46647. * Update the current camera state depending on the inputs that have been used this frame.
  46648. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46649. */
  46650. checkInputs(): void;
  46651. /**
  46652. * Attach the input controls to a specific dom element to get the input from.
  46653. * @param element Defines the element the controls should be listened from
  46654. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46655. */
  46656. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46657. /**
  46658. * Detach the current controls from the specified dom element.
  46659. * @param element Defines the element to stop listening the inputs from
  46660. */
  46661. detachControl(element: Nullable<HTMLElement>): void;
  46662. /**
  46663. * Gets the class name of the current intput.
  46664. * @returns the class name
  46665. */
  46666. getClassName(): string;
  46667. /**
  46668. * Get the friendly name associated with the input class.
  46669. * @returns the input friendly name
  46670. */
  46671. getSimpleName(): string;
  46672. }
  46673. }
  46674. declare module "babylonjs/Cameras/Inputs/index" {
  46675. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46676. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46677. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46678. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46679. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46680. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46681. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46682. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46683. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46684. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46685. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46686. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46687. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46688. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46689. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46690. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46691. }
  46692. declare module "babylonjs/Cameras/touchCamera" {
  46693. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46694. import { Scene } from "babylonjs/scene";
  46695. import { Vector3 } from "babylonjs/Maths/math.vector";
  46696. /**
  46697. * This represents a FPS type of camera controlled by touch.
  46698. * This is like a universal camera minus the Gamepad controls.
  46699. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46700. */
  46701. export class TouchCamera extends FreeCamera {
  46702. /**
  46703. * Defines the touch sensibility for rotation.
  46704. * The higher the faster.
  46705. */
  46706. get touchAngularSensibility(): number;
  46707. set touchAngularSensibility(value: number);
  46708. /**
  46709. * Defines the touch sensibility for move.
  46710. * The higher the faster.
  46711. */
  46712. get touchMoveSensibility(): number;
  46713. set touchMoveSensibility(value: number);
  46714. /**
  46715. * Instantiates a new touch camera.
  46716. * This represents a FPS type of camera controlled by touch.
  46717. * This is like a universal camera minus the Gamepad controls.
  46718. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46719. * @param name Define the name of the camera in the scene
  46720. * @param position Define the start position of the camera in the scene
  46721. * @param scene Define the scene the camera belongs to
  46722. */
  46723. constructor(name: string, position: Vector3, scene: Scene);
  46724. /**
  46725. * Gets the current object class name.
  46726. * @return the class name
  46727. */
  46728. getClassName(): string;
  46729. /** @hidden */
  46730. _setupInputs(): void;
  46731. }
  46732. }
  46733. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46734. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46735. import { Scene } from "babylonjs/scene";
  46736. import { Vector3 } from "babylonjs/Maths/math.vector";
  46737. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46738. import { Axis } from "babylonjs/Maths/math.axis";
  46739. /**
  46740. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46741. * being tilted forward or back and left or right.
  46742. */
  46743. export class DeviceOrientationCamera extends FreeCamera {
  46744. private _initialQuaternion;
  46745. private _quaternionCache;
  46746. private _tmpDragQuaternion;
  46747. private _disablePointerInputWhenUsingDeviceOrientation;
  46748. /**
  46749. * Creates a new device orientation camera
  46750. * @param name The name of the camera
  46751. * @param position The start position camera
  46752. * @param scene The scene the camera belongs to
  46753. */
  46754. constructor(name: string, position: Vector3, scene: Scene);
  46755. /**
  46756. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46757. */
  46758. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46759. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46760. private _dragFactor;
  46761. /**
  46762. * Enabled turning on the y axis when the orientation sensor is active
  46763. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46764. */
  46765. enableHorizontalDragging(dragFactor?: number): void;
  46766. /**
  46767. * Gets the current instance class name ("DeviceOrientationCamera").
  46768. * This helps avoiding instanceof at run time.
  46769. * @returns the class name
  46770. */
  46771. getClassName(): string;
  46772. /**
  46773. * @hidden
  46774. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46775. */
  46776. _checkInputs(): void;
  46777. /**
  46778. * Reset the camera to its default orientation on the specified axis only.
  46779. * @param axis The axis to reset
  46780. */
  46781. resetToCurrentRotation(axis?: Axis): void;
  46782. }
  46783. }
  46784. declare module "babylonjs/Gamepads/xboxGamepad" {
  46785. import { Observable } from "babylonjs/Misc/observable";
  46786. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46787. /**
  46788. * Defines supported buttons for XBox360 compatible gamepads
  46789. */
  46790. export enum Xbox360Button {
  46791. /** A */
  46792. A = 0,
  46793. /** B */
  46794. B = 1,
  46795. /** X */
  46796. X = 2,
  46797. /** Y */
  46798. Y = 3,
  46799. /** Left button */
  46800. LB = 4,
  46801. /** Right button */
  46802. RB = 5,
  46803. /** Back */
  46804. Back = 8,
  46805. /** Start */
  46806. Start = 9,
  46807. /** Left stick */
  46808. LeftStick = 10,
  46809. /** Right stick */
  46810. RightStick = 11
  46811. }
  46812. /** Defines values for XBox360 DPad */
  46813. export enum Xbox360Dpad {
  46814. /** Up */
  46815. Up = 12,
  46816. /** Down */
  46817. Down = 13,
  46818. /** Left */
  46819. Left = 14,
  46820. /** Right */
  46821. Right = 15
  46822. }
  46823. /**
  46824. * Defines a XBox360 gamepad
  46825. */
  46826. export class Xbox360Pad extends Gamepad {
  46827. private _leftTrigger;
  46828. private _rightTrigger;
  46829. private _onlefttriggerchanged;
  46830. private _onrighttriggerchanged;
  46831. private _onbuttondown;
  46832. private _onbuttonup;
  46833. private _ondpaddown;
  46834. private _ondpadup;
  46835. /** Observable raised when a button is pressed */
  46836. onButtonDownObservable: Observable<Xbox360Button>;
  46837. /** Observable raised when a button is released */
  46838. onButtonUpObservable: Observable<Xbox360Button>;
  46839. /** Observable raised when a pad is pressed */
  46840. onPadDownObservable: Observable<Xbox360Dpad>;
  46841. /** Observable raised when a pad is released */
  46842. onPadUpObservable: Observable<Xbox360Dpad>;
  46843. private _buttonA;
  46844. private _buttonB;
  46845. private _buttonX;
  46846. private _buttonY;
  46847. private _buttonBack;
  46848. private _buttonStart;
  46849. private _buttonLB;
  46850. private _buttonRB;
  46851. private _buttonLeftStick;
  46852. private _buttonRightStick;
  46853. private _dPadUp;
  46854. private _dPadDown;
  46855. private _dPadLeft;
  46856. private _dPadRight;
  46857. private _isXboxOnePad;
  46858. /**
  46859. * Creates a new XBox360 gamepad object
  46860. * @param id defines the id of this gamepad
  46861. * @param index defines its index
  46862. * @param gamepad defines the internal HTML gamepad object
  46863. * @param xboxOne defines if it is a XBox One gamepad
  46864. */
  46865. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  46866. /**
  46867. * Defines the callback to call when left trigger is pressed
  46868. * @param callback defines the callback to use
  46869. */
  46870. onlefttriggerchanged(callback: (value: number) => void): void;
  46871. /**
  46872. * Defines the callback to call when right trigger is pressed
  46873. * @param callback defines the callback to use
  46874. */
  46875. onrighttriggerchanged(callback: (value: number) => void): void;
  46876. /**
  46877. * Gets the left trigger value
  46878. */
  46879. get leftTrigger(): number;
  46880. /**
  46881. * Sets the left trigger value
  46882. */
  46883. set leftTrigger(newValue: number);
  46884. /**
  46885. * Gets the right trigger value
  46886. */
  46887. get rightTrigger(): number;
  46888. /**
  46889. * Sets the right trigger value
  46890. */
  46891. set rightTrigger(newValue: number);
  46892. /**
  46893. * Defines the callback to call when a button is pressed
  46894. * @param callback defines the callback to use
  46895. */
  46896. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  46897. /**
  46898. * Defines the callback to call when a button is released
  46899. * @param callback defines the callback to use
  46900. */
  46901. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  46902. /**
  46903. * Defines the callback to call when a pad is pressed
  46904. * @param callback defines the callback to use
  46905. */
  46906. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  46907. /**
  46908. * Defines the callback to call when a pad is released
  46909. * @param callback defines the callback to use
  46910. */
  46911. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  46912. private _setButtonValue;
  46913. private _setDPadValue;
  46914. /**
  46915. * Gets the value of the `A` button
  46916. */
  46917. get buttonA(): number;
  46918. /**
  46919. * Sets the value of the `A` button
  46920. */
  46921. set buttonA(value: number);
  46922. /**
  46923. * Gets the value of the `B` button
  46924. */
  46925. get buttonB(): number;
  46926. /**
  46927. * Sets the value of the `B` button
  46928. */
  46929. set buttonB(value: number);
  46930. /**
  46931. * Gets the value of the `X` button
  46932. */
  46933. get buttonX(): number;
  46934. /**
  46935. * Sets the value of the `X` button
  46936. */
  46937. set buttonX(value: number);
  46938. /**
  46939. * Gets the value of the `Y` button
  46940. */
  46941. get buttonY(): number;
  46942. /**
  46943. * Sets the value of the `Y` button
  46944. */
  46945. set buttonY(value: number);
  46946. /**
  46947. * Gets the value of the `Start` button
  46948. */
  46949. get buttonStart(): number;
  46950. /**
  46951. * Sets the value of the `Start` button
  46952. */
  46953. set buttonStart(value: number);
  46954. /**
  46955. * Gets the value of the `Back` button
  46956. */
  46957. get buttonBack(): number;
  46958. /**
  46959. * Sets the value of the `Back` button
  46960. */
  46961. set buttonBack(value: number);
  46962. /**
  46963. * Gets the value of the `Left` button
  46964. */
  46965. get buttonLB(): number;
  46966. /**
  46967. * Sets the value of the `Left` button
  46968. */
  46969. set buttonLB(value: number);
  46970. /**
  46971. * Gets the value of the `Right` button
  46972. */
  46973. get buttonRB(): number;
  46974. /**
  46975. * Sets the value of the `Right` button
  46976. */
  46977. set buttonRB(value: number);
  46978. /**
  46979. * Gets the value of the Left joystick
  46980. */
  46981. get buttonLeftStick(): number;
  46982. /**
  46983. * Sets the value of the Left joystick
  46984. */
  46985. set buttonLeftStick(value: number);
  46986. /**
  46987. * Gets the value of the Right joystick
  46988. */
  46989. get buttonRightStick(): number;
  46990. /**
  46991. * Sets the value of the Right joystick
  46992. */
  46993. set buttonRightStick(value: number);
  46994. /**
  46995. * Gets the value of D-pad up
  46996. */
  46997. get dPadUp(): number;
  46998. /**
  46999. * Sets the value of D-pad up
  47000. */
  47001. set dPadUp(value: number);
  47002. /**
  47003. * Gets the value of D-pad down
  47004. */
  47005. get dPadDown(): number;
  47006. /**
  47007. * Sets the value of D-pad down
  47008. */
  47009. set dPadDown(value: number);
  47010. /**
  47011. * Gets the value of D-pad left
  47012. */
  47013. get dPadLeft(): number;
  47014. /**
  47015. * Sets the value of D-pad left
  47016. */
  47017. set dPadLeft(value: number);
  47018. /**
  47019. * Gets the value of D-pad right
  47020. */
  47021. get dPadRight(): number;
  47022. /**
  47023. * Sets the value of D-pad right
  47024. */
  47025. set dPadRight(value: number);
  47026. /**
  47027. * Force the gamepad to synchronize with device values
  47028. */
  47029. update(): void;
  47030. /**
  47031. * Disposes the gamepad
  47032. */
  47033. dispose(): void;
  47034. }
  47035. }
  47036. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47037. import { Observable } from "babylonjs/Misc/observable";
  47038. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47039. /**
  47040. * Defines supported buttons for DualShock compatible gamepads
  47041. */
  47042. export enum DualShockButton {
  47043. /** Cross */
  47044. Cross = 0,
  47045. /** Circle */
  47046. Circle = 1,
  47047. /** Square */
  47048. Square = 2,
  47049. /** Triangle */
  47050. Triangle = 3,
  47051. /** L1 */
  47052. L1 = 4,
  47053. /** R1 */
  47054. R1 = 5,
  47055. /** Share */
  47056. Share = 8,
  47057. /** Options */
  47058. Options = 9,
  47059. /** Left stick */
  47060. LeftStick = 10,
  47061. /** Right stick */
  47062. RightStick = 11
  47063. }
  47064. /** Defines values for DualShock DPad */
  47065. export enum DualShockDpad {
  47066. /** Up */
  47067. Up = 12,
  47068. /** Down */
  47069. Down = 13,
  47070. /** Left */
  47071. Left = 14,
  47072. /** Right */
  47073. Right = 15
  47074. }
  47075. /**
  47076. * Defines a DualShock gamepad
  47077. */
  47078. export class DualShockPad extends Gamepad {
  47079. private _leftTrigger;
  47080. private _rightTrigger;
  47081. private _onlefttriggerchanged;
  47082. private _onrighttriggerchanged;
  47083. private _onbuttondown;
  47084. private _onbuttonup;
  47085. private _ondpaddown;
  47086. private _ondpadup;
  47087. /** Observable raised when a button is pressed */
  47088. onButtonDownObservable: Observable<DualShockButton>;
  47089. /** Observable raised when a button is released */
  47090. onButtonUpObservable: Observable<DualShockButton>;
  47091. /** Observable raised when a pad is pressed */
  47092. onPadDownObservable: Observable<DualShockDpad>;
  47093. /** Observable raised when a pad is released */
  47094. onPadUpObservable: Observable<DualShockDpad>;
  47095. private _buttonCross;
  47096. private _buttonCircle;
  47097. private _buttonSquare;
  47098. private _buttonTriangle;
  47099. private _buttonShare;
  47100. private _buttonOptions;
  47101. private _buttonL1;
  47102. private _buttonR1;
  47103. private _buttonLeftStick;
  47104. private _buttonRightStick;
  47105. private _dPadUp;
  47106. private _dPadDown;
  47107. private _dPadLeft;
  47108. private _dPadRight;
  47109. /**
  47110. * Creates a new DualShock gamepad object
  47111. * @param id defines the id of this gamepad
  47112. * @param index defines its index
  47113. * @param gamepad defines the internal HTML gamepad object
  47114. */
  47115. constructor(id: string, index: number, gamepad: any);
  47116. /**
  47117. * Defines the callback to call when left trigger is pressed
  47118. * @param callback defines the callback to use
  47119. */
  47120. onlefttriggerchanged(callback: (value: number) => void): void;
  47121. /**
  47122. * Defines the callback to call when right trigger is pressed
  47123. * @param callback defines the callback to use
  47124. */
  47125. onrighttriggerchanged(callback: (value: number) => void): void;
  47126. /**
  47127. * Gets the left trigger value
  47128. */
  47129. get leftTrigger(): number;
  47130. /**
  47131. * Sets the left trigger value
  47132. */
  47133. set leftTrigger(newValue: number);
  47134. /**
  47135. * Gets the right trigger value
  47136. */
  47137. get rightTrigger(): number;
  47138. /**
  47139. * Sets the right trigger value
  47140. */
  47141. set rightTrigger(newValue: number);
  47142. /**
  47143. * Defines the callback to call when a button is pressed
  47144. * @param callback defines the callback to use
  47145. */
  47146. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47147. /**
  47148. * Defines the callback to call when a button is released
  47149. * @param callback defines the callback to use
  47150. */
  47151. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47152. /**
  47153. * Defines the callback to call when a pad is pressed
  47154. * @param callback defines the callback to use
  47155. */
  47156. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47157. /**
  47158. * Defines the callback to call when a pad is released
  47159. * @param callback defines the callback to use
  47160. */
  47161. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47162. private _setButtonValue;
  47163. private _setDPadValue;
  47164. /**
  47165. * Gets the value of the `Cross` button
  47166. */
  47167. get buttonCross(): number;
  47168. /**
  47169. * Sets the value of the `Cross` button
  47170. */
  47171. set buttonCross(value: number);
  47172. /**
  47173. * Gets the value of the `Circle` button
  47174. */
  47175. get buttonCircle(): number;
  47176. /**
  47177. * Sets the value of the `Circle` button
  47178. */
  47179. set buttonCircle(value: number);
  47180. /**
  47181. * Gets the value of the `Square` button
  47182. */
  47183. get buttonSquare(): number;
  47184. /**
  47185. * Sets the value of the `Square` button
  47186. */
  47187. set buttonSquare(value: number);
  47188. /**
  47189. * Gets the value of the `Triangle` button
  47190. */
  47191. get buttonTriangle(): number;
  47192. /**
  47193. * Sets the value of the `Triangle` button
  47194. */
  47195. set buttonTriangle(value: number);
  47196. /**
  47197. * Gets the value of the `Options` button
  47198. */
  47199. get buttonOptions(): number;
  47200. /**
  47201. * Sets the value of the `Options` button
  47202. */
  47203. set buttonOptions(value: number);
  47204. /**
  47205. * Gets the value of the `Share` button
  47206. */
  47207. get buttonShare(): number;
  47208. /**
  47209. * Sets the value of the `Share` button
  47210. */
  47211. set buttonShare(value: number);
  47212. /**
  47213. * Gets the value of the `L1` button
  47214. */
  47215. get buttonL1(): number;
  47216. /**
  47217. * Sets the value of the `L1` button
  47218. */
  47219. set buttonL1(value: number);
  47220. /**
  47221. * Gets the value of the `R1` button
  47222. */
  47223. get buttonR1(): number;
  47224. /**
  47225. * Sets the value of the `R1` button
  47226. */
  47227. set buttonR1(value: number);
  47228. /**
  47229. * Gets the value of the Left joystick
  47230. */
  47231. get buttonLeftStick(): number;
  47232. /**
  47233. * Sets the value of the Left joystick
  47234. */
  47235. set buttonLeftStick(value: number);
  47236. /**
  47237. * Gets the value of the Right joystick
  47238. */
  47239. get buttonRightStick(): number;
  47240. /**
  47241. * Sets the value of the Right joystick
  47242. */
  47243. set buttonRightStick(value: number);
  47244. /**
  47245. * Gets the value of D-pad up
  47246. */
  47247. get dPadUp(): number;
  47248. /**
  47249. * Sets the value of D-pad up
  47250. */
  47251. set dPadUp(value: number);
  47252. /**
  47253. * Gets the value of D-pad down
  47254. */
  47255. get dPadDown(): number;
  47256. /**
  47257. * Sets the value of D-pad down
  47258. */
  47259. set dPadDown(value: number);
  47260. /**
  47261. * Gets the value of D-pad left
  47262. */
  47263. get dPadLeft(): number;
  47264. /**
  47265. * Sets the value of D-pad left
  47266. */
  47267. set dPadLeft(value: number);
  47268. /**
  47269. * Gets the value of D-pad right
  47270. */
  47271. get dPadRight(): number;
  47272. /**
  47273. * Sets the value of D-pad right
  47274. */
  47275. set dPadRight(value: number);
  47276. /**
  47277. * Force the gamepad to synchronize with device values
  47278. */
  47279. update(): void;
  47280. /**
  47281. * Disposes the gamepad
  47282. */
  47283. dispose(): void;
  47284. }
  47285. }
  47286. declare module "babylonjs/Gamepads/gamepadManager" {
  47287. import { Observable } from "babylonjs/Misc/observable";
  47288. import { Nullable } from "babylonjs/types";
  47289. import { Scene } from "babylonjs/scene";
  47290. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47291. /**
  47292. * Manager for handling gamepads
  47293. */
  47294. export class GamepadManager {
  47295. private _scene?;
  47296. private _babylonGamepads;
  47297. private _oneGamepadConnected;
  47298. /** @hidden */
  47299. _isMonitoring: boolean;
  47300. private _gamepadEventSupported;
  47301. private _gamepadSupport?;
  47302. /**
  47303. * observable to be triggered when the gamepad controller has been connected
  47304. */
  47305. onGamepadConnectedObservable: Observable<Gamepad>;
  47306. /**
  47307. * observable to be triggered when the gamepad controller has been disconnected
  47308. */
  47309. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47310. private _onGamepadConnectedEvent;
  47311. private _onGamepadDisconnectedEvent;
  47312. /**
  47313. * Initializes the gamepad manager
  47314. * @param _scene BabylonJS scene
  47315. */
  47316. constructor(_scene?: Scene | undefined);
  47317. /**
  47318. * The gamepads in the game pad manager
  47319. */
  47320. get gamepads(): Gamepad[];
  47321. /**
  47322. * Get the gamepad controllers based on type
  47323. * @param type The type of gamepad controller
  47324. * @returns Nullable gamepad
  47325. */
  47326. getGamepadByType(type?: number): Nullable<Gamepad>;
  47327. /**
  47328. * Disposes the gamepad manager
  47329. */
  47330. dispose(): void;
  47331. private _addNewGamepad;
  47332. private _startMonitoringGamepads;
  47333. private _stopMonitoringGamepads;
  47334. /** @hidden */
  47335. _checkGamepadsStatus(): void;
  47336. private _updateGamepadObjects;
  47337. }
  47338. }
  47339. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47340. import { Nullable } from "babylonjs/types";
  47341. import { Scene } from "babylonjs/scene";
  47342. import { ISceneComponent } from "babylonjs/sceneComponent";
  47343. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47344. module "babylonjs/scene" {
  47345. interface Scene {
  47346. /** @hidden */
  47347. _gamepadManager: Nullable<GamepadManager>;
  47348. /**
  47349. * Gets the gamepad manager associated with the scene
  47350. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47351. */
  47352. gamepadManager: GamepadManager;
  47353. }
  47354. }
  47355. module "babylonjs/Cameras/freeCameraInputsManager" {
  47356. /**
  47357. * Interface representing a free camera inputs manager
  47358. */
  47359. interface FreeCameraInputsManager {
  47360. /**
  47361. * Adds gamepad input support to the FreeCameraInputsManager.
  47362. * @returns the FreeCameraInputsManager
  47363. */
  47364. addGamepad(): FreeCameraInputsManager;
  47365. }
  47366. }
  47367. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47368. /**
  47369. * Interface representing an arc rotate camera inputs manager
  47370. */
  47371. interface ArcRotateCameraInputsManager {
  47372. /**
  47373. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47374. * @returns the camera inputs manager
  47375. */
  47376. addGamepad(): ArcRotateCameraInputsManager;
  47377. }
  47378. }
  47379. /**
  47380. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47381. */
  47382. export class GamepadSystemSceneComponent implements ISceneComponent {
  47383. /**
  47384. * The component name helpfull to identify the component in the list of scene components.
  47385. */
  47386. readonly name: string;
  47387. /**
  47388. * The scene the component belongs to.
  47389. */
  47390. scene: Scene;
  47391. /**
  47392. * Creates a new instance of the component for the given scene
  47393. * @param scene Defines the scene to register the component in
  47394. */
  47395. constructor(scene: Scene);
  47396. /**
  47397. * Registers the component in a given scene
  47398. */
  47399. register(): void;
  47400. /**
  47401. * Rebuilds the elements related to this component in case of
  47402. * context lost for instance.
  47403. */
  47404. rebuild(): void;
  47405. /**
  47406. * Disposes the component and the associated ressources
  47407. */
  47408. dispose(): void;
  47409. private _beforeCameraUpdate;
  47410. }
  47411. }
  47412. declare module "babylonjs/Cameras/universalCamera" {
  47413. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47414. import { Scene } from "babylonjs/scene";
  47415. import { Vector3 } from "babylonjs/Maths/math.vector";
  47416. import "babylonjs/Gamepads/gamepadSceneComponent";
  47417. /**
  47418. * 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,
  47419. * which still works and will still be found in many Playgrounds.
  47420. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47421. */
  47422. export class UniversalCamera extends TouchCamera {
  47423. /**
  47424. * Defines the gamepad rotation sensiblity.
  47425. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47426. */
  47427. get gamepadAngularSensibility(): number;
  47428. set gamepadAngularSensibility(value: number);
  47429. /**
  47430. * Defines the gamepad move sensiblity.
  47431. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47432. */
  47433. get gamepadMoveSensibility(): number;
  47434. set gamepadMoveSensibility(value: number);
  47435. /**
  47436. * 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,
  47437. * which still works and will still be found in many Playgrounds.
  47438. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47439. * @param name Define the name of the camera in the scene
  47440. * @param position Define the start position of the camera in the scene
  47441. * @param scene Define the scene the camera belongs to
  47442. */
  47443. constructor(name: string, position: Vector3, scene: Scene);
  47444. /**
  47445. * Gets the current object class name.
  47446. * @return the class name
  47447. */
  47448. getClassName(): string;
  47449. }
  47450. }
  47451. declare module "babylonjs/Cameras/gamepadCamera" {
  47452. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47453. import { Scene } from "babylonjs/scene";
  47454. import { Vector3 } from "babylonjs/Maths/math.vector";
  47455. /**
  47456. * This represents a FPS type of camera. This is only here for back compat purpose.
  47457. * Please use the UniversalCamera instead as both are identical.
  47458. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47459. */
  47460. export class GamepadCamera extends UniversalCamera {
  47461. /**
  47462. * Instantiates a new Gamepad Camera
  47463. * This represents a FPS type of camera. This is only here for back compat purpose.
  47464. * Please use the UniversalCamera instead as both are identical.
  47465. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47466. * @param name Define the name of the camera in the scene
  47467. * @param position Define the start position of the camera in the scene
  47468. * @param scene Define the scene the camera belongs to
  47469. */
  47470. constructor(name: string, position: Vector3, scene: Scene);
  47471. /**
  47472. * Gets the current object class name.
  47473. * @return the class name
  47474. */
  47475. getClassName(): string;
  47476. }
  47477. }
  47478. declare module "babylonjs/Shaders/pass.fragment" {
  47479. /** @hidden */
  47480. export var passPixelShader: {
  47481. name: string;
  47482. shader: string;
  47483. };
  47484. }
  47485. declare module "babylonjs/Shaders/passCube.fragment" {
  47486. /** @hidden */
  47487. export var passCubePixelShader: {
  47488. name: string;
  47489. shader: string;
  47490. };
  47491. }
  47492. declare module "babylonjs/PostProcesses/passPostProcess" {
  47493. import { Nullable } from "babylonjs/types";
  47494. import { Camera } from "babylonjs/Cameras/camera";
  47495. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47496. import { Engine } from "babylonjs/Engines/engine";
  47497. import "babylonjs/Shaders/pass.fragment";
  47498. import "babylonjs/Shaders/passCube.fragment";
  47499. /**
  47500. * PassPostProcess which produces an output the same as it's input
  47501. */
  47502. export class PassPostProcess extends PostProcess {
  47503. /**
  47504. * Creates the PassPostProcess
  47505. * @param name The name of the effect.
  47506. * @param options The required width/height ratio to downsize to before computing the render pass.
  47507. * @param camera The camera to apply the render pass to.
  47508. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47509. * @param engine The engine which the post process will be applied. (default: current engine)
  47510. * @param reusable If the post process can be reused on the same frame. (default: false)
  47511. * @param textureType The type of texture to be used when performing the post processing.
  47512. * @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)
  47513. */
  47514. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47515. }
  47516. /**
  47517. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47518. */
  47519. export class PassCubePostProcess extends PostProcess {
  47520. private _face;
  47521. /**
  47522. * Gets or sets the cube face to display.
  47523. * * 0 is +X
  47524. * * 1 is -X
  47525. * * 2 is +Y
  47526. * * 3 is -Y
  47527. * * 4 is +Z
  47528. * * 5 is -Z
  47529. */
  47530. get face(): number;
  47531. set face(value: number);
  47532. /**
  47533. * Creates the PassCubePostProcess
  47534. * @param name The name of the effect.
  47535. * @param options The required width/height ratio to downsize to before computing the render pass.
  47536. * @param camera The camera to apply the render pass to.
  47537. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47538. * @param engine The engine which the post process will be applied. (default: current engine)
  47539. * @param reusable If the post process can be reused on the same frame. (default: false)
  47540. * @param textureType The type of texture to be used when performing the post processing.
  47541. * @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)
  47542. */
  47543. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47544. }
  47545. }
  47546. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47547. /** @hidden */
  47548. export var anaglyphPixelShader: {
  47549. name: string;
  47550. shader: string;
  47551. };
  47552. }
  47553. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47554. import { Engine } from "babylonjs/Engines/engine";
  47555. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47556. import { Camera } from "babylonjs/Cameras/camera";
  47557. import "babylonjs/Shaders/anaglyph.fragment";
  47558. /**
  47559. * Postprocess used to generate anaglyphic rendering
  47560. */
  47561. export class AnaglyphPostProcess extends PostProcess {
  47562. private _passedProcess;
  47563. /**
  47564. * Creates a new AnaglyphPostProcess
  47565. * @param name defines postprocess name
  47566. * @param options defines creation options or target ratio scale
  47567. * @param rigCameras defines cameras using this postprocess
  47568. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47569. * @param engine defines hosting engine
  47570. * @param reusable defines if the postprocess will be reused multiple times per frame
  47571. */
  47572. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47573. }
  47574. }
  47575. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47576. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47577. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47578. import { Scene } from "babylonjs/scene";
  47579. import { Vector3 } from "babylonjs/Maths/math.vector";
  47580. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47581. /**
  47582. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47583. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47584. */
  47585. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47586. /**
  47587. * Creates a new AnaglyphArcRotateCamera
  47588. * @param name defines camera name
  47589. * @param alpha defines alpha angle (in radians)
  47590. * @param beta defines beta angle (in radians)
  47591. * @param radius defines radius
  47592. * @param target defines camera target
  47593. * @param interaxialDistance defines distance between each color axis
  47594. * @param scene defines the hosting scene
  47595. */
  47596. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47597. /**
  47598. * Gets camera class name
  47599. * @returns AnaglyphArcRotateCamera
  47600. */
  47601. getClassName(): string;
  47602. }
  47603. }
  47604. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47605. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47606. import { Scene } from "babylonjs/scene";
  47607. import { Vector3 } from "babylonjs/Maths/math.vector";
  47608. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47609. /**
  47610. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47611. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47612. */
  47613. export class AnaglyphFreeCamera extends FreeCamera {
  47614. /**
  47615. * Creates a new AnaglyphFreeCamera
  47616. * @param name defines camera name
  47617. * @param position defines initial position
  47618. * @param interaxialDistance defines distance between each color axis
  47619. * @param scene defines the hosting scene
  47620. */
  47621. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47622. /**
  47623. * Gets camera class name
  47624. * @returns AnaglyphFreeCamera
  47625. */
  47626. getClassName(): string;
  47627. }
  47628. }
  47629. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47630. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47631. import { Scene } from "babylonjs/scene";
  47632. import { Vector3 } from "babylonjs/Maths/math.vector";
  47633. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47634. /**
  47635. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47636. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47637. */
  47638. export class AnaglyphGamepadCamera extends GamepadCamera {
  47639. /**
  47640. * Creates a new AnaglyphGamepadCamera
  47641. * @param name defines camera name
  47642. * @param position defines initial position
  47643. * @param interaxialDistance defines distance between each color axis
  47644. * @param scene defines the hosting scene
  47645. */
  47646. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47647. /**
  47648. * Gets camera class name
  47649. * @returns AnaglyphGamepadCamera
  47650. */
  47651. getClassName(): string;
  47652. }
  47653. }
  47654. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47655. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47656. import { Scene } from "babylonjs/scene";
  47657. import { Vector3 } from "babylonjs/Maths/math.vector";
  47658. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47659. /**
  47660. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47661. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47662. */
  47663. export class AnaglyphUniversalCamera extends UniversalCamera {
  47664. /**
  47665. * Creates a new AnaglyphUniversalCamera
  47666. * @param name defines camera name
  47667. * @param position defines initial position
  47668. * @param interaxialDistance defines distance between each color axis
  47669. * @param scene defines the hosting scene
  47670. */
  47671. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47672. /**
  47673. * Gets camera class name
  47674. * @returns AnaglyphUniversalCamera
  47675. */
  47676. getClassName(): string;
  47677. }
  47678. }
  47679. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47680. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47681. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47682. import { Scene } from "babylonjs/scene";
  47683. import { Vector3 } from "babylonjs/Maths/math.vector";
  47684. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47685. /**
  47686. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47687. * @see https://doc.babylonjs.com/features/cameras
  47688. */
  47689. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47690. /**
  47691. * Creates a new StereoscopicArcRotateCamera
  47692. * @param name defines camera name
  47693. * @param alpha defines alpha angle (in radians)
  47694. * @param beta defines beta angle (in radians)
  47695. * @param radius defines radius
  47696. * @param target defines camera target
  47697. * @param interaxialDistance defines distance between each color axis
  47698. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47699. * @param scene defines the hosting scene
  47700. */
  47701. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47702. /**
  47703. * Gets camera class name
  47704. * @returns StereoscopicArcRotateCamera
  47705. */
  47706. getClassName(): string;
  47707. }
  47708. }
  47709. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47710. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47711. import { Scene } from "babylonjs/scene";
  47712. import { Vector3 } from "babylonjs/Maths/math.vector";
  47713. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47714. /**
  47715. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47716. * @see https://doc.babylonjs.com/features/cameras
  47717. */
  47718. export class StereoscopicFreeCamera extends FreeCamera {
  47719. /**
  47720. * Creates a new StereoscopicFreeCamera
  47721. * @param name defines camera name
  47722. * @param position defines initial position
  47723. * @param interaxialDistance defines distance between each color axis
  47724. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47725. * @param scene defines the hosting scene
  47726. */
  47727. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47728. /**
  47729. * Gets camera class name
  47730. * @returns StereoscopicFreeCamera
  47731. */
  47732. getClassName(): string;
  47733. }
  47734. }
  47735. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47736. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47737. import { Scene } from "babylonjs/scene";
  47738. import { Vector3 } from "babylonjs/Maths/math.vector";
  47739. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47740. /**
  47741. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47742. * @see https://doc.babylonjs.com/features/cameras
  47743. */
  47744. export class StereoscopicGamepadCamera extends GamepadCamera {
  47745. /**
  47746. * Creates a new StereoscopicGamepadCamera
  47747. * @param name defines camera name
  47748. * @param position defines initial position
  47749. * @param interaxialDistance defines distance between each color axis
  47750. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47751. * @param scene defines the hosting scene
  47752. */
  47753. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47754. /**
  47755. * Gets camera class name
  47756. * @returns StereoscopicGamepadCamera
  47757. */
  47758. getClassName(): string;
  47759. }
  47760. }
  47761. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47762. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47763. import { Scene } from "babylonjs/scene";
  47764. import { Vector3 } from "babylonjs/Maths/math.vector";
  47765. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47766. /**
  47767. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47768. * @see https://doc.babylonjs.com/features/cameras
  47769. */
  47770. export class StereoscopicUniversalCamera extends UniversalCamera {
  47771. /**
  47772. * Creates a new StereoscopicUniversalCamera
  47773. * @param name defines camera name
  47774. * @param position defines initial position
  47775. * @param interaxialDistance defines distance between each color axis
  47776. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47777. * @param scene defines the hosting scene
  47778. */
  47779. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47780. /**
  47781. * Gets camera class name
  47782. * @returns StereoscopicUniversalCamera
  47783. */
  47784. getClassName(): string;
  47785. }
  47786. }
  47787. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47788. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47789. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47790. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47791. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47792. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47793. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  47794. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  47795. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  47796. }
  47797. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  47798. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47799. import { Scene } from "babylonjs/scene";
  47800. import { Vector3 } from "babylonjs/Maths/math.vector";
  47801. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47802. /**
  47803. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  47804. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47805. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47806. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47807. */
  47808. export class VirtualJoysticksCamera extends FreeCamera {
  47809. /**
  47810. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  47811. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47812. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47813. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47814. * @param name Define the name of the camera in the scene
  47815. * @param position Define the start position of the camera in the scene
  47816. * @param scene Define the scene the camera belongs to
  47817. */
  47818. constructor(name: string, position: Vector3, scene: Scene);
  47819. /**
  47820. * Gets the current object class name.
  47821. * @return the class name
  47822. */
  47823. getClassName(): string;
  47824. }
  47825. }
  47826. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  47827. import { Matrix } from "babylonjs/Maths/math.vector";
  47828. /**
  47829. * This represents all the required metrics to create a VR camera.
  47830. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  47831. */
  47832. export class VRCameraMetrics {
  47833. /**
  47834. * Define the horizontal resolution off the screen.
  47835. */
  47836. hResolution: number;
  47837. /**
  47838. * Define the vertical resolution off the screen.
  47839. */
  47840. vResolution: number;
  47841. /**
  47842. * Define the horizontal screen size.
  47843. */
  47844. hScreenSize: number;
  47845. /**
  47846. * Define the vertical screen size.
  47847. */
  47848. vScreenSize: number;
  47849. /**
  47850. * Define the vertical screen center position.
  47851. */
  47852. vScreenCenter: number;
  47853. /**
  47854. * Define the distance of the eyes to the screen.
  47855. */
  47856. eyeToScreenDistance: number;
  47857. /**
  47858. * Define the distance between both lenses
  47859. */
  47860. lensSeparationDistance: number;
  47861. /**
  47862. * Define the distance between both viewer's eyes.
  47863. */
  47864. interpupillaryDistance: number;
  47865. /**
  47866. * Define the distortion factor of the VR postprocess.
  47867. * Please, touch with care.
  47868. */
  47869. distortionK: number[];
  47870. /**
  47871. * Define the chromatic aberration correction factors for the VR post process.
  47872. */
  47873. chromaAbCorrection: number[];
  47874. /**
  47875. * Define the scale factor of the post process.
  47876. * The smaller the better but the slower.
  47877. */
  47878. postProcessScaleFactor: number;
  47879. /**
  47880. * Define an offset for the lens center.
  47881. */
  47882. lensCenterOffset: number;
  47883. /**
  47884. * Define if the current vr camera should compensate the distortion of the lense or not.
  47885. */
  47886. compensateDistortion: boolean;
  47887. /**
  47888. * Defines if multiview should be enabled when rendering (Default: false)
  47889. */
  47890. multiviewEnabled: boolean;
  47891. /**
  47892. * Gets the rendering aspect ratio based on the provided resolutions.
  47893. */
  47894. get aspectRatio(): number;
  47895. /**
  47896. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  47897. */
  47898. get aspectRatioFov(): number;
  47899. /**
  47900. * @hidden
  47901. */
  47902. get leftHMatrix(): Matrix;
  47903. /**
  47904. * @hidden
  47905. */
  47906. get rightHMatrix(): Matrix;
  47907. /**
  47908. * @hidden
  47909. */
  47910. get leftPreViewMatrix(): Matrix;
  47911. /**
  47912. * @hidden
  47913. */
  47914. get rightPreViewMatrix(): Matrix;
  47915. /**
  47916. * Get the default VRMetrics based on the most generic setup.
  47917. * @returns the default vr metrics
  47918. */
  47919. static GetDefault(): VRCameraMetrics;
  47920. }
  47921. }
  47922. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  47923. /** @hidden */
  47924. export var vrDistortionCorrectionPixelShader: {
  47925. name: string;
  47926. shader: string;
  47927. };
  47928. }
  47929. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  47930. import { Camera } from "babylonjs/Cameras/camera";
  47931. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47932. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  47933. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  47934. /**
  47935. * VRDistortionCorrectionPostProcess used for mobile VR
  47936. */
  47937. export class VRDistortionCorrectionPostProcess extends PostProcess {
  47938. private _isRightEye;
  47939. private _distortionFactors;
  47940. private _postProcessScaleFactor;
  47941. private _lensCenterOffset;
  47942. private _scaleIn;
  47943. private _scaleFactor;
  47944. private _lensCenter;
  47945. /**
  47946. * Initializes the VRDistortionCorrectionPostProcess
  47947. * @param name The name of the effect.
  47948. * @param camera The camera to apply the render pass to.
  47949. * @param isRightEye If this is for the right eye distortion
  47950. * @param vrMetrics All the required metrics for the VR camera
  47951. */
  47952. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  47953. }
  47954. }
  47955. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  47956. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  47957. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47958. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47959. import { Scene } from "babylonjs/scene";
  47960. import { Vector3 } from "babylonjs/Maths/math.vector";
  47961. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  47962. import "babylonjs/Cameras/RigModes/vrRigMode";
  47963. /**
  47964. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  47965. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47966. */
  47967. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  47968. /**
  47969. * Creates a new VRDeviceOrientationArcRotateCamera
  47970. * @param name defines camera name
  47971. * @param alpha defines the camera rotation along the logitudinal axis
  47972. * @param beta defines the camera rotation along the latitudinal axis
  47973. * @param radius defines the camera distance from its target
  47974. * @param target defines the camera target
  47975. * @param scene defines the scene the camera belongs to
  47976. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47977. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47978. */
  47979. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47980. /**
  47981. * Gets camera class name
  47982. * @returns VRDeviceOrientationArcRotateCamera
  47983. */
  47984. getClassName(): string;
  47985. }
  47986. }
  47987. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  47988. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  47989. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47990. import { Scene } from "babylonjs/scene";
  47991. import { Vector3 } from "babylonjs/Maths/math.vector";
  47992. import "babylonjs/Cameras/RigModes/vrRigMode";
  47993. /**
  47994. * Camera used to simulate VR rendering (based on FreeCamera)
  47995. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47996. */
  47997. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  47998. /**
  47999. * Creates a new VRDeviceOrientationFreeCamera
  48000. * @param name defines camera name
  48001. * @param position defines the start position of the camera
  48002. * @param scene defines the scene the camera belongs to
  48003. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48004. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48005. */
  48006. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48007. /**
  48008. * Gets camera class name
  48009. * @returns VRDeviceOrientationFreeCamera
  48010. */
  48011. getClassName(): string;
  48012. }
  48013. }
  48014. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48015. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48016. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48017. import { Scene } from "babylonjs/scene";
  48018. import { Vector3 } from "babylonjs/Maths/math.vector";
  48019. import "babylonjs/Gamepads/gamepadSceneComponent";
  48020. /**
  48021. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48022. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48023. */
  48024. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48025. /**
  48026. * Creates a new VRDeviceOrientationGamepadCamera
  48027. * @param name defines camera name
  48028. * @param position defines the start position of the camera
  48029. * @param scene defines the scene the camera belongs to
  48030. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48031. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48032. */
  48033. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48034. /**
  48035. * Gets camera class name
  48036. * @returns VRDeviceOrientationGamepadCamera
  48037. */
  48038. getClassName(): string;
  48039. }
  48040. }
  48041. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48042. import { Scene } from "babylonjs/scene";
  48043. import { Texture } from "babylonjs/Materials/Textures/texture";
  48044. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48045. /**
  48046. * A class extending Texture allowing drawing on a texture
  48047. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48048. */
  48049. export class DynamicTexture extends Texture {
  48050. private _generateMipMaps;
  48051. private _canvas;
  48052. private _context;
  48053. /**
  48054. * Creates a DynamicTexture
  48055. * @param name defines the name of the texture
  48056. * @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
  48057. * @param scene defines the scene where you want the texture
  48058. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48059. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48060. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48061. */
  48062. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48063. /**
  48064. * Get the current class name of the texture useful for serialization or dynamic coding.
  48065. * @returns "DynamicTexture"
  48066. */
  48067. getClassName(): string;
  48068. /**
  48069. * Gets the current state of canRescale
  48070. */
  48071. get canRescale(): boolean;
  48072. private _recreate;
  48073. /**
  48074. * Scales the texture
  48075. * @param ratio the scale factor to apply to both width and height
  48076. */
  48077. scale(ratio: number): void;
  48078. /**
  48079. * Resizes the texture
  48080. * @param width the new width
  48081. * @param height the new height
  48082. */
  48083. scaleTo(width: number, height: number): void;
  48084. /**
  48085. * Gets the context of the canvas used by the texture
  48086. * @returns the canvas context of the dynamic texture
  48087. */
  48088. getContext(): CanvasRenderingContext2D;
  48089. /**
  48090. * Clears the texture
  48091. */
  48092. clear(): void;
  48093. /**
  48094. * Updates the texture
  48095. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48096. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48097. */
  48098. update(invertY?: boolean, premulAlpha?: boolean): void;
  48099. /**
  48100. * Draws text onto the texture
  48101. * @param text defines the text to be drawn
  48102. * @param x defines the placement of the text from the left
  48103. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48104. * @param font defines the font to be used with font-style, font-size, font-name
  48105. * @param color defines the color used for the text
  48106. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48107. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48108. * @param update defines whether texture is immediately update (default is true)
  48109. */
  48110. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48111. /**
  48112. * Clones the texture
  48113. * @returns the clone of the texture.
  48114. */
  48115. clone(): DynamicTexture;
  48116. /**
  48117. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48118. * @returns a serialized dynamic texture object
  48119. */
  48120. serialize(): any;
  48121. private _IsCanvasElement;
  48122. /** @hidden */
  48123. _rebuild(): void;
  48124. }
  48125. }
  48126. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48127. import { Scene } from "babylonjs/scene";
  48128. import { Color3 } from "babylonjs/Maths/math.color";
  48129. import { Mesh } from "babylonjs/Meshes/mesh";
  48130. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48131. import { Nullable } from "babylonjs/types";
  48132. /**
  48133. * Class containing static functions to help procedurally build meshes
  48134. */
  48135. export class GroundBuilder {
  48136. /**
  48137. * Creates a ground mesh
  48138. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48139. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48140. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48141. * @param name defines the name of the mesh
  48142. * @param options defines the options used to create the mesh
  48143. * @param scene defines the hosting scene
  48144. * @returns the ground mesh
  48145. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48146. */
  48147. static CreateGround(name: string, options: {
  48148. width?: number;
  48149. height?: number;
  48150. subdivisions?: number;
  48151. subdivisionsX?: number;
  48152. subdivisionsY?: number;
  48153. updatable?: boolean;
  48154. }, scene: any): Mesh;
  48155. /**
  48156. * Creates a tiled ground mesh
  48157. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48158. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48159. * * 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
  48160. * * 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
  48161. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48162. * @param name defines the name of the mesh
  48163. * @param options defines the options used to create the mesh
  48164. * @param scene defines the hosting scene
  48165. * @returns the tiled ground mesh
  48166. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48167. */
  48168. static CreateTiledGround(name: string, options: {
  48169. xmin: number;
  48170. zmin: number;
  48171. xmax: number;
  48172. zmax: number;
  48173. subdivisions?: {
  48174. w: number;
  48175. h: number;
  48176. };
  48177. precision?: {
  48178. w: number;
  48179. h: number;
  48180. };
  48181. updatable?: boolean;
  48182. }, scene?: Nullable<Scene>): Mesh;
  48183. /**
  48184. * Creates a ground mesh from a height map
  48185. * * The parameter `url` sets the URL of the height map image resource.
  48186. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48187. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48188. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48189. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48190. * * 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.
  48191. * * 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).
  48192. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48193. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48194. * @param name defines the name of the mesh
  48195. * @param url defines the url to the height map
  48196. * @param options defines the options used to create the mesh
  48197. * @param scene defines the hosting scene
  48198. * @returns the ground mesh
  48199. * @see https://doc.babylonjs.com/babylon101/height_map
  48200. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48201. */
  48202. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48203. width?: number;
  48204. height?: number;
  48205. subdivisions?: number;
  48206. minHeight?: number;
  48207. maxHeight?: number;
  48208. colorFilter?: Color3;
  48209. alphaFilter?: number;
  48210. updatable?: boolean;
  48211. onReady?: (mesh: GroundMesh) => void;
  48212. }, scene?: Nullable<Scene>): GroundMesh;
  48213. }
  48214. }
  48215. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48216. import { Vector4 } from "babylonjs/Maths/math.vector";
  48217. import { Mesh } from "babylonjs/Meshes/mesh";
  48218. /**
  48219. * Class containing static functions to help procedurally build meshes
  48220. */
  48221. export class TorusBuilder {
  48222. /**
  48223. * Creates a torus mesh
  48224. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48225. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48226. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48227. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48228. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48229. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48230. * @param name defines the name of the mesh
  48231. * @param options defines the options used to create the mesh
  48232. * @param scene defines the hosting scene
  48233. * @returns the torus mesh
  48234. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48235. */
  48236. static CreateTorus(name: string, options: {
  48237. diameter?: number;
  48238. thickness?: number;
  48239. tessellation?: number;
  48240. updatable?: boolean;
  48241. sideOrientation?: number;
  48242. frontUVs?: Vector4;
  48243. backUVs?: Vector4;
  48244. }, scene: any): Mesh;
  48245. }
  48246. }
  48247. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48248. import { Vector4 } from "babylonjs/Maths/math.vector";
  48249. import { Color4 } from "babylonjs/Maths/math.color";
  48250. import { Mesh } from "babylonjs/Meshes/mesh";
  48251. /**
  48252. * Class containing static functions to help procedurally build meshes
  48253. */
  48254. export class CylinderBuilder {
  48255. /**
  48256. * Creates a cylinder or a cone mesh
  48257. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48258. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48259. * * 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.
  48260. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48261. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48262. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48263. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48264. * * 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).
  48265. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48266. * * 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).
  48267. * * 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
  48268. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48269. * * 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
  48270. * * 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.
  48271. * * If `enclose` is false, a ring surface is one element.
  48272. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48273. * * 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
  48274. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48275. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48276. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48277. * @param name defines the name of the mesh
  48278. * @param options defines the options used to create the mesh
  48279. * @param scene defines the hosting scene
  48280. * @returns the cylinder mesh
  48281. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48282. */
  48283. static CreateCylinder(name: string, options: {
  48284. height?: number;
  48285. diameterTop?: number;
  48286. diameterBottom?: number;
  48287. diameter?: number;
  48288. tessellation?: number;
  48289. subdivisions?: number;
  48290. arc?: number;
  48291. faceColors?: Color4[];
  48292. faceUV?: Vector4[];
  48293. updatable?: boolean;
  48294. hasRings?: boolean;
  48295. enclose?: boolean;
  48296. cap?: number;
  48297. sideOrientation?: number;
  48298. frontUVs?: Vector4;
  48299. backUVs?: Vector4;
  48300. }, scene: any): Mesh;
  48301. }
  48302. }
  48303. declare module "babylonjs/XR/webXRTypes" {
  48304. import { Nullable } from "babylonjs/types";
  48305. import { IDisposable } from "babylonjs/scene";
  48306. /**
  48307. * States of the webXR experience
  48308. */
  48309. export enum WebXRState {
  48310. /**
  48311. * Transitioning to being in XR mode
  48312. */
  48313. ENTERING_XR = 0,
  48314. /**
  48315. * Transitioning to non XR mode
  48316. */
  48317. EXITING_XR = 1,
  48318. /**
  48319. * In XR mode and presenting
  48320. */
  48321. IN_XR = 2,
  48322. /**
  48323. * Not entered XR mode
  48324. */
  48325. NOT_IN_XR = 3
  48326. }
  48327. /**
  48328. * Abstraction of the XR render target
  48329. */
  48330. export interface WebXRRenderTarget extends IDisposable {
  48331. /**
  48332. * xrpresent context of the canvas which can be used to display/mirror xr content
  48333. */
  48334. canvasContext: WebGLRenderingContext;
  48335. /**
  48336. * xr layer for the canvas
  48337. */
  48338. xrLayer: Nullable<XRWebGLLayer>;
  48339. /**
  48340. * Initializes the xr layer for the session
  48341. * @param xrSession xr session
  48342. * @returns a promise that will resolve once the XR Layer has been created
  48343. */
  48344. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48345. }
  48346. }
  48347. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48348. import { Nullable } from "babylonjs/types";
  48349. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48350. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48351. import { Observable } from "babylonjs/Misc/observable";
  48352. /**
  48353. * COnfiguration object for WebXR output canvas
  48354. */
  48355. export class WebXRManagedOutputCanvasOptions {
  48356. /**
  48357. * An optional canvas in case you wish to create it yourself and provide it here.
  48358. * If not provided, a new canvas will be created
  48359. */
  48360. canvasElement?: HTMLCanvasElement;
  48361. /**
  48362. * Options for this XR Layer output
  48363. */
  48364. canvasOptions?: XRWebGLLayerOptions;
  48365. /**
  48366. * CSS styling for a newly created canvas (if not provided)
  48367. */
  48368. newCanvasCssStyle?: string;
  48369. /**
  48370. * Get the default values of the configuration object
  48371. * @returns default values of this configuration object
  48372. */
  48373. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  48374. }
  48375. /**
  48376. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48377. */
  48378. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48379. private _options;
  48380. private _canvas;
  48381. private _engine;
  48382. private _originalCanvasSize;
  48383. /**
  48384. * Rendering context of the canvas which can be used to display/mirror xr content
  48385. */
  48386. canvasContext: WebGLRenderingContext;
  48387. /**
  48388. * xr layer for the canvas
  48389. */
  48390. xrLayer: Nullable<XRWebGLLayer>;
  48391. /**
  48392. * Obseervers registered here will be triggered when the xr layer was initialized
  48393. */
  48394. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48395. /**
  48396. * Initializes the canvas to be added/removed upon entering/exiting xr
  48397. * @param _xrSessionManager The XR Session manager
  48398. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48399. */
  48400. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48401. /**
  48402. * Disposes of the object
  48403. */
  48404. dispose(): void;
  48405. /**
  48406. * Initializes the xr layer for the session
  48407. * @param xrSession xr session
  48408. * @returns a promise that will resolve once the XR Layer has been created
  48409. */
  48410. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48411. private _addCanvas;
  48412. private _removeCanvas;
  48413. private _setCanvasSize;
  48414. private _setManagedOutputCanvas;
  48415. }
  48416. }
  48417. declare module "babylonjs/XR/webXRSessionManager" {
  48418. import { Observable } from "babylonjs/Misc/observable";
  48419. import { Nullable } from "babylonjs/types";
  48420. import { IDisposable, Scene } from "babylonjs/scene";
  48421. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48422. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48423. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48424. /**
  48425. * Manages an XRSession to work with Babylon's engine
  48426. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48427. */
  48428. export class WebXRSessionManager implements IDisposable {
  48429. /** The scene which the session should be created for */
  48430. scene: Scene;
  48431. private _referenceSpace;
  48432. private _rttProvider;
  48433. private _sessionEnded;
  48434. private _xrNavigator;
  48435. private baseLayer;
  48436. /**
  48437. * The base reference space from which the session started. good if you want to reset your
  48438. * reference space
  48439. */
  48440. baseReferenceSpace: XRReferenceSpace;
  48441. /**
  48442. * Current XR frame
  48443. */
  48444. currentFrame: Nullable<XRFrame>;
  48445. /** WebXR timestamp updated every frame */
  48446. currentTimestamp: number;
  48447. /**
  48448. * Used just in case of a failure to initialize an immersive session.
  48449. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48450. */
  48451. defaultHeightCompensation: number;
  48452. /**
  48453. * Fires every time a new xrFrame arrives which can be used to update the camera
  48454. */
  48455. onXRFrameObservable: Observable<XRFrame>;
  48456. /**
  48457. * Fires when the reference space changed
  48458. */
  48459. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48460. /**
  48461. * Fires when the xr session is ended either by the device or manually done
  48462. */
  48463. onXRSessionEnded: Observable<any>;
  48464. /**
  48465. * Fires when the xr session is ended either by the device or manually done
  48466. */
  48467. onXRSessionInit: Observable<XRSession>;
  48468. /**
  48469. * Underlying xr session
  48470. */
  48471. session: XRSession;
  48472. /**
  48473. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48474. * or get the offset the player is currently at.
  48475. */
  48476. viewerReferenceSpace: XRReferenceSpace;
  48477. /**
  48478. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48479. * @param scene The scene which the session should be created for
  48480. */
  48481. constructor(
  48482. /** The scene which the session should be created for */
  48483. scene: Scene);
  48484. /**
  48485. * The current reference space used in this session. This reference space can constantly change!
  48486. * It is mainly used to offset the camera's position.
  48487. */
  48488. get referenceSpace(): XRReferenceSpace;
  48489. /**
  48490. * Set a new reference space and triggers the observable
  48491. */
  48492. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48493. /**
  48494. * Disposes of the session manager
  48495. */
  48496. dispose(): void;
  48497. /**
  48498. * Stops the xrSession and restores the render loop
  48499. * @returns Promise which resolves after it exits XR
  48500. */
  48501. exitXRAsync(): Promise<void>;
  48502. /**
  48503. * Gets the correct render target texture to be rendered this frame for this eye
  48504. * @param eye the eye for which to get the render target
  48505. * @returns the render target for the specified eye
  48506. */
  48507. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48508. /**
  48509. * Creates a WebXRRenderTarget object for the XR session
  48510. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48511. * @param options optional options to provide when creating a new render target
  48512. * @returns a WebXR render target to which the session can render
  48513. */
  48514. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48515. /**
  48516. * Initializes the manager
  48517. * After initialization enterXR can be called to start an XR session
  48518. * @returns Promise which resolves after it is initialized
  48519. */
  48520. initializeAsync(): Promise<void>;
  48521. /**
  48522. * Initializes an xr session
  48523. * @param xrSessionMode mode to initialize
  48524. * @param xrSessionInit defines optional and required values to pass to the session builder
  48525. * @returns a promise which will resolve once the session has been initialized
  48526. */
  48527. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48528. /**
  48529. * Checks if a session would be supported for the creation options specified
  48530. * @param sessionMode session mode to check if supported eg. immersive-vr
  48531. * @returns A Promise that resolves to true if supported and false if not
  48532. */
  48533. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48534. /**
  48535. * Resets the reference space to the one started the session
  48536. */
  48537. resetReferenceSpace(): void;
  48538. /**
  48539. * Starts rendering to the xr layer
  48540. */
  48541. runXRRenderLoop(): void;
  48542. /**
  48543. * Sets the reference space on the xr session
  48544. * @param referenceSpaceType space to set
  48545. * @returns a promise that will resolve once the reference space has been set
  48546. */
  48547. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48548. /**
  48549. * Updates the render state of the session
  48550. * @param state state to set
  48551. * @returns a promise that resolves once the render state has been updated
  48552. */
  48553. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48554. /**
  48555. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48556. * @param sessionMode defines the session to test
  48557. * @returns a promise with boolean as final value
  48558. */
  48559. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48560. private _createRenderTargetTexture;
  48561. }
  48562. }
  48563. declare module "babylonjs/XR/webXRCamera" {
  48564. import { Scene } from "babylonjs/scene";
  48565. import { Camera } from "babylonjs/Cameras/camera";
  48566. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48567. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48568. /**
  48569. * WebXR Camera which holds the views for the xrSession
  48570. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48571. */
  48572. export class WebXRCamera extends FreeCamera {
  48573. private _xrSessionManager;
  48574. private _firstFrame;
  48575. private _referenceQuaternion;
  48576. private _referencedPosition;
  48577. private _xrInvPositionCache;
  48578. private _xrInvQuaternionCache;
  48579. /**
  48580. * Should position compensation execute on first frame.
  48581. * This is used when copying the position from a native (non XR) camera
  48582. */
  48583. compensateOnFirstFrame: boolean;
  48584. /**
  48585. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48586. * @param name the name of the camera
  48587. * @param scene the scene to add the camera to
  48588. * @param _xrSessionManager a constructed xr session manager
  48589. */
  48590. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48591. /**
  48592. * Return the user's height, unrelated to the current ground.
  48593. * This will be the y position of this camera, when ground level is 0.
  48594. */
  48595. get realWorldHeight(): number;
  48596. /** @hidden */
  48597. _updateForDualEyeDebugging(): void;
  48598. /**
  48599. * Sets this camera's transformation based on a non-vr camera
  48600. * @param otherCamera the non-vr camera to copy the transformation from
  48601. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48602. */
  48603. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48604. /**
  48605. * Gets the current instance class name ("WebXRCamera").
  48606. * @returns the class name
  48607. */
  48608. getClassName(): string;
  48609. private _rotate180;
  48610. private _updateFromXRSession;
  48611. private _updateNumberOfRigCameras;
  48612. private _updateReferenceSpace;
  48613. private _updateReferenceSpaceOffset;
  48614. }
  48615. }
  48616. declare module "babylonjs/XR/webXRFeaturesManager" {
  48617. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48618. import { IDisposable } from "babylonjs/scene";
  48619. /**
  48620. * Defining the interface required for a (webxr) feature
  48621. */
  48622. export interface IWebXRFeature extends IDisposable {
  48623. /**
  48624. * Is this feature attached
  48625. */
  48626. attached: boolean;
  48627. /**
  48628. * Should auto-attach be disabled?
  48629. */
  48630. disableAutoAttach: boolean;
  48631. /**
  48632. * Attach the feature to the session
  48633. * Will usually be called by the features manager
  48634. *
  48635. * @param force should attachment be forced (even when already attached)
  48636. * @returns true if successful.
  48637. */
  48638. attach(force?: boolean): boolean;
  48639. /**
  48640. * Detach the feature from the session
  48641. * Will usually be called by the features manager
  48642. *
  48643. * @returns true if successful.
  48644. */
  48645. detach(): boolean;
  48646. /**
  48647. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48648. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48649. *
  48650. * @returns whether or not the feature is compatible in this environment
  48651. */
  48652. isCompatible(): boolean;
  48653. /**
  48654. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48655. */
  48656. xrNativeFeatureName?: string;
  48657. }
  48658. /**
  48659. * A list of the currently available features without referencing them
  48660. */
  48661. export class WebXRFeatureName {
  48662. /**
  48663. * The name of the anchor system feature
  48664. */
  48665. static ANCHOR_SYSTEM: string;
  48666. /**
  48667. * The name of the background remover feature
  48668. */
  48669. static BACKGROUND_REMOVER: string;
  48670. /**
  48671. * The name of the hit test feature
  48672. */
  48673. static HIT_TEST: string;
  48674. /**
  48675. * physics impostors for xr controllers feature
  48676. */
  48677. static PHYSICS_CONTROLLERS: string;
  48678. /**
  48679. * The name of the plane detection feature
  48680. */
  48681. static PLANE_DETECTION: string;
  48682. /**
  48683. * The name of the pointer selection feature
  48684. */
  48685. static POINTER_SELECTION: string;
  48686. /**
  48687. * The name of the teleportation feature
  48688. */
  48689. static TELEPORTATION: string;
  48690. }
  48691. /**
  48692. * Defining the constructor of a feature. Used to register the modules.
  48693. */
  48694. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48695. /**
  48696. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48697. * It is mainly used in AR sessions.
  48698. *
  48699. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48700. */
  48701. export class WebXRFeaturesManager implements IDisposable {
  48702. private _xrSessionManager;
  48703. private static readonly _AvailableFeatures;
  48704. private _features;
  48705. /**
  48706. * constructs a new features manages.
  48707. *
  48708. * @param _xrSessionManager an instance of WebXRSessionManager
  48709. */
  48710. constructor(_xrSessionManager: WebXRSessionManager);
  48711. /**
  48712. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48713. * Mainly used internally.
  48714. *
  48715. * @param featureName the name of the feature to register
  48716. * @param constructorFunction the function used to construct the module
  48717. * @param version the (babylon) version of the module
  48718. * @param stable is that a stable version of this module
  48719. */
  48720. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48721. /**
  48722. * Returns a constructor of a specific feature.
  48723. *
  48724. * @param featureName the name of the feature to construct
  48725. * @param version the version of the feature to load
  48726. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48727. * @param options optional options provided to the module.
  48728. * @returns a function that, when called, will return a new instance of this feature
  48729. */
  48730. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48731. /**
  48732. * Can be used to return the list of features currently registered
  48733. *
  48734. * @returns an Array of available features
  48735. */
  48736. static GetAvailableFeatures(): string[];
  48737. /**
  48738. * Gets the versions available for a specific feature
  48739. * @param featureName the name of the feature
  48740. * @returns an array with the available versions
  48741. */
  48742. static GetAvailableVersions(featureName: string): string[];
  48743. /**
  48744. * Return the latest unstable version of this feature
  48745. * @param featureName the name of the feature to search
  48746. * @returns the version number. if not found will return -1
  48747. */
  48748. static GetLatestVersionOfFeature(featureName: string): number;
  48749. /**
  48750. * Return the latest stable version of this feature
  48751. * @param featureName the name of the feature to search
  48752. * @returns the version number. if not found will return -1
  48753. */
  48754. static GetStableVersionOfFeature(featureName: string): number;
  48755. /**
  48756. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48757. * Can be used during a session to start a feature
  48758. * @param featureName the name of feature to attach
  48759. */
  48760. attachFeature(featureName: string): void;
  48761. /**
  48762. * Can be used inside a session or when the session ends to detach a specific feature
  48763. * @param featureName the name of the feature to detach
  48764. */
  48765. detachFeature(featureName: string): void;
  48766. /**
  48767. * Used to disable an already-enabled feature
  48768. * The feature will be disposed and will be recreated once enabled.
  48769. * @param featureName the feature to disable
  48770. * @returns true if disable was successful
  48771. */
  48772. disableFeature(featureName: string | {
  48773. Name: string;
  48774. }): boolean;
  48775. /**
  48776. * dispose this features manager
  48777. */
  48778. dispose(): void;
  48779. /**
  48780. * 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.
  48781. * 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.
  48782. *
  48783. * @param featureName the name of the feature to load or the class of the feature
  48784. * @param version optional version to load. if not provided the latest version will be enabled
  48785. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  48786. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  48787. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  48788. * @returns a new constructed feature or throws an error if feature not found.
  48789. */
  48790. enableFeature(featureName: string | {
  48791. Name: string;
  48792. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  48793. /**
  48794. * get the implementation of an enabled feature.
  48795. * @param featureName the name of the feature to load
  48796. * @returns the feature class, if found
  48797. */
  48798. getEnabledFeature(featureName: string): IWebXRFeature;
  48799. /**
  48800. * Get the list of enabled features
  48801. * @returns an array of enabled features
  48802. */
  48803. getEnabledFeatures(): string[];
  48804. /**
  48805. * This function will exten the session creation configuration object with enabled features.
  48806. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  48807. * according to the defined "required" variable, provided during enableFeature call
  48808. * @param xrSessionInit the xr Session init object to extend
  48809. *
  48810. * @returns an extended XRSessionInit object
  48811. */
  48812. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  48813. }
  48814. }
  48815. declare module "babylonjs/XR/webXRExperienceHelper" {
  48816. import { Observable } from "babylonjs/Misc/observable";
  48817. import { IDisposable, Scene } from "babylonjs/scene";
  48818. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48819. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  48820. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48821. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  48822. /**
  48823. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  48824. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  48825. */
  48826. export class WebXRExperienceHelper implements IDisposable {
  48827. private scene;
  48828. private _nonVRCamera;
  48829. private _originalSceneAutoClear;
  48830. private _supported;
  48831. /**
  48832. * Camera used to render xr content
  48833. */
  48834. camera: WebXRCamera;
  48835. /** A features manager for this xr session */
  48836. featuresManager: WebXRFeaturesManager;
  48837. /**
  48838. * Observers registered here will be triggered after the camera's initial transformation is set
  48839. * This can be used to set a different ground level or an extra rotation.
  48840. *
  48841. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  48842. * to the position set after this observable is done executing.
  48843. */
  48844. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  48845. /**
  48846. * Fires when the state of the experience helper has changed
  48847. */
  48848. onStateChangedObservable: Observable<WebXRState>;
  48849. /** Session manager used to keep track of xr session */
  48850. sessionManager: WebXRSessionManager;
  48851. /**
  48852. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  48853. */
  48854. state: WebXRState;
  48855. /**
  48856. * Creates a WebXRExperienceHelper
  48857. * @param scene The scene the helper should be created in
  48858. */
  48859. private constructor();
  48860. /**
  48861. * Creates the experience helper
  48862. * @param scene the scene to attach the experience helper to
  48863. * @returns a promise for the experience helper
  48864. */
  48865. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  48866. /**
  48867. * Disposes of the experience helper
  48868. */
  48869. dispose(): void;
  48870. /**
  48871. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  48872. * @param sessionMode options for the XR session
  48873. * @param referenceSpaceType frame of reference of the XR session
  48874. * @param renderTarget the output canvas that will be used to enter XR mode
  48875. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  48876. * @returns promise that resolves after xr mode has entered
  48877. */
  48878. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  48879. /**
  48880. * Exits XR mode and returns the scene to its original state
  48881. * @returns promise that resolves after xr mode has exited
  48882. */
  48883. exitXRAsync(): Promise<void>;
  48884. private _nonXRToXRCamera;
  48885. private _setState;
  48886. }
  48887. }
  48888. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  48889. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  48890. import { Observable } from "babylonjs/Misc/observable";
  48891. import { IDisposable } from "babylonjs/scene";
  48892. /**
  48893. * X-Y values for axes in WebXR
  48894. */
  48895. export interface IWebXRMotionControllerAxesValue {
  48896. /**
  48897. * The value of the x axis
  48898. */
  48899. x: number;
  48900. /**
  48901. * The value of the y-axis
  48902. */
  48903. y: number;
  48904. }
  48905. /**
  48906. * changed / previous values for the values of this component
  48907. */
  48908. export interface IWebXRMotionControllerComponentChangesValues<T> {
  48909. /**
  48910. * current (this frame) value
  48911. */
  48912. current: T;
  48913. /**
  48914. * previous (last change) value
  48915. */
  48916. previous: T;
  48917. }
  48918. /**
  48919. * Represents changes in the component between current frame and last values recorded
  48920. */
  48921. export interface IWebXRMotionControllerComponentChanges {
  48922. /**
  48923. * will be populated with previous and current values if axes changed
  48924. */
  48925. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  48926. /**
  48927. * will be populated with previous and current values if pressed changed
  48928. */
  48929. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48930. /**
  48931. * will be populated with previous and current values if touched changed
  48932. */
  48933. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48934. /**
  48935. * will be populated with previous and current values if value changed
  48936. */
  48937. value?: IWebXRMotionControllerComponentChangesValues<number>;
  48938. }
  48939. /**
  48940. * This class represents a single component (for example button or thumbstick) of a motion controller
  48941. */
  48942. export class WebXRControllerComponent implements IDisposable {
  48943. /**
  48944. * the id of this component
  48945. */
  48946. id: string;
  48947. /**
  48948. * the type of the component
  48949. */
  48950. type: MotionControllerComponentType;
  48951. private _buttonIndex;
  48952. private _axesIndices;
  48953. private _axes;
  48954. private _changes;
  48955. private _currentValue;
  48956. private _hasChanges;
  48957. private _pressed;
  48958. private _touched;
  48959. /**
  48960. * button component type
  48961. */
  48962. static BUTTON_TYPE: MotionControllerComponentType;
  48963. /**
  48964. * squeeze component type
  48965. */
  48966. static SQUEEZE_TYPE: MotionControllerComponentType;
  48967. /**
  48968. * Thumbstick component type
  48969. */
  48970. static THUMBSTICK_TYPE: MotionControllerComponentType;
  48971. /**
  48972. * Touchpad component type
  48973. */
  48974. static TOUCHPAD_TYPE: MotionControllerComponentType;
  48975. /**
  48976. * trigger component type
  48977. */
  48978. static TRIGGER_TYPE: MotionControllerComponentType;
  48979. /**
  48980. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  48981. * the axes data changes
  48982. */
  48983. onAxisValueChangedObservable: Observable<{
  48984. x: number;
  48985. y: number;
  48986. }>;
  48987. /**
  48988. * Observers registered here will be triggered when the state of a button changes
  48989. * State change is either pressed / touched / value
  48990. */
  48991. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  48992. /**
  48993. * Creates a new component for a motion controller.
  48994. * It is created by the motion controller itself
  48995. *
  48996. * @param id the id of this component
  48997. * @param type the type of the component
  48998. * @param _buttonIndex index in the buttons array of the gamepad
  48999. * @param _axesIndices indices of the values in the axes array of the gamepad
  49000. */
  49001. constructor(
  49002. /**
  49003. * the id of this component
  49004. */
  49005. id: string,
  49006. /**
  49007. * the type of the component
  49008. */
  49009. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49010. /**
  49011. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49012. */
  49013. get axes(): IWebXRMotionControllerAxesValue;
  49014. /**
  49015. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49016. */
  49017. get changes(): IWebXRMotionControllerComponentChanges;
  49018. /**
  49019. * Return whether or not the component changed the last frame
  49020. */
  49021. get hasChanges(): boolean;
  49022. /**
  49023. * is the button currently pressed
  49024. */
  49025. get pressed(): boolean;
  49026. /**
  49027. * is the button currently touched
  49028. */
  49029. get touched(): boolean;
  49030. /**
  49031. * Get the current value of this component
  49032. */
  49033. get value(): number;
  49034. /**
  49035. * Dispose this component
  49036. */
  49037. dispose(): void;
  49038. /**
  49039. * Are there axes correlating to this component
  49040. * @return true is axes data is available
  49041. */
  49042. isAxes(): boolean;
  49043. /**
  49044. * Is this component a button (hence - pressable)
  49045. * @returns true if can be pressed
  49046. */
  49047. isButton(): boolean;
  49048. /**
  49049. * update this component using the gamepad object it is in. Called on every frame
  49050. * @param nativeController the native gamepad controller object
  49051. */
  49052. update(nativeController: IMinimalMotionControllerObject): void;
  49053. }
  49054. }
  49055. declare module "babylonjs/Loading/sceneLoader" {
  49056. import { Observable } from "babylonjs/Misc/observable";
  49057. import { Nullable } from "babylonjs/types";
  49058. import { Scene } from "babylonjs/scene";
  49059. import { Engine } from "babylonjs/Engines/engine";
  49060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49061. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49062. import { AssetContainer } from "babylonjs/assetContainer";
  49063. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49064. import { Skeleton } from "babylonjs/Bones/skeleton";
  49065. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49066. import { WebRequest } from "babylonjs/Misc/webRequest";
  49067. /**
  49068. * Interface used to represent data loading progression
  49069. */
  49070. export interface ISceneLoaderProgressEvent {
  49071. /**
  49072. * Defines if data length to load can be evaluated
  49073. */
  49074. readonly lengthComputable: boolean;
  49075. /**
  49076. * Defines the loaded data length
  49077. */
  49078. readonly loaded: number;
  49079. /**
  49080. * Defines the data length to load
  49081. */
  49082. readonly total: number;
  49083. }
  49084. /**
  49085. * Interface used by SceneLoader plugins to define supported file extensions
  49086. */
  49087. export interface ISceneLoaderPluginExtensions {
  49088. /**
  49089. * Defines the list of supported extensions
  49090. */
  49091. [extension: string]: {
  49092. isBinary: boolean;
  49093. };
  49094. }
  49095. /**
  49096. * Interface used by SceneLoader plugin factory
  49097. */
  49098. export interface ISceneLoaderPluginFactory {
  49099. /**
  49100. * Defines the name of the factory
  49101. */
  49102. name: string;
  49103. /**
  49104. * Function called to create a new plugin
  49105. * @return the new plugin
  49106. */
  49107. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49108. /**
  49109. * The callback that returns true if the data can be directly loaded.
  49110. * @param data string containing the file data
  49111. * @returns if the data can be loaded directly
  49112. */
  49113. canDirectLoad?(data: string): boolean;
  49114. }
  49115. /**
  49116. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49117. */
  49118. export interface ISceneLoaderPluginBase {
  49119. /**
  49120. * The friendly name of this plugin.
  49121. */
  49122. name: string;
  49123. /**
  49124. * The file extensions supported by this plugin.
  49125. */
  49126. extensions: string | ISceneLoaderPluginExtensions;
  49127. /**
  49128. * The callback called when loading from a url.
  49129. * @param scene scene loading this url
  49130. * @param url url to load
  49131. * @param onSuccess callback called when the file successfully loads
  49132. * @param onProgress callback called while file is loading (if the server supports this mode)
  49133. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49134. * @param onError callback called when the file fails to load
  49135. * @returns a file request object
  49136. */
  49137. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49138. /**
  49139. * The callback called when loading from a file object.
  49140. * @param scene scene loading this file
  49141. * @param file defines the file to load
  49142. * @param onSuccess defines the callback to call when data is loaded
  49143. * @param onProgress defines the callback to call during loading process
  49144. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49145. * @param onError defines the callback to call when an error occurs
  49146. * @returns a file request object
  49147. */
  49148. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49149. /**
  49150. * The callback that returns true if the data can be directly loaded.
  49151. * @param data string containing the file data
  49152. * @returns if the data can be loaded directly
  49153. */
  49154. canDirectLoad?(data: string): boolean;
  49155. /**
  49156. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49157. * @param scene scene loading this data
  49158. * @param data string containing the data
  49159. * @returns data to pass to the plugin
  49160. */
  49161. directLoad?(scene: Scene, data: string): any;
  49162. /**
  49163. * The callback that allows custom handling of the root url based on the response url.
  49164. * @param rootUrl the original root url
  49165. * @param responseURL the response url if available
  49166. * @returns the new root url
  49167. */
  49168. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49169. }
  49170. /**
  49171. * Interface used to define a SceneLoader plugin
  49172. */
  49173. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49174. /**
  49175. * Import meshes into a scene.
  49176. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49177. * @param scene The scene to import into
  49178. * @param data The data to import
  49179. * @param rootUrl The root url for scene and resources
  49180. * @param meshes The meshes array to import into
  49181. * @param particleSystems The particle systems array to import into
  49182. * @param skeletons The skeletons array to import into
  49183. * @param onError The callback when import fails
  49184. * @returns True if successful or false otherwise
  49185. */
  49186. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49187. /**
  49188. * Load into a scene.
  49189. * @param scene The scene to load into
  49190. * @param data The data to import
  49191. * @param rootUrl The root url for scene and resources
  49192. * @param onError The callback when import fails
  49193. * @returns True if successful or false otherwise
  49194. */
  49195. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49196. /**
  49197. * Load into an asset container.
  49198. * @param scene The scene to load into
  49199. * @param data The data to import
  49200. * @param rootUrl The root url for scene and resources
  49201. * @param onError The callback when import fails
  49202. * @returns The loaded asset container
  49203. */
  49204. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49205. }
  49206. /**
  49207. * Interface used to define an async SceneLoader plugin
  49208. */
  49209. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49210. /**
  49211. * Import meshes into a scene.
  49212. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49213. * @param scene The scene to import into
  49214. * @param data The data to import
  49215. * @param rootUrl The root url for scene and resources
  49216. * @param onProgress The callback when the load progresses
  49217. * @param fileName Defines the name of the file to load
  49218. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49219. */
  49220. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49221. meshes: AbstractMesh[];
  49222. particleSystems: IParticleSystem[];
  49223. skeletons: Skeleton[];
  49224. animationGroups: AnimationGroup[];
  49225. }>;
  49226. /**
  49227. * Load into a scene.
  49228. * @param scene The scene to load into
  49229. * @param data The data to import
  49230. * @param rootUrl The root url for scene and resources
  49231. * @param onProgress The callback when the load progresses
  49232. * @param fileName Defines the name of the file to load
  49233. * @returns Nothing
  49234. */
  49235. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49236. /**
  49237. * Load into an asset container.
  49238. * @param scene The scene to load into
  49239. * @param data The data to import
  49240. * @param rootUrl The root url for scene and resources
  49241. * @param onProgress The callback when the load progresses
  49242. * @param fileName Defines the name of the file to load
  49243. * @returns The loaded asset container
  49244. */
  49245. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49246. }
  49247. /**
  49248. * Mode that determines how to handle old animation groups before loading new ones.
  49249. */
  49250. export enum SceneLoaderAnimationGroupLoadingMode {
  49251. /**
  49252. * Reset all old animations to initial state then dispose them.
  49253. */
  49254. Clean = 0,
  49255. /**
  49256. * Stop all old animations.
  49257. */
  49258. Stop = 1,
  49259. /**
  49260. * Restart old animations from first frame.
  49261. */
  49262. Sync = 2,
  49263. /**
  49264. * Old animations remains untouched.
  49265. */
  49266. NoSync = 3
  49267. }
  49268. /**
  49269. * Defines a plugin registered by the SceneLoader
  49270. */
  49271. interface IRegisteredPlugin {
  49272. /**
  49273. * Defines the plugin to use
  49274. */
  49275. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49276. /**
  49277. * Defines if the plugin supports binary data
  49278. */
  49279. isBinary: boolean;
  49280. }
  49281. /**
  49282. * Class used to load scene from various file formats using registered plugins
  49283. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49284. */
  49285. export class SceneLoader {
  49286. /**
  49287. * No logging while loading
  49288. */
  49289. static readonly NO_LOGGING: number;
  49290. /**
  49291. * Minimal logging while loading
  49292. */
  49293. static readonly MINIMAL_LOGGING: number;
  49294. /**
  49295. * Summary logging while loading
  49296. */
  49297. static readonly SUMMARY_LOGGING: number;
  49298. /**
  49299. * Detailled logging while loading
  49300. */
  49301. static readonly DETAILED_LOGGING: number;
  49302. /**
  49303. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49304. */
  49305. static get ForceFullSceneLoadingForIncremental(): boolean;
  49306. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49307. /**
  49308. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49309. */
  49310. static get ShowLoadingScreen(): boolean;
  49311. static set ShowLoadingScreen(value: boolean);
  49312. /**
  49313. * Defines the current logging level (while loading the scene)
  49314. * @ignorenaming
  49315. */
  49316. static get loggingLevel(): number;
  49317. static set loggingLevel(value: number);
  49318. /**
  49319. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49320. */
  49321. static get CleanBoneMatrixWeights(): boolean;
  49322. static set CleanBoneMatrixWeights(value: boolean);
  49323. /**
  49324. * Event raised when a plugin is used to load a scene
  49325. */
  49326. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49327. private static _registeredPlugins;
  49328. private static _showingLoadingScreen;
  49329. /**
  49330. * Gets the default plugin (used to load Babylon files)
  49331. * @returns the .babylon plugin
  49332. */
  49333. static GetDefaultPlugin(): IRegisteredPlugin;
  49334. private static _GetPluginForExtension;
  49335. private static _GetPluginForDirectLoad;
  49336. private static _GetPluginForFilename;
  49337. private static _GetDirectLoad;
  49338. private static _LoadData;
  49339. private static _GetFileInfo;
  49340. /**
  49341. * Gets a plugin that can load the given extension
  49342. * @param extension defines the extension to load
  49343. * @returns a plugin or null if none works
  49344. */
  49345. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49346. /**
  49347. * Gets a boolean indicating that the given extension can be loaded
  49348. * @param extension defines the extension to load
  49349. * @returns true if the extension is supported
  49350. */
  49351. static IsPluginForExtensionAvailable(extension: string): boolean;
  49352. /**
  49353. * Adds a new plugin to the list of registered plugins
  49354. * @param plugin defines the plugin to add
  49355. */
  49356. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49357. /**
  49358. * Import meshes into a scene
  49359. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49360. * @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)
  49361. * @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)
  49362. * @param scene the instance of BABYLON.Scene to append to
  49363. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49364. * @param onProgress a callback with a progress event for each file being loaded
  49365. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49366. * @param pluginExtension the extension used to determine the plugin
  49367. * @returns The loaded plugin
  49368. */
  49369. 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>;
  49370. /**
  49371. * Import meshes into a scene
  49372. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49373. * @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)
  49374. * @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)
  49375. * @param scene the instance of BABYLON.Scene to append to
  49376. * @param onProgress a callback with a progress event for each file being loaded
  49377. * @param pluginExtension the extension used to determine the plugin
  49378. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49379. */
  49380. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49381. meshes: AbstractMesh[];
  49382. particleSystems: IParticleSystem[];
  49383. skeletons: Skeleton[];
  49384. animationGroups: AnimationGroup[];
  49385. }>;
  49386. /**
  49387. * Load a scene
  49388. * @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)
  49389. * @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)
  49390. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49391. * @param onSuccess a callback with the scene when import succeeds
  49392. * @param onProgress a callback with a progress event for each file being loaded
  49393. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49394. * @param pluginExtension the extension used to determine the plugin
  49395. * @returns The loaded plugin
  49396. */
  49397. 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>;
  49398. /**
  49399. * Load a scene
  49400. * @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)
  49401. * @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)
  49402. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49403. * @param onProgress a callback with a progress event for each file being loaded
  49404. * @param pluginExtension the extension used to determine the plugin
  49405. * @returns The loaded scene
  49406. */
  49407. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49408. /**
  49409. * Append a scene
  49410. * @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)
  49411. * @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)
  49412. * @param scene is the instance of BABYLON.Scene to append to
  49413. * @param onSuccess a callback with the scene when import succeeds
  49414. * @param onProgress a callback with a progress event for each file being loaded
  49415. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49416. * @param pluginExtension the extension used to determine the plugin
  49417. * @returns The loaded plugin
  49418. */
  49419. 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>;
  49420. /**
  49421. * Append a scene
  49422. * @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)
  49423. * @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)
  49424. * @param scene is the instance of BABYLON.Scene to append to
  49425. * @param onProgress a callback with a progress event for each file being loaded
  49426. * @param pluginExtension the extension used to determine the plugin
  49427. * @returns The given scene
  49428. */
  49429. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49430. /**
  49431. * Load a scene into an asset container
  49432. * @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)
  49433. * @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)
  49434. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49435. * @param onSuccess a callback with the scene when import succeeds
  49436. * @param onProgress a callback with a progress event for each file being loaded
  49437. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49438. * @param pluginExtension the extension used to determine the plugin
  49439. * @returns The loaded plugin
  49440. */
  49441. 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>;
  49442. /**
  49443. * Load a scene into an asset container
  49444. * @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)
  49445. * @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)
  49446. * @param scene is the instance of Scene to append to
  49447. * @param onProgress a callback with a progress event for each file being loaded
  49448. * @param pluginExtension the extension used to determine the plugin
  49449. * @returns The loaded asset container
  49450. */
  49451. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49452. /**
  49453. * Import animations from a file into a scene
  49454. * @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)
  49455. * @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)
  49456. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49457. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49458. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49459. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49460. * @param onSuccess a callback with the scene when import succeeds
  49461. * @param onProgress a callback with a progress event for each file being loaded
  49462. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49463. * @param pluginExtension the extension used to determine the plugin
  49464. */
  49465. 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;
  49466. /**
  49467. * Import animations from a file into a scene
  49468. * @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)
  49469. * @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)
  49470. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49471. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49472. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49473. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49474. * @param onSuccess a callback with the scene when import succeeds
  49475. * @param onProgress a callback with a progress event for each file being loaded
  49476. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49477. * @param pluginExtension the extension used to determine the plugin
  49478. * @returns the updated scene with imported animations
  49479. */
  49480. 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>;
  49481. }
  49482. }
  49483. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49484. import { IDisposable, Scene } from "babylonjs/scene";
  49485. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49486. import { Observable } from "babylonjs/Misc/observable";
  49487. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49488. import { Nullable } from "babylonjs/types";
  49489. /**
  49490. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49491. */
  49492. export type MotionControllerHandedness = "none" | "left" | "right";
  49493. /**
  49494. * The type of components available in motion controllers.
  49495. * This is not the name of the component.
  49496. */
  49497. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49498. /**
  49499. * The state of a controller component
  49500. */
  49501. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49502. /**
  49503. * The schema of motion controller layout.
  49504. * No object will be initialized using this interface
  49505. * This is used just to define the profile.
  49506. */
  49507. export interface IMotionControllerLayout {
  49508. /**
  49509. * Path to load the assets. Usually relative to the base path
  49510. */
  49511. assetPath: string;
  49512. /**
  49513. * Available components (unsorted)
  49514. */
  49515. components: {
  49516. /**
  49517. * A map of component Ids
  49518. */
  49519. [componentId: string]: {
  49520. /**
  49521. * The type of input the component outputs
  49522. */
  49523. type: MotionControllerComponentType;
  49524. /**
  49525. * The indices of this component in the gamepad object
  49526. */
  49527. gamepadIndices: {
  49528. /**
  49529. * Index of button
  49530. */
  49531. button?: number;
  49532. /**
  49533. * If available, index of x-axis
  49534. */
  49535. xAxis?: number;
  49536. /**
  49537. * If available, index of y-axis
  49538. */
  49539. yAxis?: number;
  49540. };
  49541. /**
  49542. * The mesh's root node name
  49543. */
  49544. rootNodeName: string;
  49545. /**
  49546. * Animation definitions for this model
  49547. */
  49548. visualResponses: {
  49549. [stateKey: string]: {
  49550. /**
  49551. * What property will be animated
  49552. */
  49553. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49554. /**
  49555. * What states influence this visual response
  49556. */
  49557. states: MotionControllerComponentStateType[];
  49558. /**
  49559. * Type of animation - movement or visibility
  49560. */
  49561. valueNodeProperty: "transform" | "visibility";
  49562. /**
  49563. * Base node name to move. Its position will be calculated according to the min and max nodes
  49564. */
  49565. valueNodeName?: string;
  49566. /**
  49567. * Minimum movement node
  49568. */
  49569. minNodeName?: string;
  49570. /**
  49571. * Max movement node
  49572. */
  49573. maxNodeName?: string;
  49574. };
  49575. };
  49576. /**
  49577. * If touch enabled, what is the name of node to display user feedback
  49578. */
  49579. touchPointNodeName?: string;
  49580. };
  49581. };
  49582. /**
  49583. * Is it xr standard mapping or not
  49584. */
  49585. gamepadMapping: "" | "xr-standard";
  49586. /**
  49587. * Base root node of this entire model
  49588. */
  49589. rootNodeName: string;
  49590. /**
  49591. * Defines the main button component id
  49592. */
  49593. selectComponentId: string;
  49594. }
  49595. /**
  49596. * A definition for the layout map in the input profile
  49597. */
  49598. export interface IMotionControllerLayoutMap {
  49599. /**
  49600. * Layouts with handedness type as a key
  49601. */
  49602. [handedness: string]: IMotionControllerLayout;
  49603. }
  49604. /**
  49605. * The XR Input profile schema
  49606. * Profiles can be found here:
  49607. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49608. */
  49609. export interface IMotionControllerProfile {
  49610. /**
  49611. * fallback profiles for this profileId
  49612. */
  49613. fallbackProfileIds: string[];
  49614. /**
  49615. * The layout map, with handedness as key
  49616. */
  49617. layouts: IMotionControllerLayoutMap;
  49618. /**
  49619. * The id of this profile
  49620. * correlates to the profile(s) in the xrInput.profiles array
  49621. */
  49622. profileId: string;
  49623. }
  49624. /**
  49625. * A helper-interface for the 3 meshes needed for controller button animation
  49626. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49627. */
  49628. export interface IMotionControllerButtonMeshMap {
  49629. /**
  49630. * the mesh that defines the pressed value mesh position.
  49631. * This is used to find the max-position of this button
  49632. */
  49633. pressedMesh: AbstractMesh;
  49634. /**
  49635. * the mesh that defines the unpressed value mesh position.
  49636. * This is used to find the min (or initial) position of this button
  49637. */
  49638. unpressedMesh: AbstractMesh;
  49639. /**
  49640. * The mesh that will be changed when value changes
  49641. */
  49642. valueMesh: AbstractMesh;
  49643. }
  49644. /**
  49645. * A helper-interface for the 3 meshes needed for controller axis animation.
  49646. * This will be expanded when touchpad animations are fully supported
  49647. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49648. */
  49649. export interface IMotionControllerMeshMap {
  49650. /**
  49651. * the mesh that defines the maximum value mesh position.
  49652. */
  49653. maxMesh?: AbstractMesh;
  49654. /**
  49655. * the mesh that defines the minimum value mesh position.
  49656. */
  49657. minMesh?: AbstractMesh;
  49658. /**
  49659. * The mesh that will be changed when axis value changes
  49660. */
  49661. valueMesh: AbstractMesh;
  49662. }
  49663. /**
  49664. * The elements needed for change-detection of the gamepad objects in motion controllers
  49665. */
  49666. export interface IMinimalMotionControllerObject {
  49667. /**
  49668. * Available axes of this controller
  49669. */
  49670. axes: number[];
  49671. /**
  49672. * An array of available buttons
  49673. */
  49674. buttons: Array<{
  49675. /**
  49676. * Value of the button/trigger
  49677. */
  49678. value: number;
  49679. /**
  49680. * If the button/trigger is currently touched
  49681. */
  49682. touched: boolean;
  49683. /**
  49684. * If the button/trigger is currently pressed
  49685. */
  49686. pressed: boolean;
  49687. }>;
  49688. /**
  49689. * EXPERIMENTAL haptic support.
  49690. */
  49691. hapticActuators?: Array<{
  49692. pulse: (value: number, duration: number) => Promise<boolean>;
  49693. }>;
  49694. }
  49695. /**
  49696. * An Abstract Motion controller
  49697. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49698. * Each component has an observable to check for changes in value and state
  49699. */
  49700. export abstract class WebXRAbstractMotionController implements IDisposable {
  49701. protected scene: Scene;
  49702. protected layout: IMotionControllerLayout;
  49703. /**
  49704. * The gamepad object correlating to this controller
  49705. */
  49706. gamepadObject: IMinimalMotionControllerObject;
  49707. /**
  49708. * handedness (left/right/none) of this controller
  49709. */
  49710. handedness: MotionControllerHandedness;
  49711. private _initComponent;
  49712. private _modelReady;
  49713. /**
  49714. * A map of components (WebXRControllerComponent) in this motion controller
  49715. * Components have a ComponentType and can also have both button and axis definitions
  49716. */
  49717. readonly components: {
  49718. [id: string]: WebXRControllerComponent;
  49719. };
  49720. /**
  49721. * Disable the model's animation. Can be set at any time.
  49722. */
  49723. disableAnimation: boolean;
  49724. /**
  49725. * Observers registered here will be triggered when the model of this controller is done loading
  49726. */
  49727. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49728. /**
  49729. * The profile id of this motion controller
  49730. */
  49731. abstract profileId: string;
  49732. /**
  49733. * The root mesh of the model. It is null if the model was not yet initialized
  49734. */
  49735. rootMesh: Nullable<AbstractMesh>;
  49736. /**
  49737. * constructs a new abstract motion controller
  49738. * @param scene the scene to which the model of the controller will be added
  49739. * @param layout The profile layout to load
  49740. * @param gamepadObject The gamepad object correlating to this controller
  49741. * @param handedness handedness (left/right/none) of this controller
  49742. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49743. */
  49744. constructor(scene: Scene, layout: IMotionControllerLayout,
  49745. /**
  49746. * The gamepad object correlating to this controller
  49747. */
  49748. gamepadObject: IMinimalMotionControllerObject,
  49749. /**
  49750. * handedness (left/right/none) of this controller
  49751. */
  49752. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49753. /**
  49754. * Dispose this controller, the model mesh and all its components
  49755. */
  49756. dispose(): void;
  49757. /**
  49758. * Returns all components of specific type
  49759. * @param type the type to search for
  49760. * @return an array of components with this type
  49761. */
  49762. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49763. /**
  49764. * get a component based an its component id as defined in layout.components
  49765. * @param id the id of the component
  49766. * @returns the component correlates to the id or undefined if not found
  49767. */
  49768. getComponent(id: string): WebXRControllerComponent;
  49769. /**
  49770. * Get the list of components available in this motion controller
  49771. * @returns an array of strings correlating to available components
  49772. */
  49773. getComponentIds(): string[];
  49774. /**
  49775. * Get the first component of specific type
  49776. * @param type type of component to find
  49777. * @return a controller component or null if not found
  49778. */
  49779. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  49780. /**
  49781. * Get the main (Select) component of this controller as defined in the layout
  49782. * @returns the main component of this controller
  49783. */
  49784. getMainComponent(): WebXRControllerComponent;
  49785. /**
  49786. * Loads the model correlating to this controller
  49787. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  49788. * @returns A promise fulfilled with the result of the model loading
  49789. */
  49790. loadModel(): Promise<boolean>;
  49791. /**
  49792. * Update this model using the current XRFrame
  49793. * @param xrFrame the current xr frame to use and update the model
  49794. */
  49795. updateFromXRFrame(xrFrame: XRFrame): void;
  49796. /**
  49797. * Backwards compatibility due to a deeply-integrated typo
  49798. */
  49799. get handness(): XREye;
  49800. /**
  49801. * Pulse (vibrate) this controller
  49802. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  49803. * Consecutive calls to this function will cancel the last pulse call
  49804. *
  49805. * @param value the strength of the pulse in 0.0...1.0 range
  49806. * @param duration Duration of the pulse in milliseconds
  49807. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  49808. * @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
  49809. */
  49810. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  49811. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49812. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49813. /**
  49814. * Moves the axis on the controller mesh based on its current state
  49815. * @param axis the index of the axis
  49816. * @param axisValue the value of the axis which determines the meshes new position
  49817. * @hidden
  49818. */
  49819. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  49820. /**
  49821. * Update the model itself with the current frame data
  49822. * @param xrFrame the frame to use for updating the model mesh
  49823. */
  49824. protected updateModel(xrFrame: XRFrame): void;
  49825. /**
  49826. * Get the filename and path for this controller's model
  49827. * @returns a map of filename and path
  49828. */
  49829. protected abstract _getFilenameAndPath(): {
  49830. filename: string;
  49831. path: string;
  49832. };
  49833. /**
  49834. * This function is called before the mesh is loaded. It checks for loading constraints.
  49835. * For example, this function can check if the GLB loader is available
  49836. * If this function returns false, the generic controller will be loaded instead
  49837. * @returns Is the client ready to load the mesh
  49838. */
  49839. protected abstract _getModelLoadingConstraints(): boolean;
  49840. /**
  49841. * This function will be called after the model was successfully loaded and can be used
  49842. * for mesh transformations before it is available for the user
  49843. * @param meshes the loaded meshes
  49844. */
  49845. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  49846. /**
  49847. * Set the root mesh for this controller. Important for the WebXR controller class
  49848. * @param meshes the loaded meshes
  49849. */
  49850. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  49851. /**
  49852. * A function executed each frame that updates the mesh (if needed)
  49853. * @param xrFrame the current xrFrame
  49854. */
  49855. protected abstract _updateModel(xrFrame: XRFrame): void;
  49856. private _getGenericFilenameAndPath;
  49857. private _getGenericParentMesh;
  49858. }
  49859. }
  49860. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  49861. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49862. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49863. import { Scene } from "babylonjs/scene";
  49864. /**
  49865. * A generic trigger-only motion controller for WebXR
  49866. */
  49867. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  49868. /**
  49869. * Static version of the profile id of this controller
  49870. */
  49871. static ProfileId: string;
  49872. profileId: string;
  49873. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  49874. protected _getFilenameAndPath(): {
  49875. filename: string;
  49876. path: string;
  49877. };
  49878. protected _getModelLoadingConstraints(): boolean;
  49879. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  49880. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49881. protected _updateModel(): void;
  49882. }
  49883. }
  49884. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  49885. import { Vector4 } from "babylonjs/Maths/math.vector";
  49886. import { Mesh } from "babylonjs/Meshes/mesh";
  49887. import { Scene } from "babylonjs/scene";
  49888. import { Nullable } from "babylonjs/types";
  49889. /**
  49890. * Class containing static functions to help procedurally build meshes
  49891. */
  49892. export class SphereBuilder {
  49893. /**
  49894. * Creates a sphere mesh
  49895. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  49896. * * 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`)
  49897. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  49898. * * 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
  49899. * * 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)
  49900. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  49901. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  49902. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49903. * @param name defines the name of the mesh
  49904. * @param options defines the options used to create the mesh
  49905. * @param scene defines the hosting scene
  49906. * @returns the sphere mesh
  49907. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  49908. */
  49909. static CreateSphere(name: string, options: {
  49910. segments?: number;
  49911. diameter?: number;
  49912. diameterX?: number;
  49913. diameterY?: number;
  49914. diameterZ?: number;
  49915. arc?: number;
  49916. slice?: number;
  49917. sideOrientation?: number;
  49918. frontUVs?: Vector4;
  49919. backUVs?: Vector4;
  49920. updatable?: boolean;
  49921. }, scene?: Nullable<Scene>): Mesh;
  49922. }
  49923. }
  49924. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  49925. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49926. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49927. import { Scene } from "babylonjs/scene";
  49928. /**
  49929. * A profiled motion controller has its profile loaded from an online repository.
  49930. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  49931. */
  49932. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  49933. private _repositoryUrl;
  49934. private _buttonMeshMapping;
  49935. private _touchDots;
  49936. /**
  49937. * The profile ID of this controller. Will be populated when the controller initializes.
  49938. */
  49939. profileId: string;
  49940. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  49941. dispose(): void;
  49942. protected _getFilenameAndPath(): {
  49943. filename: string;
  49944. path: string;
  49945. };
  49946. protected _getModelLoadingConstraints(): boolean;
  49947. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  49948. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49949. protected _updateModel(_xrFrame: XRFrame): void;
  49950. }
  49951. }
  49952. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  49953. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49954. import { Scene } from "babylonjs/scene";
  49955. /**
  49956. * A construction function type to create a new controller based on an xrInput object
  49957. */
  49958. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  49959. /**
  49960. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  49961. *
  49962. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  49963. * it should be replaced with auto-loaded controllers.
  49964. *
  49965. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  49966. */
  49967. export class WebXRMotionControllerManager {
  49968. private static _AvailableControllers;
  49969. private static _Fallbacks;
  49970. private static _ProfileLoadingPromises;
  49971. private static _ProfilesList;
  49972. /**
  49973. * The base URL of the online controller repository. Can be changed at any time.
  49974. */
  49975. static BaseRepositoryUrl: string;
  49976. /**
  49977. * Which repository gets priority - local or online
  49978. */
  49979. static PrioritizeOnlineRepository: boolean;
  49980. /**
  49981. * Use the online repository, or use only locally-defined controllers
  49982. */
  49983. static UseOnlineRepository: boolean;
  49984. /**
  49985. * Clear the cache used for profile loading and reload when requested again
  49986. */
  49987. static ClearProfilesCache(): void;
  49988. /**
  49989. * Register the default fallbacks.
  49990. * This function is called automatically when this file is imported.
  49991. */
  49992. static DefaultFallbacks(): void;
  49993. /**
  49994. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  49995. * @param profileId the profile to which a fallback needs to be found
  49996. * @return an array with corresponding fallback profiles
  49997. */
  49998. static FindFallbackWithProfileId(profileId: string): string[];
  49999. /**
  50000. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50001. * The order of search:
  50002. *
  50003. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50004. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50005. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50006. * 4) return the generic trigger controller if none were found
  50007. *
  50008. * @param xrInput the xrInput to which a new controller is initialized
  50009. * @param scene the scene to which the model will be added
  50010. * @param forceProfile force a certain profile for this controller
  50011. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50012. */
  50013. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50014. /**
  50015. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50016. *
  50017. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50018. *
  50019. * @param type the profile type to register
  50020. * @param constructFunction the function to be called when loading this profile
  50021. */
  50022. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50023. /**
  50024. * Register a fallback to a specific profile.
  50025. * @param profileId the profileId that will receive the fallbacks
  50026. * @param fallbacks A list of fallback profiles
  50027. */
  50028. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50029. /**
  50030. * Will update the list of profiles available in the repository
  50031. * @return a promise that resolves to a map of profiles available online
  50032. */
  50033. static UpdateProfilesList(): Promise<{
  50034. [profile: string]: string;
  50035. }>;
  50036. private static _LoadProfileFromRepository;
  50037. private static _LoadProfilesFromAvailableControllers;
  50038. }
  50039. }
  50040. declare module "babylonjs/XR/webXRInputSource" {
  50041. import { Observable } from "babylonjs/Misc/observable";
  50042. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50043. import { Ray } from "babylonjs/Culling/ray";
  50044. import { Scene } from "babylonjs/scene";
  50045. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50046. /**
  50047. * Configuration options for the WebXR controller creation
  50048. */
  50049. export interface IWebXRControllerOptions {
  50050. /**
  50051. * Should the controller mesh be animated when a user interacts with it
  50052. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50053. */
  50054. disableMotionControllerAnimation?: boolean;
  50055. /**
  50056. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50057. */
  50058. doNotLoadControllerMesh?: boolean;
  50059. /**
  50060. * Force a specific controller type for this controller.
  50061. * This can be used when creating your own profile or when testing different controllers
  50062. */
  50063. forceControllerProfile?: string;
  50064. /**
  50065. * Defines a rendering group ID for meshes that will be loaded.
  50066. * This is for the default controllers only.
  50067. */
  50068. renderingGroupId?: number;
  50069. }
  50070. /**
  50071. * Represents an XR controller
  50072. */
  50073. export class WebXRInputSource {
  50074. private _scene;
  50075. /** The underlying input source for the controller */
  50076. inputSource: XRInputSource;
  50077. private _options;
  50078. private _tmpVector;
  50079. private _uniqueId;
  50080. /**
  50081. * 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
  50082. */
  50083. grip?: AbstractMesh;
  50084. /**
  50085. * If available, this is the gamepad object related to this controller.
  50086. * Using this object it is possible to get click events and trackpad changes of the
  50087. * webxr controller that is currently being used.
  50088. */
  50089. motionController?: WebXRAbstractMotionController;
  50090. /**
  50091. * Event that fires when the controller is removed/disposed.
  50092. * The object provided as event data is this controller, after associated assets were disposed.
  50093. * uniqueId is still available.
  50094. */
  50095. onDisposeObservable: Observable<WebXRInputSource>;
  50096. /**
  50097. * Will be triggered when the mesh associated with the motion controller is done loading.
  50098. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50099. * A shortened version of controller -> motion controller -> on mesh loaded.
  50100. */
  50101. onMeshLoadedObservable: Observable<AbstractMesh>;
  50102. /**
  50103. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50104. */
  50105. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50106. /**
  50107. * Pointer which can be used to select objects or attach a visible laser to
  50108. */
  50109. pointer: AbstractMesh;
  50110. /**
  50111. * Creates the input source object
  50112. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50113. * @param _scene the scene which the controller should be associated to
  50114. * @param inputSource the underlying input source for the controller
  50115. * @param _options options for this controller creation
  50116. */
  50117. constructor(_scene: Scene,
  50118. /** The underlying input source for the controller */
  50119. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50120. /**
  50121. * Get this controllers unique id
  50122. */
  50123. get uniqueId(): string;
  50124. /**
  50125. * Disposes of the object
  50126. */
  50127. dispose(): void;
  50128. /**
  50129. * Gets a world space ray coming from the pointer or grip
  50130. * @param result the resulting ray
  50131. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50132. */
  50133. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50134. /**
  50135. * Updates the controller pose based on the given XRFrame
  50136. * @param xrFrame xr frame to update the pose with
  50137. * @param referenceSpace reference space to use
  50138. */
  50139. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50140. }
  50141. }
  50142. declare module "babylonjs/XR/webXRInput" {
  50143. import { Observable } from "babylonjs/Misc/observable";
  50144. import { IDisposable } from "babylonjs/scene";
  50145. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50146. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50147. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50148. /**
  50149. * The schema for initialization options of the XR Input class
  50150. */
  50151. export interface IWebXRInputOptions {
  50152. /**
  50153. * If set to true no model will be automatically loaded
  50154. */
  50155. doNotLoadControllerMeshes?: boolean;
  50156. /**
  50157. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50158. * If not found, the xr input profile data will be used.
  50159. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50160. */
  50161. forceInputProfile?: string;
  50162. /**
  50163. * Do not send a request to the controller repository to load the profile.
  50164. *
  50165. * Instead, use the controllers available in babylon itself.
  50166. */
  50167. disableOnlineControllerRepository?: boolean;
  50168. /**
  50169. * A custom URL for the controllers repository
  50170. */
  50171. customControllersRepositoryURL?: string;
  50172. /**
  50173. * Should the controller model's components not move according to the user input
  50174. */
  50175. disableControllerAnimation?: boolean;
  50176. /**
  50177. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50178. */
  50179. controllerOptions?: IWebXRControllerOptions;
  50180. }
  50181. /**
  50182. * XR input used to track XR inputs such as controllers/rays
  50183. */
  50184. export class WebXRInput implements IDisposable {
  50185. /**
  50186. * the xr session manager for this session
  50187. */
  50188. xrSessionManager: WebXRSessionManager;
  50189. /**
  50190. * the WebXR camera for this session. Mainly used for teleportation
  50191. */
  50192. xrCamera: WebXRCamera;
  50193. private readonly options;
  50194. /**
  50195. * XR controllers being tracked
  50196. */
  50197. controllers: Array<WebXRInputSource>;
  50198. private _frameObserver;
  50199. private _sessionEndedObserver;
  50200. private _sessionInitObserver;
  50201. /**
  50202. * Event when a controller has been connected/added
  50203. */
  50204. onControllerAddedObservable: Observable<WebXRInputSource>;
  50205. /**
  50206. * Event when a controller has been removed/disconnected
  50207. */
  50208. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50209. /**
  50210. * Initializes the WebXRInput
  50211. * @param xrSessionManager the xr session manager for this session
  50212. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50213. * @param options = initialization options for this xr input
  50214. */
  50215. constructor(
  50216. /**
  50217. * the xr session manager for this session
  50218. */
  50219. xrSessionManager: WebXRSessionManager,
  50220. /**
  50221. * the WebXR camera for this session. Mainly used for teleportation
  50222. */
  50223. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50224. private _onInputSourcesChange;
  50225. private _addAndRemoveControllers;
  50226. /**
  50227. * Disposes of the object
  50228. */
  50229. dispose(): void;
  50230. }
  50231. }
  50232. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50233. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50234. import { Observable, EventState } from "babylonjs/Misc/observable";
  50235. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50236. /**
  50237. * This is the base class for all WebXR features.
  50238. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50239. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50240. */
  50241. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50242. protected _xrSessionManager: WebXRSessionManager;
  50243. private _attached;
  50244. private _removeOnDetach;
  50245. /**
  50246. * Should auto-attach be disabled?
  50247. */
  50248. disableAutoAttach: boolean;
  50249. /**
  50250. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50251. */
  50252. xrNativeFeatureName: string;
  50253. /**
  50254. * Construct a new (abstract) WebXR feature
  50255. * @param _xrSessionManager the xr session manager for this feature
  50256. */
  50257. constructor(_xrSessionManager: WebXRSessionManager);
  50258. /**
  50259. * Is this feature attached
  50260. */
  50261. get attached(): boolean;
  50262. /**
  50263. * attach this feature
  50264. *
  50265. * @param force should attachment be forced (even when already attached)
  50266. * @returns true if successful, false is failed or already attached
  50267. */
  50268. attach(force?: boolean): boolean;
  50269. /**
  50270. * detach this feature.
  50271. *
  50272. * @returns true if successful, false if failed or already detached
  50273. */
  50274. detach(): boolean;
  50275. /**
  50276. * Dispose this feature and all of the resources attached
  50277. */
  50278. dispose(): void;
  50279. /**
  50280. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50281. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50282. *
  50283. * @returns whether or not the feature is compatible in this environment
  50284. */
  50285. isCompatible(): boolean;
  50286. /**
  50287. * This is used to register callbacks that will automatically be removed when detach is called.
  50288. * @param observable the observable to which the observer will be attached
  50289. * @param callback the callback to register
  50290. */
  50291. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50292. /**
  50293. * Code in this function will be executed on each xrFrame received from the browser.
  50294. * This function will not execute after the feature is detached.
  50295. * @param _xrFrame the current frame
  50296. */
  50297. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50298. }
  50299. }
  50300. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50301. import { IDisposable, Scene } from "babylonjs/scene";
  50302. import { Nullable } from "babylonjs/types";
  50303. import { Observable } from "babylonjs/Misc/observable";
  50304. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50305. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50306. import { Camera } from "babylonjs/Cameras/camera";
  50307. /**
  50308. * Renders a layer on top of an existing scene
  50309. */
  50310. export class UtilityLayerRenderer implements IDisposable {
  50311. /** the original scene that will be rendered on top of */
  50312. originalScene: Scene;
  50313. private _pointerCaptures;
  50314. private _lastPointerEvents;
  50315. private static _DefaultUtilityLayer;
  50316. private static _DefaultKeepDepthUtilityLayer;
  50317. private _sharedGizmoLight;
  50318. private _renderCamera;
  50319. /**
  50320. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50321. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50322. * @returns the camera that is used when rendering the utility layer
  50323. */
  50324. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50325. /**
  50326. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50327. * @param cam the camera that should be used when rendering the utility layer
  50328. */
  50329. setRenderCamera(cam: Nullable<Camera>): void;
  50330. /**
  50331. * @hidden
  50332. * Light which used by gizmos to get light shading
  50333. */
  50334. _getSharedGizmoLight(): HemisphericLight;
  50335. /**
  50336. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50337. */
  50338. pickUtilitySceneFirst: boolean;
  50339. /**
  50340. * 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)
  50341. */
  50342. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50343. /**
  50344. * 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)
  50345. */
  50346. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50347. /**
  50348. * The scene that is rendered on top of the original scene
  50349. */
  50350. utilityLayerScene: Scene;
  50351. /**
  50352. * If the utility layer should automatically be rendered on top of existing scene
  50353. */
  50354. shouldRender: boolean;
  50355. /**
  50356. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50357. */
  50358. onlyCheckPointerDownEvents: boolean;
  50359. /**
  50360. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50361. */
  50362. processAllEvents: boolean;
  50363. /**
  50364. * Observable raised when the pointer move from the utility layer scene to the main scene
  50365. */
  50366. onPointerOutObservable: Observable<number>;
  50367. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50368. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50369. private _afterRenderObserver;
  50370. private _sceneDisposeObserver;
  50371. private _originalPointerObserver;
  50372. /**
  50373. * Instantiates a UtilityLayerRenderer
  50374. * @param originalScene the original scene that will be rendered on top of
  50375. * @param handleEvents boolean indicating if the utility layer should handle events
  50376. */
  50377. constructor(
  50378. /** the original scene that will be rendered on top of */
  50379. originalScene: Scene, handleEvents?: boolean);
  50380. private _notifyObservers;
  50381. /**
  50382. * Renders the utility layers scene on top of the original scene
  50383. */
  50384. render(): void;
  50385. /**
  50386. * Disposes of the renderer
  50387. */
  50388. dispose(): void;
  50389. private _updateCamera;
  50390. }
  50391. }
  50392. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50393. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50394. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50395. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50396. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50397. import { Scene } from "babylonjs/scene";
  50398. import { Nullable } from "babylonjs/types";
  50399. import { Color3 } from "babylonjs/Maths/math.color";
  50400. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50401. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50402. /**
  50403. * Options interface for the pointer selection module
  50404. */
  50405. export interface IWebXRControllerPointerSelectionOptions {
  50406. /**
  50407. * if provided, this scene will be used to render meshes.
  50408. */
  50409. customUtilityLayerScene?: Scene;
  50410. /**
  50411. * 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)
  50412. * If not disabled, the last picked point will be used to execute a pointer up event
  50413. * If disabled, pointer up event will be triggered right after the pointer down event.
  50414. * Used in screen and gaze target ray mode only
  50415. */
  50416. disablePointerUpOnTouchOut: boolean;
  50417. /**
  50418. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50419. */
  50420. forceGazeMode: boolean;
  50421. /**
  50422. * 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
  50423. * to start a new countdown to the pointer down event.
  50424. * Defaults to 1.
  50425. */
  50426. gazeModePointerMovedFactor?: number;
  50427. /**
  50428. * Different button type to use instead of the main component
  50429. */
  50430. overrideButtonId?: string;
  50431. /**
  50432. * use this rendering group id for the meshes (optional)
  50433. */
  50434. renderingGroupId?: number;
  50435. /**
  50436. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50437. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50438. * 3000 means 3 seconds between pointing at something and selecting it
  50439. */
  50440. timeToSelect?: number;
  50441. /**
  50442. * Should meshes created here be added to a utility layer or the main scene
  50443. */
  50444. useUtilityLayer?: boolean;
  50445. /**
  50446. * Optional WebXR camera to be used for gaze selection
  50447. */
  50448. gazeCamera?: WebXRCamera;
  50449. /**
  50450. * the xr input to use with this pointer selection
  50451. */
  50452. xrInput: WebXRInput;
  50453. }
  50454. /**
  50455. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50456. */
  50457. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50458. private readonly _options;
  50459. private static _idCounter;
  50460. private _attachController;
  50461. private _controllers;
  50462. private _scene;
  50463. private _tmpVectorForPickCompare;
  50464. /**
  50465. * The module's name
  50466. */
  50467. static readonly Name: string;
  50468. /**
  50469. * The (Babylon) version of this module.
  50470. * This is an integer representing the implementation version.
  50471. * This number does not correspond to the WebXR specs version
  50472. */
  50473. static readonly Version: number;
  50474. /**
  50475. * Disable lighting on the laser pointer (so it will always be visible)
  50476. */
  50477. disablePointerLighting: boolean;
  50478. /**
  50479. * Disable lighting on the selection mesh (so it will always be visible)
  50480. */
  50481. disableSelectionMeshLighting: boolean;
  50482. /**
  50483. * Should the laser pointer be displayed
  50484. */
  50485. displayLaserPointer: boolean;
  50486. /**
  50487. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50488. */
  50489. displaySelectionMesh: boolean;
  50490. /**
  50491. * This color will be set to the laser pointer when selection is triggered
  50492. */
  50493. laserPointerPickedColor: Color3;
  50494. /**
  50495. * Default color of the laser pointer
  50496. */
  50497. laserPointerDefaultColor: Color3;
  50498. /**
  50499. * default color of the selection ring
  50500. */
  50501. selectionMeshDefaultColor: Color3;
  50502. /**
  50503. * This color will be applied to the selection ring when selection is triggered
  50504. */
  50505. selectionMeshPickedColor: Color3;
  50506. /**
  50507. * Optional filter to be used for ray selection. This predicate shares behavior with
  50508. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50509. */
  50510. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50511. /**
  50512. * constructs a new background remover module
  50513. * @param _xrSessionManager the session manager for this module
  50514. * @param _options read-only options to be used in this module
  50515. */
  50516. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50517. /**
  50518. * attach this feature
  50519. * Will usually be called by the features manager
  50520. *
  50521. * @returns true if successful.
  50522. */
  50523. attach(): boolean;
  50524. /**
  50525. * detach this feature.
  50526. * Will usually be called by the features manager
  50527. *
  50528. * @returns true if successful.
  50529. */
  50530. detach(): boolean;
  50531. /**
  50532. * Will get the mesh under a specific pointer.
  50533. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50534. * @param controllerId the controllerId to check
  50535. * @returns The mesh under pointer or null if no mesh is under the pointer
  50536. */
  50537. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50538. /**
  50539. * Get the xr controller that correlates to the pointer id in the pointer event
  50540. *
  50541. * @param id the pointer id to search for
  50542. * @returns the controller that correlates to this id or null if not found
  50543. */
  50544. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50545. protected _onXRFrame(_xrFrame: XRFrame): void;
  50546. private _attachGazeMode;
  50547. private _attachScreenRayMode;
  50548. private _attachTrackedPointerRayMode;
  50549. private _convertNormalToDirectionOfRay;
  50550. private _detachController;
  50551. private _generateNewMeshPair;
  50552. private _pickingMoved;
  50553. private _updatePointerDistance;
  50554. /** @hidden */
  50555. get lasterPointerDefaultColor(): Color3;
  50556. }
  50557. }
  50558. declare module "babylonjs/XR/webXREnterExitUI" {
  50559. import { Nullable } from "babylonjs/types";
  50560. import { Observable } from "babylonjs/Misc/observable";
  50561. import { IDisposable, Scene } from "babylonjs/scene";
  50562. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50563. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50564. /**
  50565. * Button which can be used to enter a different mode of XR
  50566. */
  50567. export class WebXREnterExitUIButton {
  50568. /** button element */
  50569. element: HTMLElement;
  50570. /** XR initialization options for the button */
  50571. sessionMode: XRSessionMode;
  50572. /** Reference space type */
  50573. referenceSpaceType: XRReferenceSpaceType;
  50574. /**
  50575. * Creates a WebXREnterExitUIButton
  50576. * @param element button element
  50577. * @param sessionMode XR initialization session mode
  50578. * @param referenceSpaceType the type of reference space to be used
  50579. */
  50580. constructor(
  50581. /** button element */
  50582. element: HTMLElement,
  50583. /** XR initialization options for the button */
  50584. sessionMode: XRSessionMode,
  50585. /** Reference space type */
  50586. referenceSpaceType: XRReferenceSpaceType);
  50587. /**
  50588. * Extendable function which can be used to update the button's visuals when the state changes
  50589. * @param activeButton the current active button in the UI
  50590. */
  50591. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50592. }
  50593. /**
  50594. * Options to create the webXR UI
  50595. */
  50596. export class WebXREnterExitUIOptions {
  50597. /**
  50598. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50599. */
  50600. customButtons?: Array<WebXREnterExitUIButton>;
  50601. /**
  50602. * A reference space type to use when creating the default button.
  50603. * Default is local-floor
  50604. */
  50605. referenceSpaceType?: XRReferenceSpaceType;
  50606. /**
  50607. * Context to enter xr with
  50608. */
  50609. renderTarget?: Nullable<WebXRRenderTarget>;
  50610. /**
  50611. * A session mode to use when creating the default button.
  50612. * Default is immersive-vr
  50613. */
  50614. sessionMode?: XRSessionMode;
  50615. /**
  50616. * A list of optional features to init the session with
  50617. */
  50618. optionalFeatures?: string[];
  50619. /**
  50620. * A list of optional features to init the session with
  50621. */
  50622. requiredFeatures?: string[];
  50623. }
  50624. /**
  50625. * UI to allow the user to enter/exit XR mode
  50626. */
  50627. export class WebXREnterExitUI implements IDisposable {
  50628. private scene;
  50629. /** version of the options passed to this UI */
  50630. options: WebXREnterExitUIOptions;
  50631. private _activeButton;
  50632. private _buttons;
  50633. private _overlay;
  50634. /**
  50635. * Fired every time the active button is changed.
  50636. *
  50637. * When xr is entered via a button that launches xr that button will be the callback parameter
  50638. *
  50639. * When exiting xr the callback parameter will be null)
  50640. */
  50641. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50642. /**
  50643. *
  50644. * @param scene babylon scene object to use
  50645. * @param options (read-only) version of the options passed to this UI
  50646. */
  50647. private constructor();
  50648. /**
  50649. * Creates UI to allow the user to enter/exit XR mode
  50650. * @param scene the scene to add the ui to
  50651. * @param helper the xr experience helper to enter/exit xr with
  50652. * @param options options to configure the UI
  50653. * @returns the created ui
  50654. */
  50655. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50656. /**
  50657. * Disposes of the XR UI component
  50658. */
  50659. dispose(): void;
  50660. private _updateButtons;
  50661. }
  50662. }
  50663. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50664. import { Vector3 } from "babylonjs/Maths/math.vector";
  50665. import { Color4 } from "babylonjs/Maths/math.color";
  50666. import { Nullable } from "babylonjs/types";
  50667. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50668. import { Scene } from "babylonjs/scene";
  50669. /**
  50670. * Class containing static functions to help procedurally build meshes
  50671. */
  50672. export class LinesBuilder {
  50673. /**
  50674. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50675. * * 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
  50676. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50677. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50678. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50679. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50680. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50681. * * 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
  50682. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50683. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50684. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50685. * @param name defines the name of the new line system
  50686. * @param options defines the options used to create the line system
  50687. * @param scene defines the hosting scene
  50688. * @returns a new line system mesh
  50689. */
  50690. static CreateLineSystem(name: string, options: {
  50691. lines: Vector3[][];
  50692. updatable?: boolean;
  50693. instance?: Nullable<LinesMesh>;
  50694. colors?: Nullable<Color4[][]>;
  50695. useVertexAlpha?: boolean;
  50696. }, scene: Nullable<Scene>): LinesMesh;
  50697. /**
  50698. * Creates a line mesh
  50699. * 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
  50700. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50701. * * The parameter `points` is an array successive Vector3
  50702. * * 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
  50703. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50704. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50705. * * When updating an instance, remember that only point positions can change, not the number of points
  50706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50707. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50708. * @param name defines the name of the new line system
  50709. * @param options defines the options used to create the line system
  50710. * @param scene defines the hosting scene
  50711. * @returns a new line mesh
  50712. */
  50713. static CreateLines(name: string, options: {
  50714. points: Vector3[];
  50715. updatable?: boolean;
  50716. instance?: Nullable<LinesMesh>;
  50717. colors?: Color4[];
  50718. useVertexAlpha?: boolean;
  50719. }, scene?: Nullable<Scene>): LinesMesh;
  50720. /**
  50721. * Creates a dashed line mesh
  50722. * * 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
  50723. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50724. * * The parameter `points` is an array successive Vector3
  50725. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50726. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50727. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50728. * * 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
  50729. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50730. * * When updating an instance, remember that only point positions can change, not the number of points
  50731. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50732. * @param name defines the name of the mesh
  50733. * @param options defines the options used to create the mesh
  50734. * @param scene defines the hosting scene
  50735. * @returns the dashed line mesh
  50736. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50737. */
  50738. static CreateDashedLines(name: string, options: {
  50739. points: Vector3[];
  50740. dashSize?: number;
  50741. gapSize?: number;
  50742. dashNb?: number;
  50743. updatable?: boolean;
  50744. instance?: LinesMesh;
  50745. useVertexAlpha?: boolean;
  50746. }, scene?: Nullable<Scene>): LinesMesh;
  50747. }
  50748. }
  50749. declare module "babylonjs/Misc/timer" {
  50750. import { Observable, Observer } from "babylonjs/Misc/observable";
  50751. import { Nullable } from "babylonjs/types";
  50752. import { IDisposable } from "babylonjs/scene";
  50753. /**
  50754. * Construction options for a timer
  50755. */
  50756. export interface ITimerOptions<T> {
  50757. /**
  50758. * Time-to-end
  50759. */
  50760. timeout: number;
  50761. /**
  50762. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50763. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50764. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50765. */
  50766. contextObservable: Observable<T>;
  50767. /**
  50768. * Optional parameters when adding an observer to the observable
  50769. */
  50770. observableParameters?: {
  50771. mask?: number;
  50772. insertFirst?: boolean;
  50773. scope?: any;
  50774. };
  50775. /**
  50776. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  50777. */
  50778. breakCondition?: (data?: ITimerData<T>) => boolean;
  50779. /**
  50780. * Will be triggered when the time condition has met
  50781. */
  50782. onEnded?: (data: ITimerData<any>) => void;
  50783. /**
  50784. * Will be triggered when the break condition has met (prematurely ended)
  50785. */
  50786. onAborted?: (data: ITimerData<any>) => void;
  50787. /**
  50788. * Optional function to execute on each tick (or count)
  50789. */
  50790. onTick?: (data: ITimerData<any>) => void;
  50791. }
  50792. /**
  50793. * An interface defining the data sent by the timer
  50794. */
  50795. export interface ITimerData<T> {
  50796. /**
  50797. * When did it start
  50798. */
  50799. startTime: number;
  50800. /**
  50801. * Time now
  50802. */
  50803. currentTime: number;
  50804. /**
  50805. * Time passed since started
  50806. */
  50807. deltaTime: number;
  50808. /**
  50809. * How much is completed, in [0.0...1.0].
  50810. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  50811. */
  50812. completeRate: number;
  50813. /**
  50814. * What the registered observable sent in the last count
  50815. */
  50816. payload: T;
  50817. }
  50818. /**
  50819. * The current state of the timer
  50820. */
  50821. export enum TimerState {
  50822. /**
  50823. * Timer initialized, not yet started
  50824. */
  50825. INIT = 0,
  50826. /**
  50827. * Timer started and counting
  50828. */
  50829. STARTED = 1,
  50830. /**
  50831. * Timer ended (whether aborted or time reached)
  50832. */
  50833. ENDED = 2
  50834. }
  50835. /**
  50836. * A simple version of the timer. Will take options and start the timer immediately after calling it
  50837. *
  50838. * @param options options with which to initialize this timer
  50839. */
  50840. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  50841. /**
  50842. * An advanced implementation of a timer class
  50843. */
  50844. export class AdvancedTimer<T = any> implements IDisposable {
  50845. /**
  50846. * Will notify each time the timer calculates the remaining time
  50847. */
  50848. onEachCountObservable: Observable<ITimerData<T>>;
  50849. /**
  50850. * Will trigger when the timer was aborted due to the break condition
  50851. */
  50852. onTimerAbortedObservable: Observable<ITimerData<T>>;
  50853. /**
  50854. * Will trigger when the timer ended successfully
  50855. */
  50856. onTimerEndedObservable: Observable<ITimerData<T>>;
  50857. /**
  50858. * Will trigger when the timer state has changed
  50859. */
  50860. onStateChangedObservable: Observable<TimerState>;
  50861. private _observer;
  50862. private _contextObservable;
  50863. private _observableParameters;
  50864. private _startTime;
  50865. private _timer;
  50866. private _state;
  50867. private _breakCondition;
  50868. private _timeToEnd;
  50869. private _breakOnNextTick;
  50870. /**
  50871. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  50872. * @param options construction options for this advanced timer
  50873. */
  50874. constructor(options: ITimerOptions<T>);
  50875. /**
  50876. * set a breaking condition for this timer. Default is to never break during count
  50877. * @param predicate the new break condition. Returns true to break, false otherwise
  50878. */
  50879. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  50880. /**
  50881. * Reset ALL associated observables in this advanced timer
  50882. */
  50883. clearObservables(): void;
  50884. /**
  50885. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  50886. *
  50887. * @param timeToEnd how much time to measure until timer ended
  50888. */
  50889. start(timeToEnd?: number): void;
  50890. /**
  50891. * Will force a stop on the next tick.
  50892. */
  50893. stop(): void;
  50894. /**
  50895. * Dispose this timer, clearing all resources
  50896. */
  50897. dispose(): void;
  50898. private _setState;
  50899. private _tick;
  50900. private _stop;
  50901. }
  50902. }
  50903. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  50904. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50905. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50906. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50907. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50908. import { Vector3 } from "babylonjs/Maths/math.vector";
  50909. import { Material } from "babylonjs/Materials/material";
  50910. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50911. import { Scene } from "babylonjs/scene";
  50912. /**
  50913. * The options container for the teleportation module
  50914. */
  50915. export interface IWebXRTeleportationOptions {
  50916. /**
  50917. * if provided, this scene will be used to render meshes.
  50918. */
  50919. customUtilityLayerScene?: Scene;
  50920. /**
  50921. * Values to configure the default target mesh
  50922. */
  50923. defaultTargetMeshOptions?: {
  50924. /**
  50925. * Fill color of the teleportation area
  50926. */
  50927. teleportationFillColor?: string;
  50928. /**
  50929. * Border color for the teleportation area
  50930. */
  50931. teleportationBorderColor?: string;
  50932. /**
  50933. * Disable the mesh's animation sequence
  50934. */
  50935. disableAnimation?: boolean;
  50936. /**
  50937. * Disable lighting on the material or the ring and arrow
  50938. */
  50939. disableLighting?: boolean;
  50940. /**
  50941. * Override the default material of the torus and arrow
  50942. */
  50943. torusArrowMaterial?: Material;
  50944. };
  50945. /**
  50946. * A list of meshes to use as floor meshes.
  50947. * Meshes can be added and removed after initializing the feature using the
  50948. * addFloorMesh and removeFloorMesh functions
  50949. * If empty, rotation will still work
  50950. */
  50951. floorMeshes?: AbstractMesh[];
  50952. /**
  50953. * use this rendering group id for the meshes (optional)
  50954. */
  50955. renderingGroupId?: number;
  50956. /**
  50957. * Should teleportation move only to snap points
  50958. */
  50959. snapPointsOnly?: boolean;
  50960. /**
  50961. * An array of points to which the teleportation will snap to.
  50962. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  50963. */
  50964. snapPositions?: Vector3[];
  50965. /**
  50966. * How close should the teleportation ray be in order to snap to position.
  50967. * Default to 0.8 units (meters)
  50968. */
  50969. snapToPositionRadius?: number;
  50970. /**
  50971. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  50972. * If you want to support rotation, make sure your mesh has a direction indicator.
  50973. *
  50974. * When left untouched, the default mesh will be initialized.
  50975. */
  50976. teleportationTargetMesh?: AbstractMesh;
  50977. /**
  50978. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  50979. */
  50980. timeToTeleport?: number;
  50981. /**
  50982. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  50983. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  50984. */
  50985. useMainComponentOnly?: boolean;
  50986. /**
  50987. * Should meshes created here be added to a utility layer or the main scene
  50988. */
  50989. useUtilityLayer?: boolean;
  50990. /**
  50991. * Babylon XR Input class for controller
  50992. */
  50993. xrInput: WebXRInput;
  50994. }
  50995. /**
  50996. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  50997. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  50998. * the input of the attached controllers.
  50999. */
  51000. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51001. private _options;
  51002. private _controllers;
  51003. private _currentTeleportationControllerId;
  51004. private _floorMeshes;
  51005. private _quadraticBezierCurve;
  51006. private _selectionFeature;
  51007. private _snapToPositions;
  51008. private _snappedToPoint;
  51009. private _teleportationRingMaterial?;
  51010. private _tmpRay;
  51011. private _tmpVector;
  51012. /**
  51013. * The module's name
  51014. */
  51015. static readonly Name: string;
  51016. /**
  51017. * The (Babylon) version of this module.
  51018. * This is an integer representing the implementation version.
  51019. * This number does not correspond to the webxr specs version
  51020. */
  51021. static readonly Version: number;
  51022. /**
  51023. * Is movement backwards enabled
  51024. */
  51025. backwardsMovementEnabled: boolean;
  51026. /**
  51027. * Distance to travel when moving backwards
  51028. */
  51029. backwardsTeleportationDistance: number;
  51030. /**
  51031. * The distance from the user to the inspection point in the direction of the controller
  51032. * A higher number will allow the user to move further
  51033. * defaults to 5 (meters, in xr units)
  51034. */
  51035. parabolicCheckRadius: number;
  51036. /**
  51037. * Should the module support parabolic ray on top of direct ray
  51038. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51039. * Very helpful when moving between floors / different heights
  51040. */
  51041. parabolicRayEnabled: boolean;
  51042. /**
  51043. * How much rotation should be applied when rotating right and left
  51044. */
  51045. rotationAngle: number;
  51046. /**
  51047. * Is rotation enabled when moving forward?
  51048. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51049. */
  51050. rotationEnabled: boolean;
  51051. /**
  51052. * constructs a new anchor system
  51053. * @param _xrSessionManager an instance of WebXRSessionManager
  51054. * @param _options configuration object for this feature
  51055. */
  51056. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51057. /**
  51058. * Get the snapPointsOnly flag
  51059. */
  51060. get snapPointsOnly(): boolean;
  51061. /**
  51062. * Sets the snapPointsOnly flag
  51063. * @param snapToPoints should teleportation be exclusively to snap points
  51064. */
  51065. set snapPointsOnly(snapToPoints: boolean);
  51066. /**
  51067. * Add a new mesh to the floor meshes array
  51068. * @param mesh the mesh to use as floor mesh
  51069. */
  51070. addFloorMesh(mesh: AbstractMesh): void;
  51071. /**
  51072. * Add a new snap-to point to fix teleportation to this position
  51073. * @param newSnapPoint The new Snap-To point
  51074. */
  51075. addSnapPoint(newSnapPoint: Vector3): void;
  51076. attach(): boolean;
  51077. detach(): boolean;
  51078. dispose(): void;
  51079. /**
  51080. * Remove a mesh from the floor meshes array
  51081. * @param mesh the mesh to remove
  51082. */
  51083. removeFloorMesh(mesh: AbstractMesh): void;
  51084. /**
  51085. * Remove a mesh from the floor meshes array using its name
  51086. * @param name the mesh name to remove
  51087. */
  51088. removeFloorMeshByName(name: string): void;
  51089. /**
  51090. * 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
  51091. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51092. * @returns was the point found and removed or not
  51093. */
  51094. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51095. /**
  51096. * This function sets a selection feature that will be disabled when
  51097. * the forward ray is shown and will be reattached when hidden.
  51098. * This is used to remove the selection rays when moving.
  51099. * @param selectionFeature the feature to disable when forward movement is enabled
  51100. */
  51101. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51102. protected _onXRFrame(_xrFrame: XRFrame): void;
  51103. private _attachController;
  51104. private _createDefaultTargetMesh;
  51105. private _detachController;
  51106. private _findClosestSnapPointWithRadius;
  51107. private _setTargetMeshPosition;
  51108. private _setTargetMeshVisibility;
  51109. private _showParabolicPath;
  51110. private _teleportForward;
  51111. }
  51112. }
  51113. declare module "babylonjs/XR/webXRDefaultExperience" {
  51114. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51115. import { Scene } from "babylonjs/scene";
  51116. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51117. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51118. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51119. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51120. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51121. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51122. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51123. /**
  51124. * Options for the default xr helper
  51125. */
  51126. export class WebXRDefaultExperienceOptions {
  51127. /**
  51128. * Enable or disable default UI to enter XR
  51129. */
  51130. disableDefaultUI?: boolean;
  51131. /**
  51132. * Should teleportation not initialize. defaults to false.
  51133. */
  51134. disableTeleportation?: boolean;
  51135. /**
  51136. * Floor meshes that will be used for teleport
  51137. */
  51138. floorMeshes?: Array<AbstractMesh>;
  51139. /**
  51140. * If set to true, the first frame will not be used to reset position
  51141. * The first frame is mainly used when copying transformation from the old camera
  51142. * Mainly used in AR
  51143. */
  51144. ignoreNativeCameraTransformation?: boolean;
  51145. /**
  51146. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51147. */
  51148. inputOptions?: IWebXRInputOptions;
  51149. /**
  51150. * optional configuration for the output canvas
  51151. */
  51152. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51153. /**
  51154. * optional UI options. This can be used among other to change session mode and reference space type
  51155. */
  51156. uiOptions?: WebXREnterExitUIOptions;
  51157. /**
  51158. * When loading teleportation and pointer select, use stable versions instead of latest.
  51159. */
  51160. useStablePlugins?: boolean;
  51161. /**
  51162. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51163. */
  51164. renderingGroupId?: number;
  51165. /**
  51166. * A list of optional features to init the session with
  51167. * If set to true, all features we support will be added
  51168. */
  51169. optionalFeatures?: boolean | string[];
  51170. }
  51171. /**
  51172. * Default experience which provides a similar setup to the previous webVRExperience
  51173. */
  51174. export class WebXRDefaultExperience {
  51175. /**
  51176. * Base experience
  51177. */
  51178. baseExperience: WebXRExperienceHelper;
  51179. /**
  51180. * Enables ui for entering/exiting xr
  51181. */
  51182. enterExitUI: WebXREnterExitUI;
  51183. /**
  51184. * Input experience extension
  51185. */
  51186. input: WebXRInput;
  51187. /**
  51188. * Enables laser pointer and selection
  51189. */
  51190. pointerSelection: WebXRControllerPointerSelection;
  51191. /**
  51192. * Default target xr should render to
  51193. */
  51194. renderTarget: WebXRRenderTarget;
  51195. /**
  51196. * Enables teleportation
  51197. */
  51198. teleportation: WebXRMotionControllerTeleportation;
  51199. private constructor();
  51200. /**
  51201. * Creates the default xr experience
  51202. * @param scene scene
  51203. * @param options options for basic configuration
  51204. * @returns resulting WebXRDefaultExperience
  51205. */
  51206. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51207. /**
  51208. * DIsposes of the experience helper
  51209. */
  51210. dispose(): void;
  51211. }
  51212. }
  51213. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51214. import { Observable } from "babylonjs/Misc/observable";
  51215. import { Nullable } from "babylonjs/types";
  51216. import { Camera } from "babylonjs/Cameras/camera";
  51217. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51218. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51219. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51220. import { Scene } from "babylonjs/scene";
  51221. import { Vector3 } from "babylonjs/Maths/math.vector";
  51222. import { Color3 } from "babylonjs/Maths/math.color";
  51223. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51224. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51225. import { Mesh } from "babylonjs/Meshes/mesh";
  51226. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51227. import { EasingFunction } from "babylonjs/Animations/easing";
  51228. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51229. import "babylonjs/Meshes/Builders/groundBuilder";
  51230. import "babylonjs/Meshes/Builders/torusBuilder";
  51231. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51232. import "babylonjs/Gamepads/gamepadSceneComponent";
  51233. import "babylonjs/Animations/animatable";
  51234. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51235. /**
  51236. * Options to modify the vr teleportation behavior.
  51237. */
  51238. export interface VRTeleportationOptions {
  51239. /**
  51240. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51241. */
  51242. floorMeshName?: string;
  51243. /**
  51244. * A list of meshes to be used as the teleportation floor. (default: empty)
  51245. */
  51246. floorMeshes?: Mesh[];
  51247. /**
  51248. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51249. */
  51250. teleportationMode?: number;
  51251. /**
  51252. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51253. */
  51254. teleportationTime?: number;
  51255. /**
  51256. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51257. */
  51258. teleportationSpeed?: number;
  51259. /**
  51260. * The easing function used in the animation or null for Linear. (default CircleEase)
  51261. */
  51262. easingFunction?: EasingFunction;
  51263. }
  51264. /**
  51265. * Options to modify the vr experience helper's behavior.
  51266. */
  51267. export interface VRExperienceHelperOptions extends WebVROptions {
  51268. /**
  51269. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51270. */
  51271. createDeviceOrientationCamera?: boolean;
  51272. /**
  51273. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51274. */
  51275. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51276. /**
  51277. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51278. */
  51279. laserToggle?: boolean;
  51280. /**
  51281. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51282. */
  51283. floorMeshes?: Mesh[];
  51284. /**
  51285. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51286. */
  51287. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51288. /**
  51289. * Defines if WebXR should be used instead of WebVR (if available)
  51290. */
  51291. useXR?: boolean;
  51292. }
  51293. /**
  51294. * Event containing information after VR has been entered
  51295. */
  51296. export class OnAfterEnteringVRObservableEvent {
  51297. /**
  51298. * If entering vr was successful
  51299. */
  51300. success: boolean;
  51301. }
  51302. /**
  51303. * Helps to quickly add VR support to an existing scene.
  51304. * See https://doc.babylonjs.com/how_to/webvr_helper
  51305. */
  51306. export class VRExperienceHelper {
  51307. /** Options to modify the vr experience helper's behavior. */
  51308. webVROptions: VRExperienceHelperOptions;
  51309. private _scene;
  51310. private _position;
  51311. private _btnVR;
  51312. private _btnVRDisplayed;
  51313. private _webVRsupported;
  51314. private _webVRready;
  51315. private _webVRrequesting;
  51316. private _webVRpresenting;
  51317. private _hasEnteredVR;
  51318. private _fullscreenVRpresenting;
  51319. private _inputElement;
  51320. private _webVRCamera;
  51321. private _vrDeviceOrientationCamera;
  51322. private _deviceOrientationCamera;
  51323. private _existingCamera;
  51324. private _onKeyDown;
  51325. private _onVrDisplayPresentChange;
  51326. private _onVRDisplayChanged;
  51327. private _onVRRequestPresentStart;
  51328. private _onVRRequestPresentComplete;
  51329. /**
  51330. * 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)
  51331. */
  51332. enableGazeEvenWhenNoPointerLock: boolean;
  51333. /**
  51334. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51335. */
  51336. exitVROnDoubleTap: boolean;
  51337. /**
  51338. * Observable raised right before entering VR.
  51339. */
  51340. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51341. /**
  51342. * Observable raised when entering VR has completed.
  51343. */
  51344. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51345. /**
  51346. * Observable raised when exiting VR.
  51347. */
  51348. onExitingVRObservable: Observable<VRExperienceHelper>;
  51349. /**
  51350. * Observable raised when controller mesh is loaded.
  51351. */
  51352. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51353. /** Return this.onEnteringVRObservable
  51354. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51355. */
  51356. get onEnteringVR(): Observable<VRExperienceHelper>;
  51357. /** Return this.onExitingVRObservable
  51358. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51359. */
  51360. get onExitingVR(): Observable<VRExperienceHelper>;
  51361. /** Return this.onControllerMeshLoadedObservable
  51362. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51363. */
  51364. get onControllerMeshLoaded(): Observable<WebVRController>;
  51365. private _rayLength;
  51366. private _useCustomVRButton;
  51367. private _teleportationRequested;
  51368. private _teleportActive;
  51369. private _floorMeshName;
  51370. private _floorMeshesCollection;
  51371. private _teleportationMode;
  51372. private _teleportationTime;
  51373. private _teleportationSpeed;
  51374. private _teleportationEasing;
  51375. private _rotationAllowed;
  51376. private _teleportBackwardsVector;
  51377. private _teleportationTarget;
  51378. private _isDefaultTeleportationTarget;
  51379. private _postProcessMove;
  51380. private _teleportationFillColor;
  51381. private _teleportationBorderColor;
  51382. private _rotationAngle;
  51383. private _haloCenter;
  51384. private _cameraGazer;
  51385. private _padSensibilityUp;
  51386. private _padSensibilityDown;
  51387. private _leftController;
  51388. private _rightController;
  51389. private _gazeColor;
  51390. private _laserColor;
  51391. private _pickedLaserColor;
  51392. private _pickedGazeColor;
  51393. /**
  51394. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51395. */
  51396. onNewMeshSelected: Observable<AbstractMesh>;
  51397. /**
  51398. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51399. * This observable will provide the mesh and the controller used to select the mesh
  51400. */
  51401. onMeshSelectedWithController: Observable<{
  51402. mesh: AbstractMesh;
  51403. controller: WebVRController;
  51404. }>;
  51405. /**
  51406. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51407. */
  51408. onNewMeshPicked: Observable<PickingInfo>;
  51409. private _circleEase;
  51410. /**
  51411. * Observable raised before camera teleportation
  51412. */
  51413. onBeforeCameraTeleport: Observable<Vector3>;
  51414. /**
  51415. * Observable raised after camera teleportation
  51416. */
  51417. onAfterCameraTeleport: Observable<Vector3>;
  51418. /**
  51419. * Observable raised when current selected mesh gets unselected
  51420. */
  51421. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51422. private _raySelectionPredicate;
  51423. /**
  51424. * To be optionaly changed by user to define custom ray selection
  51425. */
  51426. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51427. /**
  51428. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51429. */
  51430. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51431. /**
  51432. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51433. */
  51434. teleportationEnabled: boolean;
  51435. private _defaultHeight;
  51436. private _teleportationInitialized;
  51437. private _interactionsEnabled;
  51438. private _interactionsRequested;
  51439. private _displayGaze;
  51440. private _displayLaserPointer;
  51441. /**
  51442. * The mesh used to display where the user is going to teleport.
  51443. */
  51444. get teleportationTarget(): Mesh;
  51445. /**
  51446. * Sets the mesh to be used to display where the user is going to teleport.
  51447. */
  51448. set teleportationTarget(value: Mesh);
  51449. /**
  51450. * 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
  51451. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51452. * See https://doc.babylonjs.com/resources/baking_transformations
  51453. */
  51454. get gazeTrackerMesh(): Mesh;
  51455. set gazeTrackerMesh(value: Mesh);
  51456. /**
  51457. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51458. */
  51459. updateGazeTrackerScale: boolean;
  51460. /**
  51461. * If the gaze trackers color should be updated when selecting meshes
  51462. */
  51463. updateGazeTrackerColor: boolean;
  51464. /**
  51465. * If the controller laser color should be updated when selecting meshes
  51466. */
  51467. updateControllerLaserColor: boolean;
  51468. /**
  51469. * The gaze tracking mesh corresponding to the left controller
  51470. */
  51471. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51472. /**
  51473. * The gaze tracking mesh corresponding to the right controller
  51474. */
  51475. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51476. /**
  51477. * If the ray of the gaze should be displayed.
  51478. */
  51479. get displayGaze(): boolean;
  51480. /**
  51481. * Sets if the ray of the gaze should be displayed.
  51482. */
  51483. set displayGaze(value: boolean);
  51484. /**
  51485. * If the ray of the LaserPointer should be displayed.
  51486. */
  51487. get displayLaserPointer(): boolean;
  51488. /**
  51489. * Sets if the ray of the LaserPointer should be displayed.
  51490. */
  51491. set displayLaserPointer(value: boolean);
  51492. /**
  51493. * The deviceOrientationCamera used as the camera when not in VR.
  51494. */
  51495. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51496. /**
  51497. * Based on the current WebVR support, returns the current VR camera used.
  51498. */
  51499. get currentVRCamera(): Nullable<Camera>;
  51500. /**
  51501. * The webVRCamera which is used when in VR.
  51502. */
  51503. get webVRCamera(): WebVRFreeCamera;
  51504. /**
  51505. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51506. */
  51507. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51508. /**
  51509. * The html button that is used to trigger entering into VR.
  51510. */
  51511. get vrButton(): Nullable<HTMLButtonElement>;
  51512. private get _teleportationRequestInitiated();
  51513. /**
  51514. * Defines whether or not Pointer lock should be requested when switching to
  51515. * full screen.
  51516. */
  51517. requestPointerLockOnFullScreen: boolean;
  51518. /**
  51519. * If asking to force XR, this will be populated with the default xr experience
  51520. */
  51521. xr: WebXRDefaultExperience;
  51522. /**
  51523. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51524. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51525. */
  51526. xrTestDone: boolean;
  51527. /**
  51528. * Instantiates a VRExperienceHelper.
  51529. * Helps to quickly add VR support to an existing scene.
  51530. * @param scene The scene the VRExperienceHelper belongs to.
  51531. * @param webVROptions Options to modify the vr experience helper's behavior.
  51532. */
  51533. constructor(scene: Scene,
  51534. /** Options to modify the vr experience helper's behavior. */
  51535. webVROptions?: VRExperienceHelperOptions);
  51536. private completeVRInit;
  51537. private _onDefaultMeshLoaded;
  51538. private _onResize;
  51539. private _onFullscreenChange;
  51540. /**
  51541. * Gets a value indicating if we are currently in VR mode.
  51542. */
  51543. get isInVRMode(): boolean;
  51544. private onVrDisplayPresentChange;
  51545. private onVRDisplayChanged;
  51546. private moveButtonToBottomRight;
  51547. private displayVRButton;
  51548. private updateButtonVisibility;
  51549. private _cachedAngularSensibility;
  51550. /**
  51551. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51552. * Otherwise, will use the fullscreen API.
  51553. */
  51554. enterVR(): void;
  51555. /**
  51556. * Attempt to exit VR, or fullscreen.
  51557. */
  51558. exitVR(): void;
  51559. /**
  51560. * The position of the vr experience helper.
  51561. */
  51562. get position(): Vector3;
  51563. /**
  51564. * Sets the position of the vr experience helper.
  51565. */
  51566. set position(value: Vector3);
  51567. /**
  51568. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51569. */
  51570. enableInteractions(): void;
  51571. private get _noControllerIsActive();
  51572. private beforeRender;
  51573. private _isTeleportationFloor;
  51574. /**
  51575. * Adds a floor mesh to be used for teleportation.
  51576. * @param floorMesh the mesh to be used for teleportation.
  51577. */
  51578. addFloorMesh(floorMesh: Mesh): void;
  51579. /**
  51580. * Removes a floor mesh from being used for teleportation.
  51581. * @param floorMesh the mesh to be removed.
  51582. */
  51583. removeFloorMesh(floorMesh: Mesh): void;
  51584. /**
  51585. * Enables interactions and teleportation using the VR controllers and gaze.
  51586. * @param vrTeleportationOptions options to modify teleportation behavior.
  51587. */
  51588. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51589. private _onNewGamepadConnected;
  51590. private _tryEnableInteractionOnController;
  51591. private _onNewGamepadDisconnected;
  51592. private _enableInteractionOnController;
  51593. private _checkTeleportWithRay;
  51594. private _checkRotate;
  51595. private _checkTeleportBackwards;
  51596. private _enableTeleportationOnController;
  51597. private _createTeleportationCircles;
  51598. private _displayTeleportationTarget;
  51599. private _hideTeleportationTarget;
  51600. private _rotateCamera;
  51601. private _moveTeleportationSelectorTo;
  51602. private _workingVector;
  51603. private _workingQuaternion;
  51604. private _workingMatrix;
  51605. /**
  51606. * Time Constant Teleportation Mode
  51607. */
  51608. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51609. /**
  51610. * Speed Constant Teleportation Mode
  51611. */
  51612. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51613. /**
  51614. * Teleports the users feet to the desired location
  51615. * @param location The location where the user's feet should be placed
  51616. */
  51617. teleportCamera(location: Vector3): void;
  51618. private _convertNormalToDirectionOfRay;
  51619. private _castRayAndSelectObject;
  51620. private _notifySelectedMeshUnselected;
  51621. /**
  51622. * Permanently set new colors for the laser pointer
  51623. * @param color the new laser color
  51624. * @param pickedColor the new laser color when picked mesh detected
  51625. */
  51626. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51627. /**
  51628. * Set lighting enabled / disabled on the laser pointer of both controllers
  51629. * @param enabled should the lighting be enabled on the laser pointer
  51630. */
  51631. setLaserLightingState(enabled?: boolean): void;
  51632. /**
  51633. * Permanently set new colors for the gaze pointer
  51634. * @param color the new gaze color
  51635. * @param pickedColor the new gaze color when picked mesh detected
  51636. */
  51637. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51638. /**
  51639. * Sets the color of the laser ray from the vr controllers.
  51640. * @param color new color for the ray.
  51641. */
  51642. changeLaserColor(color: Color3): void;
  51643. /**
  51644. * Sets the color of the ray from the vr headsets gaze.
  51645. * @param color new color for the ray.
  51646. */
  51647. changeGazeColor(color: Color3): void;
  51648. /**
  51649. * Exits VR and disposes of the vr experience helper
  51650. */
  51651. dispose(): void;
  51652. /**
  51653. * Gets the name of the VRExperienceHelper class
  51654. * @returns "VRExperienceHelper"
  51655. */
  51656. getClassName(): string;
  51657. }
  51658. }
  51659. declare module "babylonjs/Cameras/VR/index" {
  51660. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51661. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51662. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51663. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51664. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51665. export * from "babylonjs/Cameras/VR/webVRCamera";
  51666. }
  51667. declare module "babylonjs/Cameras/RigModes/index" {
  51668. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51669. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51670. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51671. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51672. }
  51673. declare module "babylonjs/Cameras/index" {
  51674. export * from "babylonjs/Cameras/Inputs/index";
  51675. export * from "babylonjs/Cameras/cameraInputsManager";
  51676. export * from "babylonjs/Cameras/camera";
  51677. export * from "babylonjs/Cameras/targetCamera";
  51678. export * from "babylonjs/Cameras/freeCamera";
  51679. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51680. export * from "babylonjs/Cameras/touchCamera";
  51681. export * from "babylonjs/Cameras/arcRotateCamera";
  51682. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51683. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51684. export * from "babylonjs/Cameras/flyCamera";
  51685. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51686. export * from "babylonjs/Cameras/followCamera";
  51687. export * from "babylonjs/Cameras/followCameraInputsManager";
  51688. export * from "babylonjs/Cameras/gamepadCamera";
  51689. export * from "babylonjs/Cameras/Stereoscopic/index";
  51690. export * from "babylonjs/Cameras/universalCamera";
  51691. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51692. export * from "babylonjs/Cameras/VR/index";
  51693. export * from "babylonjs/Cameras/RigModes/index";
  51694. }
  51695. declare module "babylonjs/Collisions/index" {
  51696. export * from "babylonjs/Collisions/collider";
  51697. export * from "babylonjs/Collisions/collisionCoordinator";
  51698. export * from "babylonjs/Collisions/pickingInfo";
  51699. export * from "babylonjs/Collisions/intersectionInfo";
  51700. export * from "babylonjs/Collisions/meshCollisionData";
  51701. }
  51702. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51703. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51704. import { Vector3 } from "babylonjs/Maths/math.vector";
  51705. import { Ray } from "babylonjs/Culling/ray";
  51706. import { Plane } from "babylonjs/Maths/math.plane";
  51707. /**
  51708. * Contains an array of blocks representing the octree
  51709. */
  51710. export interface IOctreeContainer<T> {
  51711. /**
  51712. * Blocks within the octree
  51713. */
  51714. blocks: Array<OctreeBlock<T>>;
  51715. }
  51716. /**
  51717. * Class used to store a cell in an octree
  51718. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51719. */
  51720. export class OctreeBlock<T> {
  51721. /**
  51722. * Gets the content of the current block
  51723. */
  51724. entries: T[];
  51725. /**
  51726. * Gets the list of block children
  51727. */
  51728. blocks: Array<OctreeBlock<T>>;
  51729. private _depth;
  51730. private _maxDepth;
  51731. private _capacity;
  51732. private _minPoint;
  51733. private _maxPoint;
  51734. private _boundingVectors;
  51735. private _creationFunc;
  51736. /**
  51737. * Creates a new block
  51738. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51739. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51740. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51741. * @param depth defines the current depth of this block in the octree
  51742. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51743. * @param creationFunc defines a callback to call when an element is added to the block
  51744. */
  51745. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51746. /**
  51747. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51748. */
  51749. get capacity(): number;
  51750. /**
  51751. * Gets the minimum vector (in world space) of the block's bounding box
  51752. */
  51753. get minPoint(): Vector3;
  51754. /**
  51755. * Gets the maximum vector (in world space) of the block's bounding box
  51756. */
  51757. get maxPoint(): Vector3;
  51758. /**
  51759. * Add a new element to this block
  51760. * @param entry defines the element to add
  51761. */
  51762. addEntry(entry: T): void;
  51763. /**
  51764. * Remove an element from this block
  51765. * @param entry defines the element to remove
  51766. */
  51767. removeEntry(entry: T): void;
  51768. /**
  51769. * Add an array of elements to this block
  51770. * @param entries defines the array of elements to add
  51771. */
  51772. addEntries(entries: T[]): void;
  51773. /**
  51774. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  51775. * @param frustumPlanes defines the frustum planes to test
  51776. * @param selection defines the array to store current content if selection is positive
  51777. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51778. */
  51779. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51780. /**
  51781. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  51782. * @param sphereCenter defines the bounding sphere center
  51783. * @param sphereRadius defines the bounding sphere radius
  51784. * @param selection defines the array to store current content if selection is positive
  51785. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51786. */
  51787. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51788. /**
  51789. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  51790. * @param ray defines the ray to test with
  51791. * @param selection defines the array to store current content if selection is positive
  51792. */
  51793. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  51794. /**
  51795. * Subdivide the content into child blocks (this block will then be empty)
  51796. */
  51797. createInnerBlocks(): void;
  51798. /**
  51799. * @hidden
  51800. */
  51801. 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;
  51802. }
  51803. }
  51804. declare module "babylonjs/Culling/Octrees/octree" {
  51805. import { SmartArray } from "babylonjs/Misc/smartArray";
  51806. import { Vector3 } from "babylonjs/Maths/math.vector";
  51807. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51808. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51809. import { Ray } from "babylonjs/Culling/ray";
  51810. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  51811. import { Plane } from "babylonjs/Maths/math.plane";
  51812. /**
  51813. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  51814. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51815. */
  51816. export class Octree<T> {
  51817. /** 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.) */
  51818. maxDepth: number;
  51819. /**
  51820. * Blocks within the octree containing objects
  51821. */
  51822. blocks: Array<OctreeBlock<T>>;
  51823. /**
  51824. * Content stored in the octree
  51825. */
  51826. dynamicContent: T[];
  51827. private _maxBlockCapacity;
  51828. private _selectionContent;
  51829. private _creationFunc;
  51830. /**
  51831. * Creates a octree
  51832. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51833. * @param creationFunc function to be used to instatiate the octree
  51834. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  51835. * @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.)
  51836. */
  51837. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  51838. /** 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.) */
  51839. maxDepth?: number);
  51840. /**
  51841. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  51842. * @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);
  51843. * @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);
  51844. * @param entries meshes to be added to the octree blocks
  51845. */
  51846. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  51847. /**
  51848. * Adds a mesh to the octree
  51849. * @param entry Mesh to add to the octree
  51850. */
  51851. addMesh(entry: T): void;
  51852. /**
  51853. * Remove an element from the octree
  51854. * @param entry defines the element to remove
  51855. */
  51856. removeMesh(entry: T): void;
  51857. /**
  51858. * Selects an array of meshes within the frustum
  51859. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  51860. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  51861. * @returns array of meshes within the frustum
  51862. */
  51863. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  51864. /**
  51865. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  51866. * @param sphereCenter defines the bounding sphere center
  51867. * @param sphereRadius defines the bounding sphere radius
  51868. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51869. * @returns an array of objects that intersect the sphere
  51870. */
  51871. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  51872. /**
  51873. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  51874. * @param ray defines the ray to test with
  51875. * @returns array of intersected objects
  51876. */
  51877. intersectsRay(ray: Ray): SmartArray<T>;
  51878. /**
  51879. * Adds a mesh into the octree block if it intersects the block
  51880. */
  51881. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  51882. /**
  51883. * Adds a submesh into the octree block if it intersects the block
  51884. */
  51885. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  51886. }
  51887. }
  51888. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  51889. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  51890. import { Scene } from "babylonjs/scene";
  51891. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51892. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51893. import { Ray } from "babylonjs/Culling/ray";
  51894. import { Octree } from "babylonjs/Culling/Octrees/octree";
  51895. import { Collider } from "babylonjs/Collisions/collider";
  51896. module "babylonjs/scene" {
  51897. interface Scene {
  51898. /**
  51899. * @hidden
  51900. * Backing Filed
  51901. */
  51902. _selectionOctree: Octree<AbstractMesh>;
  51903. /**
  51904. * Gets the octree used to boost mesh selection (picking)
  51905. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51906. */
  51907. selectionOctree: Octree<AbstractMesh>;
  51908. /**
  51909. * Creates or updates the octree used to boost selection (picking)
  51910. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51911. * @param maxCapacity defines the maximum capacity per leaf
  51912. * @param maxDepth defines the maximum depth of the octree
  51913. * @returns an octree of AbstractMesh
  51914. */
  51915. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  51916. }
  51917. }
  51918. module "babylonjs/Meshes/abstractMesh" {
  51919. interface AbstractMesh {
  51920. /**
  51921. * @hidden
  51922. * Backing Field
  51923. */
  51924. _submeshesOctree: Octree<SubMesh>;
  51925. /**
  51926. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  51927. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  51928. * @param maxCapacity defines the maximum size of each block (64 by default)
  51929. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  51930. * @returns the new octree
  51931. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  51932. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51933. */
  51934. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  51935. }
  51936. }
  51937. /**
  51938. * Defines the octree scene component responsible to manage any octrees
  51939. * in a given scene.
  51940. */
  51941. export class OctreeSceneComponent {
  51942. /**
  51943. * The component name help to identify the component in the list of scene components.
  51944. */
  51945. readonly name: string;
  51946. /**
  51947. * The scene the component belongs to.
  51948. */
  51949. scene: Scene;
  51950. /**
  51951. * Indicates if the meshes have been checked to make sure they are isEnabled()
  51952. */
  51953. readonly checksIsEnabled: boolean;
  51954. /**
  51955. * Creates a new instance of the component for the given scene
  51956. * @param scene Defines the scene to register the component in
  51957. */
  51958. constructor(scene: Scene);
  51959. /**
  51960. * Registers the component in a given scene
  51961. */
  51962. register(): void;
  51963. /**
  51964. * Return the list of active meshes
  51965. * @returns the list of active meshes
  51966. */
  51967. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  51968. /**
  51969. * Return the list of active sub meshes
  51970. * @param mesh The mesh to get the candidates sub meshes from
  51971. * @returns the list of active sub meshes
  51972. */
  51973. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  51974. private _tempRay;
  51975. /**
  51976. * Return the list of sub meshes intersecting with a given local ray
  51977. * @param mesh defines the mesh to find the submesh for
  51978. * @param localRay defines the ray in local space
  51979. * @returns the list of intersecting sub meshes
  51980. */
  51981. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  51982. /**
  51983. * Return the list of sub meshes colliding with a collider
  51984. * @param mesh defines the mesh to find the submesh for
  51985. * @param collider defines the collider to evaluate the collision against
  51986. * @returns the list of colliding sub meshes
  51987. */
  51988. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  51989. /**
  51990. * Rebuilds the elements related to this component in case of
  51991. * context lost for instance.
  51992. */
  51993. rebuild(): void;
  51994. /**
  51995. * Disposes the component and the associated ressources.
  51996. */
  51997. dispose(): void;
  51998. }
  51999. }
  52000. declare module "babylonjs/Culling/Octrees/index" {
  52001. export * from "babylonjs/Culling/Octrees/octree";
  52002. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52003. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52004. }
  52005. declare module "babylonjs/Culling/index" {
  52006. export * from "babylonjs/Culling/boundingBox";
  52007. export * from "babylonjs/Culling/boundingInfo";
  52008. export * from "babylonjs/Culling/boundingSphere";
  52009. export * from "babylonjs/Culling/Octrees/index";
  52010. export * from "babylonjs/Culling/ray";
  52011. }
  52012. declare module "babylonjs/Gizmos/gizmo" {
  52013. import { Nullable } from "babylonjs/types";
  52014. import { IDisposable } from "babylonjs/scene";
  52015. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52016. import { Mesh } from "babylonjs/Meshes/mesh";
  52017. import { Node } from "babylonjs/node";
  52018. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52019. /**
  52020. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52021. */
  52022. export class Gizmo implements IDisposable {
  52023. /** The utility layer the gizmo will be added to */
  52024. gizmoLayer: UtilityLayerRenderer;
  52025. /**
  52026. * The root mesh of the gizmo
  52027. */
  52028. _rootMesh: Mesh;
  52029. private _attachedMesh;
  52030. private _attachedNode;
  52031. /**
  52032. * Ratio for the scale of the gizmo (Default: 1)
  52033. */
  52034. scaleRatio: number;
  52035. /**
  52036. * If a custom mesh has been set (Default: false)
  52037. */
  52038. protected _customMeshSet: boolean;
  52039. /**
  52040. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52041. * * When set, interactions will be enabled
  52042. */
  52043. get attachedMesh(): Nullable<AbstractMesh>;
  52044. set attachedMesh(value: Nullable<AbstractMesh>);
  52045. /**
  52046. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52047. * * When set, interactions will be enabled
  52048. */
  52049. get attachedNode(): Nullable<Node>;
  52050. set attachedNode(value: Nullable<Node>);
  52051. /**
  52052. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52053. * @param mesh The mesh to replace the default mesh of the gizmo
  52054. */
  52055. setCustomMesh(mesh: Mesh): void;
  52056. /**
  52057. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52058. */
  52059. updateGizmoRotationToMatchAttachedMesh: boolean;
  52060. /**
  52061. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52062. */
  52063. updateGizmoPositionToMatchAttachedMesh: boolean;
  52064. /**
  52065. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52066. */
  52067. updateScale: boolean;
  52068. protected _interactionsEnabled: boolean;
  52069. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52070. private _beforeRenderObserver;
  52071. private _tempVector;
  52072. /**
  52073. * Creates a gizmo
  52074. * @param gizmoLayer The utility layer the gizmo will be added to
  52075. */
  52076. constructor(
  52077. /** The utility layer the gizmo will be added to */
  52078. gizmoLayer?: UtilityLayerRenderer);
  52079. /**
  52080. * Updates the gizmo to match the attached mesh's position/rotation
  52081. */
  52082. protected _update(): void;
  52083. /**
  52084. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52085. * @param value Node, TransformNode or mesh
  52086. */
  52087. protected _matrixChanged(): void;
  52088. /**
  52089. * Disposes of the gizmo
  52090. */
  52091. dispose(): void;
  52092. }
  52093. }
  52094. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52095. import { Observable } from "babylonjs/Misc/observable";
  52096. import { Nullable } from "babylonjs/types";
  52097. import { Vector3 } from "babylonjs/Maths/math.vector";
  52098. import { Color3 } from "babylonjs/Maths/math.color";
  52099. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52100. import { Node } from "babylonjs/node";
  52101. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52102. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52103. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52104. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52105. import { Scene } from "babylonjs/scene";
  52106. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52107. /**
  52108. * Single plane drag gizmo
  52109. */
  52110. export class PlaneDragGizmo extends Gizmo {
  52111. /**
  52112. * Drag behavior responsible for the gizmos dragging interactions
  52113. */
  52114. dragBehavior: PointerDragBehavior;
  52115. private _pointerObserver;
  52116. /**
  52117. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52118. */
  52119. snapDistance: number;
  52120. /**
  52121. * Event that fires each time the gizmo snaps to a new location.
  52122. * * snapDistance is the the change in distance
  52123. */
  52124. onSnapObservable: Observable<{
  52125. snapDistance: number;
  52126. }>;
  52127. private _plane;
  52128. private _coloredMaterial;
  52129. private _hoverMaterial;
  52130. private _isEnabled;
  52131. private _parent;
  52132. /** @hidden */
  52133. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52134. /** @hidden */
  52135. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52136. /**
  52137. * Creates a PlaneDragGizmo
  52138. * @param gizmoLayer The utility layer the gizmo will be added to
  52139. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52140. * @param color The color of the gizmo
  52141. */
  52142. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52143. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52144. /**
  52145. * If the gizmo is enabled
  52146. */
  52147. set isEnabled(value: boolean);
  52148. get isEnabled(): boolean;
  52149. /**
  52150. * Disposes of the gizmo
  52151. */
  52152. dispose(): void;
  52153. }
  52154. }
  52155. declare module "babylonjs/Gizmos/positionGizmo" {
  52156. import { Observable } from "babylonjs/Misc/observable";
  52157. import { Nullable } from "babylonjs/types";
  52158. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52159. import { Node } from "babylonjs/node";
  52160. import { Mesh } from "babylonjs/Meshes/mesh";
  52161. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52162. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52163. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52164. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52165. /**
  52166. * Gizmo that enables dragging a mesh along 3 axis
  52167. */
  52168. export class PositionGizmo extends Gizmo {
  52169. /**
  52170. * Internal gizmo used for interactions on the x axis
  52171. */
  52172. xGizmo: AxisDragGizmo;
  52173. /**
  52174. * Internal gizmo used for interactions on the y axis
  52175. */
  52176. yGizmo: AxisDragGizmo;
  52177. /**
  52178. * Internal gizmo used for interactions on the z axis
  52179. */
  52180. zGizmo: AxisDragGizmo;
  52181. /**
  52182. * Internal gizmo used for interactions on the yz plane
  52183. */
  52184. xPlaneGizmo: PlaneDragGizmo;
  52185. /**
  52186. * Internal gizmo used for interactions on the xz plane
  52187. */
  52188. yPlaneGizmo: PlaneDragGizmo;
  52189. /**
  52190. * Internal gizmo used for interactions on the xy plane
  52191. */
  52192. zPlaneGizmo: PlaneDragGizmo;
  52193. /**
  52194. * private variables
  52195. */
  52196. private _meshAttached;
  52197. private _nodeAttached;
  52198. private _updateGizmoRotationToMatchAttachedMesh;
  52199. private _snapDistance;
  52200. private _scaleRatio;
  52201. /** Fires an event when any of it's sub gizmos are dragged */
  52202. onDragStartObservable: Observable<unknown>;
  52203. /** Fires an event when any of it's sub gizmos are released from dragging */
  52204. onDragEndObservable: Observable<unknown>;
  52205. /**
  52206. * If set to true, planar drag is enabled
  52207. */
  52208. private _planarGizmoEnabled;
  52209. get attachedMesh(): Nullable<AbstractMesh>;
  52210. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52211. get attachedNode(): Nullable<Node>;
  52212. set attachedNode(node: Nullable<Node>);
  52213. /**
  52214. * Creates a PositionGizmo
  52215. * @param gizmoLayer The utility layer the gizmo will be added to
  52216. @param thickness display gizmo axis thickness
  52217. */
  52218. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52219. /**
  52220. * If the planar drag gizmo is enabled
  52221. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52222. */
  52223. set planarGizmoEnabled(value: boolean);
  52224. get planarGizmoEnabled(): boolean;
  52225. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52226. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52227. /**
  52228. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52229. */
  52230. set snapDistance(value: number);
  52231. get snapDistance(): number;
  52232. /**
  52233. * Ratio for the scale of the gizmo (Default: 1)
  52234. */
  52235. set scaleRatio(value: number);
  52236. get scaleRatio(): number;
  52237. /**
  52238. * Disposes of the gizmo
  52239. */
  52240. dispose(): void;
  52241. /**
  52242. * CustomMeshes are not supported by this gizmo
  52243. * @param mesh The mesh to replace the default mesh of the gizmo
  52244. */
  52245. setCustomMesh(mesh: Mesh): void;
  52246. }
  52247. }
  52248. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52249. import { Observable } from "babylonjs/Misc/observable";
  52250. import { Nullable } from "babylonjs/types";
  52251. import { Vector3 } from "babylonjs/Maths/math.vector";
  52252. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52253. import { Node } from "babylonjs/node";
  52254. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52255. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52256. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52257. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52258. import { Scene } from "babylonjs/scene";
  52259. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52260. import { Color3 } from "babylonjs/Maths/math.color";
  52261. /**
  52262. * Single axis drag gizmo
  52263. */
  52264. export class AxisDragGizmo extends Gizmo {
  52265. /**
  52266. * Drag behavior responsible for the gizmos dragging interactions
  52267. */
  52268. dragBehavior: PointerDragBehavior;
  52269. private _pointerObserver;
  52270. /**
  52271. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52272. */
  52273. snapDistance: number;
  52274. /**
  52275. * Event that fires each time the gizmo snaps to a new location.
  52276. * * snapDistance is the the change in distance
  52277. */
  52278. onSnapObservable: Observable<{
  52279. snapDistance: number;
  52280. }>;
  52281. private _isEnabled;
  52282. private _parent;
  52283. private _arrow;
  52284. private _coloredMaterial;
  52285. private _hoverMaterial;
  52286. /** @hidden */
  52287. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52288. /** @hidden */
  52289. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52290. /**
  52291. * Creates an AxisDragGizmo
  52292. * @param gizmoLayer The utility layer the gizmo will be added to
  52293. * @param dragAxis The axis which the gizmo will be able to drag on
  52294. * @param color The color of the gizmo
  52295. * @param thickness display gizmo axis thickness
  52296. */
  52297. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52298. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52299. /**
  52300. * If the gizmo is enabled
  52301. */
  52302. set isEnabled(value: boolean);
  52303. get isEnabled(): boolean;
  52304. /**
  52305. * Disposes of the gizmo
  52306. */
  52307. dispose(): void;
  52308. }
  52309. }
  52310. declare module "babylonjs/Debug/axesViewer" {
  52311. import { Vector3 } from "babylonjs/Maths/math.vector";
  52312. import { Nullable } from "babylonjs/types";
  52313. import { Scene } from "babylonjs/scene";
  52314. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52315. /**
  52316. * The Axes viewer will show 3 axes in a specific point in space
  52317. */
  52318. export class AxesViewer {
  52319. private _xAxis;
  52320. private _yAxis;
  52321. private _zAxis;
  52322. private _scaleLinesFactor;
  52323. private _instanced;
  52324. /**
  52325. * Gets the hosting scene
  52326. */
  52327. scene: Scene;
  52328. /**
  52329. * Gets or sets a number used to scale line length
  52330. */
  52331. scaleLines: number;
  52332. /** Gets the node hierarchy used to render x-axis */
  52333. get xAxis(): TransformNode;
  52334. /** Gets the node hierarchy used to render y-axis */
  52335. get yAxis(): TransformNode;
  52336. /** Gets the node hierarchy used to render z-axis */
  52337. get zAxis(): TransformNode;
  52338. /**
  52339. * Creates a new AxesViewer
  52340. * @param scene defines the hosting scene
  52341. * @param scaleLines defines a number used to scale line length (1 by default)
  52342. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52343. * @param xAxis defines the node hierarchy used to render the x-axis
  52344. * @param yAxis defines the node hierarchy used to render the y-axis
  52345. * @param zAxis defines the node hierarchy used to render the z-axis
  52346. */
  52347. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52348. /**
  52349. * Force the viewer to update
  52350. * @param position defines the position of the viewer
  52351. * @param xaxis defines the x axis of the viewer
  52352. * @param yaxis defines the y axis of the viewer
  52353. * @param zaxis defines the z axis of the viewer
  52354. */
  52355. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52356. /**
  52357. * Creates an instance of this axes viewer.
  52358. * @returns a new axes viewer with instanced meshes
  52359. */
  52360. createInstance(): AxesViewer;
  52361. /** Releases resources */
  52362. dispose(): void;
  52363. private static _SetRenderingGroupId;
  52364. }
  52365. }
  52366. declare module "babylonjs/Debug/boneAxesViewer" {
  52367. import { Nullable } from "babylonjs/types";
  52368. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52369. import { Vector3 } from "babylonjs/Maths/math.vector";
  52370. import { Mesh } from "babylonjs/Meshes/mesh";
  52371. import { Bone } from "babylonjs/Bones/bone";
  52372. import { Scene } from "babylonjs/scene";
  52373. /**
  52374. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52375. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52376. */
  52377. export class BoneAxesViewer extends AxesViewer {
  52378. /**
  52379. * Gets or sets the target mesh where to display the axes viewer
  52380. */
  52381. mesh: Nullable<Mesh>;
  52382. /**
  52383. * Gets or sets the target bone where to display the axes viewer
  52384. */
  52385. bone: Nullable<Bone>;
  52386. /** Gets current position */
  52387. pos: Vector3;
  52388. /** Gets direction of X axis */
  52389. xaxis: Vector3;
  52390. /** Gets direction of Y axis */
  52391. yaxis: Vector3;
  52392. /** Gets direction of Z axis */
  52393. zaxis: Vector3;
  52394. /**
  52395. * Creates a new BoneAxesViewer
  52396. * @param scene defines the hosting scene
  52397. * @param bone defines the target bone
  52398. * @param mesh defines the target mesh
  52399. * @param scaleLines defines a scaling factor for line length (1 by default)
  52400. */
  52401. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52402. /**
  52403. * Force the viewer to update
  52404. */
  52405. update(): void;
  52406. /** Releases resources */
  52407. dispose(): void;
  52408. }
  52409. }
  52410. declare module "babylonjs/Debug/debugLayer" {
  52411. import { Scene } from "babylonjs/scene";
  52412. /**
  52413. * Interface used to define scene explorer extensibility option
  52414. */
  52415. export interface IExplorerExtensibilityOption {
  52416. /**
  52417. * Define the option label
  52418. */
  52419. label: string;
  52420. /**
  52421. * Defines the action to execute on click
  52422. */
  52423. action: (entity: any) => void;
  52424. }
  52425. /**
  52426. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52427. */
  52428. export interface IExplorerExtensibilityGroup {
  52429. /**
  52430. * Defines a predicate to test if a given type mut be extended
  52431. */
  52432. predicate: (entity: any) => boolean;
  52433. /**
  52434. * Gets the list of options added to a type
  52435. */
  52436. entries: IExplorerExtensibilityOption[];
  52437. }
  52438. /**
  52439. * Interface used to define the options to use to create the Inspector
  52440. */
  52441. export interface IInspectorOptions {
  52442. /**
  52443. * Display in overlay mode (default: false)
  52444. */
  52445. overlay?: boolean;
  52446. /**
  52447. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52448. */
  52449. globalRoot?: HTMLElement;
  52450. /**
  52451. * Display the Scene explorer
  52452. */
  52453. showExplorer?: boolean;
  52454. /**
  52455. * Display the property inspector
  52456. */
  52457. showInspector?: boolean;
  52458. /**
  52459. * Display in embed mode (both panes on the right)
  52460. */
  52461. embedMode?: boolean;
  52462. /**
  52463. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52464. */
  52465. handleResize?: boolean;
  52466. /**
  52467. * Allow the panes to popup (default: true)
  52468. */
  52469. enablePopup?: boolean;
  52470. /**
  52471. * Allow the panes to be closed by users (default: true)
  52472. */
  52473. enableClose?: boolean;
  52474. /**
  52475. * Optional list of extensibility entries
  52476. */
  52477. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52478. /**
  52479. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52480. */
  52481. inspectorURL?: string;
  52482. /**
  52483. * Optional initial tab (default to DebugLayerTab.Properties)
  52484. */
  52485. initialTab?: DebugLayerTab;
  52486. }
  52487. module "babylonjs/scene" {
  52488. interface Scene {
  52489. /**
  52490. * @hidden
  52491. * Backing field
  52492. */
  52493. _debugLayer: DebugLayer;
  52494. /**
  52495. * Gets the debug layer (aka Inspector) associated with the scene
  52496. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52497. */
  52498. debugLayer: DebugLayer;
  52499. }
  52500. }
  52501. /**
  52502. * Enum of inspector action tab
  52503. */
  52504. export enum DebugLayerTab {
  52505. /**
  52506. * Properties tag (default)
  52507. */
  52508. Properties = 0,
  52509. /**
  52510. * Debug tab
  52511. */
  52512. Debug = 1,
  52513. /**
  52514. * Statistics tab
  52515. */
  52516. Statistics = 2,
  52517. /**
  52518. * Tools tab
  52519. */
  52520. Tools = 3,
  52521. /**
  52522. * Settings tab
  52523. */
  52524. Settings = 4
  52525. }
  52526. /**
  52527. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52528. * what is happening in your scene
  52529. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52530. */
  52531. export class DebugLayer {
  52532. /**
  52533. * Define the url to get the inspector script from.
  52534. * By default it uses the babylonjs CDN.
  52535. * @ignoreNaming
  52536. */
  52537. static InspectorURL: string;
  52538. private _scene;
  52539. private BJSINSPECTOR;
  52540. private _onPropertyChangedObservable?;
  52541. /**
  52542. * Observable triggered when a property is changed through the inspector.
  52543. */
  52544. get onPropertyChangedObservable(): any;
  52545. /**
  52546. * Instantiates a new debug layer.
  52547. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52548. * what is happening in your scene
  52549. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52550. * @param scene Defines the scene to inspect
  52551. */
  52552. constructor(scene: Scene);
  52553. /** Creates the inspector window. */
  52554. private _createInspector;
  52555. /**
  52556. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52557. * @param entity defines the entity to select
  52558. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52559. */
  52560. select(entity: any, lineContainerTitles?: string | string[]): void;
  52561. /** Get the inspector from bundle or global */
  52562. private _getGlobalInspector;
  52563. /**
  52564. * Get if the inspector is visible or not.
  52565. * @returns true if visible otherwise, false
  52566. */
  52567. isVisible(): boolean;
  52568. /**
  52569. * Hide the inspector and close its window.
  52570. */
  52571. hide(): void;
  52572. /**
  52573. * Update the scene in the inspector
  52574. */
  52575. setAsActiveScene(): void;
  52576. /**
  52577. * Launch the debugLayer.
  52578. * @param config Define the configuration of the inspector
  52579. * @return a promise fulfilled when the debug layer is visible
  52580. */
  52581. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52582. }
  52583. }
  52584. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52585. import { Nullable } from "babylonjs/types";
  52586. import { Scene } from "babylonjs/scene";
  52587. import { Vector4 } from "babylonjs/Maths/math.vector";
  52588. import { Color4 } from "babylonjs/Maths/math.color";
  52589. import { Mesh } from "babylonjs/Meshes/mesh";
  52590. /**
  52591. * Class containing static functions to help procedurally build meshes
  52592. */
  52593. export class BoxBuilder {
  52594. /**
  52595. * Creates a box mesh
  52596. * * The parameter `size` sets the size (float) of each box side (default 1)
  52597. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52598. * * 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)
  52599. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52600. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52601. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52602. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52603. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52604. * @param name defines the name of the mesh
  52605. * @param options defines the options used to create the mesh
  52606. * @param scene defines the hosting scene
  52607. * @returns the box mesh
  52608. */
  52609. static CreateBox(name: string, options: {
  52610. size?: number;
  52611. width?: number;
  52612. height?: number;
  52613. depth?: number;
  52614. faceUV?: Vector4[];
  52615. faceColors?: Color4[];
  52616. sideOrientation?: number;
  52617. frontUVs?: Vector4;
  52618. backUVs?: Vector4;
  52619. wrap?: boolean;
  52620. topBaseAt?: number;
  52621. bottomBaseAt?: number;
  52622. updatable?: boolean;
  52623. }, scene?: Nullable<Scene>): Mesh;
  52624. }
  52625. }
  52626. declare module "babylonjs/Debug/physicsViewer" {
  52627. import { Nullable } from "babylonjs/types";
  52628. import { Scene } from "babylonjs/scene";
  52629. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52630. import { Mesh } from "babylonjs/Meshes/mesh";
  52631. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52632. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52633. /**
  52634. * Used to show the physics impostor around the specific mesh
  52635. */
  52636. export class PhysicsViewer {
  52637. /** @hidden */
  52638. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52639. /** @hidden */
  52640. protected _meshes: Array<Nullable<AbstractMesh>>;
  52641. /** @hidden */
  52642. protected _scene: Nullable<Scene>;
  52643. /** @hidden */
  52644. protected _numMeshes: number;
  52645. /** @hidden */
  52646. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52647. private _renderFunction;
  52648. private _utilityLayer;
  52649. private _debugBoxMesh;
  52650. private _debugSphereMesh;
  52651. private _debugCylinderMesh;
  52652. private _debugMaterial;
  52653. private _debugMeshMeshes;
  52654. /**
  52655. * Creates a new PhysicsViewer
  52656. * @param scene defines the hosting scene
  52657. */
  52658. constructor(scene: Scene);
  52659. /** @hidden */
  52660. protected _updateDebugMeshes(): void;
  52661. /**
  52662. * Renders a specified physic impostor
  52663. * @param impostor defines the impostor to render
  52664. * @param targetMesh defines the mesh represented by the impostor
  52665. * @returns the new debug mesh used to render the impostor
  52666. */
  52667. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52668. /**
  52669. * Hides a specified physic impostor
  52670. * @param impostor defines the impostor to hide
  52671. */
  52672. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52673. private _getDebugMaterial;
  52674. private _getDebugBoxMesh;
  52675. private _getDebugSphereMesh;
  52676. private _getDebugCylinderMesh;
  52677. private _getDebugMeshMesh;
  52678. private _getDebugMesh;
  52679. /** Releases all resources */
  52680. dispose(): void;
  52681. }
  52682. }
  52683. declare module "babylonjs/Debug/rayHelper" {
  52684. import { Nullable } from "babylonjs/types";
  52685. import { Ray } from "babylonjs/Culling/ray";
  52686. import { Vector3 } from "babylonjs/Maths/math.vector";
  52687. import { Color3 } from "babylonjs/Maths/math.color";
  52688. import { Scene } from "babylonjs/scene";
  52689. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52690. import "babylonjs/Meshes/Builders/linesBuilder";
  52691. /**
  52692. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52693. * in order to better appreciate the issue one might have.
  52694. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52695. */
  52696. export class RayHelper {
  52697. /**
  52698. * Defines the ray we are currently tryin to visualize.
  52699. */
  52700. ray: Nullable<Ray>;
  52701. private _renderPoints;
  52702. private _renderLine;
  52703. private _renderFunction;
  52704. private _scene;
  52705. private _updateToMeshFunction;
  52706. private _attachedToMesh;
  52707. private _meshSpaceDirection;
  52708. private _meshSpaceOrigin;
  52709. /**
  52710. * Helper function to create a colored helper in a scene in one line.
  52711. * @param ray Defines the ray we are currently tryin to visualize
  52712. * @param scene Defines the scene the ray is used in
  52713. * @param color Defines the color we want to see the ray in
  52714. * @returns The newly created ray helper.
  52715. */
  52716. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52717. /**
  52718. * Instantiate a new ray helper.
  52719. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52720. * in order to better appreciate the issue one might have.
  52721. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52722. * @param ray Defines the ray we are currently tryin to visualize
  52723. */
  52724. constructor(ray: Ray);
  52725. /**
  52726. * Shows the ray we are willing to debug.
  52727. * @param scene Defines the scene the ray needs to be rendered in
  52728. * @param color Defines the color the ray needs to be rendered in
  52729. */
  52730. show(scene: Scene, color?: Color3): void;
  52731. /**
  52732. * Hides the ray we are debugging.
  52733. */
  52734. hide(): void;
  52735. private _render;
  52736. /**
  52737. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52738. * @param mesh Defines the mesh we want the helper attached to
  52739. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52740. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52741. * @param length Defines the length of the ray
  52742. */
  52743. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52744. /**
  52745. * Detach the ray helper from the mesh it has previously been attached to.
  52746. */
  52747. detachFromMesh(): void;
  52748. private _updateToMesh;
  52749. /**
  52750. * Dispose the helper and release its associated resources.
  52751. */
  52752. dispose(): void;
  52753. }
  52754. }
  52755. declare module "babylonjs/Debug/skeletonViewer" {
  52756. import { Color3 } from "babylonjs/Maths/math.color";
  52757. import { Scene } from "babylonjs/scene";
  52758. import { Nullable } from "babylonjs/types";
  52759. import { Skeleton } from "babylonjs/Bones/skeleton";
  52760. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52761. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  52762. /**
  52763. * Class used to render a debug view of a given skeleton
  52764. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  52765. */
  52766. export class SkeletonViewer {
  52767. /** defines the skeleton to render */
  52768. skeleton: Skeleton;
  52769. /** defines the mesh attached to the skeleton */
  52770. mesh: AbstractMesh;
  52771. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52772. autoUpdateBonesMatrices: boolean;
  52773. /** defines the rendering group id to use with the viewer */
  52774. renderingGroupId: number;
  52775. /** Gets or sets the color used to render the skeleton */
  52776. color: Color3;
  52777. private _scene;
  52778. private _debugLines;
  52779. private _debugMesh;
  52780. private _isEnabled;
  52781. private _renderFunction;
  52782. private _utilityLayer;
  52783. /**
  52784. * Returns the mesh used to render the bones
  52785. */
  52786. get debugMesh(): Nullable<LinesMesh>;
  52787. /**
  52788. * Creates a new SkeletonViewer
  52789. * @param skeleton defines the skeleton to render
  52790. * @param mesh defines the mesh attached to the skeleton
  52791. * @param scene defines the hosting scene
  52792. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  52793. * @param renderingGroupId defines the rendering group id to use with the viewer
  52794. */
  52795. constructor(
  52796. /** defines the skeleton to render */
  52797. skeleton: Skeleton,
  52798. /** defines the mesh attached to the skeleton */
  52799. mesh: AbstractMesh, scene: Scene,
  52800. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52801. autoUpdateBonesMatrices?: boolean,
  52802. /** defines the rendering group id to use with the viewer */
  52803. renderingGroupId?: number);
  52804. /** Gets or sets a boolean indicating if the viewer is enabled */
  52805. set isEnabled(value: boolean);
  52806. get isEnabled(): boolean;
  52807. private _getBonePosition;
  52808. private _getLinesForBonesWithLength;
  52809. private _getLinesForBonesNoLength;
  52810. /** Update the viewer to sync with current skeleton state */
  52811. update(): void;
  52812. /** Release associated resources */
  52813. dispose(): void;
  52814. }
  52815. }
  52816. declare module "babylonjs/Debug/index" {
  52817. export * from "babylonjs/Debug/axesViewer";
  52818. export * from "babylonjs/Debug/boneAxesViewer";
  52819. export * from "babylonjs/Debug/debugLayer";
  52820. export * from "babylonjs/Debug/physicsViewer";
  52821. export * from "babylonjs/Debug/rayHelper";
  52822. export * from "babylonjs/Debug/skeletonViewer";
  52823. }
  52824. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  52825. /**
  52826. * Enum for Device Types
  52827. */
  52828. export enum DeviceType {
  52829. /** Generic */
  52830. Generic = 0,
  52831. /** Keyboard */
  52832. Keyboard = 1,
  52833. /** Mouse */
  52834. Mouse = 2,
  52835. /** Touch Pointers */
  52836. Touch = 3,
  52837. /** PS4 Dual Shock */
  52838. DualShock = 4,
  52839. /** Xbox */
  52840. Xbox = 5,
  52841. /** Switch Controller */
  52842. Switch = 6
  52843. }
  52844. /**
  52845. * Enum for All Pointers (Touch/Mouse)
  52846. */
  52847. export enum PointerInput {
  52848. /** Horizontal Axis */
  52849. Horizontal = 0,
  52850. /** Vertical Axis */
  52851. Vertical = 1,
  52852. /** Left Click or Touch */
  52853. LeftClick = 2,
  52854. /** Middle Click */
  52855. MiddleClick = 3,
  52856. /** Right Click */
  52857. RightClick = 4,
  52858. /** Browser Back */
  52859. BrowserBack = 5,
  52860. /** Browser Forward */
  52861. BrowserForward = 6
  52862. }
  52863. /**
  52864. * Enum for Dual Shock Gamepad
  52865. */
  52866. export enum DualShockInput {
  52867. /** Cross */
  52868. Cross = 0,
  52869. /** Circle */
  52870. Circle = 1,
  52871. /** Square */
  52872. Square = 2,
  52873. /** Triangle */
  52874. Triangle = 3,
  52875. /** L1 */
  52876. L1 = 4,
  52877. /** R1 */
  52878. R1 = 5,
  52879. /** L2 */
  52880. L2 = 6,
  52881. /** R2 */
  52882. R2 = 7,
  52883. /** Share */
  52884. Share = 8,
  52885. /** Options */
  52886. Options = 9,
  52887. /** L3 */
  52888. L3 = 10,
  52889. /** R3 */
  52890. R3 = 11,
  52891. /** DPadUp */
  52892. DPadUp = 12,
  52893. /** DPadDown */
  52894. DPadDown = 13,
  52895. /** DPadLeft */
  52896. DPadLeft = 14,
  52897. /** DRight */
  52898. DPadRight = 15,
  52899. /** Home */
  52900. Home = 16,
  52901. /** TouchPad */
  52902. TouchPad = 17,
  52903. /** LStickXAxis */
  52904. LStickXAxis = 18,
  52905. /** LStickYAxis */
  52906. LStickYAxis = 19,
  52907. /** RStickXAxis */
  52908. RStickXAxis = 20,
  52909. /** RStickYAxis */
  52910. RStickYAxis = 21
  52911. }
  52912. /**
  52913. * Enum for Xbox Gamepad
  52914. */
  52915. export enum XboxInput {
  52916. /** A */
  52917. A = 0,
  52918. /** B */
  52919. B = 1,
  52920. /** X */
  52921. X = 2,
  52922. /** Y */
  52923. Y = 3,
  52924. /** LB */
  52925. LB = 4,
  52926. /** RB */
  52927. RB = 5,
  52928. /** LT */
  52929. LT = 6,
  52930. /** RT */
  52931. RT = 7,
  52932. /** Back */
  52933. Back = 8,
  52934. /** Start */
  52935. Start = 9,
  52936. /** LS */
  52937. LS = 10,
  52938. /** RS */
  52939. RS = 11,
  52940. /** DPadUp */
  52941. DPadUp = 12,
  52942. /** DPadDown */
  52943. DPadDown = 13,
  52944. /** DPadLeft */
  52945. DPadLeft = 14,
  52946. /** DRight */
  52947. DPadRight = 15,
  52948. /** Home */
  52949. Home = 16,
  52950. /** LStickXAxis */
  52951. LStickXAxis = 17,
  52952. /** LStickYAxis */
  52953. LStickYAxis = 18,
  52954. /** RStickXAxis */
  52955. RStickXAxis = 19,
  52956. /** RStickYAxis */
  52957. RStickYAxis = 20
  52958. }
  52959. /**
  52960. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  52961. */
  52962. export enum SwitchInput {
  52963. /** B */
  52964. B = 0,
  52965. /** A */
  52966. A = 1,
  52967. /** Y */
  52968. Y = 2,
  52969. /** X */
  52970. X = 3,
  52971. /** L */
  52972. L = 4,
  52973. /** R */
  52974. R = 5,
  52975. /** ZL */
  52976. ZL = 6,
  52977. /** ZR */
  52978. ZR = 7,
  52979. /** Minus */
  52980. Minus = 8,
  52981. /** Plus */
  52982. Plus = 9,
  52983. /** LS */
  52984. LS = 10,
  52985. /** RS */
  52986. RS = 11,
  52987. /** DPadUp */
  52988. DPadUp = 12,
  52989. /** DPadDown */
  52990. DPadDown = 13,
  52991. /** DPadLeft */
  52992. DPadLeft = 14,
  52993. /** DRight */
  52994. DPadRight = 15,
  52995. /** Home */
  52996. Home = 16,
  52997. /** Capture */
  52998. Capture = 17,
  52999. /** LStickXAxis */
  53000. LStickXAxis = 18,
  53001. /** LStickYAxis */
  53002. LStickYAxis = 19,
  53003. /** RStickXAxis */
  53004. RStickXAxis = 20,
  53005. /** RStickYAxis */
  53006. RStickYAxis = 21
  53007. }
  53008. }
  53009. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53010. import { Engine } from "babylonjs/Engines/engine";
  53011. import { IDisposable } from "babylonjs/scene";
  53012. import { Nullable } from "babylonjs/types";
  53013. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53014. /**
  53015. * This class will take all inputs from Keyboard, Pointer, and
  53016. * any Gamepads and provide a polling system that all devices
  53017. * will use. This class assumes that there will only be one
  53018. * pointer device and one keyboard.
  53019. */
  53020. export class DeviceInputSystem implements IDisposable {
  53021. /**
  53022. * Callback to be triggered when a device is connected
  53023. */
  53024. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53025. /**
  53026. * Callback to be triggered when a device is disconnected
  53027. */
  53028. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53029. /**
  53030. * Callback to be triggered when event driven input is updated
  53031. */
  53032. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53033. private _inputs;
  53034. private _gamepads;
  53035. private _keyboardActive;
  53036. private _pointerActive;
  53037. private _elementToAttachTo;
  53038. private _keyboardDownEvent;
  53039. private _keyboardUpEvent;
  53040. private _pointerMoveEvent;
  53041. private _pointerDownEvent;
  53042. private _pointerUpEvent;
  53043. private _gamepadConnectedEvent;
  53044. private _gamepadDisconnectedEvent;
  53045. private static _MAX_KEYCODES;
  53046. private static _MAX_POINTER_INPUTS;
  53047. private constructor();
  53048. /**
  53049. * Creates a new DeviceInputSystem instance
  53050. * @param engine Engine to pull input element from
  53051. * @returns The new instance
  53052. */
  53053. static Create(engine: Engine): DeviceInputSystem;
  53054. /**
  53055. * Checks for current device input value, given an id and input index
  53056. * @param deviceName Id of connected device
  53057. * @param inputIndex Index of device input
  53058. * @returns Current value of input
  53059. */
  53060. /**
  53061. * Checks for current device input value, given an id and input index
  53062. * @param deviceType Enum specifiying device type
  53063. * @param deviceSlot "Slot" or index that device is referenced in
  53064. * @param inputIndex Id of input to be checked
  53065. * @returns Current value of input
  53066. */
  53067. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  53068. /**
  53069. * Dispose of all the eventlisteners
  53070. */
  53071. dispose(): void;
  53072. /**
  53073. * Add device and inputs to device array
  53074. * @param deviceType Enum specifiying device type
  53075. * @param deviceSlot "Slot" or index that device is referenced in
  53076. * @param numberOfInputs Number of input entries to create for given device
  53077. */
  53078. private _registerDevice;
  53079. /**
  53080. * Given a specific device name, remove that device from the device map
  53081. * @param deviceType Enum specifiying device type
  53082. * @param deviceSlot "Slot" or index that device is referenced in
  53083. */
  53084. private _unregisterDevice;
  53085. /**
  53086. * Handle all actions that come from keyboard interaction
  53087. */
  53088. private _handleKeyActions;
  53089. /**
  53090. * Handle all actions that come from pointer interaction
  53091. */
  53092. private _handlePointerActions;
  53093. /**
  53094. * Handle all actions that come from gamepad interaction
  53095. */
  53096. private _handleGamepadActions;
  53097. /**
  53098. * Update all non-event based devices with each frame
  53099. * @param deviceType Enum specifiying device type
  53100. * @param deviceSlot "Slot" or index that device is referenced in
  53101. * @param inputIndex Id of input to be checked
  53102. */
  53103. private _updateDevice;
  53104. /**
  53105. * Gets DeviceType from the device name
  53106. * @param deviceName Name of Device from DeviceInputSystem
  53107. * @returns DeviceType enum value
  53108. */
  53109. private _getGamepadDeviceType;
  53110. }
  53111. }
  53112. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53113. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53114. /**
  53115. * Type to handle enforcement of inputs
  53116. */
  53117. 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;
  53118. }
  53119. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53120. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53121. import { Engine } from "babylonjs/Engines/engine";
  53122. import { IDisposable } from "babylonjs/scene";
  53123. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53124. import { Nullable } from "babylonjs/types";
  53125. import { Observable } from "babylonjs/Misc/observable";
  53126. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53127. /**
  53128. * Class that handles all input for a specific device
  53129. */
  53130. export class DeviceSource<T extends DeviceType> {
  53131. /** Type of device */
  53132. readonly deviceType: DeviceType;
  53133. /** "Slot" or index that device is referenced in */
  53134. readonly deviceSlot: number;
  53135. /**
  53136. * Observable to handle device input changes per device
  53137. */
  53138. readonly onInputChangedObservable: Observable<{
  53139. inputIndex: DeviceInput<T>;
  53140. previousState: Nullable<number>;
  53141. currentState: Nullable<number>;
  53142. }>;
  53143. private readonly _deviceInputSystem;
  53144. /**
  53145. * Default Constructor
  53146. * @param deviceInputSystem Reference to DeviceInputSystem
  53147. * @param deviceType Type of device
  53148. * @param deviceSlot "Slot" or index that device is referenced in
  53149. */
  53150. constructor(deviceInputSystem: DeviceInputSystem,
  53151. /** Type of device */
  53152. deviceType: DeviceType,
  53153. /** "Slot" or index that device is referenced in */
  53154. deviceSlot?: number);
  53155. /**
  53156. * Get input for specific input
  53157. * @param inputIndex index of specific input on device
  53158. * @returns Input value from DeviceInputSystem
  53159. */
  53160. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53161. }
  53162. /**
  53163. * Class to keep track of devices
  53164. */
  53165. export class DeviceSourceManager implements IDisposable {
  53166. /**
  53167. * Observable to be triggered when before a device is connected
  53168. */
  53169. readonly onBeforeDeviceConnectedObservable: Observable<{
  53170. deviceType: DeviceType;
  53171. deviceSlot: number;
  53172. }>;
  53173. /**
  53174. * Observable to be triggered when before a device is disconnected
  53175. */
  53176. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53177. deviceType: DeviceType;
  53178. deviceSlot: number;
  53179. }>;
  53180. /**
  53181. * Observable to be triggered when after a device is connected
  53182. */
  53183. readonly onAfterDeviceConnectedObservable: Observable<{
  53184. deviceType: DeviceType;
  53185. deviceSlot: number;
  53186. }>;
  53187. /**
  53188. * Observable to be triggered when after a device is disconnected
  53189. */
  53190. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53191. deviceType: DeviceType;
  53192. deviceSlot: number;
  53193. }>;
  53194. private readonly _devices;
  53195. private readonly _firstDevice;
  53196. private readonly _deviceInputSystem;
  53197. /**
  53198. * Default Constructor
  53199. * @param engine engine to pull input element from
  53200. */
  53201. constructor(engine: Engine);
  53202. /**
  53203. * Gets a DeviceSource, given a type and slot
  53204. * @param deviceType Enum specifying device type
  53205. * @param deviceSlot "Slot" or index that device is referenced in
  53206. * @returns DeviceSource object
  53207. */
  53208. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53209. /**
  53210. * Gets an array of DeviceSource objects for a given device type
  53211. * @param deviceType Enum specifying device type
  53212. * @returns Array of DeviceSource objects
  53213. */
  53214. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53215. /**
  53216. * Dispose of DeviceInputSystem and other parts
  53217. */
  53218. dispose(): void;
  53219. /**
  53220. * Function to add device name to device list
  53221. * @param deviceType Enum specifying device type
  53222. * @param deviceSlot "Slot" or index that device is referenced in
  53223. */
  53224. private _addDevice;
  53225. /**
  53226. * Function to remove device name to device list
  53227. * @param deviceType Enum specifying device type
  53228. * @param deviceSlot "Slot" or index that device is referenced in
  53229. */
  53230. private _removeDevice;
  53231. /**
  53232. * Updates array storing first connected device of each type
  53233. * @param type Type of Device
  53234. */
  53235. private _updateFirstDevices;
  53236. }
  53237. }
  53238. declare module "babylonjs/DeviceInput/index" {
  53239. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53240. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53241. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53242. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53243. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53244. }
  53245. declare module "babylonjs/Engines/nullEngine" {
  53246. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53247. import { Engine } from "babylonjs/Engines/engine";
  53248. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53249. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53250. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53251. import { Effect } from "babylonjs/Materials/effect";
  53252. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53253. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53254. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53255. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53256. /**
  53257. * Options to create the null engine
  53258. */
  53259. export class NullEngineOptions {
  53260. /**
  53261. * Render width (Default: 512)
  53262. */
  53263. renderWidth: number;
  53264. /**
  53265. * Render height (Default: 256)
  53266. */
  53267. renderHeight: number;
  53268. /**
  53269. * Texture size (Default: 512)
  53270. */
  53271. textureSize: number;
  53272. /**
  53273. * If delta time between frames should be constant
  53274. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53275. */
  53276. deterministicLockstep: boolean;
  53277. /**
  53278. * Maximum about of steps between frames (Default: 4)
  53279. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53280. */
  53281. lockstepMaxSteps: number;
  53282. /**
  53283. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53284. */
  53285. useHighPrecisionMatrix?: boolean;
  53286. }
  53287. /**
  53288. * The null engine class provides support for headless version of babylon.js.
  53289. * This can be used in server side scenario or for testing purposes
  53290. */
  53291. export class NullEngine extends Engine {
  53292. private _options;
  53293. /**
  53294. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53295. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53296. * @returns true if engine is in deterministic lock step mode
  53297. */
  53298. isDeterministicLockStep(): boolean;
  53299. /**
  53300. * Gets the max steps when engine is running in deterministic lock step
  53301. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53302. * @returns the max steps
  53303. */
  53304. getLockstepMaxSteps(): number;
  53305. /**
  53306. * Gets the current hardware scaling level.
  53307. * By default the hardware scaling level is computed from the window device ratio.
  53308. * 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.
  53309. * @returns a number indicating the current hardware scaling level
  53310. */
  53311. getHardwareScalingLevel(): number;
  53312. constructor(options?: NullEngineOptions);
  53313. /**
  53314. * Creates a vertex buffer
  53315. * @param vertices the data for the vertex buffer
  53316. * @returns the new WebGL static buffer
  53317. */
  53318. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53319. /**
  53320. * Creates a new index buffer
  53321. * @param indices defines the content of the index buffer
  53322. * @param updatable defines if the index buffer must be updatable
  53323. * @returns a new webGL buffer
  53324. */
  53325. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53326. /**
  53327. * Clear the current render buffer or the current render target (if any is set up)
  53328. * @param color defines the color to use
  53329. * @param backBuffer defines if the back buffer must be cleared
  53330. * @param depth defines if the depth buffer must be cleared
  53331. * @param stencil defines if the stencil buffer must be cleared
  53332. */
  53333. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53334. /**
  53335. * Gets the current render width
  53336. * @param useScreen defines if screen size must be used (or the current render target if any)
  53337. * @returns a number defining the current render width
  53338. */
  53339. getRenderWidth(useScreen?: boolean): number;
  53340. /**
  53341. * Gets the current render height
  53342. * @param useScreen defines if screen size must be used (or the current render target if any)
  53343. * @returns a number defining the current render height
  53344. */
  53345. getRenderHeight(useScreen?: boolean): number;
  53346. /**
  53347. * Set the WebGL's viewport
  53348. * @param viewport defines the viewport element to be used
  53349. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53350. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53351. */
  53352. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53353. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53354. /**
  53355. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53356. * @param pipelineContext defines the pipeline context to use
  53357. * @param uniformsNames defines the list of uniform names
  53358. * @returns an array of webGL uniform locations
  53359. */
  53360. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53361. /**
  53362. * Gets the lsit of active attributes for a given webGL program
  53363. * @param pipelineContext defines the pipeline context to use
  53364. * @param attributesNames defines the list of attribute names to get
  53365. * @returns an array of indices indicating the offset of each attribute
  53366. */
  53367. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53368. /**
  53369. * Binds an effect to the webGL context
  53370. * @param effect defines the effect to bind
  53371. */
  53372. bindSamplers(effect: Effect): void;
  53373. /**
  53374. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53375. * @param effect defines the effect to activate
  53376. */
  53377. enableEffect(effect: Effect): void;
  53378. /**
  53379. * Set various states to the webGL context
  53380. * @param culling defines backface culling state
  53381. * @param zOffset defines the value to apply to zOffset (0 by default)
  53382. * @param force defines if states must be applied even if cache is up to date
  53383. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53384. */
  53385. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53386. /**
  53387. * Set the value of an uniform to an array of int32
  53388. * @param uniform defines the webGL uniform location where to store the value
  53389. * @param array defines the array of int32 to store
  53390. */
  53391. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53392. /**
  53393. * Set the value of an uniform to an array of int32 (stored as vec2)
  53394. * @param uniform defines the webGL uniform location where to store the value
  53395. * @param array defines the array of int32 to store
  53396. */
  53397. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53398. /**
  53399. * Set the value of an uniform to an array of int32 (stored as vec3)
  53400. * @param uniform defines the webGL uniform location where to store the value
  53401. * @param array defines the array of int32 to store
  53402. */
  53403. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53404. /**
  53405. * Set the value of an uniform to an array of int32 (stored as vec4)
  53406. * @param uniform defines the webGL uniform location where to store the value
  53407. * @param array defines the array of int32 to store
  53408. */
  53409. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53410. /**
  53411. * Set the value of an uniform to an array of float32
  53412. * @param uniform defines the webGL uniform location where to store the value
  53413. * @param array defines the array of float32 to store
  53414. */
  53415. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53416. /**
  53417. * Set the value of an uniform to an array of float32 (stored as vec2)
  53418. * @param uniform defines the webGL uniform location where to store the value
  53419. * @param array defines the array of float32 to store
  53420. */
  53421. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53422. /**
  53423. * Set the value of an uniform to an array of float32 (stored as vec3)
  53424. * @param uniform defines the webGL uniform location where to store the value
  53425. * @param array defines the array of float32 to store
  53426. */
  53427. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53428. /**
  53429. * Set the value of an uniform to an array of float32 (stored as vec4)
  53430. * @param uniform defines the webGL uniform location where to store the value
  53431. * @param array defines the array of float32 to store
  53432. */
  53433. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53434. /**
  53435. * Set the value of an uniform to an array of number
  53436. * @param uniform defines the webGL uniform location where to store the value
  53437. * @param array defines the array of number to store
  53438. */
  53439. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53440. /**
  53441. * Set the value of an uniform to an array of number (stored as vec2)
  53442. * @param uniform defines the webGL uniform location where to store the value
  53443. * @param array defines the array of number to store
  53444. */
  53445. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53446. /**
  53447. * Set the value of an uniform to an array of number (stored as vec3)
  53448. * @param uniform defines the webGL uniform location where to store the value
  53449. * @param array defines the array of number to store
  53450. */
  53451. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53452. /**
  53453. * Set the value of an uniform to an array of number (stored as vec4)
  53454. * @param uniform defines the webGL uniform location where to store the value
  53455. * @param array defines the array of number to store
  53456. */
  53457. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53458. /**
  53459. * Set the value of an uniform to an array of float32 (stored as matrices)
  53460. * @param uniform defines the webGL uniform location where to store the value
  53461. * @param matrices defines the array of float32 to store
  53462. */
  53463. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53464. /**
  53465. * Set the value of an uniform to a matrix (3x3)
  53466. * @param uniform defines the webGL uniform location where to store the value
  53467. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53468. */
  53469. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53470. /**
  53471. * Set the value of an uniform to a matrix (2x2)
  53472. * @param uniform defines the webGL uniform location where to store the value
  53473. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53474. */
  53475. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53476. /**
  53477. * Set the value of an uniform to a number (float)
  53478. * @param uniform defines the webGL uniform location where to store the value
  53479. * @param value defines the float number to store
  53480. */
  53481. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53482. /**
  53483. * Set the value of an uniform to a vec2
  53484. * @param uniform defines the webGL uniform location where to store the value
  53485. * @param x defines the 1st component of the value
  53486. * @param y defines the 2nd component of the value
  53487. */
  53488. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53489. /**
  53490. * Set the value of an uniform to a vec3
  53491. * @param uniform defines the webGL uniform location where to store the value
  53492. * @param x defines the 1st component of the value
  53493. * @param y defines the 2nd component of the value
  53494. * @param z defines the 3rd component of the value
  53495. */
  53496. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53497. /**
  53498. * Set the value of an uniform to a boolean
  53499. * @param uniform defines the webGL uniform location where to store the value
  53500. * @param bool defines the boolean to store
  53501. */
  53502. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53503. /**
  53504. * Set the value of an uniform to a vec4
  53505. * @param uniform defines the webGL uniform location where to store the value
  53506. * @param x defines the 1st component of the value
  53507. * @param y defines the 2nd component of the value
  53508. * @param z defines the 3rd component of the value
  53509. * @param w defines the 4th component of the value
  53510. */
  53511. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53512. /**
  53513. * Sets the current alpha mode
  53514. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53515. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53516. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53517. */
  53518. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53519. /**
  53520. * Bind webGl buffers directly to the webGL context
  53521. * @param vertexBuffers defines the vertex buffer to bind
  53522. * @param indexBuffer defines the index buffer to bind
  53523. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53524. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53525. * @param effect defines the effect associated with the vertex buffer
  53526. */
  53527. bindBuffers(vertexBuffers: {
  53528. [key: string]: VertexBuffer;
  53529. }, indexBuffer: DataBuffer, effect: Effect): void;
  53530. /**
  53531. * Force the entire cache to be cleared
  53532. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  53533. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  53534. */
  53535. wipeCaches(bruteForce?: boolean): void;
  53536. /**
  53537. * Send a draw order
  53538. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  53539. * @param indexStart defines the starting index
  53540. * @param indexCount defines the number of index to draw
  53541. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53542. */
  53543. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  53544. /**
  53545. * Draw a list of indexed primitives
  53546. * @param fillMode defines the primitive to use
  53547. * @param indexStart defines the starting index
  53548. * @param indexCount defines the number of index to draw
  53549. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53550. */
  53551. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  53552. /**
  53553. * Draw a list of unindexed primitives
  53554. * @param fillMode defines the primitive to use
  53555. * @param verticesStart defines the index of first vertex to draw
  53556. * @param verticesCount defines the count of vertices to draw
  53557. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53558. */
  53559. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  53560. /** @hidden */
  53561. _createTexture(): WebGLTexture;
  53562. /** @hidden */
  53563. _releaseTexture(texture: InternalTexture): void;
  53564. /**
  53565. * Usually called from Texture.ts.
  53566. * Passed information to create a WebGLTexture
  53567. * @param urlArg defines a value which contains one of the following:
  53568. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  53569. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  53570. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  53571. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  53572. * @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)
  53573. * @param scene needed for loading to the correct scene
  53574. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  53575. * @param onLoad optional callback to be called upon successful completion
  53576. * @param onError optional callback to be called upon failure
  53577. * @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
  53578. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  53579. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  53580. * @param forcedExtension defines the extension to use to pick the right loader
  53581. * @param mimeType defines an optional mime type
  53582. * @returns a InternalTexture for assignment back into BABYLON.Texture
  53583. */
  53584. 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;
  53585. /**
  53586. * Creates a new render target texture
  53587. * @param size defines the size of the texture
  53588. * @param options defines the options used to create the texture
  53589. * @returns a new render target texture stored in an InternalTexture
  53590. */
  53591. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  53592. /**
  53593. * Update the sampling mode of a given texture
  53594. * @param samplingMode defines the required sampling mode
  53595. * @param texture defines the texture to update
  53596. */
  53597. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  53598. /**
  53599. * Binds the frame buffer to the specified texture.
  53600. * @param texture The texture to render to or null for the default canvas
  53601. * @param faceIndex The face of the texture to render to in case of cube texture
  53602. * @param requiredWidth The width of the target to render to
  53603. * @param requiredHeight The height of the target to render to
  53604. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  53605. * @param lodLevel defines le lod level to bind to the frame buffer
  53606. */
  53607. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  53608. /**
  53609. * Unbind the current render target texture from the webGL context
  53610. * @param texture defines the render target texture to unbind
  53611. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  53612. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  53613. */
  53614. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  53615. /**
  53616. * Creates a dynamic vertex buffer
  53617. * @param vertices the data for the dynamic vertex buffer
  53618. * @returns the new WebGL dynamic buffer
  53619. */
  53620. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  53621. /**
  53622. * Update the content of a dynamic texture
  53623. * @param texture defines the texture to update
  53624. * @param canvas defines the canvas containing the source
  53625. * @param invertY defines if data must be stored with Y axis inverted
  53626. * @param premulAlpha defines if alpha is stored as premultiplied
  53627. * @param format defines the format of the data
  53628. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  53629. */
  53630. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  53631. /**
  53632. * Gets a boolean indicating if all created effects are ready
  53633. * @returns true if all effects are ready
  53634. */
  53635. areAllEffectsReady(): boolean;
  53636. /**
  53637. * @hidden
  53638. * Get the current error code of the webGL context
  53639. * @returns the error code
  53640. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  53641. */
  53642. getError(): number;
  53643. /** @hidden */
  53644. _getUnpackAlignement(): number;
  53645. /** @hidden */
  53646. _unpackFlipY(value: boolean): void;
  53647. /**
  53648. * Update a dynamic index buffer
  53649. * @param indexBuffer defines the target index buffer
  53650. * @param indices defines the data to update
  53651. * @param offset defines the offset in the target index buffer where update should start
  53652. */
  53653. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  53654. /**
  53655. * Updates a dynamic vertex buffer.
  53656. * @param vertexBuffer the vertex buffer to update
  53657. * @param vertices the data used to update the vertex buffer
  53658. * @param byteOffset the byte offset of the data (optional)
  53659. * @param byteLength the byte length of the data (optional)
  53660. */
  53661. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  53662. /** @hidden */
  53663. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  53664. /** @hidden */
  53665. _bindTexture(channel: number, texture: InternalTexture): void;
  53666. protected _deleteBuffer(buffer: WebGLBuffer): void;
  53667. /**
  53668. * 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
  53669. */
  53670. releaseEffects(): void;
  53671. displayLoadingUI(): void;
  53672. hideLoadingUI(): void;
  53673. /** @hidden */
  53674. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53675. /** @hidden */
  53676. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53677. /** @hidden */
  53678. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53679. /** @hidden */
  53680. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  53681. }
  53682. }
  53683. declare module "babylonjs/Instrumentation/timeToken" {
  53684. import { Nullable } from "babylonjs/types";
  53685. /**
  53686. * @hidden
  53687. **/
  53688. export class _TimeToken {
  53689. _startTimeQuery: Nullable<WebGLQuery>;
  53690. _endTimeQuery: Nullable<WebGLQuery>;
  53691. _timeElapsedQuery: Nullable<WebGLQuery>;
  53692. _timeElapsedQueryEnded: boolean;
  53693. }
  53694. }
  53695. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  53696. import { Nullable, int } from "babylonjs/types";
  53697. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  53698. /** @hidden */
  53699. export class _OcclusionDataStorage {
  53700. /** @hidden */
  53701. occlusionInternalRetryCounter: number;
  53702. /** @hidden */
  53703. isOcclusionQueryInProgress: boolean;
  53704. /** @hidden */
  53705. isOccluded: boolean;
  53706. /** @hidden */
  53707. occlusionRetryCount: number;
  53708. /** @hidden */
  53709. occlusionType: number;
  53710. /** @hidden */
  53711. occlusionQueryAlgorithmType: number;
  53712. }
  53713. module "babylonjs/Engines/engine" {
  53714. interface Engine {
  53715. /**
  53716. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  53717. * @return the new query
  53718. */
  53719. createQuery(): WebGLQuery;
  53720. /**
  53721. * Delete and release a webGL query
  53722. * @param query defines the query to delete
  53723. * @return the current engine
  53724. */
  53725. deleteQuery(query: WebGLQuery): Engine;
  53726. /**
  53727. * Check if a given query has resolved and got its value
  53728. * @param query defines the query to check
  53729. * @returns true if the query got its value
  53730. */
  53731. isQueryResultAvailable(query: WebGLQuery): boolean;
  53732. /**
  53733. * Gets the value of a given query
  53734. * @param query defines the query to check
  53735. * @returns the value of the query
  53736. */
  53737. getQueryResult(query: WebGLQuery): number;
  53738. /**
  53739. * Initiates an occlusion query
  53740. * @param algorithmType defines the algorithm to use
  53741. * @param query defines the query to use
  53742. * @returns the current engine
  53743. * @see https://doc.babylonjs.com/features/occlusionquery
  53744. */
  53745. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  53746. /**
  53747. * Ends an occlusion query
  53748. * @see https://doc.babylonjs.com/features/occlusionquery
  53749. * @param algorithmType defines the algorithm to use
  53750. * @returns the current engine
  53751. */
  53752. endOcclusionQuery(algorithmType: number): Engine;
  53753. /**
  53754. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  53755. * Please note that only one query can be issued at a time
  53756. * @returns a time token used to track the time span
  53757. */
  53758. startTimeQuery(): Nullable<_TimeToken>;
  53759. /**
  53760. * Ends a time query
  53761. * @param token defines the token used to measure the time span
  53762. * @returns the time spent (in ns)
  53763. */
  53764. endTimeQuery(token: _TimeToken): int;
  53765. /** @hidden */
  53766. _currentNonTimestampToken: Nullable<_TimeToken>;
  53767. /** @hidden */
  53768. _createTimeQuery(): WebGLQuery;
  53769. /** @hidden */
  53770. _deleteTimeQuery(query: WebGLQuery): void;
  53771. /** @hidden */
  53772. _getGlAlgorithmType(algorithmType: number): number;
  53773. /** @hidden */
  53774. _getTimeQueryResult(query: WebGLQuery): any;
  53775. /** @hidden */
  53776. _getTimeQueryAvailability(query: WebGLQuery): any;
  53777. }
  53778. }
  53779. module "babylonjs/Meshes/abstractMesh" {
  53780. interface AbstractMesh {
  53781. /**
  53782. * Backing filed
  53783. * @hidden
  53784. */
  53785. __occlusionDataStorage: _OcclusionDataStorage;
  53786. /**
  53787. * Access property
  53788. * @hidden
  53789. */
  53790. _occlusionDataStorage: _OcclusionDataStorage;
  53791. /**
  53792. * 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.
  53793. * The default value is -1 which means don't break the query and wait till the result
  53794. * @see https://doc.babylonjs.com/features/occlusionquery
  53795. */
  53796. occlusionRetryCount: number;
  53797. /**
  53798. * 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:
  53799. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  53800. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  53801. * * 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.
  53802. * @see https://doc.babylonjs.com/features/occlusionquery
  53803. */
  53804. occlusionType: number;
  53805. /**
  53806. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  53807. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  53808. * * 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.
  53809. * @see https://doc.babylonjs.com/features/occlusionquery
  53810. */
  53811. occlusionQueryAlgorithmType: number;
  53812. /**
  53813. * 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
  53814. * @see https://doc.babylonjs.com/features/occlusionquery
  53815. */
  53816. isOccluded: boolean;
  53817. /**
  53818. * Flag to check the progress status of the query
  53819. * @see https://doc.babylonjs.com/features/occlusionquery
  53820. */
  53821. isOcclusionQueryInProgress: boolean;
  53822. }
  53823. }
  53824. }
  53825. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  53826. import { Nullable } from "babylonjs/types";
  53827. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53828. /** @hidden */
  53829. export var _forceTransformFeedbackToBundle: boolean;
  53830. module "babylonjs/Engines/engine" {
  53831. interface Engine {
  53832. /**
  53833. * Creates a webGL transform feedback object
  53834. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  53835. * @returns the webGL transform feedback object
  53836. */
  53837. createTransformFeedback(): WebGLTransformFeedback;
  53838. /**
  53839. * Delete a webGL transform feedback object
  53840. * @param value defines the webGL transform feedback object to delete
  53841. */
  53842. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  53843. /**
  53844. * Bind a webGL transform feedback object to the webgl context
  53845. * @param value defines the webGL transform feedback object to bind
  53846. */
  53847. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  53848. /**
  53849. * Begins a transform feedback operation
  53850. * @param usePoints defines if points or triangles must be used
  53851. */
  53852. beginTransformFeedback(usePoints: boolean): void;
  53853. /**
  53854. * Ends a transform feedback operation
  53855. */
  53856. endTransformFeedback(): void;
  53857. /**
  53858. * Specify the varyings to use with transform feedback
  53859. * @param program defines the associated webGL program
  53860. * @param value defines the list of strings representing the varying names
  53861. */
  53862. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  53863. /**
  53864. * Bind a webGL buffer for a transform feedback operation
  53865. * @param value defines the webGL buffer to bind
  53866. */
  53867. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  53868. }
  53869. }
  53870. }
  53871. declare module "babylonjs/Engines/Extensions/engine.views" {
  53872. import { Camera } from "babylonjs/Cameras/camera";
  53873. import { Nullable } from "babylonjs/types";
  53874. /**
  53875. * Class used to define an additional view for the engine
  53876. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53877. */
  53878. export class EngineView {
  53879. /** Defines the canvas where to render the view */
  53880. target: HTMLCanvasElement;
  53881. /** Defines an optional camera used to render the view (will use active camera else) */
  53882. camera?: Camera;
  53883. }
  53884. module "babylonjs/Engines/engine" {
  53885. interface Engine {
  53886. /**
  53887. * Gets or sets the HTML element to use for attaching events
  53888. */
  53889. inputElement: Nullable<HTMLElement>;
  53890. /**
  53891. * Gets the current engine view
  53892. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53893. */
  53894. activeView: Nullable<EngineView>;
  53895. /** Gets or sets the list of views */
  53896. views: EngineView[];
  53897. /**
  53898. * Register a new child canvas
  53899. * @param canvas defines the canvas to register
  53900. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  53901. * @returns the associated view
  53902. */
  53903. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  53904. /**
  53905. * Remove a registered child canvas
  53906. * @param canvas defines the canvas to remove
  53907. * @returns the current engine
  53908. */
  53909. unRegisterView(canvas: HTMLCanvasElement): Engine;
  53910. }
  53911. }
  53912. }
  53913. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  53914. import { Nullable } from "babylonjs/types";
  53915. module "babylonjs/Engines/engine" {
  53916. interface Engine {
  53917. /** @hidden */
  53918. _excludedCompressedTextures: string[];
  53919. /** @hidden */
  53920. _textureFormatInUse: string;
  53921. /**
  53922. * Gets the list of texture formats supported
  53923. */
  53924. readonly texturesSupported: Array<string>;
  53925. /**
  53926. * Gets the texture format in use
  53927. */
  53928. readonly textureFormatInUse: Nullable<string>;
  53929. /**
  53930. * Set the compressed texture extensions or file names to skip.
  53931. *
  53932. * @param skippedFiles defines the list of those texture files you want to skip
  53933. * Example: [".dds", ".env", "myfile.png"]
  53934. */
  53935. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  53936. /**
  53937. * Set the compressed texture format to use, based on the formats you have, and the formats
  53938. * supported by the hardware / browser.
  53939. *
  53940. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  53941. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  53942. * to API arguments needed to compressed textures. This puts the burden on the container
  53943. * generator to house the arcane code for determining these for current & future formats.
  53944. *
  53945. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  53946. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  53947. *
  53948. * Note: The result of this call is not taken into account when a texture is base64.
  53949. *
  53950. * @param formatsAvailable defines the list of those format families you have created
  53951. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  53952. *
  53953. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  53954. * @returns The extension selected.
  53955. */
  53956. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  53957. }
  53958. }
  53959. }
  53960. declare module "babylonjs/Engines/Extensions/index" {
  53961. export * from "babylonjs/Engines/Extensions/engine.alpha";
  53962. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  53963. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  53964. export * from "babylonjs/Engines/Extensions/engine.multiview";
  53965. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  53966. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  53967. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  53968. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  53969. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  53970. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  53971. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  53972. export * from "babylonjs/Engines/Extensions/engine.webVR";
  53973. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  53974. export * from "babylonjs/Engines/Extensions/engine.views";
  53975. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  53976. import "babylonjs/Engines/Extensions/engine.textureSelector";
  53977. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  53978. }
  53979. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  53980. import { Nullable } from "babylonjs/types";
  53981. /**
  53982. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  53983. */
  53984. export interface CubeMapInfo {
  53985. /**
  53986. * The pixel array for the front face.
  53987. * This is stored in format, left to right, up to down format.
  53988. */
  53989. front: Nullable<ArrayBufferView>;
  53990. /**
  53991. * The pixel array for the back face.
  53992. * This is stored in format, left to right, up to down format.
  53993. */
  53994. back: Nullable<ArrayBufferView>;
  53995. /**
  53996. * The pixel array for the left face.
  53997. * This is stored in format, left to right, up to down format.
  53998. */
  53999. left: Nullable<ArrayBufferView>;
  54000. /**
  54001. * The pixel array for the right face.
  54002. * This is stored in format, left to right, up to down format.
  54003. */
  54004. right: Nullable<ArrayBufferView>;
  54005. /**
  54006. * The pixel array for the up face.
  54007. * This is stored in format, left to right, up to down format.
  54008. */
  54009. up: Nullable<ArrayBufferView>;
  54010. /**
  54011. * The pixel array for the down face.
  54012. * This is stored in format, left to right, up to down format.
  54013. */
  54014. down: Nullable<ArrayBufferView>;
  54015. /**
  54016. * The size of the cubemap stored.
  54017. *
  54018. * Each faces will be size * size pixels.
  54019. */
  54020. size: number;
  54021. /**
  54022. * The format of the texture.
  54023. *
  54024. * RGBA, RGB.
  54025. */
  54026. format: number;
  54027. /**
  54028. * The type of the texture data.
  54029. *
  54030. * UNSIGNED_INT, FLOAT.
  54031. */
  54032. type: number;
  54033. /**
  54034. * Specifies whether the texture is in gamma space.
  54035. */
  54036. gammaSpace: boolean;
  54037. }
  54038. /**
  54039. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54040. */
  54041. export class PanoramaToCubeMapTools {
  54042. private static FACE_LEFT;
  54043. private static FACE_RIGHT;
  54044. private static FACE_FRONT;
  54045. private static FACE_BACK;
  54046. private static FACE_DOWN;
  54047. private static FACE_UP;
  54048. /**
  54049. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54050. *
  54051. * @param float32Array The source data.
  54052. * @param inputWidth The width of the input panorama.
  54053. * @param inputHeight The height of the input panorama.
  54054. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54055. * @return The cubemap data
  54056. */
  54057. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54058. private static CreateCubemapTexture;
  54059. private static CalcProjectionSpherical;
  54060. }
  54061. }
  54062. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54063. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54064. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54065. import { Nullable } from "babylonjs/types";
  54066. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54067. /**
  54068. * Helper class dealing with the extraction of spherical polynomial dataArray
  54069. * from a cube map.
  54070. */
  54071. export class CubeMapToSphericalPolynomialTools {
  54072. private static FileFaces;
  54073. /**
  54074. * Converts a texture to the according Spherical Polynomial data.
  54075. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54076. *
  54077. * @param texture The texture to extract the information from.
  54078. * @return The Spherical Polynomial data.
  54079. */
  54080. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54081. /**
  54082. * Converts a cubemap to the according Spherical Polynomial data.
  54083. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54084. *
  54085. * @param cubeInfo The Cube map to extract the information from.
  54086. * @return The Spherical Polynomial data.
  54087. */
  54088. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54089. }
  54090. }
  54091. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54092. import { Nullable } from "babylonjs/types";
  54093. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54094. module "babylonjs/Materials/Textures/baseTexture" {
  54095. interface BaseTexture {
  54096. /**
  54097. * Get the polynomial representation of the texture data.
  54098. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54099. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54100. */
  54101. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54102. }
  54103. }
  54104. }
  54105. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54106. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54107. /** @hidden */
  54108. export var rgbdEncodePixelShader: {
  54109. name: string;
  54110. shader: string;
  54111. };
  54112. }
  54113. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54114. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54115. /** @hidden */
  54116. export var rgbdDecodePixelShader: {
  54117. name: string;
  54118. shader: string;
  54119. };
  54120. }
  54121. declare module "babylonjs/Misc/environmentTextureTools" {
  54122. import { Nullable } from "babylonjs/types";
  54123. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54124. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54125. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54126. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54127. import "babylonjs/Engines/Extensions/engine.readTexture";
  54128. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54129. import "babylonjs/Shaders/rgbdEncode.fragment";
  54130. import "babylonjs/Shaders/rgbdDecode.fragment";
  54131. /**
  54132. * Raw texture data and descriptor sufficient for WebGL texture upload
  54133. */
  54134. export interface EnvironmentTextureInfo {
  54135. /**
  54136. * Version of the environment map
  54137. */
  54138. version: number;
  54139. /**
  54140. * Width of image
  54141. */
  54142. width: number;
  54143. /**
  54144. * Irradiance information stored in the file.
  54145. */
  54146. irradiance: any;
  54147. /**
  54148. * Specular information stored in the file.
  54149. */
  54150. specular: any;
  54151. }
  54152. /**
  54153. * Defines One Image in the file. It requires only the position in the file
  54154. * as well as the length.
  54155. */
  54156. interface BufferImageData {
  54157. /**
  54158. * Length of the image data.
  54159. */
  54160. length: number;
  54161. /**
  54162. * Position of the data from the null terminator delimiting the end of the JSON.
  54163. */
  54164. position: number;
  54165. }
  54166. /**
  54167. * Defines the specular data enclosed in the file.
  54168. * This corresponds to the version 1 of the data.
  54169. */
  54170. export interface EnvironmentTextureSpecularInfoV1 {
  54171. /**
  54172. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54173. */
  54174. specularDataPosition?: number;
  54175. /**
  54176. * This contains all the images data needed to reconstruct the cubemap.
  54177. */
  54178. mipmaps: Array<BufferImageData>;
  54179. /**
  54180. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54181. */
  54182. lodGenerationScale: number;
  54183. }
  54184. /**
  54185. * Sets of helpers addressing the serialization and deserialization of environment texture
  54186. * stored in a BabylonJS env file.
  54187. * Those files are usually stored as .env files.
  54188. */
  54189. export class EnvironmentTextureTools {
  54190. /**
  54191. * Magic number identifying the env file.
  54192. */
  54193. private static _MagicBytes;
  54194. /**
  54195. * Gets the environment info from an env file.
  54196. * @param data The array buffer containing the .env bytes.
  54197. * @returns the environment file info (the json header) if successfully parsed.
  54198. */
  54199. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54200. /**
  54201. * Creates an environment texture from a loaded cube texture.
  54202. * @param texture defines the cube texture to convert in env file
  54203. * @return a promise containing the environment data if succesfull.
  54204. */
  54205. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54206. /**
  54207. * Creates a JSON representation of the spherical data.
  54208. * @param texture defines the texture containing the polynomials
  54209. * @return the JSON representation of the spherical info
  54210. */
  54211. private static _CreateEnvTextureIrradiance;
  54212. /**
  54213. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54214. * @param data the image data
  54215. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54216. * @return the views described by info providing access to the underlying buffer
  54217. */
  54218. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54219. /**
  54220. * Uploads the texture info contained in the env file to the GPU.
  54221. * @param texture defines the internal texture to upload to
  54222. * @param data defines the data to load
  54223. * @param info defines the texture info retrieved through the GetEnvInfo method
  54224. * @returns a promise
  54225. */
  54226. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54227. private static _OnImageReadyAsync;
  54228. /**
  54229. * Uploads the levels of image data to the GPU.
  54230. * @param texture defines the internal texture to upload to
  54231. * @param imageData defines the array buffer views of image data [mipmap][face]
  54232. * @returns a promise
  54233. */
  54234. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54235. /**
  54236. * Uploads spherical polynomials information to the texture.
  54237. * @param texture defines the texture we are trying to upload the information to
  54238. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54239. */
  54240. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54241. /** @hidden */
  54242. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54243. }
  54244. }
  54245. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54246. /**
  54247. * Class used to inline functions in shader code
  54248. */
  54249. export class ShaderCodeInliner {
  54250. private static readonly _RegexpFindFunctionNameAndType;
  54251. private _sourceCode;
  54252. private _functionDescr;
  54253. private _numMaxIterations;
  54254. /** Gets or sets the token used to mark the functions to inline */
  54255. inlineToken: string;
  54256. /** Gets or sets the debug mode */
  54257. debug: boolean;
  54258. /** Gets the code after the inlining process */
  54259. get code(): string;
  54260. /**
  54261. * Initializes the inliner
  54262. * @param sourceCode shader code source to inline
  54263. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54264. */
  54265. constructor(sourceCode: string, numMaxIterations?: number);
  54266. /**
  54267. * Start the processing of the shader code
  54268. */
  54269. processCode(): void;
  54270. private _collectFunctions;
  54271. private _processInlining;
  54272. private _extractBetweenMarkers;
  54273. private _skipWhitespaces;
  54274. private _removeComments;
  54275. private _replaceFunctionCallsByCode;
  54276. private _findBackward;
  54277. private _escapeRegExp;
  54278. private _replaceNames;
  54279. }
  54280. }
  54281. declare module "babylonjs/Engines/nativeEngine" {
  54282. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54283. import { Engine } from "babylonjs/Engines/engine";
  54284. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54285. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54286. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54287. import { Effect } from "babylonjs/Materials/effect";
  54288. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54289. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54290. import { IColor4Like } from "babylonjs/Maths/math.like";
  54291. import { Scene } from "babylonjs/scene";
  54292. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54293. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54294. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54295. /**
  54296. * Container for accessors for natively-stored mesh data buffers.
  54297. */
  54298. class NativeDataBuffer extends DataBuffer {
  54299. /**
  54300. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54301. */
  54302. nativeIndexBuffer?: any;
  54303. /**
  54304. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54305. */
  54306. nativeVertexBuffer?: any;
  54307. }
  54308. /** @hidden */
  54309. class NativeTexture extends InternalTexture {
  54310. getInternalTexture(): InternalTexture;
  54311. getViewCount(): number;
  54312. }
  54313. /** @hidden */
  54314. export class NativeEngine extends Engine {
  54315. private readonly _native;
  54316. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54317. private readonly INVALID_HANDLE;
  54318. getHardwareScalingLevel(): number;
  54319. constructor();
  54320. dispose(): void;
  54321. /**
  54322. * Can be used to override the current requestAnimationFrame requester.
  54323. * @hidden
  54324. */
  54325. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54326. /**
  54327. * Override default engine behavior.
  54328. * @param color
  54329. * @param backBuffer
  54330. * @param depth
  54331. * @param stencil
  54332. */
  54333. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54334. /**
  54335. * Gets host document
  54336. * @returns the host document object
  54337. */
  54338. getHostDocument(): Nullable<Document>;
  54339. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54340. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54341. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54342. recordVertexArrayObject(vertexBuffers: {
  54343. [key: string]: VertexBuffer;
  54344. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54345. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54346. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54347. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54348. /**
  54349. * Draw a list of indexed primitives
  54350. * @param fillMode defines the primitive to use
  54351. * @param indexStart defines the starting index
  54352. * @param indexCount defines the number of index to draw
  54353. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54354. */
  54355. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54356. /**
  54357. * Draw a list of unindexed primitives
  54358. * @param fillMode defines the primitive to use
  54359. * @param verticesStart defines the index of first vertex to draw
  54360. * @param verticesCount defines the count of vertices to draw
  54361. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54362. */
  54363. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54364. createPipelineContext(): IPipelineContext;
  54365. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54366. /** @hidden */
  54367. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54368. /** @hidden */
  54369. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54370. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54371. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54372. protected _setProgram(program: WebGLProgram): void;
  54373. _releaseEffect(effect: Effect): void;
  54374. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54375. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54376. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54377. bindSamplers(effect: Effect): void;
  54378. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54379. getRenderWidth(useScreen?: boolean): number;
  54380. getRenderHeight(useScreen?: boolean): number;
  54381. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54382. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54383. /**
  54384. * Set the z offset to apply to current rendering
  54385. * @param value defines the offset to apply
  54386. */
  54387. setZOffset(value: number): void;
  54388. /**
  54389. * Gets the current value of the zOffset
  54390. * @returns the current zOffset state
  54391. */
  54392. getZOffset(): number;
  54393. /**
  54394. * Enable or disable depth buffering
  54395. * @param enable defines the state to set
  54396. */
  54397. setDepthBuffer(enable: boolean): void;
  54398. /**
  54399. * Gets a boolean indicating if depth writing is enabled
  54400. * @returns the current depth writing state
  54401. */
  54402. getDepthWrite(): boolean;
  54403. /**
  54404. * Enable or disable depth writing
  54405. * @param enable defines the state to set
  54406. */
  54407. setDepthWrite(enable: boolean): void;
  54408. /**
  54409. * Enable or disable color writing
  54410. * @param enable defines the state to set
  54411. */
  54412. setColorWrite(enable: boolean): void;
  54413. /**
  54414. * Gets a boolean indicating if color writing is enabled
  54415. * @returns the current color writing state
  54416. */
  54417. getColorWrite(): boolean;
  54418. /**
  54419. * Sets alpha constants used by some alpha blending modes
  54420. * @param r defines the red component
  54421. * @param g defines the green component
  54422. * @param b defines the blue component
  54423. * @param a defines the alpha component
  54424. */
  54425. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54426. /**
  54427. * Sets the current alpha mode
  54428. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54429. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54430. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54431. */
  54432. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54433. /**
  54434. * Gets the current alpha mode
  54435. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54436. * @returns the current alpha mode
  54437. */
  54438. getAlphaMode(): number;
  54439. setInt(uniform: WebGLUniformLocation, int: number): void;
  54440. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54441. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54442. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54443. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54444. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54445. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54446. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54447. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54448. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54449. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54450. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54451. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54452. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54453. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54454. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54455. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54456. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54457. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54458. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54459. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54460. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54461. wipeCaches(bruteForce?: boolean): void;
  54462. _createTexture(): WebGLTexture;
  54463. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54464. /**
  54465. * Usually called from Texture.ts.
  54466. * Passed information to create a WebGLTexture
  54467. * @param url defines a value which contains one of the following:
  54468. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54469. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54470. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54471. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54472. * @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)
  54473. * @param scene needed for loading to the correct scene
  54474. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54475. * @param onLoad optional callback to be called upon successful completion
  54476. * @param onError optional callback to be called upon failure
  54477. * @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
  54478. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54479. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54480. * @param forcedExtension defines the extension to use to pick the right loader
  54481. * @param mimeType defines an optional mime type
  54482. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54483. */
  54484. 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;
  54485. /**
  54486. * Creates a cube texture
  54487. * @param rootUrl defines the url where the files to load is located
  54488. * @param scene defines the current scene
  54489. * @param files defines the list of files to load (1 per face)
  54490. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54491. * @param onLoad defines an optional callback raised when the texture is loaded
  54492. * @param onError defines an optional callback raised if there is an issue to load the texture
  54493. * @param format defines the format of the data
  54494. * @param forcedExtension defines the extension to use to pick the right loader
  54495. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54496. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54497. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54498. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54499. * @returns the cube texture as an InternalTexture
  54500. */
  54501. 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;
  54502. private _getSamplingFilter;
  54503. private static _GetNativeTextureFormat;
  54504. createRenderTargetTexture(size: number | {
  54505. width: number;
  54506. height: number;
  54507. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54508. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54509. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54510. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54511. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54512. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54513. /**
  54514. * Updates a dynamic vertex buffer.
  54515. * @param vertexBuffer the vertex buffer to update
  54516. * @param data the data used to update the vertex buffer
  54517. * @param byteOffset the byte offset of the data (optional)
  54518. * @param byteLength the byte length of the data (optional)
  54519. */
  54520. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  54521. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  54522. private _updateAnisotropicLevel;
  54523. private _getAddressMode;
  54524. /** @hidden */
  54525. _bindTexture(channel: number, texture: InternalTexture): void;
  54526. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  54527. releaseEffects(): void;
  54528. /** @hidden */
  54529. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54530. /** @hidden */
  54531. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54532. /** @hidden */
  54533. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54534. /** @hidden */
  54535. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54536. }
  54537. }
  54538. declare module "babylonjs/Engines/index" {
  54539. export * from "babylonjs/Engines/constants";
  54540. export * from "babylonjs/Engines/engineCapabilities";
  54541. export * from "babylonjs/Engines/instancingAttributeInfo";
  54542. export * from "babylonjs/Engines/thinEngine";
  54543. export * from "babylonjs/Engines/engine";
  54544. export * from "babylonjs/Engines/engineStore";
  54545. export * from "babylonjs/Engines/nullEngine";
  54546. export * from "babylonjs/Engines/Extensions/index";
  54547. export * from "babylonjs/Engines/IPipelineContext";
  54548. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  54549. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  54550. export * from "babylonjs/Engines/nativeEngine";
  54551. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  54552. export * from "babylonjs/Engines/performanceConfigurator";
  54553. }
  54554. declare module "babylonjs/Events/clipboardEvents" {
  54555. /**
  54556. * Gather the list of clipboard event types as constants.
  54557. */
  54558. export class ClipboardEventTypes {
  54559. /**
  54560. * The clipboard event is fired when a copy command is active (pressed).
  54561. */
  54562. static readonly COPY: number;
  54563. /**
  54564. * The clipboard event is fired when a cut command is active (pressed).
  54565. */
  54566. static readonly CUT: number;
  54567. /**
  54568. * The clipboard event is fired when a paste command is active (pressed).
  54569. */
  54570. static readonly PASTE: number;
  54571. }
  54572. /**
  54573. * This class is used to store clipboard related info for the onClipboardObservable event.
  54574. */
  54575. export class ClipboardInfo {
  54576. /**
  54577. * Defines the type of event (BABYLON.ClipboardEventTypes)
  54578. */
  54579. type: number;
  54580. /**
  54581. * Defines the related dom event
  54582. */
  54583. event: ClipboardEvent;
  54584. /**
  54585. *Creates an instance of ClipboardInfo.
  54586. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  54587. * @param event Defines the related dom event
  54588. */
  54589. constructor(
  54590. /**
  54591. * Defines the type of event (BABYLON.ClipboardEventTypes)
  54592. */
  54593. type: number,
  54594. /**
  54595. * Defines the related dom event
  54596. */
  54597. event: ClipboardEvent);
  54598. /**
  54599. * Get the clipboard event's type from the keycode.
  54600. * @param keyCode Defines the keyCode for the current keyboard event.
  54601. * @return {number}
  54602. */
  54603. static GetTypeFromCharacter(keyCode: number): number;
  54604. }
  54605. }
  54606. declare module "babylonjs/Events/index" {
  54607. export * from "babylonjs/Events/keyboardEvents";
  54608. export * from "babylonjs/Events/pointerEvents";
  54609. export * from "babylonjs/Events/clipboardEvents";
  54610. }
  54611. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  54612. import { Scene } from "babylonjs/scene";
  54613. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54614. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54615. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54616. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54617. /**
  54618. * Google Daydream controller
  54619. */
  54620. export class DaydreamController extends WebVRController {
  54621. /**
  54622. * Base Url for the controller model.
  54623. */
  54624. static MODEL_BASE_URL: string;
  54625. /**
  54626. * File name for the controller model.
  54627. */
  54628. static MODEL_FILENAME: string;
  54629. /**
  54630. * Gamepad Id prefix used to identify Daydream Controller.
  54631. */
  54632. static readonly GAMEPAD_ID_PREFIX: string;
  54633. /**
  54634. * Creates a new DaydreamController from a gamepad
  54635. * @param vrGamepad the gamepad that the controller should be created from
  54636. */
  54637. constructor(vrGamepad: any);
  54638. /**
  54639. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54640. * @param scene scene in which to add meshes
  54641. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54642. */
  54643. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54644. /**
  54645. * Called once for each button that changed state since the last frame
  54646. * @param buttonIdx Which button index changed
  54647. * @param state New state of the button
  54648. * @param changes Which properties on the state changed since last frame
  54649. */
  54650. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54651. }
  54652. }
  54653. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  54654. import { Scene } from "babylonjs/scene";
  54655. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54656. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54657. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54658. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54659. /**
  54660. * Gear VR Controller
  54661. */
  54662. export class GearVRController extends WebVRController {
  54663. /**
  54664. * Base Url for the controller model.
  54665. */
  54666. static MODEL_BASE_URL: string;
  54667. /**
  54668. * File name for the controller model.
  54669. */
  54670. static MODEL_FILENAME: string;
  54671. /**
  54672. * Gamepad Id prefix used to identify this controller.
  54673. */
  54674. static readonly GAMEPAD_ID_PREFIX: string;
  54675. private readonly _buttonIndexToObservableNameMap;
  54676. /**
  54677. * Creates a new GearVRController from a gamepad
  54678. * @param vrGamepad the gamepad that the controller should be created from
  54679. */
  54680. constructor(vrGamepad: any);
  54681. /**
  54682. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54683. * @param scene scene in which to add meshes
  54684. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54685. */
  54686. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54687. /**
  54688. * Called once for each button that changed state since the last frame
  54689. * @param buttonIdx Which button index changed
  54690. * @param state New state of the button
  54691. * @param changes Which properties on the state changed since last frame
  54692. */
  54693. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54694. }
  54695. }
  54696. declare module "babylonjs/Gamepads/Controllers/genericController" {
  54697. import { Scene } from "babylonjs/scene";
  54698. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54699. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54700. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54701. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54702. /**
  54703. * Generic Controller
  54704. */
  54705. export class GenericController extends WebVRController {
  54706. /**
  54707. * Base Url for the controller model.
  54708. */
  54709. static readonly MODEL_BASE_URL: string;
  54710. /**
  54711. * File name for the controller model.
  54712. */
  54713. static readonly MODEL_FILENAME: string;
  54714. /**
  54715. * Creates a new GenericController from a gamepad
  54716. * @param vrGamepad the gamepad that the controller should be created from
  54717. */
  54718. constructor(vrGamepad: any);
  54719. /**
  54720. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54721. * @param scene scene in which to add meshes
  54722. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54723. */
  54724. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54725. /**
  54726. * Called once for each button that changed state since the last frame
  54727. * @param buttonIdx Which button index changed
  54728. * @param state New state of the button
  54729. * @param changes Which properties on the state changed since last frame
  54730. */
  54731. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54732. }
  54733. }
  54734. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  54735. import { Observable } from "babylonjs/Misc/observable";
  54736. import { Scene } from "babylonjs/scene";
  54737. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54738. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54739. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54740. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54741. /**
  54742. * Oculus Touch Controller
  54743. */
  54744. export class OculusTouchController extends WebVRController {
  54745. /**
  54746. * Base Url for the controller model.
  54747. */
  54748. static MODEL_BASE_URL: string;
  54749. /**
  54750. * File name for the left controller model.
  54751. */
  54752. static MODEL_LEFT_FILENAME: string;
  54753. /**
  54754. * File name for the right controller model.
  54755. */
  54756. static MODEL_RIGHT_FILENAME: string;
  54757. /**
  54758. * Base Url for the Quest controller model.
  54759. */
  54760. static QUEST_MODEL_BASE_URL: string;
  54761. /**
  54762. * @hidden
  54763. * If the controllers are running on a device that needs the updated Quest controller models
  54764. */
  54765. static _IsQuest: boolean;
  54766. /**
  54767. * Fired when the secondary trigger on this controller is modified
  54768. */
  54769. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  54770. /**
  54771. * Fired when the thumb rest on this controller is modified
  54772. */
  54773. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  54774. /**
  54775. * Creates a new OculusTouchController from a gamepad
  54776. * @param vrGamepad the gamepad that the controller should be created from
  54777. */
  54778. constructor(vrGamepad: any);
  54779. /**
  54780. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54781. * @param scene scene in which to add meshes
  54782. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54783. */
  54784. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54785. /**
  54786. * Fired when the A button on this controller is modified
  54787. */
  54788. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54789. /**
  54790. * Fired when the B button on this controller is modified
  54791. */
  54792. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54793. /**
  54794. * Fired when the X button on this controller is modified
  54795. */
  54796. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54797. /**
  54798. * Fired when the Y button on this controller is modified
  54799. */
  54800. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54801. /**
  54802. * Called once for each button that changed state since the last frame
  54803. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  54804. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  54805. * 2) secondary trigger (same)
  54806. * 3) A (right) X (left), touch, pressed = value
  54807. * 4) B / Y
  54808. * 5) thumb rest
  54809. * @param buttonIdx Which button index changed
  54810. * @param state New state of the button
  54811. * @param changes Which properties on the state changed since last frame
  54812. */
  54813. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54814. }
  54815. }
  54816. declare module "babylonjs/Gamepads/Controllers/viveController" {
  54817. import { Scene } from "babylonjs/scene";
  54818. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54819. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54820. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54821. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54822. import { Observable } from "babylonjs/Misc/observable";
  54823. /**
  54824. * Vive Controller
  54825. */
  54826. export class ViveController extends WebVRController {
  54827. /**
  54828. * Base Url for the controller model.
  54829. */
  54830. static MODEL_BASE_URL: string;
  54831. /**
  54832. * File name for the controller model.
  54833. */
  54834. static MODEL_FILENAME: string;
  54835. /**
  54836. * Creates a new ViveController from a gamepad
  54837. * @param vrGamepad the gamepad that the controller should be created from
  54838. */
  54839. constructor(vrGamepad: any);
  54840. /**
  54841. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54842. * @param scene scene in which to add meshes
  54843. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54844. */
  54845. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54846. /**
  54847. * Fired when the left button on this controller is modified
  54848. */
  54849. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54850. /**
  54851. * Fired when the right button on this controller is modified
  54852. */
  54853. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54854. /**
  54855. * Fired when the menu button on this controller is modified
  54856. */
  54857. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54858. /**
  54859. * Called once for each button that changed state since the last frame
  54860. * Vive mapping:
  54861. * 0: touchpad
  54862. * 1: trigger
  54863. * 2: left AND right buttons
  54864. * 3: menu button
  54865. * @param buttonIdx Which button index changed
  54866. * @param state New state of the button
  54867. * @param changes Which properties on the state changed since last frame
  54868. */
  54869. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54870. }
  54871. }
  54872. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  54873. import { Observable } from "babylonjs/Misc/observable";
  54874. import { Scene } from "babylonjs/scene";
  54875. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54876. import { Ray } from "babylonjs/Culling/ray";
  54877. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54878. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54879. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54880. /**
  54881. * Defines the WindowsMotionController object that the state of the windows motion controller
  54882. */
  54883. export class WindowsMotionController extends WebVRController {
  54884. /**
  54885. * The base url used to load the left and right controller models
  54886. */
  54887. static MODEL_BASE_URL: string;
  54888. /**
  54889. * The name of the left controller model file
  54890. */
  54891. static MODEL_LEFT_FILENAME: string;
  54892. /**
  54893. * The name of the right controller model file
  54894. */
  54895. static MODEL_RIGHT_FILENAME: string;
  54896. /**
  54897. * The controller name prefix for this controller type
  54898. */
  54899. static readonly GAMEPAD_ID_PREFIX: string;
  54900. /**
  54901. * The controller id pattern for this controller type
  54902. */
  54903. private static readonly GAMEPAD_ID_PATTERN;
  54904. private _loadedMeshInfo;
  54905. protected readonly _mapping: {
  54906. buttons: string[];
  54907. buttonMeshNames: {
  54908. trigger: string;
  54909. menu: string;
  54910. grip: string;
  54911. thumbstick: string;
  54912. trackpad: string;
  54913. };
  54914. buttonObservableNames: {
  54915. trigger: string;
  54916. menu: string;
  54917. grip: string;
  54918. thumbstick: string;
  54919. trackpad: string;
  54920. };
  54921. axisMeshNames: string[];
  54922. pointingPoseMeshName: string;
  54923. };
  54924. /**
  54925. * Fired when the trackpad on this controller is clicked
  54926. */
  54927. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  54928. /**
  54929. * Fired when the trackpad on this controller is modified
  54930. */
  54931. onTrackpadValuesChangedObservable: Observable<StickValues>;
  54932. /**
  54933. * The current x and y values of this controller's trackpad
  54934. */
  54935. trackpad: StickValues;
  54936. /**
  54937. * Creates a new WindowsMotionController from a gamepad
  54938. * @param vrGamepad the gamepad that the controller should be created from
  54939. */
  54940. constructor(vrGamepad: any);
  54941. /**
  54942. * Fired when the trigger on this controller is modified
  54943. */
  54944. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54945. /**
  54946. * Fired when the menu button on this controller is modified
  54947. */
  54948. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54949. /**
  54950. * Fired when the grip button on this controller is modified
  54951. */
  54952. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54953. /**
  54954. * Fired when the thumbstick button on this controller is modified
  54955. */
  54956. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54957. /**
  54958. * Fired when the touchpad button on this controller is modified
  54959. */
  54960. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54961. /**
  54962. * Fired when the touchpad values on this controller are modified
  54963. */
  54964. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  54965. protected _updateTrackpad(): void;
  54966. /**
  54967. * Called once per frame by the engine.
  54968. */
  54969. update(): void;
  54970. /**
  54971. * Called once for each button that changed state since the last frame
  54972. * @param buttonIdx Which button index changed
  54973. * @param state New state of the button
  54974. * @param changes Which properties on the state changed since last frame
  54975. */
  54976. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54977. /**
  54978. * Moves the buttons on the controller mesh based on their current state
  54979. * @param buttonName the name of the button to move
  54980. * @param buttonValue the value of the button which determines the buttons new position
  54981. */
  54982. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  54983. /**
  54984. * Moves the axis on the controller mesh based on its current state
  54985. * @param axis the index of the axis
  54986. * @param axisValue the value of the axis which determines the meshes new position
  54987. * @hidden
  54988. */
  54989. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  54990. /**
  54991. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54992. * @param scene scene in which to add meshes
  54993. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54994. */
  54995. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  54996. /**
  54997. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  54998. * can be transformed by button presses and axes values, based on this._mapping.
  54999. *
  55000. * @param scene scene in which the meshes exist
  55001. * @param meshes list of meshes that make up the controller model to process
  55002. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55003. */
  55004. private processModel;
  55005. private createMeshInfo;
  55006. /**
  55007. * Gets the ray of the controller in the direction the controller is pointing
  55008. * @param length the length the resulting ray should be
  55009. * @returns a ray in the direction the controller is pointing
  55010. */
  55011. getForwardRay(length?: number): Ray;
  55012. /**
  55013. * Disposes of the controller
  55014. */
  55015. dispose(): void;
  55016. }
  55017. /**
  55018. * This class represents a new windows motion controller in XR.
  55019. */
  55020. export class XRWindowsMotionController extends WindowsMotionController {
  55021. /**
  55022. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55023. */
  55024. protected readonly _mapping: {
  55025. buttons: string[];
  55026. buttonMeshNames: {
  55027. trigger: string;
  55028. menu: string;
  55029. grip: string;
  55030. thumbstick: string;
  55031. trackpad: string;
  55032. };
  55033. buttonObservableNames: {
  55034. trigger: string;
  55035. menu: string;
  55036. grip: string;
  55037. thumbstick: string;
  55038. trackpad: string;
  55039. };
  55040. axisMeshNames: string[];
  55041. pointingPoseMeshName: string;
  55042. };
  55043. /**
  55044. * Construct a new XR-Based windows motion controller
  55045. *
  55046. * @param gamepadInfo the gamepad object from the browser
  55047. */
  55048. constructor(gamepadInfo: any);
  55049. /**
  55050. * holds the thumbstick values (X,Y)
  55051. */
  55052. thumbstickValues: StickValues;
  55053. /**
  55054. * Fired when the thumbstick on this controller is clicked
  55055. */
  55056. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55057. /**
  55058. * Fired when the thumbstick on this controller is modified
  55059. */
  55060. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55061. /**
  55062. * Fired when the touchpad button on this controller is modified
  55063. */
  55064. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55065. /**
  55066. * Fired when the touchpad values on this controller are modified
  55067. */
  55068. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55069. /**
  55070. * Fired when the thumbstick button on this controller is modified
  55071. * here to prevent breaking changes
  55072. */
  55073. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55074. /**
  55075. * updating the thumbstick(!) and not the trackpad.
  55076. * This is named this way due to the difference between WebVR and XR and to avoid
  55077. * changing the parent class.
  55078. */
  55079. protected _updateTrackpad(): void;
  55080. /**
  55081. * Disposes the class with joy
  55082. */
  55083. dispose(): void;
  55084. }
  55085. }
  55086. declare module "babylonjs/Gamepads/Controllers/index" {
  55087. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55088. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55089. export * from "babylonjs/Gamepads/Controllers/genericController";
  55090. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55091. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55092. export * from "babylonjs/Gamepads/Controllers/viveController";
  55093. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55094. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55095. }
  55096. declare module "babylonjs/Gamepads/index" {
  55097. export * from "babylonjs/Gamepads/Controllers/index";
  55098. export * from "babylonjs/Gamepads/gamepad";
  55099. export * from "babylonjs/Gamepads/gamepadManager";
  55100. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55101. export * from "babylonjs/Gamepads/xboxGamepad";
  55102. export * from "babylonjs/Gamepads/dualShockGamepad";
  55103. }
  55104. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55105. import { Scene } from "babylonjs/scene";
  55106. import { Vector4 } from "babylonjs/Maths/math.vector";
  55107. import { Color4 } from "babylonjs/Maths/math.color";
  55108. import { Mesh } from "babylonjs/Meshes/mesh";
  55109. import { Nullable } from "babylonjs/types";
  55110. /**
  55111. * Class containing static functions to help procedurally build meshes
  55112. */
  55113. export class PolyhedronBuilder {
  55114. /**
  55115. * Creates a polyhedron mesh
  55116. * * 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
  55117. * * The parameter `size` (positive float, default 1) sets the polygon size
  55118. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55119. * * 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`
  55120. * * 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
  55121. * * 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)`)
  55122. * * 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
  55123. * * 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
  55124. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55125. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55126. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55127. * @param name defines the name of the mesh
  55128. * @param options defines the options used to create the mesh
  55129. * @param scene defines the hosting scene
  55130. * @returns the polyhedron mesh
  55131. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55132. */
  55133. static CreatePolyhedron(name: string, options: {
  55134. type?: number;
  55135. size?: number;
  55136. sizeX?: number;
  55137. sizeY?: number;
  55138. sizeZ?: number;
  55139. custom?: any;
  55140. faceUV?: Vector4[];
  55141. faceColors?: Color4[];
  55142. flat?: boolean;
  55143. updatable?: boolean;
  55144. sideOrientation?: number;
  55145. frontUVs?: Vector4;
  55146. backUVs?: Vector4;
  55147. }, scene?: Nullable<Scene>): Mesh;
  55148. }
  55149. }
  55150. declare module "babylonjs/Gizmos/scaleGizmo" {
  55151. import { Observable } from "babylonjs/Misc/observable";
  55152. import { Nullable } from "babylonjs/types";
  55153. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55154. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55155. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55156. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55157. import { Node } from "babylonjs/node";
  55158. /**
  55159. * Gizmo that enables scaling a mesh along 3 axis
  55160. */
  55161. export class ScaleGizmo extends Gizmo {
  55162. /**
  55163. * Internal gizmo used for interactions on the x axis
  55164. */
  55165. xGizmo: AxisScaleGizmo;
  55166. /**
  55167. * Internal gizmo used for interactions on the y axis
  55168. */
  55169. yGizmo: AxisScaleGizmo;
  55170. /**
  55171. * Internal gizmo used for interactions on the z axis
  55172. */
  55173. zGizmo: AxisScaleGizmo;
  55174. /**
  55175. * Internal gizmo used to scale all axis equally
  55176. */
  55177. uniformScaleGizmo: AxisScaleGizmo;
  55178. private _meshAttached;
  55179. private _nodeAttached;
  55180. private _updateGizmoRotationToMatchAttachedMesh;
  55181. private _snapDistance;
  55182. private _scaleRatio;
  55183. private _uniformScalingMesh;
  55184. private _octahedron;
  55185. private _sensitivity;
  55186. /** Fires an event when any of it's sub gizmos are dragged */
  55187. onDragStartObservable: Observable<unknown>;
  55188. /** Fires an event when any of it's sub gizmos are released from dragging */
  55189. onDragEndObservable: Observable<unknown>;
  55190. get attachedMesh(): Nullable<AbstractMesh>;
  55191. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55192. get attachedNode(): Nullable<Node>;
  55193. set attachedNode(node: Nullable<Node>);
  55194. /**
  55195. * Creates a ScaleGizmo
  55196. * @param gizmoLayer The utility layer the gizmo will be added to
  55197. * @param thickness display gizmo axis thickness
  55198. */
  55199. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55200. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55201. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55202. /**
  55203. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55204. */
  55205. set snapDistance(value: number);
  55206. get snapDistance(): number;
  55207. /**
  55208. * Ratio for the scale of the gizmo (Default: 1)
  55209. */
  55210. set scaleRatio(value: number);
  55211. get scaleRatio(): number;
  55212. /**
  55213. * Sensitivity factor for dragging (Default: 1)
  55214. */
  55215. set sensitivity(value: number);
  55216. get sensitivity(): number;
  55217. /**
  55218. * Disposes of the gizmo
  55219. */
  55220. dispose(): void;
  55221. }
  55222. }
  55223. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55224. import { Observable } from "babylonjs/Misc/observable";
  55225. import { Nullable } from "babylonjs/types";
  55226. import { Vector3 } from "babylonjs/Maths/math.vector";
  55227. import { Node } from "babylonjs/node";
  55228. import { Mesh } from "babylonjs/Meshes/mesh";
  55229. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55230. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55231. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55232. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55233. import { Color3 } from "babylonjs/Maths/math.color";
  55234. /**
  55235. * Single axis scale gizmo
  55236. */
  55237. export class AxisScaleGizmo extends Gizmo {
  55238. /**
  55239. * Drag behavior responsible for the gizmos dragging interactions
  55240. */
  55241. dragBehavior: PointerDragBehavior;
  55242. private _pointerObserver;
  55243. /**
  55244. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55245. */
  55246. snapDistance: number;
  55247. /**
  55248. * Event that fires each time the gizmo snaps to a new location.
  55249. * * snapDistance is the the change in distance
  55250. */
  55251. onSnapObservable: Observable<{
  55252. snapDistance: number;
  55253. }>;
  55254. /**
  55255. * If the scaling operation should be done on all axis (default: false)
  55256. */
  55257. uniformScaling: boolean;
  55258. /**
  55259. * Custom sensitivity value for the drag strength
  55260. */
  55261. sensitivity: number;
  55262. private _isEnabled;
  55263. private _parent;
  55264. private _arrow;
  55265. private _coloredMaterial;
  55266. private _hoverMaterial;
  55267. /**
  55268. * Creates an AxisScaleGizmo
  55269. * @param gizmoLayer The utility layer the gizmo will be added to
  55270. * @param dragAxis The axis which the gizmo will be able to scale on
  55271. * @param color The color of the gizmo
  55272. * @param thickness display gizmo axis thickness
  55273. */
  55274. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55275. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55276. /**
  55277. * If the gizmo is enabled
  55278. */
  55279. set isEnabled(value: boolean);
  55280. get isEnabled(): boolean;
  55281. /**
  55282. * Disposes of the gizmo
  55283. */
  55284. dispose(): void;
  55285. /**
  55286. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55287. * @param mesh The mesh to replace the default mesh of the gizmo
  55288. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55289. */
  55290. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55291. }
  55292. }
  55293. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55294. import { Observable } from "babylonjs/Misc/observable";
  55295. import { Nullable } from "babylonjs/types";
  55296. import { Vector3 } from "babylonjs/Maths/math.vector";
  55297. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55298. import { Mesh } from "babylonjs/Meshes/mesh";
  55299. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55300. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55301. import { Color3 } from "babylonjs/Maths/math.color";
  55302. import "babylonjs/Meshes/Builders/boxBuilder";
  55303. /**
  55304. * Bounding box gizmo
  55305. */
  55306. export class BoundingBoxGizmo extends Gizmo {
  55307. private _lineBoundingBox;
  55308. private _rotateSpheresParent;
  55309. private _scaleBoxesParent;
  55310. private _boundingDimensions;
  55311. private _renderObserver;
  55312. private _pointerObserver;
  55313. private _scaleDragSpeed;
  55314. private _tmpQuaternion;
  55315. private _tmpVector;
  55316. private _tmpRotationMatrix;
  55317. /**
  55318. * 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)
  55319. */
  55320. ignoreChildren: boolean;
  55321. /**
  55322. * 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)
  55323. */
  55324. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55325. /**
  55326. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55327. */
  55328. rotationSphereSize: number;
  55329. /**
  55330. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55331. */
  55332. scaleBoxSize: number;
  55333. /**
  55334. * 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)
  55335. */
  55336. fixedDragMeshScreenSize: boolean;
  55337. /**
  55338. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55339. */
  55340. fixedDragMeshScreenSizeDistanceFactor: number;
  55341. /**
  55342. * Fired when a rotation sphere or scale box is dragged
  55343. */
  55344. onDragStartObservable: Observable<{}>;
  55345. /**
  55346. * Fired when a scale box is dragged
  55347. */
  55348. onScaleBoxDragObservable: Observable<{}>;
  55349. /**
  55350. * Fired when a scale box drag is ended
  55351. */
  55352. onScaleBoxDragEndObservable: Observable<{}>;
  55353. /**
  55354. * Fired when a rotation sphere is dragged
  55355. */
  55356. onRotationSphereDragObservable: Observable<{}>;
  55357. /**
  55358. * Fired when a rotation sphere drag is ended
  55359. */
  55360. onRotationSphereDragEndObservable: Observable<{}>;
  55361. /**
  55362. * 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)
  55363. */
  55364. scalePivot: Nullable<Vector3>;
  55365. /**
  55366. * Mesh used as a pivot to rotate the attached node
  55367. */
  55368. private _anchorMesh;
  55369. private _existingMeshScale;
  55370. private _dragMesh;
  55371. private pointerDragBehavior;
  55372. private coloredMaterial;
  55373. private hoverColoredMaterial;
  55374. /**
  55375. * Sets the color of the bounding box gizmo
  55376. * @param color the color to set
  55377. */
  55378. setColor(color: Color3): void;
  55379. /**
  55380. * Creates an BoundingBoxGizmo
  55381. * @param gizmoLayer The utility layer the gizmo will be added to
  55382. * @param color The color of the gizmo
  55383. */
  55384. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55385. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55386. private _selectNode;
  55387. /**
  55388. * Updates the bounding box information for the Gizmo
  55389. */
  55390. updateBoundingBox(): void;
  55391. private _updateRotationSpheres;
  55392. private _updateScaleBoxes;
  55393. /**
  55394. * Enables rotation on the specified axis and disables rotation on the others
  55395. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55396. */
  55397. setEnabledRotationAxis(axis: string): void;
  55398. /**
  55399. * Enables/disables scaling
  55400. * @param enable if scaling should be enabled
  55401. * @param homogeneousScaling defines if scaling should only be homogeneous
  55402. */
  55403. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55404. private _updateDummy;
  55405. /**
  55406. * Enables a pointer drag behavior on the bounding box of the gizmo
  55407. */
  55408. enableDragBehavior(): void;
  55409. /**
  55410. * Disposes of the gizmo
  55411. */
  55412. dispose(): void;
  55413. /**
  55414. * 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)
  55415. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55416. * @returns the bounding box mesh with the passed in mesh as a child
  55417. */
  55418. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55419. /**
  55420. * CustomMeshes are not supported by this gizmo
  55421. * @param mesh The mesh to replace the default mesh of the gizmo
  55422. */
  55423. setCustomMesh(mesh: Mesh): void;
  55424. }
  55425. }
  55426. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55427. import { Observable } from "babylonjs/Misc/observable";
  55428. import { Nullable } from "babylonjs/types";
  55429. import { Vector3 } from "babylonjs/Maths/math.vector";
  55430. import { Color3 } from "babylonjs/Maths/math.color";
  55431. import { Node } from "babylonjs/node";
  55432. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55433. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55434. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55435. import "babylonjs/Meshes/Builders/linesBuilder";
  55436. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55437. /**
  55438. * Single plane rotation gizmo
  55439. */
  55440. export class PlaneRotationGizmo extends Gizmo {
  55441. /**
  55442. * Drag behavior responsible for the gizmos dragging interactions
  55443. */
  55444. dragBehavior: PointerDragBehavior;
  55445. private _pointerObserver;
  55446. /**
  55447. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55448. */
  55449. snapDistance: number;
  55450. /**
  55451. * Event that fires each time the gizmo snaps to a new location.
  55452. * * snapDistance is the the change in distance
  55453. */
  55454. onSnapObservable: Observable<{
  55455. snapDistance: number;
  55456. }>;
  55457. private _isEnabled;
  55458. private _parent;
  55459. /**
  55460. * Creates a PlaneRotationGizmo
  55461. * @param gizmoLayer The utility layer the gizmo will be added to
  55462. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55463. * @param color The color of the gizmo
  55464. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55465. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55466. * @param thickness display gizmo axis thickness
  55467. */
  55468. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55469. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55470. /**
  55471. * If the gizmo is enabled
  55472. */
  55473. set isEnabled(value: boolean);
  55474. get isEnabled(): boolean;
  55475. /**
  55476. * Disposes of the gizmo
  55477. */
  55478. dispose(): void;
  55479. }
  55480. }
  55481. declare module "babylonjs/Gizmos/rotationGizmo" {
  55482. import { Observable } from "babylonjs/Misc/observable";
  55483. import { Nullable } from "babylonjs/types";
  55484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55485. import { Mesh } from "babylonjs/Meshes/mesh";
  55486. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55487. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55488. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55489. import { Node } from "babylonjs/node";
  55490. /**
  55491. * Gizmo that enables rotating a mesh along 3 axis
  55492. */
  55493. export class RotationGizmo extends Gizmo {
  55494. /**
  55495. * Internal gizmo used for interactions on the x axis
  55496. */
  55497. xGizmo: PlaneRotationGizmo;
  55498. /**
  55499. * Internal gizmo used for interactions on the y axis
  55500. */
  55501. yGizmo: PlaneRotationGizmo;
  55502. /**
  55503. * Internal gizmo used for interactions on the z axis
  55504. */
  55505. zGizmo: PlaneRotationGizmo;
  55506. /** Fires an event when any of it's sub gizmos are dragged */
  55507. onDragStartObservable: Observable<unknown>;
  55508. /** Fires an event when any of it's sub gizmos are released from dragging */
  55509. onDragEndObservable: Observable<unknown>;
  55510. private _meshAttached;
  55511. private _nodeAttached;
  55512. get attachedMesh(): Nullable<AbstractMesh>;
  55513. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55514. get attachedNode(): Nullable<Node>;
  55515. set attachedNode(node: Nullable<Node>);
  55516. /**
  55517. * Creates a RotationGizmo
  55518. * @param gizmoLayer The utility layer the gizmo will be added to
  55519. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55520. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55521. * @param thickness display gizmo axis thickness
  55522. */
  55523. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  55524. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55525. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55526. /**
  55527. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55528. */
  55529. set snapDistance(value: number);
  55530. get snapDistance(): number;
  55531. /**
  55532. * Ratio for the scale of the gizmo (Default: 1)
  55533. */
  55534. set scaleRatio(value: number);
  55535. get scaleRatio(): number;
  55536. /**
  55537. * Disposes of the gizmo
  55538. */
  55539. dispose(): void;
  55540. /**
  55541. * CustomMeshes are not supported by this gizmo
  55542. * @param mesh The mesh to replace the default mesh of the gizmo
  55543. */
  55544. setCustomMesh(mesh: Mesh): void;
  55545. }
  55546. }
  55547. declare module "babylonjs/Gizmos/gizmoManager" {
  55548. import { Observable } from "babylonjs/Misc/observable";
  55549. import { Nullable } from "babylonjs/types";
  55550. import { Scene, IDisposable } from "babylonjs/scene";
  55551. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55552. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55553. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  55554. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55555. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  55556. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55557. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  55558. /**
  55559. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  55560. */
  55561. export class GizmoManager implements IDisposable {
  55562. private scene;
  55563. /**
  55564. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  55565. */
  55566. gizmos: {
  55567. positionGizmo: Nullable<PositionGizmo>;
  55568. rotationGizmo: Nullable<RotationGizmo>;
  55569. scaleGizmo: Nullable<ScaleGizmo>;
  55570. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  55571. };
  55572. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  55573. clearGizmoOnEmptyPointerEvent: boolean;
  55574. /** Fires an event when the manager is attached to a mesh */
  55575. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  55576. private _gizmosEnabled;
  55577. private _pointerObserver;
  55578. private _attachedMesh;
  55579. private _boundingBoxColor;
  55580. private _defaultUtilityLayer;
  55581. private _defaultKeepDepthUtilityLayer;
  55582. private _thickness;
  55583. /**
  55584. * When bounding box gizmo is enabled, this can be used to track drag/end events
  55585. */
  55586. boundingBoxDragBehavior: SixDofDragBehavior;
  55587. /**
  55588. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  55589. */
  55590. attachableMeshes: Nullable<Array<AbstractMesh>>;
  55591. /**
  55592. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  55593. */
  55594. usePointerToAttachGizmos: boolean;
  55595. /**
  55596. * Utility layer that the bounding box gizmo belongs to
  55597. */
  55598. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  55599. /**
  55600. * Utility layer that all gizmos besides bounding box belong to
  55601. */
  55602. get utilityLayer(): UtilityLayerRenderer;
  55603. /**
  55604. * Instatiates a gizmo manager
  55605. * @param scene the scene to overlay the gizmos on top of
  55606. * @param thickness display gizmo axis thickness
  55607. */
  55608. constructor(scene: Scene, thickness?: number);
  55609. /**
  55610. * Attaches a set of gizmos to the specified mesh
  55611. * @param mesh The mesh the gizmo's should be attached to
  55612. */
  55613. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  55614. /**
  55615. * If the position gizmo is enabled
  55616. */
  55617. set positionGizmoEnabled(value: boolean);
  55618. get positionGizmoEnabled(): boolean;
  55619. /**
  55620. * If the rotation gizmo is enabled
  55621. */
  55622. set rotationGizmoEnabled(value: boolean);
  55623. get rotationGizmoEnabled(): boolean;
  55624. /**
  55625. * If the scale gizmo is enabled
  55626. */
  55627. set scaleGizmoEnabled(value: boolean);
  55628. get scaleGizmoEnabled(): boolean;
  55629. /**
  55630. * If the boundingBox gizmo is enabled
  55631. */
  55632. set boundingBoxGizmoEnabled(value: boolean);
  55633. get boundingBoxGizmoEnabled(): boolean;
  55634. /**
  55635. * Disposes of the gizmo manager
  55636. */
  55637. dispose(): void;
  55638. }
  55639. }
  55640. declare module "babylonjs/Lights/directionalLight" {
  55641. import { Camera } from "babylonjs/Cameras/camera";
  55642. import { Scene } from "babylonjs/scene";
  55643. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55644. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55645. import { Light } from "babylonjs/Lights/light";
  55646. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55647. import { Effect } from "babylonjs/Materials/effect";
  55648. /**
  55649. * A directional light is defined by a direction (what a surprise!).
  55650. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  55651. * 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.
  55652. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55653. */
  55654. export class DirectionalLight extends ShadowLight {
  55655. private _shadowFrustumSize;
  55656. /**
  55657. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  55658. */
  55659. get shadowFrustumSize(): number;
  55660. /**
  55661. * Specifies a fix frustum size for the shadow generation.
  55662. */
  55663. set shadowFrustumSize(value: number);
  55664. private _shadowOrthoScale;
  55665. /**
  55666. * Gets the shadow projection scale against the optimal computed one.
  55667. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55668. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55669. */
  55670. get shadowOrthoScale(): number;
  55671. /**
  55672. * Sets the shadow projection scale against the optimal computed one.
  55673. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55674. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55675. */
  55676. set shadowOrthoScale(value: number);
  55677. /**
  55678. * Automatically compute the projection matrix to best fit (including all the casters)
  55679. * on each frame.
  55680. */
  55681. autoUpdateExtends: boolean;
  55682. /**
  55683. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  55684. * on each frame. autoUpdateExtends must be set to true for this to work
  55685. */
  55686. autoCalcShadowZBounds: boolean;
  55687. private _orthoLeft;
  55688. private _orthoRight;
  55689. private _orthoTop;
  55690. private _orthoBottom;
  55691. /**
  55692. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  55693. * The directional light is emitted from everywhere in the given direction.
  55694. * It can cast shadows.
  55695. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55696. * @param name The friendly name of the light
  55697. * @param direction The direction of the light
  55698. * @param scene The scene the light belongs to
  55699. */
  55700. constructor(name: string, direction: Vector3, scene: Scene);
  55701. /**
  55702. * Returns the string "DirectionalLight".
  55703. * @return The class name
  55704. */
  55705. getClassName(): string;
  55706. /**
  55707. * Returns the integer 1.
  55708. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55709. */
  55710. getTypeID(): number;
  55711. /**
  55712. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  55713. * Returns the DirectionalLight Shadow projection matrix.
  55714. */
  55715. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55716. /**
  55717. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  55718. * Returns the DirectionalLight Shadow projection matrix.
  55719. */
  55720. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  55721. /**
  55722. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  55723. * Returns the DirectionalLight Shadow projection matrix.
  55724. */
  55725. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55726. protected _buildUniformLayout(): void;
  55727. /**
  55728. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  55729. * @param effect The effect to update
  55730. * @param lightIndex The index of the light in the effect to update
  55731. * @returns The directional light
  55732. */
  55733. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  55734. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  55735. /**
  55736. * Gets the minZ used for shadow according to both the scene and the light.
  55737. *
  55738. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55739. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55740. * @param activeCamera The camera we are returning the min for
  55741. * @returns the depth min z
  55742. */
  55743. getDepthMinZ(activeCamera: Camera): number;
  55744. /**
  55745. * Gets the maxZ used for shadow according to both the scene and the light.
  55746. *
  55747. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55748. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55749. * @param activeCamera The camera we are returning the max for
  55750. * @returns the depth max z
  55751. */
  55752. getDepthMaxZ(activeCamera: Camera): number;
  55753. /**
  55754. * Prepares the list of defines specific to the light type.
  55755. * @param defines the list of defines
  55756. * @param lightIndex defines the index of the light for the effect
  55757. */
  55758. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55759. }
  55760. }
  55761. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  55762. import { Mesh } from "babylonjs/Meshes/mesh";
  55763. /**
  55764. * Class containing static functions to help procedurally build meshes
  55765. */
  55766. export class HemisphereBuilder {
  55767. /**
  55768. * Creates a hemisphere mesh
  55769. * @param name defines the name of the mesh
  55770. * @param options defines the options used to create the mesh
  55771. * @param scene defines the hosting scene
  55772. * @returns the hemisphere mesh
  55773. */
  55774. static CreateHemisphere(name: string, options: {
  55775. segments?: number;
  55776. diameter?: number;
  55777. sideOrientation?: number;
  55778. }, scene: any): Mesh;
  55779. }
  55780. }
  55781. declare module "babylonjs/Lights/spotLight" {
  55782. import { Nullable } from "babylonjs/types";
  55783. import { Scene } from "babylonjs/scene";
  55784. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55785. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55786. import { Effect } from "babylonjs/Materials/effect";
  55787. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55788. import { Light } from "babylonjs/Lights/light";
  55789. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55790. /**
  55791. * A spot light is defined by a position, a direction, an angle, and an exponent.
  55792. * These values define a cone of light starting from the position, emitting toward the direction.
  55793. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  55794. * and the exponent defines the speed of the decay of the light with distance (reach).
  55795. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55796. */
  55797. export class SpotLight extends ShadowLight {
  55798. private _angle;
  55799. private _innerAngle;
  55800. private _cosHalfAngle;
  55801. private _lightAngleScale;
  55802. private _lightAngleOffset;
  55803. /**
  55804. * Gets the cone angle of the spot light in Radians.
  55805. */
  55806. get angle(): number;
  55807. /**
  55808. * Sets the cone angle of the spot light in Radians.
  55809. */
  55810. set angle(value: number);
  55811. /**
  55812. * Only used in gltf falloff mode, this defines the angle where
  55813. * the directional falloff will start before cutting at angle which could be seen
  55814. * as outer angle.
  55815. */
  55816. get innerAngle(): number;
  55817. /**
  55818. * Only used in gltf falloff mode, this defines the angle where
  55819. * the directional falloff will start before cutting at angle which could be seen
  55820. * as outer angle.
  55821. */
  55822. set innerAngle(value: number);
  55823. private _shadowAngleScale;
  55824. /**
  55825. * Allows scaling the angle of the light for shadow generation only.
  55826. */
  55827. get shadowAngleScale(): number;
  55828. /**
  55829. * Allows scaling the angle of the light for shadow generation only.
  55830. */
  55831. set shadowAngleScale(value: number);
  55832. /**
  55833. * The light decay speed with the distance from the emission spot.
  55834. */
  55835. exponent: number;
  55836. private _projectionTextureMatrix;
  55837. /**
  55838. * Allows reading the projecton texture
  55839. */
  55840. get projectionTextureMatrix(): Matrix;
  55841. protected _projectionTextureLightNear: number;
  55842. /**
  55843. * Gets the near clip of the Spotlight for texture projection.
  55844. */
  55845. get projectionTextureLightNear(): number;
  55846. /**
  55847. * Sets the near clip of the Spotlight for texture projection.
  55848. */
  55849. set projectionTextureLightNear(value: number);
  55850. protected _projectionTextureLightFar: number;
  55851. /**
  55852. * Gets the far clip of the Spotlight for texture projection.
  55853. */
  55854. get projectionTextureLightFar(): number;
  55855. /**
  55856. * Sets the far clip of the Spotlight for texture projection.
  55857. */
  55858. set projectionTextureLightFar(value: number);
  55859. protected _projectionTextureUpDirection: Vector3;
  55860. /**
  55861. * Gets the Up vector of the Spotlight for texture projection.
  55862. */
  55863. get projectionTextureUpDirection(): Vector3;
  55864. /**
  55865. * Sets the Up vector of the Spotlight for texture projection.
  55866. */
  55867. set projectionTextureUpDirection(value: Vector3);
  55868. private _projectionTexture;
  55869. /**
  55870. * Gets the projection texture of the light.
  55871. */
  55872. get projectionTexture(): Nullable<BaseTexture>;
  55873. /**
  55874. * Sets the projection texture of the light.
  55875. */
  55876. set projectionTexture(value: Nullable<BaseTexture>);
  55877. private _projectionTextureViewLightDirty;
  55878. private _projectionTextureProjectionLightDirty;
  55879. private _projectionTextureDirty;
  55880. private _projectionTextureViewTargetVector;
  55881. private _projectionTextureViewLightMatrix;
  55882. private _projectionTextureProjectionLightMatrix;
  55883. private _projectionTextureScalingMatrix;
  55884. /**
  55885. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  55886. * It can cast shadows.
  55887. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55888. * @param name The light friendly name
  55889. * @param position The position of the spot light in the scene
  55890. * @param direction The direction of the light in the scene
  55891. * @param angle The cone angle of the light in Radians
  55892. * @param exponent The light decay speed with the distance from the emission spot
  55893. * @param scene The scene the lights belongs to
  55894. */
  55895. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  55896. /**
  55897. * Returns the string "SpotLight".
  55898. * @returns the class name
  55899. */
  55900. getClassName(): string;
  55901. /**
  55902. * Returns the integer 2.
  55903. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55904. */
  55905. getTypeID(): number;
  55906. /**
  55907. * Overrides the direction setter to recompute the projection texture view light Matrix.
  55908. */
  55909. protected _setDirection(value: Vector3): void;
  55910. /**
  55911. * Overrides the position setter to recompute the projection texture view light Matrix.
  55912. */
  55913. protected _setPosition(value: Vector3): void;
  55914. /**
  55915. * 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.
  55916. * Returns the SpotLight.
  55917. */
  55918. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55919. protected _computeProjectionTextureViewLightMatrix(): void;
  55920. protected _computeProjectionTextureProjectionLightMatrix(): void;
  55921. /**
  55922. * Main function for light texture projection matrix computing.
  55923. */
  55924. protected _computeProjectionTextureMatrix(): void;
  55925. protected _buildUniformLayout(): void;
  55926. private _computeAngleValues;
  55927. /**
  55928. * Sets the passed Effect "effect" with the Light textures.
  55929. * @param effect The effect to update
  55930. * @param lightIndex The index of the light in the effect to update
  55931. * @returns The light
  55932. */
  55933. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  55934. /**
  55935. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  55936. * @param effect The effect to update
  55937. * @param lightIndex The index of the light in the effect to update
  55938. * @returns The spot light
  55939. */
  55940. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  55941. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  55942. /**
  55943. * Disposes the light and the associated resources.
  55944. */
  55945. dispose(): void;
  55946. /**
  55947. * Prepares the list of defines specific to the light type.
  55948. * @param defines the list of defines
  55949. * @param lightIndex defines the index of the light for the effect
  55950. */
  55951. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55952. }
  55953. }
  55954. declare module "babylonjs/Gizmos/lightGizmo" {
  55955. import { Nullable } from "babylonjs/types";
  55956. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55957. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55958. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  55959. import { Light } from "babylonjs/Lights/light";
  55960. /**
  55961. * Gizmo that enables viewing a light
  55962. */
  55963. export class LightGizmo extends Gizmo {
  55964. private _lightMesh;
  55965. private _material;
  55966. private _cachedPosition;
  55967. private _cachedForward;
  55968. private _attachedMeshParent;
  55969. /**
  55970. * Creates a LightGizmo
  55971. * @param gizmoLayer The utility layer the gizmo will be added to
  55972. */
  55973. constructor(gizmoLayer?: UtilityLayerRenderer);
  55974. private _light;
  55975. /**
  55976. * The light that the gizmo is attached to
  55977. */
  55978. set light(light: Nullable<Light>);
  55979. get light(): Nullable<Light>;
  55980. /**
  55981. * Gets the material used to render the light gizmo
  55982. */
  55983. get material(): StandardMaterial;
  55984. /**
  55985. * @hidden
  55986. * Updates the gizmo to match the attached mesh's position/rotation
  55987. */
  55988. protected _update(): void;
  55989. private static _Scale;
  55990. /**
  55991. * Creates the lines for a light mesh
  55992. */
  55993. private static _CreateLightLines;
  55994. /**
  55995. * Disposes of the light gizmo
  55996. */
  55997. dispose(): void;
  55998. private static _CreateHemisphericLightMesh;
  55999. private static _CreatePointLightMesh;
  56000. private static _CreateSpotLightMesh;
  56001. private static _CreateDirectionalLightMesh;
  56002. }
  56003. }
  56004. declare module "babylonjs/Gizmos/index" {
  56005. export * from "babylonjs/Gizmos/axisDragGizmo";
  56006. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56007. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56008. export * from "babylonjs/Gizmos/gizmo";
  56009. export * from "babylonjs/Gizmos/gizmoManager";
  56010. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56011. export * from "babylonjs/Gizmos/positionGizmo";
  56012. export * from "babylonjs/Gizmos/rotationGizmo";
  56013. export * from "babylonjs/Gizmos/scaleGizmo";
  56014. export * from "babylonjs/Gizmos/lightGizmo";
  56015. export * from "babylonjs/Gizmos/planeDragGizmo";
  56016. }
  56017. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56018. /** @hidden */
  56019. export var backgroundFragmentDeclaration: {
  56020. name: string;
  56021. shader: string;
  56022. };
  56023. }
  56024. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56025. /** @hidden */
  56026. export var backgroundUboDeclaration: {
  56027. name: string;
  56028. shader: string;
  56029. };
  56030. }
  56031. declare module "babylonjs/Shaders/background.fragment" {
  56032. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56033. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56034. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56035. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56036. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56037. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56038. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56039. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56040. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56041. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56042. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56043. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56044. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56045. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56046. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56047. /** @hidden */
  56048. export var backgroundPixelShader: {
  56049. name: string;
  56050. shader: string;
  56051. };
  56052. }
  56053. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56054. /** @hidden */
  56055. export var backgroundVertexDeclaration: {
  56056. name: string;
  56057. shader: string;
  56058. };
  56059. }
  56060. declare module "babylonjs/Shaders/background.vertex" {
  56061. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56062. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56063. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56064. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56065. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56066. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56067. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56068. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56069. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56070. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56071. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56072. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56073. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56074. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56075. /** @hidden */
  56076. export var backgroundVertexShader: {
  56077. name: string;
  56078. shader: string;
  56079. };
  56080. }
  56081. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56082. import { Nullable, int, float } from "babylonjs/types";
  56083. import { Scene } from "babylonjs/scene";
  56084. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56085. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56086. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56087. import { Mesh } from "babylonjs/Meshes/mesh";
  56088. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56089. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56090. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56091. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56092. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56093. import { Color3 } from "babylonjs/Maths/math.color";
  56094. import "babylonjs/Shaders/background.fragment";
  56095. import "babylonjs/Shaders/background.vertex";
  56096. /**
  56097. * Background material used to create an efficient environement around your scene.
  56098. */
  56099. export class BackgroundMaterial extends PushMaterial {
  56100. /**
  56101. * Standard reflectance value at parallel view angle.
  56102. */
  56103. static StandardReflectance0: number;
  56104. /**
  56105. * Standard reflectance value at grazing angle.
  56106. */
  56107. static StandardReflectance90: number;
  56108. protected _primaryColor: Color3;
  56109. /**
  56110. * Key light Color (multiply against the environement texture)
  56111. */
  56112. primaryColor: Color3;
  56113. protected __perceptualColor: Nullable<Color3>;
  56114. /**
  56115. * Experimental Internal Use Only.
  56116. *
  56117. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56118. * This acts as a helper to set the primary color to a more "human friendly" value.
  56119. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56120. * output color as close as possible from the chosen value.
  56121. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56122. * part of lighting setup.)
  56123. */
  56124. get _perceptualColor(): Nullable<Color3>;
  56125. set _perceptualColor(value: Nullable<Color3>);
  56126. protected _primaryColorShadowLevel: float;
  56127. /**
  56128. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56129. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56130. */
  56131. get primaryColorShadowLevel(): float;
  56132. set primaryColorShadowLevel(value: float);
  56133. protected _primaryColorHighlightLevel: float;
  56134. /**
  56135. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56136. * The primary color is used at the level chosen to define what the white area would look.
  56137. */
  56138. get primaryColorHighlightLevel(): float;
  56139. set primaryColorHighlightLevel(value: float);
  56140. protected _reflectionTexture: Nullable<BaseTexture>;
  56141. /**
  56142. * Reflection Texture used in the material.
  56143. * Should be author in a specific way for the best result (refer to the documentation).
  56144. */
  56145. reflectionTexture: Nullable<BaseTexture>;
  56146. protected _reflectionBlur: float;
  56147. /**
  56148. * Reflection Texture level of blur.
  56149. *
  56150. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56151. * texture twice.
  56152. */
  56153. reflectionBlur: float;
  56154. protected _diffuseTexture: Nullable<BaseTexture>;
  56155. /**
  56156. * Diffuse Texture used in the material.
  56157. * Should be author in a specific way for the best result (refer to the documentation).
  56158. */
  56159. diffuseTexture: Nullable<BaseTexture>;
  56160. protected _shadowLights: Nullable<IShadowLight[]>;
  56161. /**
  56162. * Specify the list of lights casting shadow on the material.
  56163. * All scene shadow lights will be included if null.
  56164. */
  56165. shadowLights: Nullable<IShadowLight[]>;
  56166. protected _shadowLevel: float;
  56167. /**
  56168. * Helps adjusting the shadow to a softer level if required.
  56169. * 0 means black shadows and 1 means no shadows.
  56170. */
  56171. shadowLevel: float;
  56172. protected _sceneCenter: Vector3;
  56173. /**
  56174. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56175. * It is usually zero but might be interesting to modify according to your setup.
  56176. */
  56177. sceneCenter: Vector3;
  56178. protected _opacityFresnel: boolean;
  56179. /**
  56180. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56181. * This helps ensuring a nice transition when the camera goes under the ground.
  56182. */
  56183. opacityFresnel: boolean;
  56184. protected _reflectionFresnel: boolean;
  56185. /**
  56186. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56187. * This helps adding a mirror texture on the ground.
  56188. */
  56189. reflectionFresnel: boolean;
  56190. protected _reflectionFalloffDistance: number;
  56191. /**
  56192. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56193. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56194. */
  56195. reflectionFalloffDistance: number;
  56196. protected _reflectionAmount: number;
  56197. /**
  56198. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56199. */
  56200. reflectionAmount: number;
  56201. protected _reflectionReflectance0: number;
  56202. /**
  56203. * This specifies the weight of the reflection at grazing angle.
  56204. */
  56205. reflectionReflectance0: number;
  56206. protected _reflectionReflectance90: number;
  56207. /**
  56208. * This specifies the weight of the reflection at a perpendicular point of view.
  56209. */
  56210. reflectionReflectance90: number;
  56211. /**
  56212. * Sets the reflection reflectance fresnel values according to the default standard
  56213. * empirically know to work well :-)
  56214. */
  56215. set reflectionStandardFresnelWeight(value: number);
  56216. protected _useRGBColor: boolean;
  56217. /**
  56218. * Helps to directly use the maps channels instead of their level.
  56219. */
  56220. useRGBColor: boolean;
  56221. protected _enableNoise: boolean;
  56222. /**
  56223. * This helps reducing the banding effect that could occur on the background.
  56224. */
  56225. enableNoise: boolean;
  56226. /**
  56227. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56228. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56229. * Recommended to be keep at 1.0 except for special cases.
  56230. */
  56231. get fovMultiplier(): number;
  56232. set fovMultiplier(value: number);
  56233. private _fovMultiplier;
  56234. /**
  56235. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56236. */
  56237. useEquirectangularFOV: boolean;
  56238. private _maxSimultaneousLights;
  56239. /**
  56240. * Number of Simultaneous lights allowed on the material.
  56241. */
  56242. maxSimultaneousLights: int;
  56243. private _shadowOnly;
  56244. /**
  56245. * Make the material only render shadows
  56246. */
  56247. shadowOnly: boolean;
  56248. /**
  56249. * Default configuration related to image processing available in the Background Material.
  56250. */
  56251. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56252. /**
  56253. * Keep track of the image processing observer to allow dispose and replace.
  56254. */
  56255. private _imageProcessingObserver;
  56256. /**
  56257. * Attaches a new image processing configuration to the PBR Material.
  56258. * @param configuration (if null the scene configuration will be use)
  56259. */
  56260. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56261. /**
  56262. * Gets the image processing configuration used either in this material.
  56263. */
  56264. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56265. /**
  56266. * Sets the Default image processing configuration used either in the this material.
  56267. *
  56268. * If sets to null, the scene one is in use.
  56269. */
  56270. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56271. /**
  56272. * Gets wether the color curves effect is enabled.
  56273. */
  56274. get cameraColorCurvesEnabled(): boolean;
  56275. /**
  56276. * Sets wether the color curves effect is enabled.
  56277. */
  56278. set cameraColorCurvesEnabled(value: boolean);
  56279. /**
  56280. * Gets wether the color grading effect is enabled.
  56281. */
  56282. get cameraColorGradingEnabled(): boolean;
  56283. /**
  56284. * Gets wether the color grading effect is enabled.
  56285. */
  56286. set cameraColorGradingEnabled(value: boolean);
  56287. /**
  56288. * Gets wether tonemapping is enabled or not.
  56289. */
  56290. get cameraToneMappingEnabled(): boolean;
  56291. /**
  56292. * Sets wether tonemapping is enabled or not
  56293. */
  56294. set cameraToneMappingEnabled(value: boolean);
  56295. /**
  56296. * The camera exposure used on this material.
  56297. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56298. * This corresponds to a photographic exposure.
  56299. */
  56300. get cameraExposure(): float;
  56301. /**
  56302. * The camera exposure used on this material.
  56303. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56304. * This corresponds to a photographic exposure.
  56305. */
  56306. set cameraExposure(value: float);
  56307. /**
  56308. * Gets The camera contrast used on this material.
  56309. */
  56310. get cameraContrast(): float;
  56311. /**
  56312. * Sets The camera contrast used on this material.
  56313. */
  56314. set cameraContrast(value: float);
  56315. /**
  56316. * Gets the Color Grading 2D Lookup Texture.
  56317. */
  56318. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56319. /**
  56320. * Sets the Color Grading 2D Lookup Texture.
  56321. */
  56322. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56323. /**
  56324. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56325. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56326. * 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;
  56327. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56328. */
  56329. get cameraColorCurves(): Nullable<ColorCurves>;
  56330. /**
  56331. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56332. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56333. * 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;
  56334. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56335. */
  56336. set cameraColorCurves(value: Nullable<ColorCurves>);
  56337. /**
  56338. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56339. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56340. */
  56341. switchToBGR: boolean;
  56342. private _renderTargets;
  56343. private _reflectionControls;
  56344. private _white;
  56345. private _primaryShadowColor;
  56346. private _primaryHighlightColor;
  56347. /**
  56348. * Instantiates a Background Material in the given scene
  56349. * @param name The friendly name of the material
  56350. * @param scene The scene to add the material to
  56351. */
  56352. constructor(name: string, scene: Scene);
  56353. /**
  56354. * Gets a boolean indicating that current material needs to register RTT
  56355. */
  56356. get hasRenderTargetTextures(): boolean;
  56357. /**
  56358. * The entire material has been created in order to prevent overdraw.
  56359. * @returns false
  56360. */
  56361. needAlphaTesting(): boolean;
  56362. /**
  56363. * The entire material has been created in order to prevent overdraw.
  56364. * @returns true if blending is enable
  56365. */
  56366. needAlphaBlending(): boolean;
  56367. /**
  56368. * Checks wether the material is ready to be rendered for a given mesh.
  56369. * @param mesh The mesh to render
  56370. * @param subMesh The submesh to check against
  56371. * @param useInstances Specify wether or not the material is used with instances
  56372. * @returns true if all the dependencies are ready (Textures, Effects...)
  56373. */
  56374. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56375. /**
  56376. * Compute the primary color according to the chosen perceptual color.
  56377. */
  56378. private _computePrimaryColorFromPerceptualColor;
  56379. /**
  56380. * Compute the highlights and shadow colors according to their chosen levels.
  56381. */
  56382. private _computePrimaryColors;
  56383. /**
  56384. * Build the uniform buffer used in the material.
  56385. */
  56386. buildUniformLayout(): void;
  56387. /**
  56388. * Unbind the material.
  56389. */
  56390. unbind(): void;
  56391. /**
  56392. * Bind only the world matrix to the material.
  56393. * @param world The world matrix to bind.
  56394. */
  56395. bindOnlyWorldMatrix(world: Matrix): void;
  56396. /**
  56397. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56398. * @param world The world matrix to bind.
  56399. * @param subMesh The submesh to bind for.
  56400. */
  56401. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56402. /**
  56403. * Checks to see if a texture is used in the material.
  56404. * @param texture - Base texture to use.
  56405. * @returns - Boolean specifying if a texture is used in the material.
  56406. */
  56407. hasTexture(texture: BaseTexture): boolean;
  56408. /**
  56409. * Dispose the material.
  56410. * @param forceDisposeEffect Force disposal of the associated effect.
  56411. * @param forceDisposeTextures Force disposal of the associated textures.
  56412. */
  56413. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56414. /**
  56415. * Clones the material.
  56416. * @param name The cloned name.
  56417. * @returns The cloned material.
  56418. */
  56419. clone(name: string): BackgroundMaterial;
  56420. /**
  56421. * Serializes the current material to its JSON representation.
  56422. * @returns The JSON representation.
  56423. */
  56424. serialize(): any;
  56425. /**
  56426. * Gets the class name of the material
  56427. * @returns "BackgroundMaterial"
  56428. */
  56429. getClassName(): string;
  56430. /**
  56431. * Parse a JSON input to create back a background material.
  56432. * @param source The JSON data to parse
  56433. * @param scene The scene to create the parsed material in
  56434. * @param rootUrl The root url of the assets the material depends upon
  56435. * @returns the instantiated BackgroundMaterial.
  56436. */
  56437. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56438. }
  56439. }
  56440. declare module "babylonjs/Helpers/environmentHelper" {
  56441. import { Observable } from "babylonjs/Misc/observable";
  56442. import { Nullable } from "babylonjs/types";
  56443. import { Scene } from "babylonjs/scene";
  56444. import { Vector3 } from "babylonjs/Maths/math.vector";
  56445. import { Color3 } from "babylonjs/Maths/math.color";
  56446. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56447. import { Mesh } from "babylonjs/Meshes/mesh";
  56448. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56449. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56450. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56451. import "babylonjs/Meshes/Builders/planeBuilder";
  56452. import "babylonjs/Meshes/Builders/boxBuilder";
  56453. /**
  56454. * Represents the different options available during the creation of
  56455. * a Environment helper.
  56456. *
  56457. * This can control the default ground, skybox and image processing setup of your scene.
  56458. */
  56459. export interface IEnvironmentHelperOptions {
  56460. /**
  56461. * Specifies whether or not to create a ground.
  56462. * True by default.
  56463. */
  56464. createGround: boolean;
  56465. /**
  56466. * Specifies the ground size.
  56467. * 15 by default.
  56468. */
  56469. groundSize: number;
  56470. /**
  56471. * The texture used on the ground for the main color.
  56472. * Comes from the BabylonJS CDN by default.
  56473. *
  56474. * Remarks: Can be either a texture or a url.
  56475. */
  56476. groundTexture: string | BaseTexture;
  56477. /**
  56478. * The color mixed in the ground texture by default.
  56479. * BabylonJS clearColor by default.
  56480. */
  56481. groundColor: Color3;
  56482. /**
  56483. * Specifies the ground opacity.
  56484. * 1 by default.
  56485. */
  56486. groundOpacity: number;
  56487. /**
  56488. * Enables the ground to receive shadows.
  56489. * True by default.
  56490. */
  56491. enableGroundShadow: boolean;
  56492. /**
  56493. * Helps preventing the shadow to be fully black on the ground.
  56494. * 0.5 by default.
  56495. */
  56496. groundShadowLevel: number;
  56497. /**
  56498. * Creates a mirror texture attach to the ground.
  56499. * false by default.
  56500. */
  56501. enableGroundMirror: boolean;
  56502. /**
  56503. * Specifies the ground mirror size ratio.
  56504. * 0.3 by default as the default kernel is 64.
  56505. */
  56506. groundMirrorSizeRatio: number;
  56507. /**
  56508. * Specifies the ground mirror blur kernel size.
  56509. * 64 by default.
  56510. */
  56511. groundMirrorBlurKernel: number;
  56512. /**
  56513. * Specifies the ground mirror visibility amount.
  56514. * 1 by default
  56515. */
  56516. groundMirrorAmount: number;
  56517. /**
  56518. * Specifies the ground mirror reflectance weight.
  56519. * This uses the standard weight of the background material to setup the fresnel effect
  56520. * of the mirror.
  56521. * 1 by default.
  56522. */
  56523. groundMirrorFresnelWeight: number;
  56524. /**
  56525. * Specifies the ground mirror Falloff distance.
  56526. * This can helps reducing the size of the reflection.
  56527. * 0 by Default.
  56528. */
  56529. groundMirrorFallOffDistance: number;
  56530. /**
  56531. * Specifies the ground mirror texture type.
  56532. * Unsigned Int by Default.
  56533. */
  56534. groundMirrorTextureType: number;
  56535. /**
  56536. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  56537. * the shown objects.
  56538. */
  56539. groundYBias: number;
  56540. /**
  56541. * Specifies whether or not to create a skybox.
  56542. * True by default.
  56543. */
  56544. createSkybox: boolean;
  56545. /**
  56546. * Specifies the skybox size.
  56547. * 20 by default.
  56548. */
  56549. skyboxSize: number;
  56550. /**
  56551. * The texture used on the skybox for the main color.
  56552. * Comes from the BabylonJS CDN by default.
  56553. *
  56554. * Remarks: Can be either a texture or a url.
  56555. */
  56556. skyboxTexture: string | BaseTexture;
  56557. /**
  56558. * The color mixed in the skybox texture by default.
  56559. * BabylonJS clearColor by default.
  56560. */
  56561. skyboxColor: Color3;
  56562. /**
  56563. * The background rotation around the Y axis of the scene.
  56564. * This helps aligning the key lights of your scene with the background.
  56565. * 0 by default.
  56566. */
  56567. backgroundYRotation: number;
  56568. /**
  56569. * Compute automatically the size of the elements to best fit with the scene.
  56570. */
  56571. sizeAuto: boolean;
  56572. /**
  56573. * Default position of the rootMesh if autoSize is not true.
  56574. */
  56575. rootPosition: Vector3;
  56576. /**
  56577. * Sets up the image processing in the scene.
  56578. * true by default.
  56579. */
  56580. setupImageProcessing: boolean;
  56581. /**
  56582. * The texture used as your environment texture in the scene.
  56583. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  56584. *
  56585. * Remarks: Can be either a texture or a url.
  56586. */
  56587. environmentTexture: string | BaseTexture;
  56588. /**
  56589. * The value of the exposure to apply to the scene.
  56590. * 0.6 by default if setupImageProcessing is true.
  56591. */
  56592. cameraExposure: number;
  56593. /**
  56594. * The value of the contrast to apply to the scene.
  56595. * 1.6 by default if setupImageProcessing is true.
  56596. */
  56597. cameraContrast: number;
  56598. /**
  56599. * Specifies whether or not tonemapping should be enabled in the scene.
  56600. * true by default if setupImageProcessing is true.
  56601. */
  56602. toneMappingEnabled: boolean;
  56603. }
  56604. /**
  56605. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  56606. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  56607. * It also helps with the default setup of your imageProcessing configuration.
  56608. */
  56609. export class EnvironmentHelper {
  56610. /**
  56611. * Default ground texture URL.
  56612. */
  56613. private static _groundTextureCDNUrl;
  56614. /**
  56615. * Default skybox texture URL.
  56616. */
  56617. private static _skyboxTextureCDNUrl;
  56618. /**
  56619. * Default environment texture URL.
  56620. */
  56621. private static _environmentTextureCDNUrl;
  56622. /**
  56623. * Creates the default options for the helper.
  56624. */
  56625. private static _getDefaultOptions;
  56626. private _rootMesh;
  56627. /**
  56628. * Gets the root mesh created by the helper.
  56629. */
  56630. get rootMesh(): Mesh;
  56631. private _skybox;
  56632. /**
  56633. * Gets the skybox created by the helper.
  56634. */
  56635. get skybox(): Nullable<Mesh>;
  56636. private _skyboxTexture;
  56637. /**
  56638. * Gets the skybox texture created by the helper.
  56639. */
  56640. get skyboxTexture(): Nullable<BaseTexture>;
  56641. private _skyboxMaterial;
  56642. /**
  56643. * Gets the skybox material created by the helper.
  56644. */
  56645. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  56646. private _ground;
  56647. /**
  56648. * Gets the ground mesh created by the helper.
  56649. */
  56650. get ground(): Nullable<Mesh>;
  56651. private _groundTexture;
  56652. /**
  56653. * Gets the ground texture created by the helper.
  56654. */
  56655. get groundTexture(): Nullable<BaseTexture>;
  56656. private _groundMirror;
  56657. /**
  56658. * Gets the ground mirror created by the helper.
  56659. */
  56660. get groundMirror(): Nullable<MirrorTexture>;
  56661. /**
  56662. * Gets the ground mirror render list to helps pushing the meshes
  56663. * you wish in the ground reflection.
  56664. */
  56665. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  56666. private _groundMaterial;
  56667. /**
  56668. * Gets the ground material created by the helper.
  56669. */
  56670. get groundMaterial(): Nullable<BackgroundMaterial>;
  56671. /**
  56672. * Stores the creation options.
  56673. */
  56674. private readonly _scene;
  56675. private _options;
  56676. /**
  56677. * This observable will be notified with any error during the creation of the environment,
  56678. * mainly texture creation errors.
  56679. */
  56680. onErrorObservable: Observable<{
  56681. message?: string;
  56682. exception?: any;
  56683. }>;
  56684. /**
  56685. * constructor
  56686. * @param options Defines the options we want to customize the helper
  56687. * @param scene The scene to add the material to
  56688. */
  56689. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  56690. /**
  56691. * Updates the background according to the new options
  56692. * @param options
  56693. */
  56694. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  56695. /**
  56696. * Sets the primary color of all the available elements.
  56697. * @param color the main color to affect to the ground and the background
  56698. */
  56699. setMainColor(color: Color3): void;
  56700. /**
  56701. * Setup the image processing according to the specified options.
  56702. */
  56703. private _setupImageProcessing;
  56704. /**
  56705. * Setup the environment texture according to the specified options.
  56706. */
  56707. private _setupEnvironmentTexture;
  56708. /**
  56709. * Setup the background according to the specified options.
  56710. */
  56711. private _setupBackground;
  56712. /**
  56713. * Get the scene sizes according to the setup.
  56714. */
  56715. private _getSceneSize;
  56716. /**
  56717. * Setup the ground according to the specified options.
  56718. */
  56719. private _setupGround;
  56720. /**
  56721. * Setup the ground material according to the specified options.
  56722. */
  56723. private _setupGroundMaterial;
  56724. /**
  56725. * Setup the ground diffuse texture according to the specified options.
  56726. */
  56727. private _setupGroundDiffuseTexture;
  56728. /**
  56729. * Setup the ground mirror texture according to the specified options.
  56730. */
  56731. private _setupGroundMirrorTexture;
  56732. /**
  56733. * Setup the ground to receive the mirror texture.
  56734. */
  56735. private _setupMirrorInGroundMaterial;
  56736. /**
  56737. * Setup the skybox according to the specified options.
  56738. */
  56739. private _setupSkybox;
  56740. /**
  56741. * Setup the skybox material according to the specified options.
  56742. */
  56743. private _setupSkyboxMaterial;
  56744. /**
  56745. * Setup the skybox reflection texture according to the specified options.
  56746. */
  56747. private _setupSkyboxReflectionTexture;
  56748. private _errorHandler;
  56749. /**
  56750. * Dispose all the elements created by the Helper.
  56751. */
  56752. dispose(): void;
  56753. }
  56754. }
  56755. declare module "babylonjs/Helpers/photoDome" {
  56756. import { Observable } from "babylonjs/Misc/observable";
  56757. import { Nullable } from "babylonjs/types";
  56758. import { Scene } from "babylonjs/scene";
  56759. import { TransformNode } from "babylonjs/Meshes/transformNode";
  56760. import { Mesh } from "babylonjs/Meshes/mesh";
  56761. import { Texture } from "babylonjs/Materials/Textures/texture";
  56762. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56763. import "babylonjs/Meshes/Builders/sphereBuilder";
  56764. /**
  56765. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  56766. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  56767. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  56768. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  56769. */
  56770. export class PhotoDome extends TransformNode {
  56771. /**
  56772. * Define the image as a Monoscopic panoramic 360 image.
  56773. */
  56774. static readonly MODE_MONOSCOPIC: number;
  56775. /**
  56776. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56777. */
  56778. static readonly MODE_TOPBOTTOM: number;
  56779. /**
  56780. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56781. */
  56782. static readonly MODE_SIDEBYSIDE: number;
  56783. private _useDirectMapping;
  56784. /**
  56785. * The texture being displayed on the sphere
  56786. */
  56787. protected _photoTexture: Texture;
  56788. /**
  56789. * Gets or sets the texture being displayed on the sphere
  56790. */
  56791. get photoTexture(): Texture;
  56792. set photoTexture(value: Texture);
  56793. /**
  56794. * Observable raised when an error occured while loading the 360 image
  56795. */
  56796. onLoadErrorObservable: Observable<string>;
  56797. /**
  56798. * The skybox material
  56799. */
  56800. protected _material: BackgroundMaterial;
  56801. /**
  56802. * The surface used for the skybox
  56803. */
  56804. protected _mesh: Mesh;
  56805. /**
  56806. * Gets the mesh used for the skybox.
  56807. */
  56808. get mesh(): Mesh;
  56809. /**
  56810. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56811. * Also see the options.resolution property.
  56812. */
  56813. get fovMultiplier(): number;
  56814. set fovMultiplier(value: number);
  56815. private _imageMode;
  56816. /**
  56817. * Gets or set the current video mode for the video. It can be:
  56818. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  56819. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56820. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56821. */
  56822. get imageMode(): number;
  56823. set imageMode(value: number);
  56824. /**
  56825. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  56826. * @param name Element's name, child elements will append suffixes for their own names.
  56827. * @param urlsOfPhoto defines the url of the photo to display
  56828. * @param options defines an object containing optional or exposed sub element properties
  56829. * @param onError defines a callback called when an error occured while loading the texture
  56830. */
  56831. constructor(name: string, urlOfPhoto: string, options: {
  56832. resolution?: number;
  56833. size?: number;
  56834. useDirectMapping?: boolean;
  56835. faceForward?: boolean;
  56836. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  56837. private _onBeforeCameraRenderObserver;
  56838. private _changeImageMode;
  56839. /**
  56840. * Releases resources associated with this node.
  56841. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  56842. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  56843. */
  56844. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  56845. }
  56846. }
  56847. declare module "babylonjs/Misc/rgbdTextureTools" {
  56848. import "babylonjs/Shaders/rgbdDecode.fragment";
  56849. import "babylonjs/Engines/Extensions/engine.renderTarget";
  56850. import { Texture } from "babylonjs/Materials/Textures/texture";
  56851. /**
  56852. * Class used to host RGBD texture specific utilities
  56853. */
  56854. export class RGBDTextureTools {
  56855. /**
  56856. * Expand the RGBD Texture from RGBD to Half Float if possible.
  56857. * @param texture the texture to expand.
  56858. */
  56859. static ExpandRGBDTexture(texture: Texture): void;
  56860. }
  56861. }
  56862. declare module "babylonjs/Misc/brdfTextureTools" {
  56863. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56864. import { Scene } from "babylonjs/scene";
  56865. /**
  56866. * Class used to host texture specific utilities
  56867. */
  56868. export class BRDFTextureTools {
  56869. /**
  56870. * Prevents texture cache collision
  56871. */
  56872. private static _instanceNumber;
  56873. /**
  56874. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  56875. * @param scene defines the hosting scene
  56876. * @returns the environment BRDF texture
  56877. */
  56878. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  56879. private static _environmentBRDFBase64Texture;
  56880. }
  56881. }
  56882. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  56883. import { Nullable } from "babylonjs/types";
  56884. import { Color3 } from "babylonjs/Maths/math.color";
  56885. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56886. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56887. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56888. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56889. import { Engine } from "babylonjs/Engines/engine";
  56890. import { Scene } from "babylonjs/scene";
  56891. /**
  56892. * @hidden
  56893. */
  56894. export interface IMaterialClearCoatDefines {
  56895. CLEARCOAT: boolean;
  56896. CLEARCOAT_DEFAULTIOR: boolean;
  56897. CLEARCOAT_TEXTURE: boolean;
  56898. CLEARCOAT_TEXTUREDIRECTUV: number;
  56899. CLEARCOAT_BUMP: boolean;
  56900. CLEARCOAT_BUMPDIRECTUV: number;
  56901. CLEARCOAT_TINT: boolean;
  56902. CLEARCOAT_TINT_TEXTURE: boolean;
  56903. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  56904. /** @hidden */
  56905. _areTexturesDirty: boolean;
  56906. }
  56907. /**
  56908. * Define the code related to the clear coat parameters of the pbr material.
  56909. */
  56910. export class PBRClearCoatConfiguration {
  56911. /**
  56912. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56913. * The default fits with a polyurethane material.
  56914. */
  56915. private static readonly _DefaultIndexOfRefraction;
  56916. private _isEnabled;
  56917. /**
  56918. * Defines if the clear coat is enabled in the material.
  56919. */
  56920. isEnabled: boolean;
  56921. /**
  56922. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  56923. */
  56924. intensity: number;
  56925. /**
  56926. * Defines the clear coat layer roughness.
  56927. */
  56928. roughness: number;
  56929. private _indexOfRefraction;
  56930. /**
  56931. * Defines the index of refraction of the clear coat.
  56932. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56933. * The default fits with a polyurethane material.
  56934. * Changing the default value is more performance intensive.
  56935. */
  56936. indexOfRefraction: number;
  56937. private _texture;
  56938. /**
  56939. * Stores the clear coat values in a texture.
  56940. */
  56941. texture: Nullable<BaseTexture>;
  56942. private _bumpTexture;
  56943. /**
  56944. * Define the clear coat specific bump texture.
  56945. */
  56946. bumpTexture: Nullable<BaseTexture>;
  56947. private _isTintEnabled;
  56948. /**
  56949. * Defines if the clear coat tint is enabled in the material.
  56950. */
  56951. isTintEnabled: boolean;
  56952. /**
  56953. * Defines the clear coat tint of the material.
  56954. * This is only use if tint is enabled
  56955. */
  56956. tintColor: Color3;
  56957. /**
  56958. * Defines the distance at which the tint color should be found in the
  56959. * clear coat media.
  56960. * This is only use if tint is enabled
  56961. */
  56962. tintColorAtDistance: number;
  56963. /**
  56964. * Defines the clear coat layer thickness.
  56965. * This is only use if tint is enabled
  56966. */
  56967. tintThickness: number;
  56968. private _tintTexture;
  56969. /**
  56970. * Stores the clear tint values in a texture.
  56971. * rgb is tint
  56972. * a is a thickness factor
  56973. */
  56974. tintTexture: Nullable<BaseTexture>;
  56975. /** @hidden */
  56976. private _internalMarkAllSubMeshesAsTexturesDirty;
  56977. /** @hidden */
  56978. _markAllSubMeshesAsTexturesDirty(): void;
  56979. /**
  56980. * Instantiate a new istance of clear coat configuration.
  56981. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  56982. */
  56983. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  56984. /**
  56985. * Gets wehter the submesh is ready to be used or not.
  56986. * @param defines the list of "defines" to update.
  56987. * @param scene defines the scene the material belongs to.
  56988. * @param engine defines the engine the material belongs to.
  56989. * @param disableBumpMap defines wether the material disables bump or not.
  56990. * @returns - boolean indicating that the submesh is ready or not.
  56991. */
  56992. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  56993. /**
  56994. * Checks to see if a texture is used in the material.
  56995. * @param defines the list of "defines" to update.
  56996. * @param scene defines the scene to the material belongs to.
  56997. */
  56998. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  56999. /**
  57000. * Binds the material data.
  57001. * @param uniformBuffer defines the Uniform buffer to fill in.
  57002. * @param scene defines the scene the material belongs to.
  57003. * @param engine defines the engine the material belongs to.
  57004. * @param disableBumpMap defines wether the material disables bump or not.
  57005. * @param isFrozen defines wether the material is frozen or not.
  57006. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57007. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57008. */
  57009. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57010. /**
  57011. * Checks to see if a texture is used in the material.
  57012. * @param texture - Base texture to use.
  57013. * @returns - Boolean specifying if a texture is used in the material.
  57014. */
  57015. hasTexture(texture: BaseTexture): boolean;
  57016. /**
  57017. * Returns an array of the actively used textures.
  57018. * @param activeTextures Array of BaseTextures
  57019. */
  57020. getActiveTextures(activeTextures: BaseTexture[]): void;
  57021. /**
  57022. * Returns the animatable textures.
  57023. * @param animatables Array of animatable textures.
  57024. */
  57025. getAnimatables(animatables: IAnimatable[]): void;
  57026. /**
  57027. * Disposes the resources of the material.
  57028. * @param forceDisposeTextures - Forces the disposal of all textures.
  57029. */
  57030. dispose(forceDisposeTextures?: boolean): void;
  57031. /**
  57032. * Get the current class name of the texture useful for serialization or dynamic coding.
  57033. * @returns "PBRClearCoatConfiguration"
  57034. */
  57035. getClassName(): string;
  57036. /**
  57037. * Add fallbacks to the effect fallbacks list.
  57038. * @param defines defines the Base texture to use.
  57039. * @param fallbacks defines the current fallback list.
  57040. * @param currentRank defines the current fallback rank.
  57041. * @returns the new fallback rank.
  57042. */
  57043. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57044. /**
  57045. * Add the required uniforms to the current list.
  57046. * @param uniforms defines the current uniform list.
  57047. */
  57048. static AddUniforms(uniforms: string[]): void;
  57049. /**
  57050. * Add the required samplers to the current list.
  57051. * @param samplers defines the current sampler list.
  57052. */
  57053. static AddSamplers(samplers: string[]): void;
  57054. /**
  57055. * Add the required uniforms to the current buffer.
  57056. * @param uniformBuffer defines the current uniform buffer.
  57057. */
  57058. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57059. /**
  57060. * Makes a duplicate of the current configuration into another one.
  57061. * @param clearCoatConfiguration define the config where to copy the info
  57062. */
  57063. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57064. /**
  57065. * Serializes this clear coat configuration.
  57066. * @returns - An object with the serialized config.
  57067. */
  57068. serialize(): any;
  57069. /**
  57070. * Parses a anisotropy Configuration from a serialized object.
  57071. * @param source - Serialized object.
  57072. * @param scene Defines the scene we are parsing for
  57073. * @param rootUrl Defines the rootUrl to load from
  57074. */
  57075. parse(source: any, scene: Scene, rootUrl: string): void;
  57076. }
  57077. }
  57078. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57079. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57080. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57081. import { Vector2 } from "babylonjs/Maths/math.vector";
  57082. import { Scene } from "babylonjs/scene";
  57083. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57084. import { Nullable } from "babylonjs/types";
  57085. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57086. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57087. /**
  57088. * @hidden
  57089. */
  57090. export interface IMaterialAnisotropicDefines {
  57091. ANISOTROPIC: boolean;
  57092. ANISOTROPIC_TEXTURE: boolean;
  57093. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57094. MAINUV1: boolean;
  57095. _areTexturesDirty: boolean;
  57096. _needUVs: boolean;
  57097. }
  57098. /**
  57099. * Define the code related to the anisotropic parameters of the pbr material.
  57100. */
  57101. export class PBRAnisotropicConfiguration {
  57102. private _isEnabled;
  57103. /**
  57104. * Defines if the anisotropy is enabled in the material.
  57105. */
  57106. isEnabled: boolean;
  57107. /**
  57108. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57109. */
  57110. intensity: number;
  57111. /**
  57112. * Defines if the effect is along the tangents, bitangents or in between.
  57113. * By default, the effect is "strectching" the highlights along the tangents.
  57114. */
  57115. direction: Vector2;
  57116. private _texture;
  57117. /**
  57118. * Stores the anisotropy values in a texture.
  57119. * rg is direction (like normal from -1 to 1)
  57120. * b is a intensity
  57121. */
  57122. texture: Nullable<BaseTexture>;
  57123. /** @hidden */
  57124. private _internalMarkAllSubMeshesAsTexturesDirty;
  57125. /** @hidden */
  57126. _markAllSubMeshesAsTexturesDirty(): void;
  57127. /**
  57128. * Instantiate a new istance of anisotropy configuration.
  57129. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57130. */
  57131. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57132. /**
  57133. * Specifies that the submesh is ready to be used.
  57134. * @param defines the list of "defines" to update.
  57135. * @param scene defines the scene the material belongs to.
  57136. * @returns - boolean indicating that the submesh is ready or not.
  57137. */
  57138. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57139. /**
  57140. * Checks to see if a texture is used in the material.
  57141. * @param defines the list of "defines" to update.
  57142. * @param mesh the mesh we are preparing the defines for.
  57143. * @param scene defines the scene the material belongs to.
  57144. */
  57145. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57146. /**
  57147. * Binds the material data.
  57148. * @param uniformBuffer defines the Uniform buffer to fill in.
  57149. * @param scene defines the scene the material belongs to.
  57150. * @param isFrozen defines wether the material is frozen or not.
  57151. */
  57152. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57153. /**
  57154. * Checks to see if a texture is used in the material.
  57155. * @param texture - Base texture to use.
  57156. * @returns - Boolean specifying if a texture is used in the material.
  57157. */
  57158. hasTexture(texture: BaseTexture): boolean;
  57159. /**
  57160. * Returns an array of the actively used textures.
  57161. * @param activeTextures Array of BaseTextures
  57162. */
  57163. getActiveTextures(activeTextures: BaseTexture[]): void;
  57164. /**
  57165. * Returns the animatable textures.
  57166. * @param animatables Array of animatable textures.
  57167. */
  57168. getAnimatables(animatables: IAnimatable[]): void;
  57169. /**
  57170. * Disposes the resources of the material.
  57171. * @param forceDisposeTextures - Forces the disposal of all textures.
  57172. */
  57173. dispose(forceDisposeTextures?: boolean): void;
  57174. /**
  57175. * Get the current class name of the texture useful for serialization or dynamic coding.
  57176. * @returns "PBRAnisotropicConfiguration"
  57177. */
  57178. getClassName(): string;
  57179. /**
  57180. * Add fallbacks to the effect fallbacks list.
  57181. * @param defines defines the Base texture to use.
  57182. * @param fallbacks defines the current fallback list.
  57183. * @param currentRank defines the current fallback rank.
  57184. * @returns the new fallback rank.
  57185. */
  57186. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57187. /**
  57188. * Add the required uniforms to the current list.
  57189. * @param uniforms defines the current uniform list.
  57190. */
  57191. static AddUniforms(uniforms: string[]): void;
  57192. /**
  57193. * Add the required uniforms to the current buffer.
  57194. * @param uniformBuffer defines the current uniform buffer.
  57195. */
  57196. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57197. /**
  57198. * Add the required samplers to the current list.
  57199. * @param samplers defines the current sampler list.
  57200. */
  57201. static AddSamplers(samplers: string[]): void;
  57202. /**
  57203. * Makes a duplicate of the current configuration into another one.
  57204. * @param anisotropicConfiguration define the config where to copy the info
  57205. */
  57206. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57207. /**
  57208. * Serializes this anisotropy configuration.
  57209. * @returns - An object with the serialized config.
  57210. */
  57211. serialize(): any;
  57212. /**
  57213. * Parses a anisotropy Configuration from a serialized object.
  57214. * @param source - Serialized object.
  57215. * @param scene Defines the scene we are parsing for
  57216. * @param rootUrl Defines the rootUrl to load from
  57217. */
  57218. parse(source: any, scene: Scene, rootUrl: string): void;
  57219. }
  57220. }
  57221. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57222. import { Scene } from "babylonjs/scene";
  57223. /**
  57224. * @hidden
  57225. */
  57226. export interface IMaterialBRDFDefines {
  57227. BRDF_V_HEIGHT_CORRELATED: boolean;
  57228. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57229. SPHERICAL_HARMONICS: boolean;
  57230. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57231. /** @hidden */
  57232. _areMiscDirty: boolean;
  57233. }
  57234. /**
  57235. * Define the code related to the BRDF parameters of the pbr material.
  57236. */
  57237. export class PBRBRDFConfiguration {
  57238. /**
  57239. * Default value used for the energy conservation.
  57240. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57241. */
  57242. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57243. /**
  57244. * Default value used for the Smith Visibility Height Correlated mode.
  57245. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57246. */
  57247. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57248. /**
  57249. * Default value used for the IBL diffuse part.
  57250. * This can help switching back to the polynomials mode globally which is a tiny bit
  57251. * less GPU intensive at the drawback of a lower quality.
  57252. */
  57253. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57254. /**
  57255. * Default value used for activating energy conservation for the specular workflow.
  57256. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57257. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57258. */
  57259. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57260. private _useEnergyConservation;
  57261. /**
  57262. * Defines if the material uses energy conservation.
  57263. */
  57264. useEnergyConservation: boolean;
  57265. private _useSmithVisibilityHeightCorrelated;
  57266. /**
  57267. * LEGACY Mode set to false
  57268. * Defines if the material uses height smith correlated visibility term.
  57269. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57270. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57271. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57272. * Not relying on height correlated will also disable energy conservation.
  57273. */
  57274. useSmithVisibilityHeightCorrelated: boolean;
  57275. private _useSphericalHarmonics;
  57276. /**
  57277. * LEGACY Mode set to false
  57278. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57279. * diffuse part of the IBL.
  57280. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57281. * to the ground truth.
  57282. */
  57283. useSphericalHarmonics: boolean;
  57284. private _useSpecularGlossinessInputEnergyConservation;
  57285. /**
  57286. * Defines if the material uses energy conservation, when the specular workflow is active.
  57287. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57288. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57289. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57290. */
  57291. useSpecularGlossinessInputEnergyConservation: boolean;
  57292. /** @hidden */
  57293. private _internalMarkAllSubMeshesAsMiscDirty;
  57294. /** @hidden */
  57295. _markAllSubMeshesAsMiscDirty(): void;
  57296. /**
  57297. * Instantiate a new istance of clear coat configuration.
  57298. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57299. */
  57300. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57301. /**
  57302. * Checks to see if a texture is used in the material.
  57303. * @param defines the list of "defines" to update.
  57304. */
  57305. prepareDefines(defines: IMaterialBRDFDefines): void;
  57306. /**
  57307. * Get the current class name of the texture useful for serialization or dynamic coding.
  57308. * @returns "PBRClearCoatConfiguration"
  57309. */
  57310. getClassName(): string;
  57311. /**
  57312. * Makes a duplicate of the current configuration into another one.
  57313. * @param brdfConfiguration define the config where to copy the info
  57314. */
  57315. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57316. /**
  57317. * Serializes this BRDF configuration.
  57318. * @returns - An object with the serialized config.
  57319. */
  57320. serialize(): any;
  57321. /**
  57322. * Parses a anisotropy Configuration from a serialized object.
  57323. * @param source - Serialized object.
  57324. * @param scene Defines the scene we are parsing for
  57325. * @param rootUrl Defines the rootUrl to load from
  57326. */
  57327. parse(source: any, scene: Scene, rootUrl: string): void;
  57328. }
  57329. }
  57330. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57331. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57332. import { Color3 } from "babylonjs/Maths/math.color";
  57333. import { Scene } from "babylonjs/scene";
  57334. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57335. import { Nullable } from "babylonjs/types";
  57336. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57337. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57338. /**
  57339. * @hidden
  57340. */
  57341. export interface IMaterialSheenDefines {
  57342. SHEEN: boolean;
  57343. SHEEN_TEXTURE: boolean;
  57344. SHEEN_TEXTUREDIRECTUV: number;
  57345. SHEEN_LINKWITHALBEDO: boolean;
  57346. SHEEN_ROUGHNESS: boolean;
  57347. SHEEN_ALBEDOSCALING: boolean;
  57348. /** @hidden */
  57349. _areTexturesDirty: boolean;
  57350. }
  57351. /**
  57352. * Define the code related to the Sheen parameters of the pbr material.
  57353. */
  57354. export class PBRSheenConfiguration {
  57355. private _isEnabled;
  57356. /**
  57357. * Defines if the material uses sheen.
  57358. */
  57359. isEnabled: boolean;
  57360. private _linkSheenWithAlbedo;
  57361. /**
  57362. * Defines if the sheen is linked to the sheen color.
  57363. */
  57364. linkSheenWithAlbedo: boolean;
  57365. /**
  57366. * Defines the sheen intensity.
  57367. */
  57368. intensity: number;
  57369. /**
  57370. * Defines the sheen color.
  57371. */
  57372. color: Color3;
  57373. private _texture;
  57374. /**
  57375. * Stores the sheen tint values in a texture.
  57376. * rgb is tint
  57377. * a is a intensity or roughness if roughness has been defined
  57378. */
  57379. texture: Nullable<BaseTexture>;
  57380. private _roughness;
  57381. /**
  57382. * Defines the sheen roughness.
  57383. * It is not taken into account if linkSheenWithAlbedo is true.
  57384. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  57385. */
  57386. roughness: Nullable<number>;
  57387. private _albedoScaling;
  57388. /**
  57389. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  57390. * It allows the strength of the sheen effect to not depend on the base color of the material,
  57391. * making it easier to setup and tweak the effect
  57392. */
  57393. albedoScaling: boolean;
  57394. /** @hidden */
  57395. private _internalMarkAllSubMeshesAsTexturesDirty;
  57396. /** @hidden */
  57397. _markAllSubMeshesAsTexturesDirty(): void;
  57398. /**
  57399. * Instantiate a new istance of clear coat configuration.
  57400. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57401. */
  57402. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57403. /**
  57404. * Specifies that the submesh is ready to be used.
  57405. * @param defines the list of "defines" to update.
  57406. * @param scene defines the scene the material belongs to.
  57407. * @returns - boolean indicating that the submesh is ready or not.
  57408. */
  57409. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  57410. /**
  57411. * Checks to see if a texture is used in the material.
  57412. * @param defines the list of "defines" to update.
  57413. * @param scene defines the scene the material belongs to.
  57414. */
  57415. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  57416. /**
  57417. * Binds the material data.
  57418. * @param uniformBuffer defines the Uniform buffer to fill in.
  57419. * @param scene defines the scene the material belongs to.
  57420. * @param isFrozen defines wether the material is frozen or not.
  57421. */
  57422. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57423. /**
  57424. * Checks to see if a texture is used in the material.
  57425. * @param texture - Base texture to use.
  57426. * @returns - Boolean specifying if a texture is used in the material.
  57427. */
  57428. hasTexture(texture: BaseTexture): boolean;
  57429. /**
  57430. * Returns an array of the actively used textures.
  57431. * @param activeTextures Array of BaseTextures
  57432. */
  57433. getActiveTextures(activeTextures: BaseTexture[]): void;
  57434. /**
  57435. * Returns the animatable textures.
  57436. * @param animatables Array of animatable textures.
  57437. */
  57438. getAnimatables(animatables: IAnimatable[]): void;
  57439. /**
  57440. * Disposes the resources of the material.
  57441. * @param forceDisposeTextures - Forces the disposal of all textures.
  57442. */
  57443. dispose(forceDisposeTextures?: boolean): void;
  57444. /**
  57445. * Get the current class name of the texture useful for serialization or dynamic coding.
  57446. * @returns "PBRSheenConfiguration"
  57447. */
  57448. getClassName(): string;
  57449. /**
  57450. * Add fallbacks to the effect fallbacks list.
  57451. * @param defines defines the Base texture to use.
  57452. * @param fallbacks defines the current fallback list.
  57453. * @param currentRank defines the current fallback rank.
  57454. * @returns the new fallback rank.
  57455. */
  57456. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57457. /**
  57458. * Add the required uniforms to the current list.
  57459. * @param uniforms defines the current uniform list.
  57460. */
  57461. static AddUniforms(uniforms: string[]): void;
  57462. /**
  57463. * Add the required uniforms to the current buffer.
  57464. * @param uniformBuffer defines the current uniform buffer.
  57465. */
  57466. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57467. /**
  57468. * Add the required samplers to the current list.
  57469. * @param samplers defines the current sampler list.
  57470. */
  57471. static AddSamplers(samplers: string[]): void;
  57472. /**
  57473. * Makes a duplicate of the current configuration into another one.
  57474. * @param sheenConfiguration define the config where to copy the info
  57475. */
  57476. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  57477. /**
  57478. * Serializes this BRDF configuration.
  57479. * @returns - An object with the serialized config.
  57480. */
  57481. serialize(): any;
  57482. /**
  57483. * Parses a anisotropy Configuration from a serialized object.
  57484. * @param source - Serialized object.
  57485. * @param scene Defines the scene we are parsing for
  57486. * @param rootUrl Defines the rootUrl to load from
  57487. */
  57488. parse(source: any, scene: Scene, rootUrl: string): void;
  57489. }
  57490. }
  57491. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  57492. import { Nullable } from "babylonjs/types";
  57493. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57494. import { Color3 } from "babylonjs/Maths/math.color";
  57495. import { SmartArray } from "babylonjs/Misc/smartArray";
  57496. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57497. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  57498. import { Effect } from "babylonjs/Materials/effect";
  57499. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57500. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57501. import { Engine } from "babylonjs/Engines/engine";
  57502. import { Scene } from "babylonjs/scene";
  57503. /**
  57504. * @hidden
  57505. */
  57506. export interface IMaterialSubSurfaceDefines {
  57507. SUBSURFACE: boolean;
  57508. SS_REFRACTION: boolean;
  57509. SS_TRANSLUCENCY: boolean;
  57510. SS_SCATTERING: boolean;
  57511. SS_THICKNESSANDMASK_TEXTURE: boolean;
  57512. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  57513. SS_REFRACTIONMAP_3D: boolean;
  57514. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  57515. SS_LODINREFRACTIONALPHA: boolean;
  57516. SS_GAMMAREFRACTION: boolean;
  57517. SS_RGBDREFRACTION: boolean;
  57518. SS_LINEARSPECULARREFRACTION: boolean;
  57519. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  57520. SS_ALBEDOFORREFRACTIONTINT: boolean;
  57521. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  57522. /** @hidden */
  57523. _areTexturesDirty: boolean;
  57524. }
  57525. /**
  57526. * Define the code related to the sub surface parameters of the pbr material.
  57527. */
  57528. export class PBRSubSurfaceConfiguration {
  57529. private _isRefractionEnabled;
  57530. /**
  57531. * Defines if the refraction is enabled in the material.
  57532. */
  57533. isRefractionEnabled: boolean;
  57534. private _isTranslucencyEnabled;
  57535. /**
  57536. * Defines if the translucency is enabled in the material.
  57537. */
  57538. isTranslucencyEnabled: boolean;
  57539. private _isScatteringEnabled;
  57540. /**
  57541. * Defines if the sub surface scattering is enabled in the material.
  57542. */
  57543. isScatteringEnabled: boolean;
  57544. private _scatteringDiffusionProfileIndex;
  57545. /**
  57546. * Diffusion profile for subsurface scattering.
  57547. * Useful for better scattering in the skins or foliages.
  57548. */
  57549. get scatteringDiffusionProfile(): Nullable<Color3>;
  57550. set scatteringDiffusionProfile(c: Nullable<Color3>);
  57551. /**
  57552. * Defines the refraction intensity of the material.
  57553. * The refraction when enabled replaces the Diffuse part of the material.
  57554. * The intensity helps transitionning between diffuse and refraction.
  57555. */
  57556. refractionIntensity: number;
  57557. /**
  57558. * Defines the translucency intensity of the material.
  57559. * When translucency has been enabled, this defines how much of the "translucency"
  57560. * is addded to the diffuse part of the material.
  57561. */
  57562. translucencyIntensity: number;
  57563. /**
  57564. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  57565. */
  57566. useAlbedoToTintRefraction: boolean;
  57567. private _thicknessTexture;
  57568. /**
  57569. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  57570. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  57571. * 0 would mean minimumThickness
  57572. * 1 would mean maximumThickness
  57573. * The other channels might be use as a mask to vary the different effects intensity.
  57574. */
  57575. thicknessTexture: Nullable<BaseTexture>;
  57576. private _refractionTexture;
  57577. /**
  57578. * Defines the texture to use for refraction.
  57579. */
  57580. refractionTexture: Nullable<BaseTexture>;
  57581. private _indexOfRefraction;
  57582. /**
  57583. * Index of refraction of the material base layer.
  57584. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  57585. *
  57586. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  57587. *
  57588. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  57589. */
  57590. indexOfRefraction: number;
  57591. private _volumeIndexOfRefraction;
  57592. /**
  57593. * Index of refraction of the material's volume.
  57594. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  57595. *
  57596. * This ONLY impacts refraction. If not provided or given a non-valid value,
  57597. * the volume will use the same IOR as the surface.
  57598. */
  57599. get volumeIndexOfRefraction(): number;
  57600. set volumeIndexOfRefraction(value: number);
  57601. private _invertRefractionY;
  57602. /**
  57603. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  57604. */
  57605. invertRefractionY: boolean;
  57606. private _linkRefractionWithTransparency;
  57607. /**
  57608. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  57609. * Materials half opaque for instance using refraction could benefit from this control.
  57610. */
  57611. linkRefractionWithTransparency: boolean;
  57612. /**
  57613. * Defines the minimum thickness stored in the thickness map.
  57614. * If no thickness map is defined, this value will be used to simulate thickness.
  57615. */
  57616. minimumThickness: number;
  57617. /**
  57618. * Defines the maximum thickness stored in the thickness map.
  57619. */
  57620. maximumThickness: number;
  57621. /**
  57622. * Defines the volume tint of the material.
  57623. * This is used for both translucency and scattering.
  57624. */
  57625. tintColor: Color3;
  57626. /**
  57627. * Defines the distance at which the tint color should be found in the media.
  57628. * This is used for refraction only.
  57629. */
  57630. tintColorAtDistance: number;
  57631. /**
  57632. * Defines how far each channel transmit through the media.
  57633. * It is defined as a color to simplify it selection.
  57634. */
  57635. diffusionDistance: Color3;
  57636. private _useMaskFromThicknessTexture;
  57637. /**
  57638. * Stores the intensity of the different subsurface effects in the thickness texture.
  57639. * * the green channel is the translucency intensity.
  57640. * * the blue channel is the scattering intensity.
  57641. * * the alpha channel is the refraction intensity.
  57642. */
  57643. useMaskFromThicknessTexture: boolean;
  57644. private _scene;
  57645. /** @hidden */
  57646. private _internalMarkAllSubMeshesAsTexturesDirty;
  57647. private _internalMarkScenePrePassDirty;
  57648. /** @hidden */
  57649. _markAllSubMeshesAsTexturesDirty(): void;
  57650. /** @hidden */
  57651. _markScenePrePassDirty(): void;
  57652. /**
  57653. * Instantiate a new istance of sub surface configuration.
  57654. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57655. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  57656. * @param scene The scene
  57657. */
  57658. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  57659. /**
  57660. * Gets wehter the submesh is ready to be used or not.
  57661. * @param defines the list of "defines" to update.
  57662. * @param scene defines the scene the material belongs to.
  57663. * @returns - boolean indicating that the submesh is ready or not.
  57664. */
  57665. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  57666. /**
  57667. * Checks to see if a texture is used in the material.
  57668. * @param defines the list of "defines" to update.
  57669. * @param scene defines the scene to the material belongs to.
  57670. */
  57671. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  57672. /**
  57673. * Binds the material data.
  57674. * @param uniformBuffer defines the Uniform buffer to fill in.
  57675. * @param scene defines the scene the material belongs to.
  57676. * @param engine defines the engine the material belongs to.
  57677. * @param isFrozen defines whether the material is frozen or not.
  57678. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  57679. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  57680. */
  57681. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  57682. /**
  57683. * Unbinds the material from the mesh.
  57684. * @param activeEffect defines the effect that should be unbound from.
  57685. * @returns true if unbound, otherwise false
  57686. */
  57687. unbind(activeEffect: Effect): boolean;
  57688. /**
  57689. * Returns the texture used for refraction or null if none is used.
  57690. * @param scene defines the scene the material belongs to.
  57691. * @returns - Refraction texture if present. If no refraction texture and refraction
  57692. * is linked with transparency, returns environment texture. Otherwise, returns null.
  57693. */
  57694. private _getRefractionTexture;
  57695. /**
  57696. * Returns true if alpha blending should be disabled.
  57697. */
  57698. get disableAlphaBlending(): boolean;
  57699. /**
  57700. * Fills the list of render target textures.
  57701. * @param renderTargets the list of render targets to update
  57702. */
  57703. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  57704. /**
  57705. * Checks to see if a texture is used in the material.
  57706. * @param texture - Base texture to use.
  57707. * @returns - Boolean specifying if a texture is used in the material.
  57708. */
  57709. hasTexture(texture: BaseTexture): boolean;
  57710. /**
  57711. * Gets a boolean indicating that current material needs to register RTT
  57712. * @returns true if this uses a render target otherwise false.
  57713. */
  57714. hasRenderTargetTextures(): boolean;
  57715. /**
  57716. * Returns an array of the actively used textures.
  57717. * @param activeTextures Array of BaseTextures
  57718. */
  57719. getActiveTextures(activeTextures: BaseTexture[]): void;
  57720. /**
  57721. * Returns the animatable textures.
  57722. * @param animatables Array of animatable textures.
  57723. */
  57724. getAnimatables(animatables: IAnimatable[]): void;
  57725. /**
  57726. * Disposes the resources of the material.
  57727. * @param forceDisposeTextures - Forces the disposal of all textures.
  57728. */
  57729. dispose(forceDisposeTextures?: boolean): void;
  57730. /**
  57731. * Get the current class name of the texture useful for serialization or dynamic coding.
  57732. * @returns "PBRSubSurfaceConfiguration"
  57733. */
  57734. getClassName(): string;
  57735. /**
  57736. * Add fallbacks to the effect fallbacks list.
  57737. * @param defines defines the Base texture to use.
  57738. * @param fallbacks defines the current fallback list.
  57739. * @param currentRank defines the current fallback rank.
  57740. * @returns the new fallback rank.
  57741. */
  57742. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57743. /**
  57744. * Add the required uniforms to the current list.
  57745. * @param uniforms defines the current uniform list.
  57746. */
  57747. static AddUniforms(uniforms: string[]): void;
  57748. /**
  57749. * Add the required samplers to the current list.
  57750. * @param samplers defines the current sampler list.
  57751. */
  57752. static AddSamplers(samplers: string[]): void;
  57753. /**
  57754. * Add the required uniforms to the current buffer.
  57755. * @param uniformBuffer defines the current uniform buffer.
  57756. */
  57757. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57758. /**
  57759. * Makes a duplicate of the current configuration into another one.
  57760. * @param configuration define the config where to copy the info
  57761. */
  57762. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  57763. /**
  57764. * Serializes this Sub Surface configuration.
  57765. * @returns - An object with the serialized config.
  57766. */
  57767. serialize(): any;
  57768. /**
  57769. * Parses a anisotropy Configuration from a serialized object.
  57770. * @param source - Serialized object.
  57771. * @param scene Defines the scene we are parsing for
  57772. * @param rootUrl Defines the rootUrl to load from
  57773. */
  57774. parse(source: any, scene: Scene, rootUrl: string): void;
  57775. }
  57776. }
  57777. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  57778. /** @hidden */
  57779. export var pbrFragmentDeclaration: {
  57780. name: string;
  57781. shader: string;
  57782. };
  57783. }
  57784. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  57785. /** @hidden */
  57786. export var pbrUboDeclaration: {
  57787. name: string;
  57788. shader: string;
  57789. };
  57790. }
  57791. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  57792. /** @hidden */
  57793. export var pbrFragmentExtraDeclaration: {
  57794. name: string;
  57795. shader: string;
  57796. };
  57797. }
  57798. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  57799. /** @hidden */
  57800. export var pbrFragmentSamplersDeclaration: {
  57801. name: string;
  57802. shader: string;
  57803. };
  57804. }
  57805. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  57806. /** @hidden */
  57807. export var importanceSampling: {
  57808. name: string;
  57809. shader: string;
  57810. };
  57811. }
  57812. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  57813. /** @hidden */
  57814. export var pbrHelperFunctions: {
  57815. name: string;
  57816. shader: string;
  57817. };
  57818. }
  57819. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  57820. /** @hidden */
  57821. export var harmonicsFunctions: {
  57822. name: string;
  57823. shader: string;
  57824. };
  57825. }
  57826. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  57827. /** @hidden */
  57828. export var pbrDirectLightingSetupFunctions: {
  57829. name: string;
  57830. shader: string;
  57831. };
  57832. }
  57833. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  57834. /** @hidden */
  57835. export var pbrDirectLightingFalloffFunctions: {
  57836. name: string;
  57837. shader: string;
  57838. };
  57839. }
  57840. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  57841. /** @hidden */
  57842. export var pbrBRDFFunctions: {
  57843. name: string;
  57844. shader: string;
  57845. };
  57846. }
  57847. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  57848. /** @hidden */
  57849. export var hdrFilteringFunctions: {
  57850. name: string;
  57851. shader: string;
  57852. };
  57853. }
  57854. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  57855. /** @hidden */
  57856. export var pbrDirectLightingFunctions: {
  57857. name: string;
  57858. shader: string;
  57859. };
  57860. }
  57861. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  57862. /** @hidden */
  57863. export var pbrIBLFunctions: {
  57864. name: string;
  57865. shader: string;
  57866. };
  57867. }
  57868. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  57869. /** @hidden */
  57870. export var pbrBlockAlbedoOpacity: {
  57871. name: string;
  57872. shader: string;
  57873. };
  57874. }
  57875. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  57876. /** @hidden */
  57877. export var pbrBlockReflectivity: {
  57878. name: string;
  57879. shader: string;
  57880. };
  57881. }
  57882. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  57883. /** @hidden */
  57884. export var pbrBlockAmbientOcclusion: {
  57885. name: string;
  57886. shader: string;
  57887. };
  57888. }
  57889. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  57890. /** @hidden */
  57891. export var pbrBlockAlphaFresnel: {
  57892. name: string;
  57893. shader: string;
  57894. };
  57895. }
  57896. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  57897. /** @hidden */
  57898. export var pbrBlockAnisotropic: {
  57899. name: string;
  57900. shader: string;
  57901. };
  57902. }
  57903. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  57904. /** @hidden */
  57905. export var pbrBlockReflection: {
  57906. name: string;
  57907. shader: string;
  57908. };
  57909. }
  57910. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  57911. /** @hidden */
  57912. export var pbrBlockSheen: {
  57913. name: string;
  57914. shader: string;
  57915. };
  57916. }
  57917. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  57918. /** @hidden */
  57919. export var pbrBlockClearcoat: {
  57920. name: string;
  57921. shader: string;
  57922. };
  57923. }
  57924. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  57925. /** @hidden */
  57926. export var pbrBlockSubSurface: {
  57927. name: string;
  57928. shader: string;
  57929. };
  57930. }
  57931. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  57932. /** @hidden */
  57933. export var pbrBlockNormalGeometric: {
  57934. name: string;
  57935. shader: string;
  57936. };
  57937. }
  57938. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  57939. /** @hidden */
  57940. export var pbrBlockNormalFinal: {
  57941. name: string;
  57942. shader: string;
  57943. };
  57944. }
  57945. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  57946. /** @hidden */
  57947. export var pbrBlockLightmapInit: {
  57948. name: string;
  57949. shader: string;
  57950. };
  57951. }
  57952. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  57953. /** @hidden */
  57954. export var pbrBlockGeometryInfo: {
  57955. name: string;
  57956. shader: string;
  57957. };
  57958. }
  57959. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  57960. /** @hidden */
  57961. export var pbrBlockReflectance0: {
  57962. name: string;
  57963. shader: string;
  57964. };
  57965. }
  57966. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  57967. /** @hidden */
  57968. export var pbrBlockReflectance: {
  57969. name: string;
  57970. shader: string;
  57971. };
  57972. }
  57973. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  57974. /** @hidden */
  57975. export var pbrBlockDirectLighting: {
  57976. name: string;
  57977. shader: string;
  57978. };
  57979. }
  57980. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  57981. /** @hidden */
  57982. export var pbrBlockFinalLitComponents: {
  57983. name: string;
  57984. shader: string;
  57985. };
  57986. }
  57987. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  57988. /** @hidden */
  57989. export var pbrBlockFinalUnlitComponents: {
  57990. name: string;
  57991. shader: string;
  57992. };
  57993. }
  57994. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  57995. /** @hidden */
  57996. export var pbrBlockFinalColorComposition: {
  57997. name: string;
  57998. shader: string;
  57999. };
  58000. }
  58001. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58002. /** @hidden */
  58003. export var pbrBlockImageProcessing: {
  58004. name: string;
  58005. shader: string;
  58006. };
  58007. }
  58008. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58009. /** @hidden */
  58010. export var pbrDebug: {
  58011. name: string;
  58012. shader: string;
  58013. };
  58014. }
  58015. declare module "babylonjs/Shaders/pbr.fragment" {
  58016. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58017. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58018. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58019. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58020. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58021. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58022. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58023. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58024. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58025. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58026. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58027. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58028. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58029. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58030. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58031. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58032. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58033. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58034. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58035. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58036. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58037. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58038. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58039. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58040. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58041. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58042. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58043. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58044. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58045. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58046. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58047. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58048. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58049. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58050. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58051. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58052. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58053. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58054. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58055. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58056. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58057. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58058. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58059. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58060. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58061. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58062. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58063. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58064. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58065. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58066. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58067. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58068. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58069. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58070. /** @hidden */
  58071. export var pbrPixelShader: {
  58072. name: string;
  58073. shader: string;
  58074. };
  58075. }
  58076. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58077. /** @hidden */
  58078. export var pbrVertexDeclaration: {
  58079. name: string;
  58080. shader: string;
  58081. };
  58082. }
  58083. declare module "babylonjs/Shaders/pbr.vertex" {
  58084. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58085. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58086. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58087. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58088. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58089. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58090. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58091. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58092. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58093. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58094. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58095. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58096. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58097. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58098. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58099. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58100. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58101. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58102. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58103. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58104. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58105. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58106. /** @hidden */
  58107. export var pbrVertexShader: {
  58108. name: string;
  58109. shader: string;
  58110. };
  58111. }
  58112. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58113. import { Nullable } from "babylonjs/types";
  58114. import { Scene } from "babylonjs/scene";
  58115. import { Matrix } from "babylonjs/Maths/math.vector";
  58116. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58118. import { Mesh } from "babylonjs/Meshes/mesh";
  58119. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58120. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58121. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58122. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58123. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58124. import { Color3 } from "babylonjs/Maths/math.color";
  58125. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58126. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58127. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58128. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58129. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58130. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58131. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58132. import "babylonjs/Shaders/pbr.fragment";
  58133. import "babylonjs/Shaders/pbr.vertex";
  58134. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58135. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58136. /**
  58137. * Manages the defines for the PBR Material.
  58138. * @hidden
  58139. */
  58140. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58141. PBR: boolean;
  58142. NUM_SAMPLES: string;
  58143. REALTIME_FILTERING: boolean;
  58144. MAINUV1: boolean;
  58145. MAINUV2: boolean;
  58146. UV1: boolean;
  58147. UV2: boolean;
  58148. ALBEDO: boolean;
  58149. GAMMAALBEDO: boolean;
  58150. ALBEDODIRECTUV: number;
  58151. VERTEXCOLOR: boolean;
  58152. DETAIL: boolean;
  58153. DETAILDIRECTUV: number;
  58154. DETAIL_NORMALBLENDMETHOD: number;
  58155. AMBIENT: boolean;
  58156. AMBIENTDIRECTUV: number;
  58157. AMBIENTINGRAYSCALE: boolean;
  58158. OPACITY: boolean;
  58159. VERTEXALPHA: boolean;
  58160. OPACITYDIRECTUV: number;
  58161. OPACITYRGB: boolean;
  58162. ALPHATEST: boolean;
  58163. DEPTHPREPASS: boolean;
  58164. ALPHABLEND: boolean;
  58165. ALPHAFROMALBEDO: boolean;
  58166. ALPHATESTVALUE: string;
  58167. SPECULAROVERALPHA: boolean;
  58168. RADIANCEOVERALPHA: boolean;
  58169. ALPHAFRESNEL: boolean;
  58170. LINEARALPHAFRESNEL: boolean;
  58171. PREMULTIPLYALPHA: boolean;
  58172. EMISSIVE: boolean;
  58173. EMISSIVEDIRECTUV: number;
  58174. REFLECTIVITY: boolean;
  58175. REFLECTIVITYDIRECTUV: number;
  58176. SPECULARTERM: boolean;
  58177. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58178. MICROSURFACEAUTOMATIC: boolean;
  58179. LODBASEDMICROSFURACE: boolean;
  58180. MICROSURFACEMAP: boolean;
  58181. MICROSURFACEMAPDIRECTUV: number;
  58182. METALLICWORKFLOW: boolean;
  58183. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58184. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58185. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58186. AOSTOREINMETALMAPRED: boolean;
  58187. METALLIC_REFLECTANCE: boolean;
  58188. METALLIC_REFLECTANCEDIRECTUV: number;
  58189. ENVIRONMENTBRDF: boolean;
  58190. ENVIRONMENTBRDF_RGBD: boolean;
  58191. NORMAL: boolean;
  58192. TANGENT: boolean;
  58193. BUMP: boolean;
  58194. BUMPDIRECTUV: number;
  58195. OBJECTSPACE_NORMALMAP: boolean;
  58196. PARALLAX: boolean;
  58197. PARALLAXOCCLUSION: boolean;
  58198. NORMALXYSCALE: boolean;
  58199. LIGHTMAP: boolean;
  58200. LIGHTMAPDIRECTUV: number;
  58201. USELIGHTMAPASSHADOWMAP: boolean;
  58202. GAMMALIGHTMAP: boolean;
  58203. RGBDLIGHTMAP: boolean;
  58204. REFLECTION: boolean;
  58205. REFLECTIONMAP_3D: boolean;
  58206. REFLECTIONMAP_SPHERICAL: boolean;
  58207. REFLECTIONMAP_PLANAR: boolean;
  58208. REFLECTIONMAP_CUBIC: boolean;
  58209. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58210. REFLECTIONMAP_PROJECTION: boolean;
  58211. REFLECTIONMAP_SKYBOX: boolean;
  58212. REFLECTIONMAP_EXPLICIT: boolean;
  58213. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58214. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58215. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58216. INVERTCUBICMAP: boolean;
  58217. USESPHERICALFROMREFLECTIONMAP: boolean;
  58218. USEIRRADIANCEMAP: boolean;
  58219. SPHERICAL_HARMONICS: boolean;
  58220. USESPHERICALINVERTEX: boolean;
  58221. REFLECTIONMAP_OPPOSITEZ: boolean;
  58222. LODINREFLECTIONALPHA: boolean;
  58223. GAMMAREFLECTION: boolean;
  58224. RGBDREFLECTION: boolean;
  58225. LINEARSPECULARREFLECTION: boolean;
  58226. RADIANCEOCCLUSION: boolean;
  58227. HORIZONOCCLUSION: boolean;
  58228. INSTANCES: boolean;
  58229. THIN_INSTANCES: boolean;
  58230. PREPASS: boolean;
  58231. SCENE_MRT_COUNT: number;
  58232. NUM_BONE_INFLUENCERS: number;
  58233. BonesPerMesh: number;
  58234. BONETEXTURE: boolean;
  58235. NONUNIFORMSCALING: boolean;
  58236. MORPHTARGETS: boolean;
  58237. MORPHTARGETS_NORMAL: boolean;
  58238. MORPHTARGETS_TANGENT: boolean;
  58239. MORPHTARGETS_UV: boolean;
  58240. NUM_MORPH_INFLUENCERS: number;
  58241. IMAGEPROCESSING: boolean;
  58242. VIGNETTE: boolean;
  58243. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58244. VIGNETTEBLENDMODEOPAQUE: boolean;
  58245. TONEMAPPING: boolean;
  58246. TONEMAPPING_ACES: boolean;
  58247. CONTRAST: boolean;
  58248. COLORCURVES: boolean;
  58249. COLORGRADING: boolean;
  58250. COLORGRADING3D: boolean;
  58251. SAMPLER3DGREENDEPTH: boolean;
  58252. SAMPLER3DBGRMAP: boolean;
  58253. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58254. EXPOSURE: boolean;
  58255. MULTIVIEW: boolean;
  58256. USEPHYSICALLIGHTFALLOFF: boolean;
  58257. USEGLTFLIGHTFALLOFF: boolean;
  58258. TWOSIDEDLIGHTING: boolean;
  58259. SHADOWFLOAT: boolean;
  58260. CLIPPLANE: boolean;
  58261. CLIPPLANE2: boolean;
  58262. CLIPPLANE3: boolean;
  58263. CLIPPLANE4: boolean;
  58264. CLIPPLANE5: boolean;
  58265. CLIPPLANE6: boolean;
  58266. POINTSIZE: boolean;
  58267. FOG: boolean;
  58268. LOGARITHMICDEPTH: boolean;
  58269. FORCENORMALFORWARD: boolean;
  58270. SPECULARAA: boolean;
  58271. CLEARCOAT: boolean;
  58272. CLEARCOAT_DEFAULTIOR: boolean;
  58273. CLEARCOAT_TEXTURE: boolean;
  58274. CLEARCOAT_TEXTUREDIRECTUV: number;
  58275. CLEARCOAT_BUMP: boolean;
  58276. CLEARCOAT_BUMPDIRECTUV: number;
  58277. CLEARCOAT_TINT: boolean;
  58278. CLEARCOAT_TINT_TEXTURE: boolean;
  58279. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58280. ANISOTROPIC: boolean;
  58281. ANISOTROPIC_TEXTURE: boolean;
  58282. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58283. BRDF_V_HEIGHT_CORRELATED: boolean;
  58284. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58285. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58286. SHEEN: boolean;
  58287. SHEEN_TEXTURE: boolean;
  58288. SHEEN_TEXTUREDIRECTUV: number;
  58289. SHEEN_LINKWITHALBEDO: boolean;
  58290. SHEEN_ROUGHNESS: boolean;
  58291. SHEEN_ALBEDOSCALING: boolean;
  58292. SUBSURFACE: boolean;
  58293. SS_REFRACTION: boolean;
  58294. SS_TRANSLUCENCY: boolean;
  58295. SS_SCATTERING: boolean;
  58296. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58297. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58298. SS_REFRACTIONMAP_3D: boolean;
  58299. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58300. SS_LODINREFRACTIONALPHA: boolean;
  58301. SS_GAMMAREFRACTION: boolean;
  58302. SS_RGBDREFRACTION: boolean;
  58303. SS_LINEARSPECULARREFRACTION: boolean;
  58304. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58305. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58306. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58307. UNLIT: boolean;
  58308. DEBUGMODE: number;
  58309. /**
  58310. * Initializes the PBR Material defines.
  58311. */
  58312. constructor();
  58313. /**
  58314. * Resets the PBR Material defines.
  58315. */
  58316. reset(): void;
  58317. }
  58318. /**
  58319. * The Physically based material base class of BJS.
  58320. *
  58321. * This offers the main features of a standard PBR material.
  58322. * For more information, please refer to the documentation :
  58323. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58324. */
  58325. export abstract class PBRBaseMaterial extends PushMaterial {
  58326. /**
  58327. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58328. */
  58329. static readonly PBRMATERIAL_OPAQUE: number;
  58330. /**
  58331. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58332. */
  58333. static readonly PBRMATERIAL_ALPHATEST: number;
  58334. /**
  58335. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58336. */
  58337. static readonly PBRMATERIAL_ALPHABLEND: number;
  58338. /**
  58339. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58340. * They are also discarded below the alpha cutoff threshold to improve performances.
  58341. */
  58342. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58343. /**
  58344. * Defines the default value of how much AO map is occluding the analytical lights
  58345. * (point spot...).
  58346. */
  58347. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58348. /**
  58349. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58350. */
  58351. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58352. /**
  58353. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58354. * to enhance interoperability with other engines.
  58355. */
  58356. static readonly LIGHTFALLOFF_GLTF: number;
  58357. /**
  58358. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58359. * to enhance interoperability with other materials.
  58360. */
  58361. static readonly LIGHTFALLOFF_STANDARD: number;
  58362. /**
  58363. * Intensity of the direct lights e.g. the four lights available in your scene.
  58364. * This impacts both the direct diffuse and specular highlights.
  58365. */
  58366. protected _directIntensity: number;
  58367. /**
  58368. * Intensity of the emissive part of the material.
  58369. * This helps controlling the emissive effect without modifying the emissive color.
  58370. */
  58371. protected _emissiveIntensity: number;
  58372. /**
  58373. * Intensity of the environment e.g. how much the environment will light the object
  58374. * either through harmonics for rough material or through the refelction for shiny ones.
  58375. */
  58376. protected _environmentIntensity: number;
  58377. /**
  58378. * This is a special control allowing the reduction of the specular highlights coming from the
  58379. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58380. */
  58381. protected _specularIntensity: number;
  58382. /**
  58383. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  58384. */
  58385. private _lightingInfos;
  58386. /**
  58387. * Debug Control allowing disabling the bump map on this material.
  58388. */
  58389. protected _disableBumpMap: boolean;
  58390. /**
  58391. * AKA Diffuse Texture in standard nomenclature.
  58392. */
  58393. protected _albedoTexture: Nullable<BaseTexture>;
  58394. /**
  58395. * AKA Occlusion Texture in other nomenclature.
  58396. */
  58397. protected _ambientTexture: Nullable<BaseTexture>;
  58398. /**
  58399. * AKA Occlusion Texture Intensity in other nomenclature.
  58400. */
  58401. protected _ambientTextureStrength: number;
  58402. /**
  58403. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58404. * 1 means it completely occludes it
  58405. * 0 mean it has no impact
  58406. */
  58407. protected _ambientTextureImpactOnAnalyticalLights: number;
  58408. /**
  58409. * Stores the alpha values in a texture.
  58410. */
  58411. protected _opacityTexture: Nullable<BaseTexture>;
  58412. /**
  58413. * Stores the reflection values in a texture.
  58414. */
  58415. protected _reflectionTexture: Nullable<BaseTexture>;
  58416. /**
  58417. * Stores the emissive values in a texture.
  58418. */
  58419. protected _emissiveTexture: Nullable<BaseTexture>;
  58420. /**
  58421. * AKA Specular texture in other nomenclature.
  58422. */
  58423. protected _reflectivityTexture: Nullable<BaseTexture>;
  58424. /**
  58425. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58426. */
  58427. protected _metallicTexture: Nullable<BaseTexture>;
  58428. /**
  58429. * Specifies the metallic scalar of the metallic/roughness workflow.
  58430. * Can also be used to scale the metalness values of the metallic texture.
  58431. */
  58432. protected _metallic: Nullable<number>;
  58433. /**
  58434. * Specifies the roughness scalar of the metallic/roughness workflow.
  58435. * Can also be used to scale the roughness values of the metallic texture.
  58436. */
  58437. protected _roughness: Nullable<number>;
  58438. /**
  58439. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58440. * By default the indexOfrefraction is used to compute F0;
  58441. *
  58442. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58443. *
  58444. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58445. * F90 = metallicReflectanceColor;
  58446. */
  58447. protected _metallicF0Factor: number;
  58448. /**
  58449. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58450. * By default the F90 is always 1;
  58451. *
  58452. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58453. *
  58454. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58455. * F90 = metallicReflectanceColor;
  58456. */
  58457. protected _metallicReflectanceColor: Color3;
  58458. /**
  58459. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58460. * This is multiply against the scalar values defined in the material.
  58461. */
  58462. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  58463. /**
  58464. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58465. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58466. */
  58467. protected _microSurfaceTexture: Nullable<BaseTexture>;
  58468. /**
  58469. * Stores surface normal data used to displace a mesh in a texture.
  58470. */
  58471. protected _bumpTexture: Nullable<BaseTexture>;
  58472. /**
  58473. * Stores the pre-calculated light information of a mesh in a texture.
  58474. */
  58475. protected _lightmapTexture: Nullable<BaseTexture>;
  58476. /**
  58477. * The color of a material in ambient lighting.
  58478. */
  58479. protected _ambientColor: Color3;
  58480. /**
  58481. * AKA Diffuse Color in other nomenclature.
  58482. */
  58483. protected _albedoColor: Color3;
  58484. /**
  58485. * AKA Specular Color in other nomenclature.
  58486. */
  58487. protected _reflectivityColor: Color3;
  58488. /**
  58489. * The color applied when light is reflected from a material.
  58490. */
  58491. protected _reflectionColor: Color3;
  58492. /**
  58493. * The color applied when light is emitted from a material.
  58494. */
  58495. protected _emissiveColor: Color3;
  58496. /**
  58497. * AKA Glossiness in other nomenclature.
  58498. */
  58499. protected _microSurface: number;
  58500. /**
  58501. * Specifies that the material will use the light map as a show map.
  58502. */
  58503. protected _useLightmapAsShadowmap: boolean;
  58504. /**
  58505. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  58506. * makes the reflect vector face the model (under horizon).
  58507. */
  58508. protected _useHorizonOcclusion: boolean;
  58509. /**
  58510. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  58511. * too much the area relying on ambient texture to define their ambient occlusion.
  58512. */
  58513. protected _useRadianceOcclusion: boolean;
  58514. /**
  58515. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  58516. */
  58517. protected _useAlphaFromAlbedoTexture: boolean;
  58518. /**
  58519. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  58520. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  58521. */
  58522. protected _useSpecularOverAlpha: boolean;
  58523. /**
  58524. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  58525. */
  58526. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  58527. /**
  58528. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  58529. */
  58530. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  58531. /**
  58532. * Specifies if the metallic texture contains the roughness information in its green channel.
  58533. */
  58534. protected _useRoughnessFromMetallicTextureGreen: boolean;
  58535. /**
  58536. * Specifies if the metallic texture contains the metallness information in its blue channel.
  58537. */
  58538. protected _useMetallnessFromMetallicTextureBlue: boolean;
  58539. /**
  58540. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  58541. */
  58542. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  58543. /**
  58544. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  58545. */
  58546. protected _useAmbientInGrayScale: boolean;
  58547. /**
  58548. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  58549. * The material will try to infer what glossiness each pixel should be.
  58550. */
  58551. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  58552. /**
  58553. * Defines the falloff type used in this material.
  58554. * It by default is Physical.
  58555. */
  58556. protected _lightFalloff: number;
  58557. /**
  58558. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  58559. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  58560. */
  58561. protected _useRadianceOverAlpha: boolean;
  58562. /**
  58563. * Allows using an object space normal map (instead of tangent space).
  58564. */
  58565. protected _useObjectSpaceNormalMap: boolean;
  58566. /**
  58567. * Allows using the bump map in parallax mode.
  58568. */
  58569. protected _useParallax: boolean;
  58570. /**
  58571. * Allows using the bump map in parallax occlusion mode.
  58572. */
  58573. protected _useParallaxOcclusion: boolean;
  58574. /**
  58575. * Controls the scale bias of the parallax mode.
  58576. */
  58577. protected _parallaxScaleBias: number;
  58578. /**
  58579. * If sets to true, disables all the lights affecting the material.
  58580. */
  58581. protected _disableLighting: boolean;
  58582. /**
  58583. * Number of Simultaneous lights allowed on the material.
  58584. */
  58585. protected _maxSimultaneousLights: number;
  58586. /**
  58587. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  58588. */
  58589. protected _invertNormalMapX: boolean;
  58590. /**
  58591. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  58592. */
  58593. protected _invertNormalMapY: boolean;
  58594. /**
  58595. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  58596. */
  58597. protected _twoSidedLighting: boolean;
  58598. /**
  58599. * Defines the alpha limits in alpha test mode.
  58600. */
  58601. protected _alphaCutOff: number;
  58602. /**
  58603. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  58604. */
  58605. protected _forceAlphaTest: boolean;
  58606. /**
  58607. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58608. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  58609. */
  58610. protected _useAlphaFresnel: boolean;
  58611. /**
  58612. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58613. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  58614. */
  58615. protected _useLinearAlphaFresnel: boolean;
  58616. /**
  58617. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  58618. * from cos thetav and roughness:
  58619. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  58620. */
  58621. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  58622. /**
  58623. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  58624. */
  58625. protected _forceIrradianceInFragment: boolean;
  58626. private _realTimeFiltering;
  58627. /**
  58628. * Enables realtime filtering on the texture.
  58629. */
  58630. get realTimeFiltering(): boolean;
  58631. set realTimeFiltering(b: boolean);
  58632. private _realTimeFilteringQuality;
  58633. /**
  58634. * Quality switch for realtime filtering
  58635. */
  58636. get realTimeFilteringQuality(): number;
  58637. set realTimeFilteringQuality(n: number);
  58638. /**
  58639. * Can this material render to several textures at once
  58640. */
  58641. get canRenderToMRT(): boolean;
  58642. /**
  58643. * Force normal to face away from face.
  58644. */
  58645. protected _forceNormalForward: boolean;
  58646. /**
  58647. * Enables specular anti aliasing in the PBR shader.
  58648. * It will both interacts on the Geometry for analytical and IBL lighting.
  58649. * It also prefilter the roughness map based on the bump values.
  58650. */
  58651. protected _enableSpecularAntiAliasing: boolean;
  58652. /**
  58653. * Default configuration related to image processing available in the PBR Material.
  58654. */
  58655. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  58656. /**
  58657. * Keep track of the image processing observer to allow dispose and replace.
  58658. */
  58659. private _imageProcessingObserver;
  58660. /**
  58661. * Attaches a new image processing configuration to the PBR Material.
  58662. * @param configuration
  58663. */
  58664. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  58665. /**
  58666. * Stores the available render targets.
  58667. */
  58668. private _renderTargets;
  58669. /**
  58670. * Sets the global ambient color for the material used in lighting calculations.
  58671. */
  58672. private _globalAmbientColor;
  58673. /**
  58674. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  58675. */
  58676. private _useLogarithmicDepth;
  58677. /**
  58678. * If set to true, no lighting calculations will be applied.
  58679. */
  58680. private _unlit;
  58681. private _debugMode;
  58682. /**
  58683. * @hidden
  58684. * This is reserved for the inspector.
  58685. * Defines the material debug mode.
  58686. * It helps seeing only some components of the material while troubleshooting.
  58687. */
  58688. debugMode: number;
  58689. /**
  58690. * @hidden
  58691. * This is reserved for the inspector.
  58692. * Specify from where on screen the debug mode should start.
  58693. * The value goes from -1 (full screen) to 1 (not visible)
  58694. * It helps with side by side comparison against the final render
  58695. * This defaults to -1
  58696. */
  58697. private debugLimit;
  58698. /**
  58699. * @hidden
  58700. * This is reserved for the inspector.
  58701. * As the default viewing range might not be enough (if the ambient is really small for instance)
  58702. * You can use the factor to better multiply the final value.
  58703. */
  58704. private debugFactor;
  58705. /**
  58706. * Defines the clear coat layer parameters for the material.
  58707. */
  58708. readonly clearCoat: PBRClearCoatConfiguration;
  58709. /**
  58710. * Defines the anisotropic parameters for the material.
  58711. */
  58712. readonly anisotropy: PBRAnisotropicConfiguration;
  58713. /**
  58714. * Defines the BRDF parameters for the material.
  58715. */
  58716. readonly brdf: PBRBRDFConfiguration;
  58717. /**
  58718. * Defines the Sheen parameters for the material.
  58719. */
  58720. readonly sheen: PBRSheenConfiguration;
  58721. /**
  58722. * Defines the SubSurface parameters for the material.
  58723. */
  58724. readonly subSurface: PBRSubSurfaceConfiguration;
  58725. /**
  58726. * Defines the detail map parameters for the material.
  58727. */
  58728. readonly detailMap: DetailMapConfiguration;
  58729. protected _rebuildInParallel: boolean;
  58730. /**
  58731. * Instantiates a new PBRMaterial instance.
  58732. *
  58733. * @param name The material name
  58734. * @param scene The scene the material will be use in.
  58735. */
  58736. constructor(name: string, scene: Scene);
  58737. /**
  58738. * Gets a boolean indicating that current material needs to register RTT
  58739. */
  58740. get hasRenderTargetTextures(): boolean;
  58741. /**
  58742. * Gets the name of the material class.
  58743. */
  58744. getClassName(): string;
  58745. /**
  58746. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58747. */
  58748. get useLogarithmicDepth(): boolean;
  58749. /**
  58750. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58751. */
  58752. set useLogarithmicDepth(value: boolean);
  58753. /**
  58754. * Returns true if alpha blending should be disabled.
  58755. */
  58756. protected get _disableAlphaBlending(): boolean;
  58757. /**
  58758. * Specifies whether or not this material should be rendered in alpha blend mode.
  58759. */
  58760. needAlphaBlending(): boolean;
  58761. /**
  58762. * Specifies whether or not this material should be rendered in alpha test mode.
  58763. */
  58764. needAlphaTesting(): boolean;
  58765. /**
  58766. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  58767. */
  58768. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  58769. /**
  58770. * Gets the texture used for the alpha test.
  58771. */
  58772. getAlphaTestTexture(): Nullable<BaseTexture>;
  58773. /**
  58774. * Specifies that the submesh is ready to be used.
  58775. * @param mesh - BJS mesh.
  58776. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  58777. * @param useInstances - Specifies that instances should be used.
  58778. * @returns - boolean indicating that the submesh is ready or not.
  58779. */
  58780. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  58781. /**
  58782. * Specifies if the material uses metallic roughness workflow.
  58783. * @returns boolean specifiying if the material uses metallic roughness workflow.
  58784. */
  58785. isMetallicWorkflow(): boolean;
  58786. private _prepareEffect;
  58787. private _prepareDefines;
  58788. /**
  58789. * Force shader compilation
  58790. */
  58791. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  58792. /**
  58793. * Initializes the uniform buffer layout for the shader.
  58794. */
  58795. buildUniformLayout(): void;
  58796. /**
  58797. * Unbinds the material from the mesh
  58798. */
  58799. unbind(): void;
  58800. /**
  58801. * Binds the submesh data.
  58802. * @param world - The world matrix.
  58803. * @param mesh - The BJS mesh.
  58804. * @param subMesh - A submesh of the BJS mesh.
  58805. */
  58806. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  58807. /**
  58808. * Returns the animatable textures.
  58809. * @returns - Array of animatable textures.
  58810. */
  58811. getAnimatables(): IAnimatable[];
  58812. /**
  58813. * Returns the texture used for reflections.
  58814. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  58815. */
  58816. private _getReflectionTexture;
  58817. /**
  58818. * Returns an array of the actively used textures.
  58819. * @returns - Array of BaseTextures
  58820. */
  58821. getActiveTextures(): BaseTexture[];
  58822. /**
  58823. * Checks to see if a texture is used in the material.
  58824. * @param texture - Base texture to use.
  58825. * @returns - Boolean specifying if a texture is used in the material.
  58826. */
  58827. hasTexture(texture: BaseTexture): boolean;
  58828. /**
  58829. * Sets the required values to the prepass renderer.
  58830. * @param prePassRenderer defines the prepass renderer to setup
  58831. */
  58832. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  58833. /**
  58834. * Disposes the resources of the material.
  58835. * @param forceDisposeEffect - Forces the disposal of effects.
  58836. * @param forceDisposeTextures - Forces the disposal of all textures.
  58837. */
  58838. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  58839. }
  58840. }
  58841. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  58842. import { Nullable } from "babylonjs/types";
  58843. import { Scene } from "babylonjs/scene";
  58844. import { Color3 } from "babylonjs/Maths/math.color";
  58845. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  58846. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  58847. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58848. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  58849. /**
  58850. * The Physically based material of BJS.
  58851. *
  58852. * This offers the main features of a standard PBR material.
  58853. * For more information, please refer to the documentation :
  58854. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58855. */
  58856. export class PBRMaterial extends PBRBaseMaterial {
  58857. /**
  58858. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58859. */
  58860. static readonly PBRMATERIAL_OPAQUE: number;
  58861. /**
  58862. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58863. */
  58864. static readonly PBRMATERIAL_ALPHATEST: number;
  58865. /**
  58866. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58867. */
  58868. static readonly PBRMATERIAL_ALPHABLEND: number;
  58869. /**
  58870. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58871. * They are also discarded below the alpha cutoff threshold to improve performances.
  58872. */
  58873. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58874. /**
  58875. * Defines the default value of how much AO map is occluding the analytical lights
  58876. * (point spot...).
  58877. */
  58878. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58879. /**
  58880. * Intensity of the direct lights e.g. the four lights available in your scene.
  58881. * This impacts both the direct diffuse and specular highlights.
  58882. */
  58883. directIntensity: number;
  58884. /**
  58885. * Intensity of the emissive part of the material.
  58886. * This helps controlling the emissive effect without modifying the emissive color.
  58887. */
  58888. emissiveIntensity: number;
  58889. /**
  58890. * Intensity of the environment e.g. how much the environment will light the object
  58891. * either through harmonics for rough material or through the refelction for shiny ones.
  58892. */
  58893. environmentIntensity: number;
  58894. /**
  58895. * This is a special control allowing the reduction of the specular highlights coming from the
  58896. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58897. */
  58898. specularIntensity: number;
  58899. /**
  58900. * Debug Control allowing disabling the bump map on this material.
  58901. */
  58902. disableBumpMap: boolean;
  58903. /**
  58904. * AKA Diffuse Texture in standard nomenclature.
  58905. */
  58906. albedoTexture: BaseTexture;
  58907. /**
  58908. * AKA Occlusion Texture in other nomenclature.
  58909. */
  58910. ambientTexture: BaseTexture;
  58911. /**
  58912. * AKA Occlusion Texture Intensity in other nomenclature.
  58913. */
  58914. ambientTextureStrength: number;
  58915. /**
  58916. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58917. * 1 means it completely occludes it
  58918. * 0 mean it has no impact
  58919. */
  58920. ambientTextureImpactOnAnalyticalLights: number;
  58921. /**
  58922. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  58923. */
  58924. opacityTexture: BaseTexture;
  58925. /**
  58926. * Stores the reflection values in a texture.
  58927. */
  58928. reflectionTexture: Nullable<BaseTexture>;
  58929. /**
  58930. * Stores the emissive values in a texture.
  58931. */
  58932. emissiveTexture: BaseTexture;
  58933. /**
  58934. * AKA Specular texture in other nomenclature.
  58935. */
  58936. reflectivityTexture: BaseTexture;
  58937. /**
  58938. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58939. */
  58940. metallicTexture: BaseTexture;
  58941. /**
  58942. * Specifies the metallic scalar of the metallic/roughness workflow.
  58943. * Can also be used to scale the metalness values of the metallic texture.
  58944. */
  58945. metallic: Nullable<number>;
  58946. /**
  58947. * Specifies the roughness scalar of the metallic/roughness workflow.
  58948. * Can also be used to scale the roughness values of the metallic texture.
  58949. */
  58950. roughness: Nullable<number>;
  58951. /**
  58952. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58953. * By default the indexOfrefraction is used to compute F0;
  58954. *
  58955. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58956. *
  58957. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58958. * F90 = metallicReflectanceColor;
  58959. */
  58960. metallicF0Factor: number;
  58961. /**
  58962. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58963. * By default the F90 is always 1;
  58964. *
  58965. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58966. *
  58967. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58968. * F90 = metallicReflectanceColor;
  58969. */
  58970. metallicReflectanceColor: Color3;
  58971. /**
  58972. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58973. * This is multiply against the scalar values defined in the material.
  58974. */
  58975. metallicReflectanceTexture: Nullable<BaseTexture>;
  58976. /**
  58977. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58978. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58979. */
  58980. microSurfaceTexture: BaseTexture;
  58981. /**
  58982. * Stores surface normal data used to displace a mesh in a texture.
  58983. */
  58984. bumpTexture: BaseTexture;
  58985. /**
  58986. * Stores the pre-calculated light information of a mesh in a texture.
  58987. */
  58988. lightmapTexture: BaseTexture;
  58989. /**
  58990. * Stores the refracted light information in a texture.
  58991. */
  58992. get refractionTexture(): Nullable<BaseTexture>;
  58993. set refractionTexture(value: Nullable<BaseTexture>);
  58994. /**
  58995. * The color of a material in ambient lighting.
  58996. */
  58997. ambientColor: Color3;
  58998. /**
  58999. * AKA Diffuse Color in other nomenclature.
  59000. */
  59001. albedoColor: Color3;
  59002. /**
  59003. * AKA Specular Color in other nomenclature.
  59004. */
  59005. reflectivityColor: Color3;
  59006. /**
  59007. * The color reflected from the material.
  59008. */
  59009. reflectionColor: Color3;
  59010. /**
  59011. * The color emitted from the material.
  59012. */
  59013. emissiveColor: Color3;
  59014. /**
  59015. * AKA Glossiness in other nomenclature.
  59016. */
  59017. microSurface: number;
  59018. /**
  59019. * Index of refraction of the material base layer.
  59020. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59021. *
  59022. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59023. *
  59024. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59025. */
  59026. get indexOfRefraction(): number;
  59027. set indexOfRefraction(value: number);
  59028. /**
  59029. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59030. */
  59031. get invertRefractionY(): boolean;
  59032. set invertRefractionY(value: boolean);
  59033. /**
  59034. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59035. * Materials half opaque for instance using refraction could benefit from this control.
  59036. */
  59037. get linkRefractionWithTransparency(): boolean;
  59038. set linkRefractionWithTransparency(value: boolean);
  59039. /**
  59040. * If true, the light map contains occlusion information instead of lighting info.
  59041. */
  59042. useLightmapAsShadowmap: boolean;
  59043. /**
  59044. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59045. */
  59046. useAlphaFromAlbedoTexture: boolean;
  59047. /**
  59048. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59049. */
  59050. forceAlphaTest: boolean;
  59051. /**
  59052. * Defines the alpha limits in alpha test mode.
  59053. */
  59054. alphaCutOff: number;
  59055. /**
  59056. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59057. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59058. */
  59059. useSpecularOverAlpha: boolean;
  59060. /**
  59061. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59062. */
  59063. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59064. /**
  59065. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59066. */
  59067. useRoughnessFromMetallicTextureAlpha: boolean;
  59068. /**
  59069. * Specifies if the metallic texture contains the roughness information in its green channel.
  59070. */
  59071. useRoughnessFromMetallicTextureGreen: boolean;
  59072. /**
  59073. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59074. */
  59075. useMetallnessFromMetallicTextureBlue: boolean;
  59076. /**
  59077. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59078. */
  59079. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59080. /**
  59081. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59082. */
  59083. useAmbientInGrayScale: boolean;
  59084. /**
  59085. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59086. * The material will try to infer what glossiness each pixel should be.
  59087. */
  59088. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59089. /**
  59090. * BJS is using an harcoded light falloff based on a manually sets up range.
  59091. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59092. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59093. */
  59094. get usePhysicalLightFalloff(): boolean;
  59095. /**
  59096. * BJS is using an harcoded light falloff based on a manually sets up range.
  59097. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59098. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59099. */
  59100. set usePhysicalLightFalloff(value: boolean);
  59101. /**
  59102. * In order to support the falloff compatibility with gltf, a special mode has been added
  59103. * to reproduce the gltf light falloff.
  59104. */
  59105. get useGLTFLightFalloff(): boolean;
  59106. /**
  59107. * In order to support the falloff compatibility with gltf, a special mode has been added
  59108. * to reproduce the gltf light falloff.
  59109. */
  59110. set useGLTFLightFalloff(value: boolean);
  59111. /**
  59112. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59113. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59114. */
  59115. useRadianceOverAlpha: boolean;
  59116. /**
  59117. * Allows using an object space normal map (instead of tangent space).
  59118. */
  59119. useObjectSpaceNormalMap: boolean;
  59120. /**
  59121. * Allows using the bump map in parallax mode.
  59122. */
  59123. useParallax: boolean;
  59124. /**
  59125. * Allows using the bump map in parallax occlusion mode.
  59126. */
  59127. useParallaxOcclusion: boolean;
  59128. /**
  59129. * Controls the scale bias of the parallax mode.
  59130. */
  59131. parallaxScaleBias: number;
  59132. /**
  59133. * If sets to true, disables all the lights affecting the material.
  59134. */
  59135. disableLighting: boolean;
  59136. /**
  59137. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59138. */
  59139. forceIrradianceInFragment: boolean;
  59140. /**
  59141. * Number of Simultaneous lights allowed on the material.
  59142. */
  59143. maxSimultaneousLights: number;
  59144. /**
  59145. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59146. */
  59147. invertNormalMapX: boolean;
  59148. /**
  59149. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59150. */
  59151. invertNormalMapY: boolean;
  59152. /**
  59153. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59154. */
  59155. twoSidedLighting: boolean;
  59156. /**
  59157. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59158. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59159. */
  59160. useAlphaFresnel: boolean;
  59161. /**
  59162. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59163. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59164. */
  59165. useLinearAlphaFresnel: boolean;
  59166. /**
  59167. * Let user defines the brdf lookup texture used for IBL.
  59168. * A default 8bit version is embedded but you could point at :
  59169. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59170. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59171. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59172. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59173. */
  59174. environmentBRDFTexture: Nullable<BaseTexture>;
  59175. /**
  59176. * Force normal to face away from face.
  59177. */
  59178. forceNormalForward: boolean;
  59179. /**
  59180. * Enables specular anti aliasing in the PBR shader.
  59181. * It will both interacts on the Geometry for analytical and IBL lighting.
  59182. * It also prefilter the roughness map based on the bump values.
  59183. */
  59184. enableSpecularAntiAliasing: boolean;
  59185. /**
  59186. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59187. * makes the reflect vector face the model (under horizon).
  59188. */
  59189. useHorizonOcclusion: boolean;
  59190. /**
  59191. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59192. * too much the area relying on ambient texture to define their ambient occlusion.
  59193. */
  59194. useRadianceOcclusion: boolean;
  59195. /**
  59196. * If set to true, no lighting calculations will be applied.
  59197. */
  59198. unlit: boolean;
  59199. /**
  59200. * Gets the image processing configuration used either in this material.
  59201. */
  59202. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59203. /**
  59204. * Sets the Default image processing configuration used either in the this material.
  59205. *
  59206. * If sets to null, the scene one is in use.
  59207. */
  59208. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59209. /**
  59210. * Gets wether the color curves effect is enabled.
  59211. */
  59212. get cameraColorCurvesEnabled(): boolean;
  59213. /**
  59214. * Sets wether the color curves effect is enabled.
  59215. */
  59216. set cameraColorCurvesEnabled(value: boolean);
  59217. /**
  59218. * Gets wether the color grading effect is enabled.
  59219. */
  59220. get cameraColorGradingEnabled(): boolean;
  59221. /**
  59222. * Gets wether the color grading effect is enabled.
  59223. */
  59224. set cameraColorGradingEnabled(value: boolean);
  59225. /**
  59226. * Gets wether tonemapping is enabled or not.
  59227. */
  59228. get cameraToneMappingEnabled(): boolean;
  59229. /**
  59230. * Sets wether tonemapping is enabled or not
  59231. */
  59232. set cameraToneMappingEnabled(value: boolean);
  59233. /**
  59234. * The camera exposure used on this material.
  59235. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59236. * This corresponds to a photographic exposure.
  59237. */
  59238. get cameraExposure(): number;
  59239. /**
  59240. * The camera exposure used on this material.
  59241. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59242. * This corresponds to a photographic exposure.
  59243. */
  59244. set cameraExposure(value: number);
  59245. /**
  59246. * Gets The camera contrast used on this material.
  59247. */
  59248. get cameraContrast(): number;
  59249. /**
  59250. * Sets The camera contrast used on this material.
  59251. */
  59252. set cameraContrast(value: number);
  59253. /**
  59254. * Gets the Color Grading 2D Lookup Texture.
  59255. */
  59256. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59257. /**
  59258. * Sets the Color Grading 2D Lookup Texture.
  59259. */
  59260. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59261. /**
  59262. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59263. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59264. * 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;
  59265. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59266. */
  59267. get cameraColorCurves(): Nullable<ColorCurves>;
  59268. /**
  59269. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59270. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59271. * 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;
  59272. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59273. */
  59274. set cameraColorCurves(value: Nullable<ColorCurves>);
  59275. /**
  59276. * Instantiates a new PBRMaterial instance.
  59277. *
  59278. * @param name The material name
  59279. * @param scene The scene the material will be use in.
  59280. */
  59281. constructor(name: string, scene: Scene);
  59282. /**
  59283. * Returns the name of this material class.
  59284. */
  59285. getClassName(): string;
  59286. /**
  59287. * Makes a duplicate of the current material.
  59288. * @param name - name to use for the new material.
  59289. */
  59290. clone(name: string): PBRMaterial;
  59291. /**
  59292. * Serializes this PBR Material.
  59293. * @returns - An object with the serialized material.
  59294. */
  59295. serialize(): any;
  59296. /**
  59297. * Parses a PBR Material from a serialized object.
  59298. * @param source - Serialized object.
  59299. * @param scene - BJS scene instance.
  59300. * @param rootUrl - url for the scene object
  59301. * @returns - PBRMaterial
  59302. */
  59303. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59304. }
  59305. }
  59306. declare module "babylonjs/Misc/dds" {
  59307. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59308. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59309. import { Nullable } from "babylonjs/types";
  59310. import { Scene } from "babylonjs/scene";
  59311. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59312. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59313. /**
  59314. * Direct draw surface info
  59315. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59316. */
  59317. export interface DDSInfo {
  59318. /**
  59319. * Width of the texture
  59320. */
  59321. width: number;
  59322. /**
  59323. * Width of the texture
  59324. */
  59325. height: number;
  59326. /**
  59327. * Number of Mipmaps for the texture
  59328. * @see https://en.wikipedia.org/wiki/Mipmap
  59329. */
  59330. mipmapCount: number;
  59331. /**
  59332. * If the textures format is a known fourCC format
  59333. * @see https://www.fourcc.org/
  59334. */
  59335. isFourCC: boolean;
  59336. /**
  59337. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59338. */
  59339. isRGB: boolean;
  59340. /**
  59341. * If the texture is a lumincance format
  59342. */
  59343. isLuminance: boolean;
  59344. /**
  59345. * If this is a cube texture
  59346. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59347. */
  59348. isCube: boolean;
  59349. /**
  59350. * If the texture is a compressed format eg. FOURCC_DXT1
  59351. */
  59352. isCompressed: boolean;
  59353. /**
  59354. * The dxgiFormat of the texture
  59355. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59356. */
  59357. dxgiFormat: number;
  59358. /**
  59359. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59360. */
  59361. textureType: number;
  59362. /**
  59363. * Sphericle polynomial created for the dds texture
  59364. */
  59365. sphericalPolynomial?: SphericalPolynomial;
  59366. }
  59367. /**
  59368. * Class used to provide DDS decompression tools
  59369. */
  59370. export class DDSTools {
  59371. /**
  59372. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59373. */
  59374. static StoreLODInAlphaChannel: boolean;
  59375. /**
  59376. * Gets DDS information from an array buffer
  59377. * @param data defines the array buffer view to read data from
  59378. * @returns the DDS information
  59379. */
  59380. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59381. private static _FloatView;
  59382. private static _Int32View;
  59383. private static _ToHalfFloat;
  59384. private static _FromHalfFloat;
  59385. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59386. private static _GetHalfFloatRGBAArrayBuffer;
  59387. private static _GetFloatRGBAArrayBuffer;
  59388. private static _GetFloatAsUIntRGBAArrayBuffer;
  59389. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59390. private static _GetRGBAArrayBuffer;
  59391. private static _ExtractLongWordOrder;
  59392. private static _GetRGBArrayBuffer;
  59393. private static _GetLuminanceArrayBuffer;
  59394. /**
  59395. * Uploads DDS Levels to a Babylon Texture
  59396. * @hidden
  59397. */
  59398. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  59399. }
  59400. module "babylonjs/Engines/thinEngine" {
  59401. interface ThinEngine {
  59402. /**
  59403. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  59404. * @param rootUrl defines the url where the file to load is located
  59405. * @param scene defines the current scene
  59406. * @param lodScale defines scale to apply to the mip map selection
  59407. * @param lodOffset defines offset to apply to the mip map selection
  59408. * @param onLoad defines an optional callback raised when the texture is loaded
  59409. * @param onError defines an optional callback raised if there is an issue to load the texture
  59410. * @param format defines the format of the data
  59411. * @param forcedExtension defines the extension to use to pick the right loader
  59412. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  59413. * @returns the cube texture as an InternalTexture
  59414. */
  59415. 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;
  59416. }
  59417. }
  59418. }
  59419. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  59420. import { Nullable } from "babylonjs/types";
  59421. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59422. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59423. /**
  59424. * Implementation of the DDS Texture Loader.
  59425. * @hidden
  59426. */
  59427. export class _DDSTextureLoader implements IInternalTextureLoader {
  59428. /**
  59429. * Defines wether the loader supports cascade loading the different faces.
  59430. */
  59431. readonly supportCascades: boolean;
  59432. /**
  59433. * This returns if the loader support the current file information.
  59434. * @param extension defines the file extension of the file being loaded
  59435. * @returns true if the loader can load the specified file
  59436. */
  59437. canLoad(extension: string): boolean;
  59438. /**
  59439. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59440. * @param data contains the texture data
  59441. * @param texture defines the BabylonJS internal texture
  59442. * @param createPolynomials will be true if polynomials have been requested
  59443. * @param onLoad defines the callback to trigger once the texture is ready
  59444. * @param onError defines the callback to trigger in case of error
  59445. */
  59446. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59447. /**
  59448. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59449. * @param data contains the texture data
  59450. * @param texture defines the BabylonJS internal texture
  59451. * @param callback defines the method to call once ready to upload
  59452. */
  59453. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59454. }
  59455. }
  59456. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  59457. import { Nullable } from "babylonjs/types";
  59458. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59459. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59460. /**
  59461. * Implementation of the ENV Texture Loader.
  59462. * @hidden
  59463. */
  59464. export class _ENVTextureLoader implements IInternalTextureLoader {
  59465. /**
  59466. * Defines wether the loader supports cascade loading the different faces.
  59467. */
  59468. readonly supportCascades: boolean;
  59469. /**
  59470. * This returns if the loader support the current file information.
  59471. * @param extension defines the file extension of the file being loaded
  59472. * @returns true if the loader can load the specified file
  59473. */
  59474. canLoad(extension: string): boolean;
  59475. /**
  59476. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59477. * @param data contains the texture data
  59478. * @param texture defines the BabylonJS internal texture
  59479. * @param createPolynomials will be true if polynomials have been requested
  59480. * @param onLoad defines the callback to trigger once the texture is ready
  59481. * @param onError defines the callback to trigger in case of error
  59482. */
  59483. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59484. /**
  59485. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59486. * @param data contains the texture data
  59487. * @param texture defines the BabylonJS internal texture
  59488. * @param callback defines the method to call once ready to upload
  59489. */
  59490. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59491. }
  59492. }
  59493. declare module "babylonjs/Misc/khronosTextureContainer" {
  59494. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59495. /**
  59496. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  59497. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  59498. */
  59499. export class KhronosTextureContainer {
  59500. /** contents of the KTX container file */
  59501. data: ArrayBufferView;
  59502. private static HEADER_LEN;
  59503. private static COMPRESSED_2D;
  59504. private static COMPRESSED_3D;
  59505. private static TEX_2D;
  59506. private static TEX_3D;
  59507. /**
  59508. * Gets the openGL type
  59509. */
  59510. glType: number;
  59511. /**
  59512. * Gets the openGL type size
  59513. */
  59514. glTypeSize: number;
  59515. /**
  59516. * Gets the openGL format
  59517. */
  59518. glFormat: number;
  59519. /**
  59520. * Gets the openGL internal format
  59521. */
  59522. glInternalFormat: number;
  59523. /**
  59524. * Gets the base internal format
  59525. */
  59526. glBaseInternalFormat: number;
  59527. /**
  59528. * Gets image width in pixel
  59529. */
  59530. pixelWidth: number;
  59531. /**
  59532. * Gets image height in pixel
  59533. */
  59534. pixelHeight: number;
  59535. /**
  59536. * Gets image depth in pixels
  59537. */
  59538. pixelDepth: number;
  59539. /**
  59540. * Gets the number of array elements
  59541. */
  59542. numberOfArrayElements: number;
  59543. /**
  59544. * Gets the number of faces
  59545. */
  59546. numberOfFaces: number;
  59547. /**
  59548. * Gets the number of mipmap levels
  59549. */
  59550. numberOfMipmapLevels: number;
  59551. /**
  59552. * Gets the bytes of key value data
  59553. */
  59554. bytesOfKeyValueData: number;
  59555. /**
  59556. * Gets the load type
  59557. */
  59558. loadType: number;
  59559. /**
  59560. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  59561. */
  59562. isInvalid: boolean;
  59563. /**
  59564. * Creates a new KhronosTextureContainer
  59565. * @param data contents of the KTX container file
  59566. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  59567. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  59568. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  59569. */
  59570. constructor(
  59571. /** contents of the KTX container file */
  59572. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  59573. /**
  59574. * Uploads KTX content to a Babylon Texture.
  59575. * It is assumed that the texture has already been created & is currently bound
  59576. * @hidden
  59577. */
  59578. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  59579. private _upload2DCompressedLevels;
  59580. /**
  59581. * Checks if the given data starts with a KTX file identifier.
  59582. * @param data the data to check
  59583. * @returns true if the data is a KTX file or false otherwise
  59584. */
  59585. static IsValid(data: ArrayBufferView): boolean;
  59586. }
  59587. }
  59588. declare module "babylonjs/Misc/khronosTextureContainer2" {
  59589. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59590. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59591. /**
  59592. * Class for loading KTX2 files
  59593. * !!! Experimental Extension Subject to Changes !!!
  59594. * @hidden
  59595. */
  59596. export class KhronosTextureContainer2 {
  59597. private static _ModulePromise;
  59598. private static _TranscodeFormat;
  59599. constructor(engine: ThinEngine);
  59600. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  59601. private _determineTranscodeFormat;
  59602. /**
  59603. * Checks if the given data starts with a KTX2 file identifier.
  59604. * @param data the data to check
  59605. * @returns true if the data is a KTX2 file or false otherwise
  59606. */
  59607. static IsValid(data: ArrayBufferView): boolean;
  59608. }
  59609. }
  59610. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  59611. import { Nullable } from "babylonjs/types";
  59612. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59613. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59614. /**
  59615. * Implementation of the KTX Texture Loader.
  59616. * @hidden
  59617. */
  59618. export class _KTXTextureLoader implements IInternalTextureLoader {
  59619. /**
  59620. * Defines wether the loader supports cascade loading the different faces.
  59621. */
  59622. readonly supportCascades: boolean;
  59623. /**
  59624. * This returns if the loader support the current file information.
  59625. * @param extension defines the file extension of the file being loaded
  59626. * @param mimeType defines the optional mime type of the file being loaded
  59627. * @returns true if the loader can load the specified file
  59628. */
  59629. canLoad(extension: string, mimeType?: string): boolean;
  59630. /**
  59631. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59632. * @param data contains the texture data
  59633. * @param texture defines the BabylonJS internal texture
  59634. * @param createPolynomials will be true if polynomials have been requested
  59635. * @param onLoad defines the callback to trigger once the texture is ready
  59636. * @param onError defines the callback to trigger in case of error
  59637. */
  59638. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59639. /**
  59640. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59641. * @param data contains the texture data
  59642. * @param texture defines the BabylonJS internal texture
  59643. * @param callback defines the method to call once ready to upload
  59644. */
  59645. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  59646. }
  59647. }
  59648. declare module "babylonjs/Helpers/sceneHelpers" {
  59649. import { Nullable } from "babylonjs/types";
  59650. import { Mesh } from "babylonjs/Meshes/mesh";
  59651. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59652. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  59653. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  59654. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  59655. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  59656. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  59657. import "babylonjs/Meshes/Builders/boxBuilder";
  59658. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  59659. /** @hidden */
  59660. export var _forceSceneHelpersToBundle: boolean;
  59661. module "babylonjs/scene" {
  59662. interface Scene {
  59663. /**
  59664. * Creates a default light for the scene.
  59665. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  59666. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  59667. */
  59668. createDefaultLight(replace?: boolean): void;
  59669. /**
  59670. * Creates a default camera for the scene.
  59671. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  59672. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59673. * @param replace has default false, when true replaces the active camera in the scene
  59674. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  59675. */
  59676. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59677. /**
  59678. * Creates a default camera and a default light.
  59679. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  59680. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59681. * @param replace has the default false, when true replaces the active camera/light in the scene
  59682. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  59683. */
  59684. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59685. /**
  59686. * Creates a new sky box
  59687. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  59688. * @param environmentTexture defines the texture to use as environment texture
  59689. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  59690. * @param scale defines the overall scale of the skybox
  59691. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  59692. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  59693. * @returns a new mesh holding the sky box
  59694. */
  59695. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  59696. /**
  59697. * Creates a new environment
  59698. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  59699. * @param options defines the options you can use to configure the environment
  59700. * @returns the new EnvironmentHelper
  59701. */
  59702. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  59703. /**
  59704. * Creates a new VREXperienceHelper
  59705. * @see https://doc.babylonjs.com/how_to/webvr_helper
  59706. * @param webVROptions defines the options used to create the new VREXperienceHelper
  59707. * @returns a new VREXperienceHelper
  59708. */
  59709. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  59710. /**
  59711. * Creates a new WebXRDefaultExperience
  59712. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  59713. * @param options experience options
  59714. * @returns a promise for a new WebXRDefaultExperience
  59715. */
  59716. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  59717. }
  59718. }
  59719. }
  59720. declare module "babylonjs/Helpers/videoDome" {
  59721. import { Scene } from "babylonjs/scene";
  59722. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59723. import { Mesh } from "babylonjs/Meshes/mesh";
  59724. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  59725. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  59726. import "babylonjs/Meshes/Builders/sphereBuilder";
  59727. /**
  59728. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  59729. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  59730. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  59731. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  59732. */
  59733. export class VideoDome extends TransformNode {
  59734. /**
  59735. * Define the video source as a Monoscopic panoramic 360 video.
  59736. */
  59737. static readonly MODE_MONOSCOPIC: number;
  59738. /**
  59739. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59740. */
  59741. static readonly MODE_TOPBOTTOM: number;
  59742. /**
  59743. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59744. */
  59745. static readonly MODE_SIDEBYSIDE: number;
  59746. private _halfDome;
  59747. private _useDirectMapping;
  59748. /**
  59749. * The video texture being displayed on the sphere
  59750. */
  59751. protected _videoTexture: VideoTexture;
  59752. /**
  59753. * Gets the video texture being displayed on the sphere
  59754. */
  59755. get videoTexture(): VideoTexture;
  59756. /**
  59757. * The skybox material
  59758. */
  59759. protected _material: BackgroundMaterial;
  59760. /**
  59761. * The surface used for the video dome
  59762. */
  59763. protected _mesh: Mesh;
  59764. /**
  59765. * Gets the mesh used for the video dome.
  59766. */
  59767. get mesh(): Mesh;
  59768. /**
  59769. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  59770. */
  59771. private _halfDomeMask;
  59772. /**
  59773. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  59774. * Also see the options.resolution property.
  59775. */
  59776. get fovMultiplier(): number;
  59777. set fovMultiplier(value: number);
  59778. private _videoMode;
  59779. /**
  59780. * Gets or set the current video mode for the video. It can be:
  59781. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  59782. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59783. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59784. */
  59785. get videoMode(): number;
  59786. set videoMode(value: number);
  59787. /**
  59788. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  59789. *
  59790. */
  59791. get halfDome(): boolean;
  59792. /**
  59793. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  59794. */
  59795. set halfDome(enabled: boolean);
  59796. /**
  59797. * Oberserver used in Stereoscopic VR Mode.
  59798. */
  59799. private _onBeforeCameraRenderObserver;
  59800. /**
  59801. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  59802. * @param name Element's name, child elements will append suffixes for their own names.
  59803. * @param urlsOrVideo defines the url(s) or the video element to use
  59804. * @param options An object containing optional or exposed sub element properties
  59805. */
  59806. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  59807. resolution?: number;
  59808. clickToPlay?: boolean;
  59809. autoPlay?: boolean;
  59810. loop?: boolean;
  59811. size?: number;
  59812. poster?: string;
  59813. faceForward?: boolean;
  59814. useDirectMapping?: boolean;
  59815. halfDomeMode?: boolean;
  59816. }, scene: Scene);
  59817. private _changeVideoMode;
  59818. /**
  59819. * Releases resources associated with this node.
  59820. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  59821. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  59822. */
  59823. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  59824. }
  59825. }
  59826. declare module "babylonjs/Helpers/index" {
  59827. export * from "babylonjs/Helpers/environmentHelper";
  59828. export * from "babylonjs/Helpers/photoDome";
  59829. export * from "babylonjs/Helpers/sceneHelpers";
  59830. export * from "babylonjs/Helpers/videoDome";
  59831. }
  59832. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  59833. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59834. import { IDisposable } from "babylonjs/scene";
  59835. import { Engine } from "babylonjs/Engines/engine";
  59836. /**
  59837. * This class can be used to get instrumentation data from a Babylon engine
  59838. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59839. */
  59840. export class EngineInstrumentation implements IDisposable {
  59841. /**
  59842. * Define the instrumented engine.
  59843. */
  59844. engine: Engine;
  59845. private _captureGPUFrameTime;
  59846. private _gpuFrameTimeToken;
  59847. private _gpuFrameTime;
  59848. private _captureShaderCompilationTime;
  59849. private _shaderCompilationTime;
  59850. private _onBeginFrameObserver;
  59851. private _onEndFrameObserver;
  59852. private _onBeforeShaderCompilationObserver;
  59853. private _onAfterShaderCompilationObserver;
  59854. /**
  59855. * Gets the perf counter used for GPU frame time
  59856. */
  59857. get gpuFrameTimeCounter(): PerfCounter;
  59858. /**
  59859. * Gets the GPU frame time capture status
  59860. */
  59861. get captureGPUFrameTime(): boolean;
  59862. /**
  59863. * Enable or disable the GPU frame time capture
  59864. */
  59865. set captureGPUFrameTime(value: boolean);
  59866. /**
  59867. * Gets the perf counter used for shader compilation time
  59868. */
  59869. get shaderCompilationTimeCounter(): PerfCounter;
  59870. /**
  59871. * Gets the shader compilation time capture status
  59872. */
  59873. get captureShaderCompilationTime(): boolean;
  59874. /**
  59875. * Enable or disable the shader compilation time capture
  59876. */
  59877. set captureShaderCompilationTime(value: boolean);
  59878. /**
  59879. * Instantiates a new engine instrumentation.
  59880. * This class can be used to get instrumentation data from a Babylon engine
  59881. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59882. * @param engine Defines the engine to instrument
  59883. */
  59884. constructor(
  59885. /**
  59886. * Define the instrumented engine.
  59887. */
  59888. engine: Engine);
  59889. /**
  59890. * Dispose and release associated resources.
  59891. */
  59892. dispose(): void;
  59893. }
  59894. }
  59895. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  59896. import { Scene, IDisposable } from "babylonjs/scene";
  59897. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59898. /**
  59899. * This class can be used to get instrumentation data from a Babylon engine
  59900. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59901. */
  59902. export class SceneInstrumentation implements IDisposable {
  59903. /**
  59904. * Defines the scene to instrument
  59905. */
  59906. scene: Scene;
  59907. private _captureActiveMeshesEvaluationTime;
  59908. private _activeMeshesEvaluationTime;
  59909. private _captureRenderTargetsRenderTime;
  59910. private _renderTargetsRenderTime;
  59911. private _captureFrameTime;
  59912. private _frameTime;
  59913. private _captureRenderTime;
  59914. private _renderTime;
  59915. private _captureInterFrameTime;
  59916. private _interFrameTime;
  59917. private _captureParticlesRenderTime;
  59918. private _particlesRenderTime;
  59919. private _captureSpritesRenderTime;
  59920. private _spritesRenderTime;
  59921. private _capturePhysicsTime;
  59922. private _physicsTime;
  59923. private _captureAnimationsTime;
  59924. private _animationsTime;
  59925. private _captureCameraRenderTime;
  59926. private _cameraRenderTime;
  59927. private _onBeforeActiveMeshesEvaluationObserver;
  59928. private _onAfterActiveMeshesEvaluationObserver;
  59929. private _onBeforeRenderTargetsRenderObserver;
  59930. private _onAfterRenderTargetsRenderObserver;
  59931. private _onAfterRenderObserver;
  59932. private _onBeforeDrawPhaseObserver;
  59933. private _onAfterDrawPhaseObserver;
  59934. private _onBeforeAnimationsObserver;
  59935. private _onBeforeParticlesRenderingObserver;
  59936. private _onAfterParticlesRenderingObserver;
  59937. private _onBeforeSpritesRenderingObserver;
  59938. private _onAfterSpritesRenderingObserver;
  59939. private _onBeforePhysicsObserver;
  59940. private _onAfterPhysicsObserver;
  59941. private _onAfterAnimationsObserver;
  59942. private _onBeforeCameraRenderObserver;
  59943. private _onAfterCameraRenderObserver;
  59944. /**
  59945. * Gets the perf counter used for active meshes evaluation time
  59946. */
  59947. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  59948. /**
  59949. * Gets the active meshes evaluation time capture status
  59950. */
  59951. get captureActiveMeshesEvaluationTime(): boolean;
  59952. /**
  59953. * Enable or disable the active meshes evaluation time capture
  59954. */
  59955. set captureActiveMeshesEvaluationTime(value: boolean);
  59956. /**
  59957. * Gets the perf counter used for render targets render time
  59958. */
  59959. get renderTargetsRenderTimeCounter(): PerfCounter;
  59960. /**
  59961. * Gets the render targets render time capture status
  59962. */
  59963. get captureRenderTargetsRenderTime(): boolean;
  59964. /**
  59965. * Enable or disable the render targets render time capture
  59966. */
  59967. set captureRenderTargetsRenderTime(value: boolean);
  59968. /**
  59969. * Gets the perf counter used for particles render time
  59970. */
  59971. get particlesRenderTimeCounter(): PerfCounter;
  59972. /**
  59973. * Gets the particles render time capture status
  59974. */
  59975. get captureParticlesRenderTime(): boolean;
  59976. /**
  59977. * Enable or disable the particles render time capture
  59978. */
  59979. set captureParticlesRenderTime(value: boolean);
  59980. /**
  59981. * Gets the perf counter used for sprites render time
  59982. */
  59983. get spritesRenderTimeCounter(): PerfCounter;
  59984. /**
  59985. * Gets the sprites render time capture status
  59986. */
  59987. get captureSpritesRenderTime(): boolean;
  59988. /**
  59989. * Enable or disable the sprites render time capture
  59990. */
  59991. set captureSpritesRenderTime(value: boolean);
  59992. /**
  59993. * Gets the perf counter used for physics time
  59994. */
  59995. get physicsTimeCounter(): PerfCounter;
  59996. /**
  59997. * Gets the physics time capture status
  59998. */
  59999. get capturePhysicsTime(): boolean;
  60000. /**
  60001. * Enable or disable the physics time capture
  60002. */
  60003. set capturePhysicsTime(value: boolean);
  60004. /**
  60005. * Gets the perf counter used for animations time
  60006. */
  60007. get animationsTimeCounter(): PerfCounter;
  60008. /**
  60009. * Gets the animations time capture status
  60010. */
  60011. get captureAnimationsTime(): boolean;
  60012. /**
  60013. * Enable or disable the animations time capture
  60014. */
  60015. set captureAnimationsTime(value: boolean);
  60016. /**
  60017. * Gets the perf counter used for frame time capture
  60018. */
  60019. get frameTimeCounter(): PerfCounter;
  60020. /**
  60021. * Gets the frame time capture status
  60022. */
  60023. get captureFrameTime(): boolean;
  60024. /**
  60025. * Enable or disable the frame time capture
  60026. */
  60027. set captureFrameTime(value: boolean);
  60028. /**
  60029. * Gets the perf counter used for inter-frames time capture
  60030. */
  60031. get interFrameTimeCounter(): PerfCounter;
  60032. /**
  60033. * Gets the inter-frames time capture status
  60034. */
  60035. get captureInterFrameTime(): boolean;
  60036. /**
  60037. * Enable or disable the inter-frames time capture
  60038. */
  60039. set captureInterFrameTime(value: boolean);
  60040. /**
  60041. * Gets the perf counter used for render time capture
  60042. */
  60043. get renderTimeCounter(): PerfCounter;
  60044. /**
  60045. * Gets the render time capture status
  60046. */
  60047. get captureRenderTime(): boolean;
  60048. /**
  60049. * Enable or disable the render time capture
  60050. */
  60051. set captureRenderTime(value: boolean);
  60052. /**
  60053. * Gets the perf counter used for camera render time capture
  60054. */
  60055. get cameraRenderTimeCounter(): PerfCounter;
  60056. /**
  60057. * Gets the camera render time capture status
  60058. */
  60059. get captureCameraRenderTime(): boolean;
  60060. /**
  60061. * Enable or disable the camera render time capture
  60062. */
  60063. set captureCameraRenderTime(value: boolean);
  60064. /**
  60065. * Gets the perf counter used for draw calls
  60066. */
  60067. get drawCallsCounter(): PerfCounter;
  60068. /**
  60069. * Instantiates a new scene instrumentation.
  60070. * This class can be used to get instrumentation data from a Babylon engine
  60071. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60072. * @param scene Defines the scene to instrument
  60073. */
  60074. constructor(
  60075. /**
  60076. * Defines the scene to instrument
  60077. */
  60078. scene: Scene);
  60079. /**
  60080. * Dispose and release associated resources.
  60081. */
  60082. dispose(): void;
  60083. }
  60084. }
  60085. declare module "babylonjs/Instrumentation/index" {
  60086. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60087. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60088. export * from "babylonjs/Instrumentation/timeToken";
  60089. }
  60090. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60091. /** @hidden */
  60092. export var glowMapGenerationPixelShader: {
  60093. name: string;
  60094. shader: string;
  60095. };
  60096. }
  60097. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60098. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60099. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60100. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60101. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60102. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60103. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60104. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60105. /** @hidden */
  60106. export var glowMapGenerationVertexShader: {
  60107. name: string;
  60108. shader: string;
  60109. };
  60110. }
  60111. declare module "babylonjs/Layers/effectLayer" {
  60112. import { Observable } from "babylonjs/Misc/observable";
  60113. import { Nullable } from "babylonjs/types";
  60114. import { Camera } from "babylonjs/Cameras/camera";
  60115. import { Scene } from "babylonjs/scene";
  60116. import { ISize } from "babylonjs/Maths/math.size";
  60117. import { Color4 } from "babylonjs/Maths/math.color";
  60118. import { Engine } from "babylonjs/Engines/engine";
  60119. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60120. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60121. import { Mesh } from "babylonjs/Meshes/mesh";
  60122. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60123. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60124. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60125. import { Effect } from "babylonjs/Materials/effect";
  60126. import { Material } from "babylonjs/Materials/material";
  60127. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60128. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60129. /**
  60130. * Effect layer options. This helps customizing the behaviour
  60131. * of the effect layer.
  60132. */
  60133. export interface IEffectLayerOptions {
  60134. /**
  60135. * Multiplication factor apply to the canvas size to compute the render target size
  60136. * used to generated the objects (the smaller the faster).
  60137. */
  60138. mainTextureRatio: number;
  60139. /**
  60140. * Enforces a fixed size texture to ensure effect stability across devices.
  60141. */
  60142. mainTextureFixedSize?: number;
  60143. /**
  60144. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60145. */
  60146. alphaBlendingMode: number;
  60147. /**
  60148. * The camera attached to the layer.
  60149. */
  60150. camera: Nullable<Camera>;
  60151. /**
  60152. * The rendering group to draw the layer in.
  60153. */
  60154. renderingGroupId: number;
  60155. }
  60156. /**
  60157. * The effect layer Helps adding post process effect blended with the main pass.
  60158. *
  60159. * This can be for instance use to generate glow or higlight effects on the scene.
  60160. *
  60161. * The effect layer class can not be used directly and is intented to inherited from to be
  60162. * customized per effects.
  60163. */
  60164. export abstract class EffectLayer {
  60165. private _vertexBuffers;
  60166. private _indexBuffer;
  60167. private _cachedDefines;
  60168. private _effectLayerMapGenerationEffect;
  60169. private _effectLayerOptions;
  60170. private _mergeEffect;
  60171. protected _scene: Scene;
  60172. protected _engine: Engine;
  60173. protected _maxSize: number;
  60174. protected _mainTextureDesiredSize: ISize;
  60175. protected _mainTexture: RenderTargetTexture;
  60176. protected _shouldRender: boolean;
  60177. protected _postProcesses: PostProcess[];
  60178. protected _textures: BaseTexture[];
  60179. protected _emissiveTextureAndColor: {
  60180. texture: Nullable<BaseTexture>;
  60181. color: Color4;
  60182. };
  60183. /**
  60184. * The name of the layer
  60185. */
  60186. name: string;
  60187. /**
  60188. * The clear color of the texture used to generate the glow map.
  60189. */
  60190. neutralColor: Color4;
  60191. /**
  60192. * Specifies whether the highlight layer is enabled or not.
  60193. */
  60194. isEnabled: boolean;
  60195. /**
  60196. * Gets the camera attached to the layer.
  60197. */
  60198. get camera(): Nullable<Camera>;
  60199. /**
  60200. * Gets the rendering group id the layer should render in.
  60201. */
  60202. get renderingGroupId(): number;
  60203. set renderingGroupId(renderingGroupId: number);
  60204. /**
  60205. * An event triggered when the effect layer has been disposed.
  60206. */
  60207. onDisposeObservable: Observable<EffectLayer>;
  60208. /**
  60209. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60210. */
  60211. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60212. /**
  60213. * An event triggered when the generated texture is being merged in the scene.
  60214. */
  60215. onBeforeComposeObservable: Observable<EffectLayer>;
  60216. /**
  60217. * An event triggered when the mesh is rendered into the effect render target.
  60218. */
  60219. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60220. /**
  60221. * An event triggered after the mesh has been rendered into the effect render target.
  60222. */
  60223. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60224. /**
  60225. * An event triggered when the generated texture has been merged in the scene.
  60226. */
  60227. onAfterComposeObservable: Observable<EffectLayer>;
  60228. /**
  60229. * An event triggered when the efffect layer changes its size.
  60230. */
  60231. onSizeChangedObservable: Observable<EffectLayer>;
  60232. /** @hidden */
  60233. static _SceneComponentInitialization: (scene: Scene) => void;
  60234. /**
  60235. * Instantiates a new effect Layer and references it in the scene.
  60236. * @param name The name of the layer
  60237. * @param scene The scene to use the layer in
  60238. */
  60239. constructor(
  60240. /** The Friendly of the effect in the scene */
  60241. name: string, scene: Scene);
  60242. /**
  60243. * Get the effect name of the layer.
  60244. * @return The effect name
  60245. */
  60246. abstract getEffectName(): string;
  60247. /**
  60248. * Checks for the readiness of the element composing the layer.
  60249. * @param subMesh the mesh to check for
  60250. * @param useInstances specify whether or not to use instances to render the mesh
  60251. * @return true if ready otherwise, false
  60252. */
  60253. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60254. /**
  60255. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60256. * @returns true if the effect requires stencil during the main canvas render pass.
  60257. */
  60258. abstract needStencil(): boolean;
  60259. /**
  60260. * Create the merge effect. This is the shader use to blit the information back
  60261. * to the main canvas at the end of the scene rendering.
  60262. * @returns The effect containing the shader used to merge the effect on the main canvas
  60263. */
  60264. protected abstract _createMergeEffect(): Effect;
  60265. /**
  60266. * Creates the render target textures and post processes used in the effect layer.
  60267. */
  60268. protected abstract _createTextureAndPostProcesses(): void;
  60269. /**
  60270. * Implementation specific of rendering the generating effect on the main canvas.
  60271. * @param effect The effect used to render through
  60272. */
  60273. protected abstract _internalRender(effect: Effect): void;
  60274. /**
  60275. * Sets the required values for both the emissive texture and and the main color.
  60276. */
  60277. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60278. /**
  60279. * Free any resources and references associated to a mesh.
  60280. * Internal use
  60281. * @param mesh The mesh to free.
  60282. */
  60283. abstract _disposeMesh(mesh: Mesh): void;
  60284. /**
  60285. * Serializes this layer (Glow or Highlight for example)
  60286. * @returns a serialized layer object
  60287. */
  60288. abstract serialize?(): any;
  60289. /**
  60290. * Initializes the effect layer with the required options.
  60291. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60292. */
  60293. protected _init(options: Partial<IEffectLayerOptions>): void;
  60294. /**
  60295. * Generates the index buffer of the full screen quad blending to the main canvas.
  60296. */
  60297. private _generateIndexBuffer;
  60298. /**
  60299. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60300. */
  60301. private _generateVertexBuffer;
  60302. /**
  60303. * Sets the main texture desired size which is the closest power of two
  60304. * of the engine canvas size.
  60305. */
  60306. private _setMainTextureSize;
  60307. /**
  60308. * Creates the main texture for the effect layer.
  60309. */
  60310. protected _createMainTexture(): void;
  60311. /**
  60312. * Adds specific effects defines.
  60313. * @param defines The defines to add specifics to.
  60314. */
  60315. protected _addCustomEffectDefines(defines: string[]): void;
  60316. /**
  60317. * Checks for the readiness of the element composing the layer.
  60318. * @param subMesh the mesh to check for
  60319. * @param useInstances specify whether or not to use instances to render the mesh
  60320. * @param emissiveTexture the associated emissive texture used to generate the glow
  60321. * @return true if ready otherwise, false
  60322. */
  60323. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60324. /**
  60325. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60326. */
  60327. render(): void;
  60328. /**
  60329. * Determine if a given mesh will be used in the current effect.
  60330. * @param mesh mesh to test
  60331. * @returns true if the mesh will be used
  60332. */
  60333. hasMesh(mesh: AbstractMesh): boolean;
  60334. /**
  60335. * Returns true if the layer contains information to display, otherwise false.
  60336. * @returns true if the glow layer should be rendered
  60337. */
  60338. shouldRender(): boolean;
  60339. /**
  60340. * Returns true if the mesh should render, otherwise false.
  60341. * @param mesh The mesh to render
  60342. * @returns true if it should render otherwise false
  60343. */
  60344. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60345. /**
  60346. * Returns true if the mesh can be rendered, otherwise false.
  60347. * @param mesh The mesh to render
  60348. * @param material The material used on the mesh
  60349. * @returns true if it can be rendered otherwise false
  60350. */
  60351. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60352. /**
  60353. * Returns true if the mesh should render, otherwise false.
  60354. * @param mesh The mesh to render
  60355. * @returns true if it should render otherwise false
  60356. */
  60357. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60358. /**
  60359. * Renders the submesh passed in parameter to the generation map.
  60360. */
  60361. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60362. /**
  60363. * Defines whether the current material of the mesh should be use to render the effect.
  60364. * @param mesh defines the current mesh to render
  60365. */
  60366. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60367. /**
  60368. * Rebuild the required buffers.
  60369. * @hidden Internal use only.
  60370. */
  60371. _rebuild(): void;
  60372. /**
  60373. * Dispose only the render target textures and post process.
  60374. */
  60375. private _disposeTextureAndPostProcesses;
  60376. /**
  60377. * Dispose the highlight layer and free resources.
  60378. */
  60379. dispose(): void;
  60380. /**
  60381. * Gets the class name of the effect layer
  60382. * @returns the string with the class name of the effect layer
  60383. */
  60384. getClassName(): string;
  60385. /**
  60386. * Creates an effect layer from parsed effect layer data
  60387. * @param parsedEffectLayer defines effect layer data
  60388. * @param scene defines the current scene
  60389. * @param rootUrl defines the root URL containing the effect layer information
  60390. * @returns a parsed effect Layer
  60391. */
  60392. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60393. }
  60394. }
  60395. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60396. import { Scene } from "babylonjs/scene";
  60397. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60398. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60399. import { AbstractScene } from "babylonjs/abstractScene";
  60400. module "babylonjs/abstractScene" {
  60401. interface AbstractScene {
  60402. /**
  60403. * The list of effect layers (highlights/glow) added to the scene
  60404. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60405. * @see https://doc.babylonjs.com/how_to/glow_layer
  60406. */
  60407. effectLayers: Array<EffectLayer>;
  60408. /**
  60409. * Removes the given effect layer from this scene.
  60410. * @param toRemove defines the effect layer to remove
  60411. * @returns the index of the removed effect layer
  60412. */
  60413. removeEffectLayer(toRemove: EffectLayer): number;
  60414. /**
  60415. * Adds the given effect layer to this scene
  60416. * @param newEffectLayer defines the effect layer to add
  60417. */
  60418. addEffectLayer(newEffectLayer: EffectLayer): void;
  60419. }
  60420. }
  60421. /**
  60422. * Defines the layer scene component responsible to manage any effect layers
  60423. * in a given scene.
  60424. */
  60425. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60426. /**
  60427. * The component name helpfull to identify the component in the list of scene components.
  60428. */
  60429. readonly name: string;
  60430. /**
  60431. * The scene the component belongs to.
  60432. */
  60433. scene: Scene;
  60434. private _engine;
  60435. private _renderEffects;
  60436. private _needStencil;
  60437. private _previousStencilState;
  60438. /**
  60439. * Creates a new instance of the component for the given scene
  60440. * @param scene Defines the scene to register the component in
  60441. */
  60442. constructor(scene: Scene);
  60443. /**
  60444. * Registers the component in a given scene
  60445. */
  60446. register(): void;
  60447. /**
  60448. * Rebuilds the elements related to this component in case of
  60449. * context lost for instance.
  60450. */
  60451. rebuild(): void;
  60452. /**
  60453. * Serializes the component data to the specified json object
  60454. * @param serializationObject The object to serialize to
  60455. */
  60456. serialize(serializationObject: any): void;
  60457. /**
  60458. * Adds all the elements from the container to the scene
  60459. * @param container the container holding the elements
  60460. */
  60461. addFromContainer(container: AbstractScene): void;
  60462. /**
  60463. * Removes all the elements in the container from the scene
  60464. * @param container contains the elements to remove
  60465. * @param dispose if the removed element should be disposed (default: false)
  60466. */
  60467. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60468. /**
  60469. * Disposes the component and the associated ressources.
  60470. */
  60471. dispose(): void;
  60472. private _isReadyForMesh;
  60473. private _renderMainTexture;
  60474. private _setStencil;
  60475. private _setStencilBack;
  60476. private _draw;
  60477. private _drawCamera;
  60478. private _drawRenderingGroup;
  60479. }
  60480. }
  60481. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  60482. /** @hidden */
  60483. export var glowMapMergePixelShader: {
  60484. name: string;
  60485. shader: string;
  60486. };
  60487. }
  60488. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  60489. /** @hidden */
  60490. export var glowMapMergeVertexShader: {
  60491. name: string;
  60492. shader: string;
  60493. };
  60494. }
  60495. declare module "babylonjs/Layers/glowLayer" {
  60496. import { Nullable } from "babylonjs/types";
  60497. import { Camera } from "babylonjs/Cameras/camera";
  60498. import { Scene } from "babylonjs/scene";
  60499. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60500. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60501. import { Mesh } from "babylonjs/Meshes/mesh";
  60502. import { Texture } from "babylonjs/Materials/Textures/texture";
  60503. import { Effect } from "babylonjs/Materials/effect";
  60504. import { Material } from "babylonjs/Materials/material";
  60505. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60506. import { Color4 } from "babylonjs/Maths/math.color";
  60507. import "babylonjs/Shaders/glowMapMerge.fragment";
  60508. import "babylonjs/Shaders/glowMapMerge.vertex";
  60509. import "babylonjs/Layers/effectLayerSceneComponent";
  60510. module "babylonjs/abstractScene" {
  60511. interface AbstractScene {
  60512. /**
  60513. * Return a the first highlight layer of the scene with a given name.
  60514. * @param name The name of the highlight layer to look for.
  60515. * @return The highlight layer if found otherwise null.
  60516. */
  60517. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  60518. }
  60519. }
  60520. /**
  60521. * Glow layer options. This helps customizing the behaviour
  60522. * of the glow layer.
  60523. */
  60524. export interface IGlowLayerOptions {
  60525. /**
  60526. * Multiplication factor apply to the canvas size to compute the render target size
  60527. * used to generated the glowing objects (the smaller the faster).
  60528. */
  60529. mainTextureRatio: number;
  60530. /**
  60531. * Enforces a fixed size texture to ensure resize independant blur.
  60532. */
  60533. mainTextureFixedSize?: number;
  60534. /**
  60535. * How big is the kernel of the blur texture.
  60536. */
  60537. blurKernelSize: number;
  60538. /**
  60539. * The camera attached to the layer.
  60540. */
  60541. camera: Nullable<Camera>;
  60542. /**
  60543. * Enable MSAA by chosing the number of samples.
  60544. */
  60545. mainTextureSamples?: number;
  60546. /**
  60547. * The rendering group to draw the layer in.
  60548. */
  60549. renderingGroupId: number;
  60550. }
  60551. /**
  60552. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  60553. *
  60554. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  60555. *
  60556. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  60557. */
  60558. export class GlowLayer extends EffectLayer {
  60559. /**
  60560. * Effect Name of the layer.
  60561. */
  60562. static readonly EffectName: string;
  60563. /**
  60564. * The default blur kernel size used for the glow.
  60565. */
  60566. static DefaultBlurKernelSize: number;
  60567. /**
  60568. * The default texture size ratio used for the glow.
  60569. */
  60570. static DefaultTextureRatio: number;
  60571. /**
  60572. * Sets the kernel size of the blur.
  60573. */
  60574. set blurKernelSize(value: number);
  60575. /**
  60576. * Gets the kernel size of the blur.
  60577. */
  60578. get blurKernelSize(): number;
  60579. /**
  60580. * Sets the glow intensity.
  60581. */
  60582. set intensity(value: number);
  60583. /**
  60584. * Gets the glow intensity.
  60585. */
  60586. get intensity(): number;
  60587. private _options;
  60588. private _intensity;
  60589. private _horizontalBlurPostprocess1;
  60590. private _verticalBlurPostprocess1;
  60591. private _horizontalBlurPostprocess2;
  60592. private _verticalBlurPostprocess2;
  60593. private _blurTexture1;
  60594. private _blurTexture2;
  60595. private _postProcesses1;
  60596. private _postProcesses2;
  60597. private _includedOnlyMeshes;
  60598. private _excludedMeshes;
  60599. private _meshesUsingTheirOwnMaterials;
  60600. /**
  60601. * Callback used to let the user override the color selection on a per mesh basis
  60602. */
  60603. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  60604. /**
  60605. * Callback used to let the user override the texture selection on a per mesh basis
  60606. */
  60607. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  60608. /**
  60609. * Instantiates a new glow Layer and references it to the scene.
  60610. * @param name The name of the layer
  60611. * @param scene The scene to use the layer in
  60612. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  60613. */
  60614. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  60615. /**
  60616. * Get the effect name of the layer.
  60617. * @return The effect name
  60618. */
  60619. getEffectName(): string;
  60620. /**
  60621. * Create the merge effect. This is the shader use to blit the information back
  60622. * to the main canvas at the end of the scene rendering.
  60623. */
  60624. protected _createMergeEffect(): Effect;
  60625. /**
  60626. * Creates the render target textures and post processes used in the glow layer.
  60627. */
  60628. protected _createTextureAndPostProcesses(): void;
  60629. /**
  60630. * Checks for the readiness of the element composing the layer.
  60631. * @param subMesh the mesh to check for
  60632. * @param useInstances specify wether or not to use instances to render the mesh
  60633. * @param emissiveTexture the associated emissive texture used to generate the glow
  60634. * @return true if ready otherwise, false
  60635. */
  60636. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60637. /**
  60638. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60639. */
  60640. needStencil(): boolean;
  60641. /**
  60642. * Returns true if the mesh can be rendered, otherwise false.
  60643. * @param mesh The mesh to render
  60644. * @param material The material used on the mesh
  60645. * @returns true if it can be rendered otherwise false
  60646. */
  60647. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60648. /**
  60649. * Implementation specific of rendering the generating effect on the main canvas.
  60650. * @param effect The effect used to render through
  60651. */
  60652. protected _internalRender(effect: Effect): void;
  60653. /**
  60654. * Sets the required values for both the emissive texture and and the main color.
  60655. */
  60656. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60657. /**
  60658. * Returns true if the mesh should render, otherwise false.
  60659. * @param mesh The mesh to render
  60660. * @returns true if it should render otherwise false
  60661. */
  60662. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60663. /**
  60664. * Adds specific effects defines.
  60665. * @param defines The defines to add specifics to.
  60666. */
  60667. protected _addCustomEffectDefines(defines: string[]): void;
  60668. /**
  60669. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  60670. * @param mesh The mesh to exclude from the glow layer
  60671. */
  60672. addExcludedMesh(mesh: Mesh): void;
  60673. /**
  60674. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  60675. * @param mesh The mesh to remove
  60676. */
  60677. removeExcludedMesh(mesh: Mesh): void;
  60678. /**
  60679. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  60680. * @param mesh The mesh to include in the glow layer
  60681. */
  60682. addIncludedOnlyMesh(mesh: Mesh): void;
  60683. /**
  60684. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  60685. * @param mesh The mesh to remove
  60686. */
  60687. removeIncludedOnlyMesh(mesh: Mesh): void;
  60688. /**
  60689. * Determine if a given mesh will be used in the glow layer
  60690. * @param mesh The mesh to test
  60691. * @returns true if the mesh will be highlighted by the current glow layer
  60692. */
  60693. hasMesh(mesh: AbstractMesh): boolean;
  60694. /**
  60695. * Defines whether the current material of the mesh should be use to render the effect.
  60696. * @param mesh defines the current mesh to render
  60697. */
  60698. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60699. /**
  60700. * Add a mesh to be rendered through its own material and not with emissive only.
  60701. * @param mesh The mesh for which we need to use its material
  60702. */
  60703. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  60704. /**
  60705. * Remove a mesh from being rendered through its own material and not with emissive only.
  60706. * @param mesh The mesh for which we need to not use its material
  60707. */
  60708. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  60709. /**
  60710. * Free any resources and references associated to a mesh.
  60711. * Internal use
  60712. * @param mesh The mesh to free.
  60713. * @hidden
  60714. */
  60715. _disposeMesh(mesh: Mesh): void;
  60716. /**
  60717. * Gets the class name of the effect layer
  60718. * @returns the string with the class name of the effect layer
  60719. */
  60720. getClassName(): string;
  60721. /**
  60722. * Serializes this glow layer
  60723. * @returns a serialized glow layer object
  60724. */
  60725. serialize(): any;
  60726. /**
  60727. * Creates a Glow Layer from parsed glow layer data
  60728. * @param parsedGlowLayer defines glow layer data
  60729. * @param scene defines the current scene
  60730. * @param rootUrl defines the root URL containing the glow layer information
  60731. * @returns a parsed Glow Layer
  60732. */
  60733. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  60734. }
  60735. }
  60736. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  60737. /** @hidden */
  60738. export var glowBlurPostProcessPixelShader: {
  60739. name: string;
  60740. shader: string;
  60741. };
  60742. }
  60743. declare module "babylonjs/Layers/highlightLayer" {
  60744. import { Observable } from "babylonjs/Misc/observable";
  60745. import { Nullable } from "babylonjs/types";
  60746. import { Camera } from "babylonjs/Cameras/camera";
  60747. import { Scene } from "babylonjs/scene";
  60748. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60750. import { Mesh } from "babylonjs/Meshes/mesh";
  60751. import { Effect } from "babylonjs/Materials/effect";
  60752. import { Material } from "babylonjs/Materials/material";
  60753. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60754. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60755. import "babylonjs/Shaders/glowMapMerge.fragment";
  60756. import "babylonjs/Shaders/glowMapMerge.vertex";
  60757. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  60758. module "babylonjs/abstractScene" {
  60759. interface AbstractScene {
  60760. /**
  60761. * Return a the first highlight layer of the scene with a given name.
  60762. * @param name The name of the highlight layer to look for.
  60763. * @return The highlight layer if found otherwise null.
  60764. */
  60765. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  60766. }
  60767. }
  60768. /**
  60769. * Highlight layer options. This helps customizing the behaviour
  60770. * of the highlight layer.
  60771. */
  60772. export interface IHighlightLayerOptions {
  60773. /**
  60774. * Multiplication factor apply to the canvas size to compute the render target size
  60775. * used to generated the glowing objects (the smaller the faster).
  60776. */
  60777. mainTextureRatio: number;
  60778. /**
  60779. * Enforces a fixed size texture to ensure resize independant blur.
  60780. */
  60781. mainTextureFixedSize?: number;
  60782. /**
  60783. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  60784. * of the picture to blur (the smaller the faster).
  60785. */
  60786. blurTextureSizeRatio: number;
  60787. /**
  60788. * How big in texel of the blur texture is the vertical blur.
  60789. */
  60790. blurVerticalSize: number;
  60791. /**
  60792. * How big in texel of the blur texture is the horizontal blur.
  60793. */
  60794. blurHorizontalSize: number;
  60795. /**
  60796. * Alpha blending mode used to apply the blur. Default is combine.
  60797. */
  60798. alphaBlendingMode: number;
  60799. /**
  60800. * The camera attached to the layer.
  60801. */
  60802. camera: Nullable<Camera>;
  60803. /**
  60804. * Should we display highlight as a solid stroke?
  60805. */
  60806. isStroke?: boolean;
  60807. /**
  60808. * The rendering group to draw the layer in.
  60809. */
  60810. renderingGroupId: number;
  60811. }
  60812. /**
  60813. * The highlight layer Helps adding a glow effect around a mesh.
  60814. *
  60815. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  60816. * glowy meshes to your scene.
  60817. *
  60818. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  60819. */
  60820. export class HighlightLayer extends EffectLayer {
  60821. name: string;
  60822. /**
  60823. * Effect Name of the highlight layer.
  60824. */
  60825. static readonly EffectName: string;
  60826. /**
  60827. * The neutral color used during the preparation of the glow effect.
  60828. * This is black by default as the blend operation is a blend operation.
  60829. */
  60830. static NeutralColor: Color4;
  60831. /**
  60832. * Stencil value used for glowing meshes.
  60833. */
  60834. static GlowingMeshStencilReference: number;
  60835. /**
  60836. * Stencil value used for the other meshes in the scene.
  60837. */
  60838. static NormalMeshStencilReference: number;
  60839. /**
  60840. * Specifies whether or not the inner glow is ACTIVE in the layer.
  60841. */
  60842. innerGlow: boolean;
  60843. /**
  60844. * Specifies whether or not the outer glow is ACTIVE in the layer.
  60845. */
  60846. outerGlow: boolean;
  60847. /**
  60848. * Specifies the horizontal size of the blur.
  60849. */
  60850. set blurHorizontalSize(value: number);
  60851. /**
  60852. * Specifies the vertical size of the blur.
  60853. */
  60854. set blurVerticalSize(value: number);
  60855. /**
  60856. * Gets the horizontal size of the blur.
  60857. */
  60858. get blurHorizontalSize(): number;
  60859. /**
  60860. * Gets the vertical size of the blur.
  60861. */
  60862. get blurVerticalSize(): number;
  60863. /**
  60864. * An event triggered when the highlight layer is being blurred.
  60865. */
  60866. onBeforeBlurObservable: Observable<HighlightLayer>;
  60867. /**
  60868. * An event triggered when the highlight layer has been blurred.
  60869. */
  60870. onAfterBlurObservable: Observable<HighlightLayer>;
  60871. private _instanceGlowingMeshStencilReference;
  60872. private _options;
  60873. private _downSamplePostprocess;
  60874. private _horizontalBlurPostprocess;
  60875. private _verticalBlurPostprocess;
  60876. private _blurTexture;
  60877. private _meshes;
  60878. private _excludedMeshes;
  60879. /**
  60880. * Instantiates a new highlight Layer and references it to the scene..
  60881. * @param name The name of the layer
  60882. * @param scene The scene to use the layer in
  60883. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  60884. */
  60885. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  60886. /**
  60887. * Get the effect name of the layer.
  60888. * @return The effect name
  60889. */
  60890. getEffectName(): string;
  60891. /**
  60892. * Create the merge effect. This is the shader use to blit the information back
  60893. * to the main canvas at the end of the scene rendering.
  60894. */
  60895. protected _createMergeEffect(): Effect;
  60896. /**
  60897. * Creates the render target textures and post processes used in the highlight layer.
  60898. */
  60899. protected _createTextureAndPostProcesses(): void;
  60900. /**
  60901. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  60902. */
  60903. needStencil(): boolean;
  60904. /**
  60905. * Checks for the readiness of the element composing the layer.
  60906. * @param subMesh the mesh to check for
  60907. * @param useInstances specify wether or not to use instances to render the mesh
  60908. * @param emissiveTexture the associated emissive texture used to generate the glow
  60909. * @return true if ready otherwise, false
  60910. */
  60911. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60912. /**
  60913. * Implementation specific of rendering the generating effect on the main canvas.
  60914. * @param effect The effect used to render through
  60915. */
  60916. protected _internalRender(effect: Effect): void;
  60917. /**
  60918. * Returns true if the layer contains information to display, otherwise false.
  60919. */
  60920. shouldRender(): boolean;
  60921. /**
  60922. * Returns true if the mesh should render, otherwise false.
  60923. * @param mesh The mesh to render
  60924. * @returns true if it should render otherwise false
  60925. */
  60926. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60927. /**
  60928. * Returns true if the mesh can be rendered, otherwise false.
  60929. * @param mesh The mesh to render
  60930. * @param material The material used on the mesh
  60931. * @returns true if it can be rendered otherwise false
  60932. */
  60933. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60934. /**
  60935. * Adds specific effects defines.
  60936. * @param defines The defines to add specifics to.
  60937. */
  60938. protected _addCustomEffectDefines(defines: string[]): void;
  60939. /**
  60940. * Sets the required values for both the emissive texture and and the main color.
  60941. */
  60942. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60943. /**
  60944. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  60945. * @param mesh The mesh to exclude from the highlight layer
  60946. */
  60947. addExcludedMesh(mesh: Mesh): void;
  60948. /**
  60949. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  60950. * @param mesh The mesh to highlight
  60951. */
  60952. removeExcludedMesh(mesh: Mesh): void;
  60953. /**
  60954. * Determine if a given mesh will be highlighted by the current HighlightLayer
  60955. * @param mesh mesh to test
  60956. * @returns true if the mesh will be highlighted by the current HighlightLayer
  60957. */
  60958. hasMesh(mesh: AbstractMesh): boolean;
  60959. /**
  60960. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  60961. * @param mesh The mesh to highlight
  60962. * @param color The color of the highlight
  60963. * @param glowEmissiveOnly Extract the glow from the emissive texture
  60964. */
  60965. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  60966. /**
  60967. * Remove a mesh from the highlight layer in order to make it stop glowing.
  60968. * @param mesh The mesh to highlight
  60969. */
  60970. removeMesh(mesh: Mesh): void;
  60971. /**
  60972. * Remove all the meshes currently referenced in the highlight layer
  60973. */
  60974. removeAllMeshes(): void;
  60975. /**
  60976. * Force the stencil to the normal expected value for none glowing parts
  60977. */
  60978. private _defaultStencilReference;
  60979. /**
  60980. * Free any resources and references associated to a mesh.
  60981. * Internal use
  60982. * @param mesh The mesh to free.
  60983. * @hidden
  60984. */
  60985. _disposeMesh(mesh: Mesh): void;
  60986. /**
  60987. * Dispose the highlight layer and free resources.
  60988. */
  60989. dispose(): void;
  60990. /**
  60991. * Gets the class name of the effect layer
  60992. * @returns the string with the class name of the effect layer
  60993. */
  60994. getClassName(): string;
  60995. /**
  60996. * Serializes this Highlight layer
  60997. * @returns a serialized Highlight layer object
  60998. */
  60999. serialize(): any;
  61000. /**
  61001. * Creates a Highlight layer from parsed Highlight layer data
  61002. * @param parsedHightlightLayer defines the Highlight layer data
  61003. * @param scene defines the current scene
  61004. * @param rootUrl defines the root URL containing the Highlight layer information
  61005. * @returns a parsed Highlight layer
  61006. */
  61007. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61008. }
  61009. }
  61010. declare module "babylonjs/Layers/layerSceneComponent" {
  61011. import { Scene } from "babylonjs/scene";
  61012. import { ISceneComponent } from "babylonjs/sceneComponent";
  61013. import { Layer } from "babylonjs/Layers/layer";
  61014. import { AbstractScene } from "babylonjs/abstractScene";
  61015. module "babylonjs/abstractScene" {
  61016. interface AbstractScene {
  61017. /**
  61018. * The list of layers (background and foreground) of the scene
  61019. */
  61020. layers: Array<Layer>;
  61021. }
  61022. }
  61023. /**
  61024. * Defines the layer scene component responsible to manage any layers
  61025. * in a given scene.
  61026. */
  61027. export class LayerSceneComponent implements ISceneComponent {
  61028. /**
  61029. * The component name helpfull to identify the component in the list of scene components.
  61030. */
  61031. readonly name: string;
  61032. /**
  61033. * The scene the component belongs to.
  61034. */
  61035. scene: Scene;
  61036. private _engine;
  61037. /**
  61038. * Creates a new instance of the component for the given scene
  61039. * @param scene Defines the scene to register the component in
  61040. */
  61041. constructor(scene: Scene);
  61042. /**
  61043. * Registers the component in a given scene
  61044. */
  61045. register(): void;
  61046. /**
  61047. * Rebuilds the elements related to this component in case of
  61048. * context lost for instance.
  61049. */
  61050. rebuild(): void;
  61051. /**
  61052. * Disposes the component and the associated ressources.
  61053. */
  61054. dispose(): void;
  61055. private _draw;
  61056. private _drawCameraPredicate;
  61057. private _drawCameraBackground;
  61058. private _drawCameraForeground;
  61059. private _drawRenderTargetPredicate;
  61060. private _drawRenderTargetBackground;
  61061. private _drawRenderTargetForeground;
  61062. /**
  61063. * Adds all the elements from the container to the scene
  61064. * @param container the container holding the elements
  61065. */
  61066. addFromContainer(container: AbstractScene): void;
  61067. /**
  61068. * Removes all the elements in the container from the scene
  61069. * @param container contains the elements to remove
  61070. * @param dispose if the removed element should be disposed (default: false)
  61071. */
  61072. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61073. }
  61074. }
  61075. declare module "babylonjs/Shaders/layer.fragment" {
  61076. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61077. /** @hidden */
  61078. export var layerPixelShader: {
  61079. name: string;
  61080. shader: string;
  61081. };
  61082. }
  61083. declare module "babylonjs/Shaders/layer.vertex" {
  61084. /** @hidden */
  61085. export var layerVertexShader: {
  61086. name: string;
  61087. shader: string;
  61088. };
  61089. }
  61090. declare module "babylonjs/Layers/layer" {
  61091. import { Observable } from "babylonjs/Misc/observable";
  61092. import { Nullable } from "babylonjs/types";
  61093. import { Scene } from "babylonjs/scene";
  61094. import { Vector2 } from "babylonjs/Maths/math.vector";
  61095. import { Color4 } from "babylonjs/Maths/math.color";
  61096. import { Texture } from "babylonjs/Materials/Textures/texture";
  61097. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61098. import "babylonjs/Shaders/layer.fragment";
  61099. import "babylonjs/Shaders/layer.vertex";
  61100. /**
  61101. * This represents a full screen 2d layer.
  61102. * This can be useful to display a picture in the background of your scene for instance.
  61103. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61104. */
  61105. export class Layer {
  61106. /**
  61107. * Define the name of the layer.
  61108. */
  61109. name: string;
  61110. /**
  61111. * Define the texture the layer should display.
  61112. */
  61113. texture: Nullable<Texture>;
  61114. /**
  61115. * Is the layer in background or foreground.
  61116. */
  61117. isBackground: boolean;
  61118. /**
  61119. * Define the color of the layer (instead of texture).
  61120. */
  61121. color: Color4;
  61122. /**
  61123. * Define the scale of the layer in order to zoom in out of the texture.
  61124. */
  61125. scale: Vector2;
  61126. /**
  61127. * Define an offset for the layer in order to shift the texture.
  61128. */
  61129. offset: Vector2;
  61130. /**
  61131. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61132. */
  61133. alphaBlendingMode: number;
  61134. /**
  61135. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61136. * Alpha test will not mix with the background color in case of transparency.
  61137. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61138. */
  61139. alphaTest: boolean;
  61140. /**
  61141. * Define a mask to restrict the layer to only some of the scene cameras.
  61142. */
  61143. layerMask: number;
  61144. /**
  61145. * Define the list of render target the layer is visible into.
  61146. */
  61147. renderTargetTextures: RenderTargetTexture[];
  61148. /**
  61149. * Define if the layer is only used in renderTarget or if it also
  61150. * renders in the main frame buffer of the canvas.
  61151. */
  61152. renderOnlyInRenderTargetTextures: boolean;
  61153. private _scene;
  61154. private _vertexBuffers;
  61155. private _indexBuffer;
  61156. private _effect;
  61157. private _previousDefines;
  61158. /**
  61159. * An event triggered when the layer is disposed.
  61160. */
  61161. onDisposeObservable: Observable<Layer>;
  61162. private _onDisposeObserver;
  61163. /**
  61164. * Back compatibility with callback before the onDisposeObservable existed.
  61165. * The set callback will be triggered when the layer has been disposed.
  61166. */
  61167. set onDispose(callback: () => void);
  61168. /**
  61169. * An event triggered before rendering the scene
  61170. */
  61171. onBeforeRenderObservable: Observable<Layer>;
  61172. private _onBeforeRenderObserver;
  61173. /**
  61174. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61175. * The set callback will be triggered just before rendering the layer.
  61176. */
  61177. set onBeforeRender(callback: () => void);
  61178. /**
  61179. * An event triggered after rendering the scene
  61180. */
  61181. onAfterRenderObservable: Observable<Layer>;
  61182. private _onAfterRenderObserver;
  61183. /**
  61184. * Back compatibility with callback before the onAfterRenderObservable existed.
  61185. * The set callback will be triggered just after rendering the layer.
  61186. */
  61187. set onAfterRender(callback: () => void);
  61188. /**
  61189. * Instantiates a new layer.
  61190. * This represents a full screen 2d layer.
  61191. * This can be useful to display a picture in the background of your scene for instance.
  61192. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61193. * @param name Define the name of the layer in the scene
  61194. * @param imgUrl Define the url of the texture to display in the layer
  61195. * @param scene Define the scene the layer belongs to
  61196. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61197. * @param color Defines a color for the layer
  61198. */
  61199. constructor(
  61200. /**
  61201. * Define the name of the layer.
  61202. */
  61203. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61204. private _createIndexBuffer;
  61205. /** @hidden */
  61206. _rebuild(): void;
  61207. /**
  61208. * Renders the layer in the scene.
  61209. */
  61210. render(): void;
  61211. /**
  61212. * Disposes and releases the associated ressources.
  61213. */
  61214. dispose(): void;
  61215. }
  61216. }
  61217. declare module "babylonjs/Layers/index" {
  61218. export * from "babylonjs/Layers/effectLayer";
  61219. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61220. export * from "babylonjs/Layers/glowLayer";
  61221. export * from "babylonjs/Layers/highlightLayer";
  61222. export * from "babylonjs/Layers/layer";
  61223. export * from "babylonjs/Layers/layerSceneComponent";
  61224. }
  61225. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61226. /** @hidden */
  61227. export var lensFlarePixelShader: {
  61228. name: string;
  61229. shader: string;
  61230. };
  61231. }
  61232. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61233. /** @hidden */
  61234. export var lensFlareVertexShader: {
  61235. name: string;
  61236. shader: string;
  61237. };
  61238. }
  61239. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61240. import { Scene } from "babylonjs/scene";
  61241. import { Vector3 } from "babylonjs/Maths/math.vector";
  61242. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61243. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61244. import "babylonjs/Shaders/lensFlare.fragment";
  61245. import "babylonjs/Shaders/lensFlare.vertex";
  61246. import { Viewport } from "babylonjs/Maths/math.viewport";
  61247. /**
  61248. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61249. * It is usually composed of several `lensFlare`.
  61250. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61251. */
  61252. export class LensFlareSystem {
  61253. /**
  61254. * Define the name of the lens flare system
  61255. */
  61256. name: string;
  61257. /**
  61258. * List of lens flares used in this system.
  61259. */
  61260. lensFlares: LensFlare[];
  61261. /**
  61262. * Define a limit from the border the lens flare can be visible.
  61263. */
  61264. borderLimit: number;
  61265. /**
  61266. * Define a viewport border we do not want to see the lens flare in.
  61267. */
  61268. viewportBorder: number;
  61269. /**
  61270. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61271. */
  61272. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61273. /**
  61274. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61275. */
  61276. layerMask: number;
  61277. /**
  61278. * Define the id of the lens flare system in the scene.
  61279. * (equal to name by default)
  61280. */
  61281. id: string;
  61282. private _scene;
  61283. private _emitter;
  61284. private _vertexBuffers;
  61285. private _indexBuffer;
  61286. private _effect;
  61287. private _positionX;
  61288. private _positionY;
  61289. private _isEnabled;
  61290. /** @hidden */
  61291. static _SceneComponentInitialization: (scene: Scene) => void;
  61292. /**
  61293. * Instantiates a lens flare system.
  61294. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61295. * It is usually composed of several `lensFlare`.
  61296. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61297. * @param name Define the name of the lens flare system in the scene
  61298. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61299. * @param scene Define the scene the lens flare system belongs to
  61300. */
  61301. constructor(
  61302. /**
  61303. * Define the name of the lens flare system
  61304. */
  61305. name: string, emitter: any, scene: Scene);
  61306. /**
  61307. * Define if the lens flare system is enabled.
  61308. */
  61309. get isEnabled(): boolean;
  61310. set isEnabled(value: boolean);
  61311. /**
  61312. * Get the scene the effects belongs to.
  61313. * @returns the scene holding the lens flare system
  61314. */
  61315. getScene(): Scene;
  61316. /**
  61317. * Get the emitter of the lens flare system.
  61318. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61319. * @returns the emitter of the lens flare system
  61320. */
  61321. getEmitter(): any;
  61322. /**
  61323. * Set the emitter of the lens flare system.
  61324. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61325. * @param newEmitter Define the new emitter of the system
  61326. */
  61327. setEmitter(newEmitter: any): void;
  61328. /**
  61329. * Get the lens flare system emitter position.
  61330. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61331. * @returns the position
  61332. */
  61333. getEmitterPosition(): Vector3;
  61334. /**
  61335. * @hidden
  61336. */
  61337. computeEffectivePosition(globalViewport: Viewport): boolean;
  61338. /** @hidden */
  61339. _isVisible(): boolean;
  61340. /**
  61341. * @hidden
  61342. */
  61343. render(): boolean;
  61344. /**
  61345. * Dispose and release the lens flare with its associated resources.
  61346. */
  61347. dispose(): void;
  61348. /**
  61349. * Parse a lens flare system from a JSON repressentation
  61350. * @param parsedLensFlareSystem Define the JSON to parse
  61351. * @param scene Define the scene the parsed system should be instantiated in
  61352. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61353. * @returns the parsed system
  61354. */
  61355. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61356. /**
  61357. * Serialize the current Lens Flare System into a JSON representation.
  61358. * @returns the serialized JSON
  61359. */
  61360. serialize(): any;
  61361. }
  61362. }
  61363. declare module "babylonjs/LensFlares/lensFlare" {
  61364. import { Nullable } from "babylonjs/types";
  61365. import { Color3 } from "babylonjs/Maths/math.color";
  61366. import { Texture } from "babylonjs/Materials/Textures/texture";
  61367. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61368. /**
  61369. * This represents one of the lens effect in a `lensFlareSystem`.
  61370. * It controls one of the indiviual texture used in the effect.
  61371. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61372. */
  61373. export class LensFlare {
  61374. /**
  61375. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61376. */
  61377. size: number;
  61378. /**
  61379. * 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.
  61380. */
  61381. position: number;
  61382. /**
  61383. * Define the lens color.
  61384. */
  61385. color: Color3;
  61386. /**
  61387. * Define the lens texture.
  61388. */
  61389. texture: Nullable<Texture>;
  61390. /**
  61391. * Define the alpha mode to render this particular lens.
  61392. */
  61393. alphaMode: number;
  61394. private _system;
  61395. /**
  61396. * Creates a new Lens Flare.
  61397. * This represents one of the lens effect in a `lensFlareSystem`.
  61398. * It controls one of the indiviual texture used in the effect.
  61399. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61400. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61401. * @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.
  61402. * @param color Define the lens color
  61403. * @param imgUrl Define the lens texture url
  61404. * @param system Define the `lensFlareSystem` this flare is part of
  61405. * @returns The newly created Lens Flare
  61406. */
  61407. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61408. /**
  61409. * Instantiates a new Lens Flare.
  61410. * This represents one of the lens effect in a `lensFlareSystem`.
  61411. * It controls one of the indiviual texture used in the effect.
  61412. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61413. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61414. * @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.
  61415. * @param color Define the lens color
  61416. * @param imgUrl Define the lens texture url
  61417. * @param system Define the `lensFlareSystem` this flare is part of
  61418. */
  61419. constructor(
  61420. /**
  61421. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61422. */
  61423. size: number,
  61424. /**
  61425. * 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.
  61426. */
  61427. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61428. /**
  61429. * Dispose and release the lens flare with its associated resources.
  61430. */
  61431. dispose(): void;
  61432. }
  61433. }
  61434. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61435. import { Nullable } from "babylonjs/types";
  61436. import { Scene } from "babylonjs/scene";
  61437. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61438. import { AbstractScene } from "babylonjs/abstractScene";
  61439. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61440. module "babylonjs/abstractScene" {
  61441. interface AbstractScene {
  61442. /**
  61443. * The list of lens flare system added to the scene
  61444. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61445. */
  61446. lensFlareSystems: Array<LensFlareSystem>;
  61447. /**
  61448. * Removes the given lens flare system from this scene.
  61449. * @param toRemove The lens flare system to remove
  61450. * @returns The index of the removed lens flare system
  61451. */
  61452. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  61453. /**
  61454. * Adds the given lens flare system to this scene
  61455. * @param newLensFlareSystem The lens flare system to add
  61456. */
  61457. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  61458. /**
  61459. * Gets a lens flare system using its name
  61460. * @param name defines the name to look for
  61461. * @returns the lens flare system or null if not found
  61462. */
  61463. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  61464. /**
  61465. * Gets a lens flare system using its id
  61466. * @param id defines the id to look for
  61467. * @returns the lens flare system or null if not found
  61468. */
  61469. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  61470. }
  61471. }
  61472. /**
  61473. * Defines the lens flare scene component responsible to manage any lens flares
  61474. * in a given scene.
  61475. */
  61476. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  61477. /**
  61478. * The component name helpfull to identify the component in the list of scene components.
  61479. */
  61480. readonly name: string;
  61481. /**
  61482. * The scene the component belongs to.
  61483. */
  61484. scene: Scene;
  61485. /**
  61486. * Creates a new instance of the component for the given scene
  61487. * @param scene Defines the scene to register the component in
  61488. */
  61489. constructor(scene: Scene);
  61490. /**
  61491. * Registers the component in a given scene
  61492. */
  61493. register(): void;
  61494. /**
  61495. * Rebuilds the elements related to this component in case of
  61496. * context lost for instance.
  61497. */
  61498. rebuild(): void;
  61499. /**
  61500. * Adds all the elements from the container to the scene
  61501. * @param container the container holding the elements
  61502. */
  61503. addFromContainer(container: AbstractScene): void;
  61504. /**
  61505. * Removes all the elements in the container from the scene
  61506. * @param container contains the elements to remove
  61507. * @param dispose if the removed element should be disposed (default: false)
  61508. */
  61509. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61510. /**
  61511. * Serializes the component data to the specified json object
  61512. * @param serializationObject The object to serialize to
  61513. */
  61514. serialize(serializationObject: any): void;
  61515. /**
  61516. * Disposes the component and the associated ressources.
  61517. */
  61518. dispose(): void;
  61519. private _draw;
  61520. }
  61521. }
  61522. declare module "babylonjs/LensFlares/index" {
  61523. export * from "babylonjs/LensFlares/lensFlare";
  61524. export * from "babylonjs/LensFlares/lensFlareSystem";
  61525. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  61526. }
  61527. declare module "babylonjs/Shaders/depth.fragment" {
  61528. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  61529. /** @hidden */
  61530. export var depthPixelShader: {
  61531. name: string;
  61532. shader: string;
  61533. };
  61534. }
  61535. declare module "babylonjs/Shaders/depth.vertex" {
  61536. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61537. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61538. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61539. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61540. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61541. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61542. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61543. /** @hidden */
  61544. export var depthVertexShader: {
  61545. name: string;
  61546. shader: string;
  61547. };
  61548. }
  61549. declare module "babylonjs/Rendering/depthRenderer" {
  61550. import { Nullable } from "babylonjs/types";
  61551. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61552. import { Scene } from "babylonjs/scene";
  61553. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61554. import { Camera } from "babylonjs/Cameras/camera";
  61555. import "babylonjs/Shaders/depth.fragment";
  61556. import "babylonjs/Shaders/depth.vertex";
  61557. /**
  61558. * This represents a depth renderer in Babylon.
  61559. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  61560. */
  61561. export class DepthRenderer {
  61562. private _scene;
  61563. private _depthMap;
  61564. private _effect;
  61565. private readonly _storeNonLinearDepth;
  61566. private readonly _clearColor;
  61567. /** Get if the depth renderer is using packed depth or not */
  61568. readonly isPacked: boolean;
  61569. private _cachedDefines;
  61570. private _camera;
  61571. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  61572. enabled: boolean;
  61573. /**
  61574. * Specifiess that the depth renderer will only be used within
  61575. * the camera it is created for.
  61576. * This can help forcing its rendering during the camera processing.
  61577. */
  61578. useOnlyInActiveCamera: boolean;
  61579. /** @hidden */
  61580. static _SceneComponentInitialization: (scene: Scene) => void;
  61581. /**
  61582. * Instantiates a depth renderer
  61583. * @param scene The scene the renderer belongs to
  61584. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  61585. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  61586. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  61587. */
  61588. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  61589. /**
  61590. * Creates the depth rendering effect and checks if the effect is ready.
  61591. * @param subMesh The submesh to be used to render the depth map of
  61592. * @param useInstances If multiple world instances should be used
  61593. * @returns if the depth renderer is ready to render the depth map
  61594. */
  61595. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61596. /**
  61597. * Gets the texture which the depth map will be written to.
  61598. * @returns The depth map texture
  61599. */
  61600. getDepthMap(): RenderTargetTexture;
  61601. /**
  61602. * Disposes of the depth renderer.
  61603. */
  61604. dispose(): void;
  61605. }
  61606. }
  61607. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  61608. /** @hidden */
  61609. export var minmaxReduxPixelShader: {
  61610. name: string;
  61611. shader: string;
  61612. };
  61613. }
  61614. declare module "babylonjs/Misc/minMaxReducer" {
  61615. import { Nullable } from "babylonjs/types";
  61616. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61617. import { Camera } from "babylonjs/Cameras/camera";
  61618. import { Observer } from "babylonjs/Misc/observable";
  61619. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61620. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  61621. import { Observable } from "babylonjs/Misc/observable";
  61622. import "babylonjs/Shaders/minmaxRedux.fragment";
  61623. /**
  61624. * This class computes a min/max reduction from a texture: it means it computes the minimum
  61625. * and maximum values from all values of the texture.
  61626. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  61627. * The source values are read from the red channel of the texture.
  61628. */
  61629. export class MinMaxReducer {
  61630. /**
  61631. * Observable triggered when the computation has been performed
  61632. */
  61633. onAfterReductionPerformed: Observable<{
  61634. min: number;
  61635. max: number;
  61636. }>;
  61637. protected _camera: Camera;
  61638. protected _sourceTexture: Nullable<RenderTargetTexture>;
  61639. protected _reductionSteps: Nullable<Array<PostProcess>>;
  61640. protected _postProcessManager: PostProcessManager;
  61641. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  61642. protected _forceFullscreenViewport: boolean;
  61643. /**
  61644. * Creates a min/max reducer
  61645. * @param camera The camera to use for the post processes
  61646. */
  61647. constructor(camera: Camera);
  61648. /**
  61649. * Gets the texture used to read the values from.
  61650. */
  61651. get sourceTexture(): Nullable<RenderTargetTexture>;
  61652. /**
  61653. * Sets the source texture to read the values from.
  61654. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  61655. * because in such textures '1' value must not be taken into account to compute the maximum
  61656. * as this value is used to clear the texture.
  61657. * Note that the computation is not activated by calling this function, you must call activate() for that!
  61658. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  61659. * @param depthRedux Indicates if the texture is a depth texture or not
  61660. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  61661. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61662. */
  61663. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61664. /**
  61665. * Defines the refresh rate of the computation.
  61666. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61667. */
  61668. get refreshRate(): number;
  61669. set refreshRate(value: number);
  61670. protected _activated: boolean;
  61671. /**
  61672. * Gets the activation status of the reducer
  61673. */
  61674. get activated(): boolean;
  61675. /**
  61676. * Activates the reduction computation.
  61677. * When activated, the observers registered in onAfterReductionPerformed are
  61678. * called after the compuation is performed
  61679. */
  61680. activate(): void;
  61681. /**
  61682. * Deactivates the reduction computation.
  61683. */
  61684. deactivate(): void;
  61685. /**
  61686. * Disposes the min/max reducer
  61687. * @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.
  61688. */
  61689. dispose(disposeAll?: boolean): void;
  61690. }
  61691. }
  61692. declare module "babylonjs/Misc/depthReducer" {
  61693. import { Nullable } from "babylonjs/types";
  61694. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61695. import { Camera } from "babylonjs/Cameras/camera";
  61696. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61697. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  61698. /**
  61699. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  61700. */
  61701. export class DepthReducer extends MinMaxReducer {
  61702. private _depthRenderer;
  61703. private _depthRendererId;
  61704. /**
  61705. * Gets the depth renderer used for the computation.
  61706. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  61707. */
  61708. get depthRenderer(): Nullable<DepthRenderer>;
  61709. /**
  61710. * Creates a depth reducer
  61711. * @param camera The camera used to render the depth texture
  61712. */
  61713. constructor(camera: Camera);
  61714. /**
  61715. * Sets the depth renderer to use to generate the depth map
  61716. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  61717. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  61718. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61719. */
  61720. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  61721. /** @hidden */
  61722. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61723. /**
  61724. * Activates the reduction computation.
  61725. * When activated, the observers registered in onAfterReductionPerformed are
  61726. * called after the compuation is performed
  61727. */
  61728. activate(): void;
  61729. /**
  61730. * Deactivates the reduction computation.
  61731. */
  61732. deactivate(): void;
  61733. /**
  61734. * Disposes the depth reducer
  61735. * @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.
  61736. */
  61737. dispose(disposeAll?: boolean): void;
  61738. }
  61739. }
  61740. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  61741. import { Nullable } from "babylonjs/types";
  61742. import { Scene } from "babylonjs/scene";
  61743. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61744. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61745. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61746. import { Effect } from "babylonjs/Materials/effect";
  61747. import "babylonjs/Shaders/shadowMap.fragment";
  61748. import "babylonjs/Shaders/shadowMap.vertex";
  61749. import "babylonjs/Shaders/depthBoxBlur.fragment";
  61750. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  61751. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  61752. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  61753. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61754. /**
  61755. * A CSM implementation allowing casting shadows on large scenes.
  61756. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61757. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  61758. */
  61759. export class CascadedShadowGenerator extends ShadowGenerator {
  61760. private static readonly frustumCornersNDCSpace;
  61761. /**
  61762. * Name of the CSM class
  61763. */
  61764. static CLASSNAME: string;
  61765. /**
  61766. * Defines the default number of cascades used by the CSM.
  61767. */
  61768. static readonly DEFAULT_CASCADES_COUNT: number;
  61769. /**
  61770. * Defines the minimum number of cascades used by the CSM.
  61771. */
  61772. static readonly MIN_CASCADES_COUNT: number;
  61773. /**
  61774. * Defines the maximum number of cascades used by the CSM.
  61775. */
  61776. static readonly MAX_CASCADES_COUNT: number;
  61777. protected _validateFilter(filter: number): number;
  61778. /**
  61779. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  61780. */
  61781. penumbraDarkness: number;
  61782. private _numCascades;
  61783. /**
  61784. * Gets or set the number of cascades used by the CSM.
  61785. */
  61786. get numCascades(): number;
  61787. set numCascades(value: number);
  61788. /**
  61789. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  61790. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  61791. */
  61792. stabilizeCascades: boolean;
  61793. private _freezeShadowCastersBoundingInfo;
  61794. private _freezeShadowCastersBoundingInfoObservable;
  61795. /**
  61796. * Enables or disables the shadow casters bounding info computation.
  61797. * If your shadow casters don't move, you can disable this feature.
  61798. * If it is enabled, the bounding box computation is done every frame.
  61799. */
  61800. get freezeShadowCastersBoundingInfo(): boolean;
  61801. set freezeShadowCastersBoundingInfo(freeze: boolean);
  61802. private _scbiMin;
  61803. private _scbiMax;
  61804. protected _computeShadowCastersBoundingInfo(): void;
  61805. protected _shadowCastersBoundingInfo: BoundingInfo;
  61806. /**
  61807. * Gets or sets the shadow casters bounding info.
  61808. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  61809. * so that the system won't overwrite the bounds you provide
  61810. */
  61811. get shadowCastersBoundingInfo(): BoundingInfo;
  61812. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  61813. protected _breaksAreDirty: boolean;
  61814. protected _minDistance: number;
  61815. protected _maxDistance: number;
  61816. /**
  61817. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  61818. *
  61819. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  61820. * If you don't know these values, simply leave them to their defaults and don't call this function.
  61821. * @param min minimal distance for the breaks (default to 0.)
  61822. * @param max maximal distance for the breaks (default to 1.)
  61823. */
  61824. setMinMaxDistance(min: number, max: number): void;
  61825. /** Gets the minimal distance used in the cascade break computation */
  61826. get minDistance(): number;
  61827. /** Gets the maximal distance used in the cascade break computation */
  61828. get maxDistance(): number;
  61829. /**
  61830. * Gets the class name of that object
  61831. * @returns "CascadedShadowGenerator"
  61832. */
  61833. getClassName(): string;
  61834. private _cascadeMinExtents;
  61835. private _cascadeMaxExtents;
  61836. /**
  61837. * Gets a cascade minimum extents
  61838. * @param cascadeIndex index of the cascade
  61839. * @returns the minimum cascade extents
  61840. */
  61841. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  61842. /**
  61843. * Gets a cascade maximum extents
  61844. * @param cascadeIndex index of the cascade
  61845. * @returns the maximum cascade extents
  61846. */
  61847. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  61848. private _cascades;
  61849. private _currentLayer;
  61850. private _viewSpaceFrustumsZ;
  61851. private _viewMatrices;
  61852. private _projectionMatrices;
  61853. private _transformMatrices;
  61854. private _transformMatricesAsArray;
  61855. private _frustumLengths;
  61856. private _lightSizeUVCorrection;
  61857. private _depthCorrection;
  61858. private _frustumCornersWorldSpace;
  61859. private _frustumCenter;
  61860. private _shadowCameraPos;
  61861. private _shadowMaxZ;
  61862. /**
  61863. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  61864. * It defaults to camera.maxZ
  61865. */
  61866. get shadowMaxZ(): number;
  61867. /**
  61868. * Sets the shadow max z distance.
  61869. */
  61870. set shadowMaxZ(value: number);
  61871. protected _debug: boolean;
  61872. /**
  61873. * Gets or sets the debug flag.
  61874. * When enabled, the cascades are materialized by different colors on the screen.
  61875. */
  61876. get debug(): boolean;
  61877. set debug(dbg: boolean);
  61878. private _depthClamp;
  61879. /**
  61880. * Gets or sets the depth clamping value.
  61881. *
  61882. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  61883. * to account for the shadow casters far away.
  61884. *
  61885. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  61886. */
  61887. get depthClamp(): boolean;
  61888. set depthClamp(value: boolean);
  61889. private _cascadeBlendPercentage;
  61890. /**
  61891. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  61892. * It defaults to 0.1 (10% blending).
  61893. */
  61894. get cascadeBlendPercentage(): number;
  61895. set cascadeBlendPercentage(value: number);
  61896. private _lambda;
  61897. /**
  61898. * Gets or set the lambda parameter.
  61899. * This parameter is used to split the camera frustum and create the cascades.
  61900. * 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.
  61901. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  61902. */
  61903. get lambda(): number;
  61904. set lambda(value: number);
  61905. /**
  61906. * Gets the view matrix corresponding to a given cascade
  61907. * @param cascadeNum cascade to retrieve the view matrix from
  61908. * @returns the cascade view matrix
  61909. */
  61910. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  61911. /**
  61912. * Gets the projection matrix corresponding to a given cascade
  61913. * @param cascadeNum cascade to retrieve the projection matrix from
  61914. * @returns the cascade projection matrix
  61915. */
  61916. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  61917. /**
  61918. * Gets the transformation matrix corresponding to a given cascade
  61919. * @param cascadeNum cascade to retrieve the transformation matrix from
  61920. * @returns the cascade transformation matrix
  61921. */
  61922. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  61923. private _depthRenderer;
  61924. /**
  61925. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  61926. *
  61927. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  61928. *
  61929. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  61930. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  61931. * @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
  61932. */
  61933. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  61934. private _depthReducer;
  61935. private _autoCalcDepthBounds;
  61936. /**
  61937. * Gets or sets the autoCalcDepthBounds property.
  61938. *
  61939. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  61940. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  61941. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  61942. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  61943. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  61944. */
  61945. get autoCalcDepthBounds(): boolean;
  61946. set autoCalcDepthBounds(value: boolean);
  61947. /**
  61948. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  61949. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61950. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  61951. * for setting the refresh rate on the renderer yourself!
  61952. */
  61953. get autoCalcDepthBoundsRefreshRate(): number;
  61954. set autoCalcDepthBoundsRefreshRate(value: number);
  61955. /**
  61956. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  61957. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  61958. * you change the camera near/far planes!
  61959. */
  61960. splitFrustum(): void;
  61961. private _splitFrustum;
  61962. private _computeMatrices;
  61963. private _computeFrustumInWorldSpace;
  61964. private _computeCascadeFrustum;
  61965. /**
  61966. * Support test.
  61967. */
  61968. static get IsSupported(): boolean;
  61969. /** @hidden */
  61970. static _SceneComponentInitialization: (scene: Scene) => void;
  61971. /**
  61972. * Creates a Cascaded Shadow Generator object.
  61973. * A ShadowGenerator is the required tool to use the shadows.
  61974. * Each directional light casting shadows needs to use its own ShadowGenerator.
  61975. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61976. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  61977. * @param light The directional light object generating the shadows.
  61978. * @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.
  61979. */
  61980. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  61981. protected _initializeGenerator(): void;
  61982. protected _createTargetRenderTexture(): void;
  61983. protected _initializeShadowMap(): void;
  61984. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  61985. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  61986. /**
  61987. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  61988. * @param defines Defines of the material we want to update
  61989. * @param lightIndex Index of the light in the enabled light list of the material
  61990. */
  61991. prepareDefines(defines: any, lightIndex: number): void;
  61992. /**
  61993. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  61994. * defined in the generator but impacting the effect).
  61995. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  61996. * @param effect The effect we are binfing the information for
  61997. */
  61998. bindShadowLight(lightIndex: string, effect: Effect): void;
  61999. /**
  62000. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62001. * (eq to view projection * shadow projection matrices)
  62002. * @returns The transform matrix used to create the shadow map
  62003. */
  62004. getTransformMatrix(): Matrix;
  62005. /**
  62006. * Disposes the ShadowGenerator.
  62007. * Returns nothing.
  62008. */
  62009. dispose(): void;
  62010. /**
  62011. * Serializes the shadow generator setup to a json object.
  62012. * @returns The serialized JSON object
  62013. */
  62014. serialize(): any;
  62015. /**
  62016. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62017. * @param parsedShadowGenerator The JSON object to parse
  62018. * @param scene The scene to create the shadow map for
  62019. * @returns The parsed shadow generator
  62020. */
  62021. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62022. }
  62023. }
  62024. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62025. import { Scene } from "babylonjs/scene";
  62026. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62027. import { AbstractScene } from "babylonjs/abstractScene";
  62028. /**
  62029. * Defines the shadow generator component responsible to manage any shadow generators
  62030. * in a given scene.
  62031. */
  62032. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62033. /**
  62034. * The component name helpfull to identify the component in the list of scene components.
  62035. */
  62036. readonly name: string;
  62037. /**
  62038. * The scene the component belongs to.
  62039. */
  62040. scene: Scene;
  62041. /**
  62042. * Creates a new instance of the component for the given scene
  62043. * @param scene Defines the scene to register the component in
  62044. */
  62045. constructor(scene: Scene);
  62046. /**
  62047. * Registers the component in a given scene
  62048. */
  62049. register(): void;
  62050. /**
  62051. * Rebuilds the elements related to this component in case of
  62052. * context lost for instance.
  62053. */
  62054. rebuild(): void;
  62055. /**
  62056. * Serializes the component data to the specified json object
  62057. * @param serializationObject The object to serialize to
  62058. */
  62059. serialize(serializationObject: any): void;
  62060. /**
  62061. * Adds all the elements from the container to the scene
  62062. * @param container the container holding the elements
  62063. */
  62064. addFromContainer(container: AbstractScene): void;
  62065. /**
  62066. * Removes all the elements in the container from the scene
  62067. * @param container contains the elements to remove
  62068. * @param dispose if the removed element should be disposed (default: false)
  62069. */
  62070. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62071. /**
  62072. * Rebuilds the elements related to this component in case of
  62073. * context lost for instance.
  62074. */
  62075. dispose(): void;
  62076. private _gatherRenderTargets;
  62077. }
  62078. }
  62079. declare module "babylonjs/Lights/Shadows/index" {
  62080. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62081. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62082. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62083. }
  62084. declare module "babylonjs/Lights/pointLight" {
  62085. import { Scene } from "babylonjs/scene";
  62086. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62087. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62088. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62089. import { Effect } from "babylonjs/Materials/effect";
  62090. /**
  62091. * A point light is a light defined by an unique point in world space.
  62092. * The light is emitted in every direction from this point.
  62093. * A good example of a point light is a standard light bulb.
  62094. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62095. */
  62096. export class PointLight extends ShadowLight {
  62097. private _shadowAngle;
  62098. /**
  62099. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62100. * This specifies what angle the shadow will use to be created.
  62101. *
  62102. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62103. */
  62104. get shadowAngle(): number;
  62105. /**
  62106. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62107. * This specifies what angle the shadow will use to be created.
  62108. *
  62109. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62110. */
  62111. set shadowAngle(value: number);
  62112. /**
  62113. * Gets the direction if it has been set.
  62114. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62115. */
  62116. get direction(): Vector3;
  62117. /**
  62118. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62119. */
  62120. set direction(value: Vector3);
  62121. /**
  62122. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62123. * A PointLight emits the light in every direction.
  62124. * It can cast shadows.
  62125. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62126. * ```javascript
  62127. * var pointLight = new PointLight("pl", camera.position, scene);
  62128. * ```
  62129. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62130. * @param name The light friendly name
  62131. * @param position The position of the point light in the scene
  62132. * @param scene The scene the lights belongs to
  62133. */
  62134. constructor(name: string, position: Vector3, scene: Scene);
  62135. /**
  62136. * Returns the string "PointLight"
  62137. * @returns the class name
  62138. */
  62139. getClassName(): string;
  62140. /**
  62141. * Returns the integer 0.
  62142. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62143. */
  62144. getTypeID(): number;
  62145. /**
  62146. * Specifies wether or not the shadowmap should be a cube texture.
  62147. * @returns true if the shadowmap needs to be a cube texture.
  62148. */
  62149. needCube(): boolean;
  62150. /**
  62151. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62152. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62153. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62154. */
  62155. getShadowDirection(faceIndex?: number): Vector3;
  62156. /**
  62157. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62158. * - fov = PI / 2
  62159. * - aspect ratio : 1.0
  62160. * - z-near and far equal to the active camera minZ and maxZ.
  62161. * Returns the PointLight.
  62162. */
  62163. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62164. protected _buildUniformLayout(): void;
  62165. /**
  62166. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62167. * @param effect The effect to update
  62168. * @param lightIndex The index of the light in the effect to update
  62169. * @returns The point light
  62170. */
  62171. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62172. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62173. /**
  62174. * Prepares the list of defines specific to the light type.
  62175. * @param defines the list of defines
  62176. * @param lightIndex defines the index of the light for the effect
  62177. */
  62178. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62179. }
  62180. }
  62181. declare module "babylonjs/Lights/index" {
  62182. export * from "babylonjs/Lights/light";
  62183. export * from "babylonjs/Lights/shadowLight";
  62184. export * from "babylonjs/Lights/Shadows/index";
  62185. export * from "babylonjs/Lights/directionalLight";
  62186. export * from "babylonjs/Lights/hemisphericLight";
  62187. export * from "babylonjs/Lights/pointLight";
  62188. export * from "babylonjs/Lights/spotLight";
  62189. }
  62190. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62191. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62192. /**
  62193. * Header information of HDR texture files.
  62194. */
  62195. export interface HDRInfo {
  62196. /**
  62197. * The height of the texture in pixels.
  62198. */
  62199. height: number;
  62200. /**
  62201. * The width of the texture in pixels.
  62202. */
  62203. width: number;
  62204. /**
  62205. * The index of the beginning of the data in the binary file.
  62206. */
  62207. dataPosition: number;
  62208. }
  62209. /**
  62210. * This groups tools to convert HDR texture to native colors array.
  62211. */
  62212. export class HDRTools {
  62213. private static Ldexp;
  62214. private static Rgbe2float;
  62215. private static readStringLine;
  62216. /**
  62217. * Reads header information from an RGBE texture stored in a native array.
  62218. * More information on this format are available here:
  62219. * https://en.wikipedia.org/wiki/RGBE_image_format
  62220. *
  62221. * @param uint8array The binary file stored in native array.
  62222. * @return The header information.
  62223. */
  62224. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62225. /**
  62226. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62227. * This RGBE texture needs to store the information as a panorama.
  62228. *
  62229. * More information on this format are available here:
  62230. * https://en.wikipedia.org/wiki/RGBE_image_format
  62231. *
  62232. * @param buffer The binary file stored in an array buffer.
  62233. * @param size The expected size of the extracted cubemap.
  62234. * @return The Cube Map information.
  62235. */
  62236. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62237. /**
  62238. * Returns the pixels data extracted from an RGBE texture.
  62239. * This pixels will be stored left to right up to down in the R G B order in one array.
  62240. *
  62241. * More information on this format are available here:
  62242. * https://en.wikipedia.org/wiki/RGBE_image_format
  62243. *
  62244. * @param uint8array The binary file stored in an array buffer.
  62245. * @param hdrInfo The header information of the file.
  62246. * @return The pixels data in RGB right to left up to down order.
  62247. */
  62248. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62249. private static RGBE_ReadPixels_RLE;
  62250. private static RGBE_ReadPixels_NOT_RLE;
  62251. }
  62252. }
  62253. declare module "babylonjs/Materials/effectRenderer" {
  62254. import { Nullable } from "babylonjs/types";
  62255. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62256. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62257. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62258. import { Viewport } from "babylonjs/Maths/math.viewport";
  62259. import { Observable } from "babylonjs/Misc/observable";
  62260. import { Effect } from "babylonjs/Materials/effect";
  62261. import "babylonjs/Shaders/postprocess.vertex";
  62262. /**
  62263. * Effect Render Options
  62264. */
  62265. export interface IEffectRendererOptions {
  62266. /**
  62267. * Defines the vertices positions.
  62268. */
  62269. positions?: number[];
  62270. /**
  62271. * Defines the indices.
  62272. */
  62273. indices?: number[];
  62274. }
  62275. /**
  62276. * Helper class to render one or more effects.
  62277. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62278. */
  62279. export class EffectRenderer {
  62280. private engine;
  62281. private static _DefaultOptions;
  62282. private _vertexBuffers;
  62283. private _indexBuffer;
  62284. private _fullscreenViewport;
  62285. /**
  62286. * Creates an effect renderer
  62287. * @param engine the engine to use for rendering
  62288. * @param options defines the options of the effect renderer
  62289. */
  62290. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62291. /**
  62292. * Sets the current viewport in normalized coordinates 0-1
  62293. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62294. */
  62295. setViewport(viewport?: Viewport): void;
  62296. /**
  62297. * Binds the embedded attributes buffer to the effect.
  62298. * @param effect Defines the effect to bind the attributes for
  62299. */
  62300. bindBuffers(effect: Effect): void;
  62301. /**
  62302. * Sets the current effect wrapper to use during draw.
  62303. * The effect needs to be ready before calling this api.
  62304. * This also sets the default full screen position attribute.
  62305. * @param effectWrapper Defines the effect to draw with
  62306. */
  62307. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62308. /**
  62309. * Restores engine states
  62310. */
  62311. restoreStates(): void;
  62312. /**
  62313. * Draws a full screen quad.
  62314. */
  62315. draw(): void;
  62316. private isRenderTargetTexture;
  62317. /**
  62318. * renders one or more effects to a specified texture
  62319. * @param effectWrapper the effect to renderer
  62320. * @param outputTexture texture to draw to, if null it will render to the screen.
  62321. */
  62322. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62323. /**
  62324. * Disposes of the effect renderer
  62325. */
  62326. dispose(): void;
  62327. }
  62328. /**
  62329. * Options to create an EffectWrapper
  62330. */
  62331. interface EffectWrapperCreationOptions {
  62332. /**
  62333. * Engine to use to create the effect
  62334. */
  62335. engine: ThinEngine;
  62336. /**
  62337. * Fragment shader for the effect
  62338. */
  62339. fragmentShader: string;
  62340. /**
  62341. * Use the shader store instead of direct source code
  62342. */
  62343. useShaderStore?: boolean;
  62344. /**
  62345. * Vertex shader for the effect
  62346. */
  62347. vertexShader?: string;
  62348. /**
  62349. * Attributes to use in the shader
  62350. */
  62351. attributeNames?: Array<string>;
  62352. /**
  62353. * Uniforms to use in the shader
  62354. */
  62355. uniformNames?: Array<string>;
  62356. /**
  62357. * Texture sampler names to use in the shader
  62358. */
  62359. samplerNames?: Array<string>;
  62360. /**
  62361. * Defines to use in the shader
  62362. */
  62363. defines?: Array<string>;
  62364. /**
  62365. * Callback when effect is compiled
  62366. */
  62367. onCompiled?: Nullable<(effect: Effect) => void>;
  62368. /**
  62369. * The friendly name of the effect displayed in Spector.
  62370. */
  62371. name?: string;
  62372. }
  62373. /**
  62374. * Wraps an effect to be used for rendering
  62375. */
  62376. export class EffectWrapper {
  62377. /**
  62378. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62379. */
  62380. onApplyObservable: Observable<{}>;
  62381. /**
  62382. * The underlying effect
  62383. */
  62384. effect: Effect;
  62385. /**
  62386. * Creates an effect to be renderer
  62387. * @param creationOptions options to create the effect
  62388. */
  62389. constructor(creationOptions: EffectWrapperCreationOptions);
  62390. /**
  62391. * Disposes of the effect wrapper
  62392. */
  62393. dispose(): void;
  62394. }
  62395. }
  62396. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62397. /** @hidden */
  62398. export var hdrFilteringVertexShader: {
  62399. name: string;
  62400. shader: string;
  62401. };
  62402. }
  62403. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62404. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62405. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62406. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62407. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62408. /** @hidden */
  62409. export var hdrFilteringPixelShader: {
  62410. name: string;
  62411. shader: string;
  62412. };
  62413. }
  62414. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62416. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62417. import { Nullable } from "babylonjs/types";
  62418. import "babylonjs/Shaders/hdrFiltering.vertex";
  62419. import "babylonjs/Shaders/hdrFiltering.fragment";
  62420. /**
  62421. * Options for texture filtering
  62422. */
  62423. interface IHDRFilteringOptions {
  62424. /**
  62425. * Scales pixel intensity for the input HDR map.
  62426. */
  62427. hdrScale?: number;
  62428. /**
  62429. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62430. */
  62431. quality?: number;
  62432. }
  62433. /**
  62434. * Filters HDR maps to get correct renderings of PBR reflections
  62435. */
  62436. export class HDRFiltering {
  62437. private _engine;
  62438. private _effectRenderer;
  62439. private _effectWrapper;
  62440. private _lodGenerationOffset;
  62441. private _lodGenerationScale;
  62442. /**
  62443. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62444. * you care about baking speed.
  62445. */
  62446. quality: number;
  62447. /**
  62448. * Scales pixel intensity for the input HDR map.
  62449. */
  62450. hdrScale: number;
  62451. /**
  62452. * Instantiates HDR filter for reflection maps
  62453. *
  62454. * @param engine Thin engine
  62455. * @param options Options
  62456. */
  62457. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  62458. private _createRenderTarget;
  62459. private _prefilterInternal;
  62460. private _createEffect;
  62461. /**
  62462. * Get a value indicating if the filter is ready to be used
  62463. * @param texture Texture to filter
  62464. * @returns true if the filter is ready
  62465. */
  62466. isReady(texture: BaseTexture): boolean;
  62467. /**
  62468. * Prefilters a cube texture to have mipmap levels representing roughness values.
  62469. * Prefiltering will be invoked at the end of next rendering pass.
  62470. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  62471. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  62472. * @param texture Texture to filter
  62473. * @param onFinished Callback when filtering is done
  62474. * @return Promise called when prefiltering is done
  62475. */
  62476. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  62477. }
  62478. }
  62479. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  62480. import { Nullable } from "babylonjs/types";
  62481. import { Scene } from "babylonjs/scene";
  62482. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62483. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62484. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62485. import "babylonjs/Engines/Extensions/engine.rawTexture";
  62486. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  62487. /**
  62488. * This represents a texture coming from an HDR input.
  62489. *
  62490. * The only supported format is currently panorama picture stored in RGBE format.
  62491. * Example of such files can be found on HDRLib: http://hdrlib.com/
  62492. */
  62493. export class HDRCubeTexture extends BaseTexture {
  62494. private static _facesMapping;
  62495. private _generateHarmonics;
  62496. private _noMipmap;
  62497. private _prefilterOnLoad;
  62498. private _textureMatrix;
  62499. private _size;
  62500. private _onLoad;
  62501. private _onError;
  62502. /**
  62503. * The texture URL.
  62504. */
  62505. url: string;
  62506. /**
  62507. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  62508. */
  62509. coordinatesMode: number;
  62510. protected _isBlocking: boolean;
  62511. /**
  62512. * Sets wether or not the texture is blocking during loading.
  62513. */
  62514. set isBlocking(value: boolean);
  62515. /**
  62516. * Gets wether or not the texture is blocking during loading.
  62517. */
  62518. get isBlocking(): boolean;
  62519. protected _rotationY: number;
  62520. /**
  62521. * Sets texture matrix rotation angle around Y axis in radians.
  62522. */
  62523. set rotationY(value: number);
  62524. /**
  62525. * Gets texture matrix rotation angle around Y axis radians.
  62526. */
  62527. get rotationY(): number;
  62528. /**
  62529. * Gets or sets the center of the bounding box associated with the cube texture
  62530. * It must define where the camera used to render the texture was set
  62531. */
  62532. boundingBoxPosition: Vector3;
  62533. private _boundingBoxSize;
  62534. /**
  62535. * Gets or sets the size of the bounding box associated with the cube texture
  62536. * When defined, the cubemap will switch to local mode
  62537. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  62538. * @example https://www.babylonjs-playground.com/#RNASML
  62539. */
  62540. set boundingBoxSize(value: Vector3);
  62541. get boundingBoxSize(): Vector3;
  62542. /**
  62543. * Instantiates an HDRTexture from the following parameters.
  62544. *
  62545. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  62546. * @param sceneOrEngine The scene or engine the texture will be used in
  62547. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  62548. * @param noMipmap Forces to not generate the mipmap if true
  62549. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  62550. * @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)
  62551. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  62552. */
  62553. 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>);
  62554. /**
  62555. * Get the current class name of the texture useful for serialization or dynamic coding.
  62556. * @returns "HDRCubeTexture"
  62557. */
  62558. getClassName(): string;
  62559. /**
  62560. * Occurs when the file is raw .hdr file.
  62561. */
  62562. private loadTexture;
  62563. clone(): HDRCubeTexture;
  62564. delayLoad(): void;
  62565. /**
  62566. * Get the texture reflection matrix used to rotate/transform the reflection.
  62567. * @returns the reflection matrix
  62568. */
  62569. getReflectionTextureMatrix(): Matrix;
  62570. /**
  62571. * Set the texture reflection matrix used to rotate/transform the reflection.
  62572. * @param value Define the reflection matrix to set
  62573. */
  62574. setReflectionTextureMatrix(value: Matrix): void;
  62575. /**
  62576. * Parses a JSON representation of an HDR Texture in order to create the texture
  62577. * @param parsedTexture Define the JSON representation
  62578. * @param scene Define the scene the texture should be created in
  62579. * @param rootUrl Define the root url in case we need to load relative dependencies
  62580. * @returns the newly created texture after parsing
  62581. */
  62582. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  62583. serialize(): any;
  62584. }
  62585. }
  62586. declare module "babylonjs/Physics/physicsEngine" {
  62587. import { Nullable } from "babylonjs/types";
  62588. import { Vector3 } from "babylonjs/Maths/math.vector";
  62589. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62590. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  62591. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  62592. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62593. /**
  62594. * Class used to control physics engine
  62595. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62596. */
  62597. export class PhysicsEngine implements IPhysicsEngine {
  62598. private _physicsPlugin;
  62599. /**
  62600. * Global value used to control the smallest number supported by the simulation
  62601. */
  62602. static Epsilon: number;
  62603. private _impostors;
  62604. private _joints;
  62605. private _subTimeStep;
  62606. /**
  62607. * Gets the gravity vector used by the simulation
  62608. */
  62609. gravity: Vector3;
  62610. /**
  62611. * Factory used to create the default physics plugin.
  62612. * @returns The default physics plugin
  62613. */
  62614. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  62615. /**
  62616. * Creates a new Physics Engine
  62617. * @param gravity defines the gravity vector used by the simulation
  62618. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  62619. */
  62620. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  62621. /**
  62622. * Sets the gravity vector used by the simulation
  62623. * @param gravity defines the gravity vector to use
  62624. */
  62625. setGravity(gravity: Vector3): void;
  62626. /**
  62627. * Set the time step of the physics engine.
  62628. * Default is 1/60.
  62629. * To slow it down, enter 1/600 for example.
  62630. * To speed it up, 1/30
  62631. * @param newTimeStep defines the new timestep to apply to this world.
  62632. */
  62633. setTimeStep(newTimeStep?: number): void;
  62634. /**
  62635. * Get the time step of the physics engine.
  62636. * @returns the current time step
  62637. */
  62638. getTimeStep(): number;
  62639. /**
  62640. * Set the sub time step of the physics engine.
  62641. * Default is 0 meaning there is no sub steps
  62642. * To increase physics resolution precision, set a small value (like 1 ms)
  62643. * @param subTimeStep defines the new sub timestep used for physics resolution.
  62644. */
  62645. setSubTimeStep(subTimeStep?: number): void;
  62646. /**
  62647. * Get the sub time step of the physics engine.
  62648. * @returns the current sub time step
  62649. */
  62650. getSubTimeStep(): number;
  62651. /**
  62652. * Release all resources
  62653. */
  62654. dispose(): void;
  62655. /**
  62656. * Gets the name of the current physics plugin
  62657. * @returns the name of the plugin
  62658. */
  62659. getPhysicsPluginName(): string;
  62660. /**
  62661. * Adding a new impostor for the impostor tracking.
  62662. * This will be done by the impostor itself.
  62663. * @param impostor the impostor to add
  62664. */
  62665. addImpostor(impostor: PhysicsImpostor): void;
  62666. /**
  62667. * Remove an impostor from the engine.
  62668. * This impostor and its mesh will not longer be updated by the physics engine.
  62669. * @param impostor the impostor to remove
  62670. */
  62671. removeImpostor(impostor: PhysicsImpostor): void;
  62672. /**
  62673. * Add a joint to the physics engine
  62674. * @param mainImpostor defines the main impostor to which the joint is added.
  62675. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  62676. * @param joint defines the joint that will connect both impostors.
  62677. */
  62678. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62679. /**
  62680. * Removes a joint from the simulation
  62681. * @param mainImpostor defines the impostor used with the joint
  62682. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  62683. * @param joint defines the joint to remove
  62684. */
  62685. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62686. /**
  62687. * Called by the scene. No need to call it.
  62688. * @param delta defines the timespam between frames
  62689. */
  62690. _step(delta: number): void;
  62691. /**
  62692. * Gets the current plugin used to run the simulation
  62693. * @returns current plugin
  62694. */
  62695. getPhysicsPlugin(): IPhysicsEnginePlugin;
  62696. /**
  62697. * Gets the list of physic impostors
  62698. * @returns an array of PhysicsImpostor
  62699. */
  62700. getImpostors(): Array<PhysicsImpostor>;
  62701. /**
  62702. * Gets the impostor for a physics enabled object
  62703. * @param object defines the object impersonated by the impostor
  62704. * @returns the PhysicsImpostor or null if not found
  62705. */
  62706. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  62707. /**
  62708. * Gets the impostor for a physics body object
  62709. * @param body defines physics body used by the impostor
  62710. * @returns the PhysicsImpostor or null if not found
  62711. */
  62712. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  62713. /**
  62714. * Does a raycast in the physics world
  62715. * @param from when should the ray start?
  62716. * @param to when should the ray end?
  62717. * @returns PhysicsRaycastResult
  62718. */
  62719. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62720. }
  62721. }
  62722. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  62723. import { Nullable } from "babylonjs/types";
  62724. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62725. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62726. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62727. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62728. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62729. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62730. /** @hidden */
  62731. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  62732. private _useDeltaForWorldStep;
  62733. world: any;
  62734. name: string;
  62735. private _physicsMaterials;
  62736. private _fixedTimeStep;
  62737. private _cannonRaycastResult;
  62738. private _raycastResult;
  62739. private _physicsBodysToRemoveAfterStep;
  62740. private _firstFrame;
  62741. BJSCANNON: any;
  62742. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  62743. setGravity(gravity: Vector3): void;
  62744. setTimeStep(timeStep: number): void;
  62745. getTimeStep(): number;
  62746. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62747. private _removeMarkedPhysicsBodiesFromWorld;
  62748. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62749. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62750. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62751. private _processChildMeshes;
  62752. removePhysicsBody(impostor: PhysicsImpostor): void;
  62753. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62754. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62755. private _addMaterial;
  62756. private _checkWithEpsilon;
  62757. private _createShape;
  62758. private _createHeightmap;
  62759. private _minus90X;
  62760. private _plus90X;
  62761. private _tmpPosition;
  62762. private _tmpDeltaPosition;
  62763. private _tmpUnityRotation;
  62764. private _updatePhysicsBodyTransformation;
  62765. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62766. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62767. isSupported(): boolean;
  62768. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62769. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62770. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62771. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62772. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62773. getBodyMass(impostor: PhysicsImpostor): number;
  62774. getBodyFriction(impostor: PhysicsImpostor): number;
  62775. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62776. getBodyRestitution(impostor: PhysicsImpostor): number;
  62777. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62778. sleepBody(impostor: PhysicsImpostor): void;
  62779. wakeUpBody(impostor: PhysicsImpostor): void;
  62780. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  62781. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62782. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62783. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62784. getRadius(impostor: PhysicsImpostor): number;
  62785. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62786. dispose(): void;
  62787. private _extendNamespace;
  62788. /**
  62789. * Does a raycast in the physics world
  62790. * @param from when should the ray start?
  62791. * @param to when should the ray end?
  62792. * @returns PhysicsRaycastResult
  62793. */
  62794. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62795. }
  62796. }
  62797. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  62798. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62799. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62800. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62801. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62802. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62803. import { Nullable } from "babylonjs/types";
  62804. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62805. /** @hidden */
  62806. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  62807. private _useDeltaForWorldStep;
  62808. world: any;
  62809. name: string;
  62810. BJSOIMO: any;
  62811. private _raycastResult;
  62812. private _fixedTimeStep;
  62813. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  62814. setGravity(gravity: Vector3): void;
  62815. setTimeStep(timeStep: number): void;
  62816. getTimeStep(): number;
  62817. private _tmpImpostorsArray;
  62818. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62819. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62820. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62821. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62822. private _tmpPositionVector;
  62823. removePhysicsBody(impostor: PhysicsImpostor): void;
  62824. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62825. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62826. isSupported(): boolean;
  62827. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62828. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62829. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62830. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62831. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62832. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62833. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62834. getBodyMass(impostor: PhysicsImpostor): number;
  62835. getBodyFriction(impostor: PhysicsImpostor): number;
  62836. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62837. getBodyRestitution(impostor: PhysicsImpostor): number;
  62838. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62839. sleepBody(impostor: PhysicsImpostor): void;
  62840. wakeUpBody(impostor: PhysicsImpostor): void;
  62841. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62842. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  62843. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  62844. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62845. getRadius(impostor: PhysicsImpostor): number;
  62846. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62847. dispose(): void;
  62848. /**
  62849. * Does a raycast in the physics world
  62850. * @param from when should the ray start?
  62851. * @param to when should the ray end?
  62852. * @returns PhysicsRaycastResult
  62853. */
  62854. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62855. }
  62856. }
  62857. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  62858. import { Nullable } from "babylonjs/types";
  62859. import { Scene } from "babylonjs/scene";
  62860. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  62861. import { Color4 } from "babylonjs/Maths/math.color";
  62862. import { Mesh } from "babylonjs/Meshes/mesh";
  62863. /**
  62864. * Class containing static functions to help procedurally build meshes
  62865. */
  62866. export class RibbonBuilder {
  62867. /**
  62868. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  62869. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  62870. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  62871. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  62872. * * 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
  62873. * * 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
  62874. * * 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
  62875. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62876. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62877. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62878. * * 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
  62879. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  62880. * * 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
  62881. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  62882. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62883. * @param name defines the name of the mesh
  62884. * @param options defines the options used to create the mesh
  62885. * @param scene defines the hosting scene
  62886. * @returns the ribbon mesh
  62887. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  62888. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62889. */
  62890. static CreateRibbon(name: string, options: {
  62891. pathArray: Vector3[][];
  62892. closeArray?: boolean;
  62893. closePath?: boolean;
  62894. offset?: number;
  62895. updatable?: boolean;
  62896. sideOrientation?: number;
  62897. frontUVs?: Vector4;
  62898. backUVs?: Vector4;
  62899. instance?: Mesh;
  62900. invertUV?: boolean;
  62901. uvs?: Vector2[];
  62902. colors?: Color4[];
  62903. }, scene?: Nullable<Scene>): Mesh;
  62904. }
  62905. }
  62906. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  62907. import { Nullable } from "babylonjs/types";
  62908. import { Scene } from "babylonjs/scene";
  62909. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  62910. import { Mesh } from "babylonjs/Meshes/mesh";
  62911. /**
  62912. * Class containing static functions to help procedurally build meshes
  62913. */
  62914. export class ShapeBuilder {
  62915. /**
  62916. * 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.
  62917. * * 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.
  62918. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62919. * * 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.
  62920. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  62921. * * 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
  62922. * * 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
  62923. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  62924. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62925. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62926. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  62927. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  62928. * @param name defines the name of the mesh
  62929. * @param options defines the options used to create the mesh
  62930. * @param scene defines the hosting scene
  62931. * @returns the extruded shape mesh
  62932. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62933. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62934. */
  62935. static ExtrudeShape(name: string, options: {
  62936. shape: Vector3[];
  62937. path: Vector3[];
  62938. scale?: number;
  62939. rotation?: number;
  62940. cap?: number;
  62941. updatable?: boolean;
  62942. sideOrientation?: number;
  62943. frontUVs?: Vector4;
  62944. backUVs?: Vector4;
  62945. instance?: Mesh;
  62946. invertUV?: boolean;
  62947. }, scene?: Nullable<Scene>): Mesh;
  62948. /**
  62949. * Creates an custom extruded shape mesh.
  62950. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  62951. * * 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.
  62952. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62953. * * 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
  62954. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  62955. * * 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
  62956. * * It must returns a float value that will be the scale value applied to the shape on each path point
  62957. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  62958. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  62959. * * 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
  62960. * * 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
  62961. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  62962. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62963. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62964. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62965. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62966. * @param name defines the name of the mesh
  62967. * @param options defines the options used to create the mesh
  62968. * @param scene defines the hosting scene
  62969. * @returns the custom extruded shape mesh
  62970. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  62971. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62972. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62973. */
  62974. static ExtrudeShapeCustom(name: string, options: {
  62975. shape: Vector3[];
  62976. path: Vector3[];
  62977. scaleFunction?: any;
  62978. rotationFunction?: any;
  62979. ribbonCloseArray?: boolean;
  62980. ribbonClosePath?: boolean;
  62981. cap?: number;
  62982. updatable?: boolean;
  62983. sideOrientation?: number;
  62984. frontUVs?: Vector4;
  62985. backUVs?: Vector4;
  62986. instance?: Mesh;
  62987. invertUV?: boolean;
  62988. }, scene?: Nullable<Scene>): Mesh;
  62989. private static _ExtrudeShapeGeneric;
  62990. }
  62991. }
  62992. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  62993. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  62994. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62995. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62996. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62997. import { Nullable } from "babylonjs/types";
  62998. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62999. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63000. /**
  63001. * AmmoJS Physics plugin
  63002. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63003. * @see https://github.com/kripken/ammo.js/
  63004. */
  63005. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63006. private _useDeltaForWorldStep;
  63007. /**
  63008. * Reference to the Ammo library
  63009. */
  63010. bjsAMMO: any;
  63011. /**
  63012. * Created ammoJS world which physics bodies are added to
  63013. */
  63014. world: any;
  63015. /**
  63016. * Name of the plugin
  63017. */
  63018. name: string;
  63019. private _timeStep;
  63020. private _fixedTimeStep;
  63021. private _maxSteps;
  63022. private _tmpQuaternion;
  63023. private _tmpAmmoTransform;
  63024. private _tmpAmmoQuaternion;
  63025. private _tmpAmmoConcreteContactResultCallback;
  63026. private _collisionConfiguration;
  63027. private _dispatcher;
  63028. private _overlappingPairCache;
  63029. private _solver;
  63030. private _softBodySolver;
  63031. private _tmpAmmoVectorA;
  63032. private _tmpAmmoVectorB;
  63033. private _tmpAmmoVectorC;
  63034. private _tmpAmmoVectorD;
  63035. private _tmpContactCallbackResult;
  63036. private _tmpAmmoVectorRCA;
  63037. private _tmpAmmoVectorRCB;
  63038. private _raycastResult;
  63039. private static readonly DISABLE_COLLISION_FLAG;
  63040. private static readonly KINEMATIC_FLAG;
  63041. private static readonly DISABLE_DEACTIVATION_FLAG;
  63042. /**
  63043. * Initializes the ammoJS plugin
  63044. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63045. * @param ammoInjection can be used to inject your own ammo reference
  63046. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63047. */
  63048. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63049. /**
  63050. * Sets the gravity of the physics world (m/(s^2))
  63051. * @param gravity Gravity to set
  63052. */
  63053. setGravity(gravity: Vector3): void;
  63054. /**
  63055. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63056. * @param timeStep timestep to use in seconds
  63057. */
  63058. setTimeStep(timeStep: number): void;
  63059. /**
  63060. * 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)
  63061. * @param fixedTimeStep fixedTimeStep to use in seconds
  63062. */
  63063. setFixedTimeStep(fixedTimeStep: number): void;
  63064. /**
  63065. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63066. * @param maxSteps the maximum number of steps by the physics engine per frame
  63067. */
  63068. setMaxSteps(maxSteps: number): void;
  63069. /**
  63070. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63071. * @returns the current timestep in seconds
  63072. */
  63073. getTimeStep(): number;
  63074. /**
  63075. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63076. */
  63077. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63078. private _isImpostorInContact;
  63079. private _isImpostorPairInContact;
  63080. private _stepSimulation;
  63081. /**
  63082. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63083. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63084. * After the step the babylon meshes are set to the position of the physics imposters
  63085. * @param delta amount of time to step forward
  63086. * @param impostors array of imposters to update before/after the step
  63087. */
  63088. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63089. /**
  63090. * Update babylon mesh to match physics world object
  63091. * @param impostor imposter to match
  63092. */
  63093. private _afterSoftStep;
  63094. /**
  63095. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63096. * @param impostor imposter to match
  63097. */
  63098. private _ropeStep;
  63099. /**
  63100. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63101. * @param impostor imposter to match
  63102. */
  63103. private _softbodyOrClothStep;
  63104. private _tmpMatrix;
  63105. /**
  63106. * Applies an impulse on the imposter
  63107. * @param impostor imposter to apply impulse to
  63108. * @param force amount of force to be applied to the imposter
  63109. * @param contactPoint the location to apply the impulse on the imposter
  63110. */
  63111. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63112. /**
  63113. * Applies a force on the imposter
  63114. * @param impostor imposter to apply force
  63115. * @param force amount of force to be applied to the imposter
  63116. * @param contactPoint the location to apply the force on the imposter
  63117. */
  63118. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63119. /**
  63120. * Creates a physics body using the plugin
  63121. * @param impostor the imposter to create the physics body on
  63122. */
  63123. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63124. /**
  63125. * Removes the physics body from the imposter and disposes of the body's memory
  63126. * @param impostor imposter to remove the physics body from
  63127. */
  63128. removePhysicsBody(impostor: PhysicsImpostor): void;
  63129. /**
  63130. * Generates a joint
  63131. * @param impostorJoint the imposter joint to create the joint with
  63132. */
  63133. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63134. /**
  63135. * Removes a joint
  63136. * @param impostorJoint the imposter joint to remove the joint from
  63137. */
  63138. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63139. private _addMeshVerts;
  63140. /**
  63141. * Initialise the soft body vertices to match its object's (mesh) vertices
  63142. * Softbody vertices (nodes) are in world space and to match this
  63143. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63144. * @param impostor to create the softbody for
  63145. */
  63146. private _softVertexData;
  63147. /**
  63148. * Create an impostor's soft body
  63149. * @param impostor to create the softbody for
  63150. */
  63151. private _createSoftbody;
  63152. /**
  63153. * Create cloth for an impostor
  63154. * @param impostor to create the softbody for
  63155. */
  63156. private _createCloth;
  63157. /**
  63158. * Create rope for an impostor
  63159. * @param impostor to create the softbody for
  63160. */
  63161. private _createRope;
  63162. /**
  63163. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63164. * @param impostor to create the custom physics shape for
  63165. */
  63166. private _createCustom;
  63167. private _addHullVerts;
  63168. private _createShape;
  63169. /**
  63170. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63171. * @param impostor imposter containing the physics body and babylon object
  63172. */
  63173. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63174. /**
  63175. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63176. * @param impostor imposter containing the physics body and babylon object
  63177. * @param newPosition new position
  63178. * @param newRotation new rotation
  63179. */
  63180. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63181. /**
  63182. * If this plugin is supported
  63183. * @returns true if its supported
  63184. */
  63185. isSupported(): boolean;
  63186. /**
  63187. * Sets the linear velocity of the physics body
  63188. * @param impostor imposter to set the velocity on
  63189. * @param velocity velocity to set
  63190. */
  63191. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63192. /**
  63193. * Sets the angular velocity of the physics body
  63194. * @param impostor imposter to set the velocity on
  63195. * @param velocity velocity to set
  63196. */
  63197. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63198. /**
  63199. * gets the linear velocity
  63200. * @param impostor imposter to get linear velocity from
  63201. * @returns linear velocity
  63202. */
  63203. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63204. /**
  63205. * gets the angular velocity
  63206. * @param impostor imposter to get angular velocity from
  63207. * @returns angular velocity
  63208. */
  63209. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63210. /**
  63211. * Sets the mass of physics body
  63212. * @param impostor imposter to set the mass on
  63213. * @param mass mass to set
  63214. */
  63215. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63216. /**
  63217. * Gets the mass of the physics body
  63218. * @param impostor imposter to get the mass from
  63219. * @returns mass
  63220. */
  63221. getBodyMass(impostor: PhysicsImpostor): number;
  63222. /**
  63223. * Gets friction of the impostor
  63224. * @param impostor impostor to get friction from
  63225. * @returns friction value
  63226. */
  63227. getBodyFriction(impostor: PhysicsImpostor): number;
  63228. /**
  63229. * Sets friction of the impostor
  63230. * @param impostor impostor to set friction on
  63231. * @param friction friction value
  63232. */
  63233. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63234. /**
  63235. * Gets restitution of the impostor
  63236. * @param impostor impostor to get restitution from
  63237. * @returns restitution value
  63238. */
  63239. getBodyRestitution(impostor: PhysicsImpostor): number;
  63240. /**
  63241. * Sets resitution of the impostor
  63242. * @param impostor impostor to set resitution on
  63243. * @param restitution resitution value
  63244. */
  63245. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63246. /**
  63247. * Gets pressure inside the impostor
  63248. * @param impostor impostor to get pressure from
  63249. * @returns pressure value
  63250. */
  63251. getBodyPressure(impostor: PhysicsImpostor): number;
  63252. /**
  63253. * Sets pressure inside a soft body impostor
  63254. * Cloth and rope must remain 0 pressure
  63255. * @param impostor impostor to set pressure on
  63256. * @param pressure pressure value
  63257. */
  63258. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63259. /**
  63260. * Gets stiffness of the impostor
  63261. * @param impostor impostor to get stiffness from
  63262. * @returns pressure value
  63263. */
  63264. getBodyStiffness(impostor: PhysicsImpostor): number;
  63265. /**
  63266. * Sets stiffness of the impostor
  63267. * @param impostor impostor to set stiffness on
  63268. * @param stiffness stiffness value from 0 to 1
  63269. */
  63270. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63271. /**
  63272. * Gets velocityIterations of the impostor
  63273. * @param impostor impostor to get velocity iterations from
  63274. * @returns velocityIterations value
  63275. */
  63276. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63277. /**
  63278. * Sets velocityIterations of the impostor
  63279. * @param impostor impostor to set velocity iterations on
  63280. * @param velocityIterations velocityIterations value
  63281. */
  63282. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63283. /**
  63284. * Gets positionIterations of the impostor
  63285. * @param impostor impostor to get position iterations from
  63286. * @returns positionIterations value
  63287. */
  63288. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63289. /**
  63290. * Sets positionIterations of the impostor
  63291. * @param impostor impostor to set position on
  63292. * @param positionIterations positionIterations value
  63293. */
  63294. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63295. /**
  63296. * Append an anchor to a cloth object
  63297. * @param impostor is the cloth impostor to add anchor to
  63298. * @param otherImpostor is the rigid impostor to anchor to
  63299. * @param width ratio across width from 0 to 1
  63300. * @param height ratio up height from 0 to 1
  63301. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63302. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63303. */
  63304. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63305. /**
  63306. * Append an hook to a rope object
  63307. * @param impostor is the rope impostor to add hook to
  63308. * @param otherImpostor is the rigid impostor to hook to
  63309. * @param length ratio along the rope from 0 to 1
  63310. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63311. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63312. */
  63313. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63314. /**
  63315. * Sleeps the physics body and stops it from being active
  63316. * @param impostor impostor to sleep
  63317. */
  63318. sleepBody(impostor: PhysicsImpostor): void;
  63319. /**
  63320. * Activates the physics body
  63321. * @param impostor impostor to activate
  63322. */
  63323. wakeUpBody(impostor: PhysicsImpostor): void;
  63324. /**
  63325. * Updates the distance parameters of the joint
  63326. * @param joint joint to update
  63327. * @param maxDistance maximum distance of the joint
  63328. * @param minDistance minimum distance of the joint
  63329. */
  63330. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63331. /**
  63332. * Sets a motor on the joint
  63333. * @param joint joint to set motor on
  63334. * @param speed speed of the motor
  63335. * @param maxForce maximum force of the motor
  63336. * @param motorIndex index of the motor
  63337. */
  63338. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63339. /**
  63340. * Sets the motors limit
  63341. * @param joint joint to set limit on
  63342. * @param upperLimit upper limit
  63343. * @param lowerLimit lower limit
  63344. */
  63345. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63346. /**
  63347. * Syncs the position and rotation of a mesh with the impostor
  63348. * @param mesh mesh to sync
  63349. * @param impostor impostor to update the mesh with
  63350. */
  63351. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63352. /**
  63353. * Gets the radius of the impostor
  63354. * @param impostor impostor to get radius from
  63355. * @returns the radius
  63356. */
  63357. getRadius(impostor: PhysicsImpostor): number;
  63358. /**
  63359. * Gets the box size of the impostor
  63360. * @param impostor impostor to get box size from
  63361. * @param result the resulting box size
  63362. */
  63363. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63364. /**
  63365. * Disposes of the impostor
  63366. */
  63367. dispose(): void;
  63368. /**
  63369. * Does a raycast in the physics world
  63370. * @param from when should the ray start?
  63371. * @param to when should the ray end?
  63372. * @returns PhysicsRaycastResult
  63373. */
  63374. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63375. }
  63376. }
  63377. declare module "babylonjs/Probes/reflectionProbe" {
  63378. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63379. import { Vector3 } from "babylonjs/Maths/math.vector";
  63380. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63381. import { Nullable } from "babylonjs/types";
  63382. import { Scene } from "babylonjs/scene";
  63383. module "babylonjs/abstractScene" {
  63384. interface AbstractScene {
  63385. /**
  63386. * The list of reflection probes added to the scene
  63387. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63388. */
  63389. reflectionProbes: Array<ReflectionProbe>;
  63390. /**
  63391. * Removes the given reflection probe from this scene.
  63392. * @param toRemove The reflection probe to remove
  63393. * @returns The index of the removed reflection probe
  63394. */
  63395. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63396. /**
  63397. * Adds the given reflection probe to this scene.
  63398. * @param newReflectionProbe The reflection probe to add
  63399. */
  63400. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63401. }
  63402. }
  63403. /**
  63404. * Class used to generate realtime reflection / refraction cube textures
  63405. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63406. */
  63407. export class ReflectionProbe {
  63408. /** defines the name of the probe */
  63409. name: string;
  63410. private _scene;
  63411. private _renderTargetTexture;
  63412. private _projectionMatrix;
  63413. private _viewMatrix;
  63414. private _target;
  63415. private _add;
  63416. private _attachedMesh;
  63417. private _invertYAxis;
  63418. /** Gets or sets probe position (center of the cube map) */
  63419. position: Vector3;
  63420. /**
  63421. * Creates a new reflection probe
  63422. * @param name defines the name of the probe
  63423. * @param size defines the texture resolution (for each face)
  63424. * @param scene defines the hosting scene
  63425. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63426. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63427. */
  63428. constructor(
  63429. /** defines the name of the probe */
  63430. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63431. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63432. get samples(): number;
  63433. set samples(value: number);
  63434. /** Gets or sets the refresh rate to use (on every frame by default) */
  63435. get refreshRate(): number;
  63436. set refreshRate(value: number);
  63437. /**
  63438. * Gets the hosting scene
  63439. * @returns a Scene
  63440. */
  63441. getScene(): Scene;
  63442. /** Gets the internal CubeTexture used to render to */
  63443. get cubeTexture(): RenderTargetTexture;
  63444. /** Gets the list of meshes to render */
  63445. get renderList(): Nullable<AbstractMesh[]>;
  63446. /**
  63447. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63448. * @param mesh defines the mesh to attach to
  63449. */
  63450. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63451. /**
  63452. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63453. * @param renderingGroupId The rendering group id corresponding to its index
  63454. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63455. */
  63456. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63457. /**
  63458. * Clean all associated resources
  63459. */
  63460. dispose(): void;
  63461. /**
  63462. * Converts the reflection probe information to a readable string for debug purpose.
  63463. * @param fullDetails Supports for multiple levels of logging within scene loading
  63464. * @returns the human readable reflection probe info
  63465. */
  63466. toString(fullDetails?: boolean): string;
  63467. /**
  63468. * Get the class name of the relfection probe.
  63469. * @returns "ReflectionProbe"
  63470. */
  63471. getClassName(): string;
  63472. /**
  63473. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63474. * @returns The JSON representation of the texture
  63475. */
  63476. serialize(): any;
  63477. /**
  63478. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63479. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63480. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63481. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63482. * @returns The parsed reflection probe if successful
  63483. */
  63484. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63485. }
  63486. }
  63487. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63488. /** @hidden */
  63489. export var _BabylonLoaderRegistered: boolean;
  63490. /**
  63491. * Helps setting up some configuration for the babylon file loader.
  63492. */
  63493. export class BabylonFileLoaderConfiguration {
  63494. /**
  63495. * The loader does not allow injecting custom physix engine into the plugins.
  63496. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63497. * So you could set this variable to your engine import to make it work.
  63498. */
  63499. static LoaderInjectedPhysicsEngine: any;
  63500. }
  63501. }
  63502. declare module "babylonjs/Loading/Plugins/index" {
  63503. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63504. }
  63505. declare module "babylonjs/Loading/index" {
  63506. export * from "babylonjs/Loading/loadingScreen";
  63507. export * from "babylonjs/Loading/Plugins/index";
  63508. export * from "babylonjs/Loading/sceneLoader";
  63509. export * from "babylonjs/Loading/sceneLoaderFlags";
  63510. }
  63511. declare module "babylonjs/Materials/Background/index" {
  63512. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63513. }
  63514. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63515. import { Scene } from "babylonjs/scene";
  63516. import { Color3 } from "babylonjs/Maths/math.color";
  63517. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63518. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63519. /**
  63520. * The Physically based simple base material of BJS.
  63521. *
  63522. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63523. * It is used as the base class for both the specGloss and metalRough conventions.
  63524. */
  63525. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63526. /**
  63527. * Number of Simultaneous lights allowed on the material.
  63528. */
  63529. maxSimultaneousLights: number;
  63530. /**
  63531. * If sets to true, disables all the lights affecting the material.
  63532. */
  63533. disableLighting: boolean;
  63534. /**
  63535. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63536. */
  63537. environmentTexture: BaseTexture;
  63538. /**
  63539. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63540. */
  63541. invertNormalMapX: boolean;
  63542. /**
  63543. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63544. */
  63545. invertNormalMapY: boolean;
  63546. /**
  63547. * Normal map used in the model.
  63548. */
  63549. normalTexture: BaseTexture;
  63550. /**
  63551. * Emissivie color used to self-illuminate the model.
  63552. */
  63553. emissiveColor: Color3;
  63554. /**
  63555. * Emissivie texture used to self-illuminate the model.
  63556. */
  63557. emissiveTexture: BaseTexture;
  63558. /**
  63559. * Occlusion Channel Strenght.
  63560. */
  63561. occlusionStrength: number;
  63562. /**
  63563. * Occlusion Texture of the material (adding extra occlusion effects).
  63564. */
  63565. occlusionTexture: BaseTexture;
  63566. /**
  63567. * Defines the alpha limits in alpha test mode.
  63568. */
  63569. alphaCutOff: number;
  63570. /**
  63571. * Gets the current double sided mode.
  63572. */
  63573. get doubleSided(): boolean;
  63574. /**
  63575. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63576. */
  63577. set doubleSided(value: boolean);
  63578. /**
  63579. * Stores the pre-calculated light information of a mesh in a texture.
  63580. */
  63581. lightmapTexture: BaseTexture;
  63582. /**
  63583. * If true, the light map contains occlusion information instead of lighting info.
  63584. */
  63585. useLightmapAsShadowmap: boolean;
  63586. /**
  63587. * Instantiates a new PBRMaterial instance.
  63588. *
  63589. * @param name The material name
  63590. * @param scene The scene the material will be use in.
  63591. */
  63592. constructor(name: string, scene: Scene);
  63593. getClassName(): string;
  63594. }
  63595. }
  63596. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  63597. import { Scene } from "babylonjs/scene";
  63598. import { Color3 } from "babylonjs/Maths/math.color";
  63599. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63600. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63601. /**
  63602. * The PBR material of BJS following the metal roughness convention.
  63603. *
  63604. * This fits to the PBR convention in the GLTF definition:
  63605. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  63606. */
  63607. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  63608. /**
  63609. * The base color has two different interpretations depending on the value of metalness.
  63610. * When the material is a metal, the base color is the specific measured reflectance value
  63611. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  63612. * of the material.
  63613. */
  63614. baseColor: Color3;
  63615. /**
  63616. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  63617. * well as opacity information in the alpha channel.
  63618. */
  63619. baseTexture: BaseTexture;
  63620. /**
  63621. * Specifies the metallic scalar value of the material.
  63622. * Can also be used to scale the metalness values of the metallic texture.
  63623. */
  63624. metallic: number;
  63625. /**
  63626. * Specifies the roughness scalar value of the material.
  63627. * Can also be used to scale the roughness values of the metallic texture.
  63628. */
  63629. roughness: number;
  63630. /**
  63631. * Texture containing both the metallic value in the B channel and the
  63632. * roughness value in the G channel to keep better precision.
  63633. */
  63634. metallicRoughnessTexture: BaseTexture;
  63635. /**
  63636. * Instantiates a new PBRMetalRoughnessMaterial instance.
  63637. *
  63638. * @param name The material name
  63639. * @param scene The scene the material will be use in.
  63640. */
  63641. constructor(name: string, scene: Scene);
  63642. /**
  63643. * Return the currrent class name of the material.
  63644. */
  63645. getClassName(): string;
  63646. /**
  63647. * Makes a duplicate of the current material.
  63648. * @param name - name to use for the new material.
  63649. */
  63650. clone(name: string): PBRMetallicRoughnessMaterial;
  63651. /**
  63652. * Serialize the material to a parsable JSON object.
  63653. */
  63654. serialize(): any;
  63655. /**
  63656. * Parses a JSON object correponding to the serialize function.
  63657. */
  63658. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  63659. }
  63660. }
  63661. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  63662. import { Scene } from "babylonjs/scene";
  63663. import { Color3 } from "babylonjs/Maths/math.color";
  63664. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63665. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63666. /**
  63667. * The PBR material of BJS following the specular glossiness convention.
  63668. *
  63669. * This fits to the PBR convention in the GLTF definition:
  63670. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  63671. */
  63672. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  63673. /**
  63674. * Specifies the diffuse color of the material.
  63675. */
  63676. diffuseColor: Color3;
  63677. /**
  63678. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  63679. * channel.
  63680. */
  63681. diffuseTexture: BaseTexture;
  63682. /**
  63683. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  63684. */
  63685. specularColor: Color3;
  63686. /**
  63687. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  63688. */
  63689. glossiness: number;
  63690. /**
  63691. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  63692. */
  63693. specularGlossinessTexture: BaseTexture;
  63694. /**
  63695. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  63696. *
  63697. * @param name The material name
  63698. * @param scene The scene the material will be use in.
  63699. */
  63700. constructor(name: string, scene: Scene);
  63701. /**
  63702. * Return the currrent class name of the material.
  63703. */
  63704. getClassName(): string;
  63705. /**
  63706. * Makes a duplicate of the current material.
  63707. * @param name - name to use for the new material.
  63708. */
  63709. clone(name: string): PBRSpecularGlossinessMaterial;
  63710. /**
  63711. * Serialize the material to a parsable JSON object.
  63712. */
  63713. serialize(): any;
  63714. /**
  63715. * Parses a JSON object correponding to the serialize function.
  63716. */
  63717. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  63718. }
  63719. }
  63720. declare module "babylonjs/Materials/PBR/index" {
  63721. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63722. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63723. export * from "babylonjs/Materials/PBR/pbrMaterial";
  63724. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  63725. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  63726. }
  63727. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  63728. import { Nullable } from "babylonjs/types";
  63729. import { Scene } from "babylonjs/scene";
  63730. import { Matrix } from "babylonjs/Maths/math.vector";
  63731. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63732. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63733. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63734. /**
  63735. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  63736. * It can help converting any input color in a desired output one. This can then be used to create effects
  63737. * from sepia, black and white to sixties or futuristic rendering...
  63738. *
  63739. * The only supported format is currently 3dl.
  63740. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  63741. */
  63742. export class ColorGradingTexture extends BaseTexture {
  63743. /**
  63744. * The texture URL.
  63745. */
  63746. url: string;
  63747. /**
  63748. * Empty line regex stored for GC.
  63749. */
  63750. private static _noneEmptyLineRegex;
  63751. private _textureMatrix;
  63752. private _onLoad;
  63753. /**
  63754. * Instantiates a ColorGradingTexture from the following parameters.
  63755. *
  63756. * @param url The location of the color gradind data (currently only supporting 3dl)
  63757. * @param sceneOrEngine The scene or engine the texture will be used in
  63758. * @param onLoad defines a callback triggered when the texture has been loaded
  63759. */
  63760. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  63761. /**
  63762. * Fires the onload event from the constructor if requested.
  63763. */
  63764. private _triggerOnLoad;
  63765. /**
  63766. * Returns the texture matrix used in most of the material.
  63767. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  63768. */
  63769. getTextureMatrix(): Matrix;
  63770. /**
  63771. * Occurs when the file being loaded is a .3dl LUT file.
  63772. */
  63773. private load3dlTexture;
  63774. /**
  63775. * Starts the loading process of the texture.
  63776. */
  63777. private loadTexture;
  63778. /**
  63779. * Clones the color gradind texture.
  63780. */
  63781. clone(): ColorGradingTexture;
  63782. /**
  63783. * Called during delayed load for textures.
  63784. */
  63785. delayLoad(): void;
  63786. /**
  63787. * Parses a color grading texture serialized by Babylon.
  63788. * @param parsedTexture The texture information being parsedTexture
  63789. * @param scene The scene to load the texture in
  63790. * @param rootUrl The root url of the data assets to load
  63791. * @return A color gradind texture
  63792. */
  63793. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  63794. /**
  63795. * Serializes the LUT texture to json format.
  63796. */
  63797. serialize(): any;
  63798. }
  63799. }
  63800. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  63801. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63802. import { Scene } from "babylonjs/scene";
  63803. import { Nullable } from "babylonjs/types";
  63804. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63805. /**
  63806. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  63807. */
  63808. export class EquiRectangularCubeTexture extends BaseTexture {
  63809. /** The six faces of the cube. */
  63810. private static _FacesMapping;
  63811. private _noMipmap;
  63812. private _onLoad;
  63813. private _onError;
  63814. /** The size of the cubemap. */
  63815. private _size;
  63816. /** The buffer of the image. */
  63817. private _buffer;
  63818. /** The width of the input image. */
  63819. private _width;
  63820. /** The height of the input image. */
  63821. private _height;
  63822. /** The URL to the image. */
  63823. url: string;
  63824. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  63825. coordinatesMode: number;
  63826. /**
  63827. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  63828. * @param url The location of the image
  63829. * @param scene The scene the texture will be used in
  63830. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63831. * @param noMipmap Forces to not generate the mipmap if true
  63832. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  63833. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  63834. * @param onLoad — defines a callback called when texture is loaded
  63835. * @param onError — defines a callback called if there is an error
  63836. */
  63837. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  63838. /**
  63839. * Load the image data, by putting the image on a canvas and extracting its buffer.
  63840. */
  63841. private loadImage;
  63842. /**
  63843. * Convert the image buffer into a cubemap and create a CubeTexture.
  63844. */
  63845. private loadTexture;
  63846. /**
  63847. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  63848. * @param buffer The ArrayBuffer that should be converted.
  63849. * @returns The buffer as Float32Array.
  63850. */
  63851. private getFloat32ArrayFromArrayBuffer;
  63852. /**
  63853. * Get the current class name of the texture useful for serialization or dynamic coding.
  63854. * @returns "EquiRectangularCubeTexture"
  63855. */
  63856. getClassName(): string;
  63857. /**
  63858. * Create a clone of the current EquiRectangularCubeTexture and return it.
  63859. * @returns A clone of the current EquiRectangularCubeTexture.
  63860. */
  63861. clone(): EquiRectangularCubeTexture;
  63862. }
  63863. }
  63864. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  63865. import { Nullable } from "babylonjs/types";
  63866. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63867. import { Matrix } from "babylonjs/Maths/math.vector";
  63868. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  63869. import "babylonjs/Engines/Extensions/engine.videoTexture";
  63870. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63871. import { Scene } from "babylonjs/scene";
  63872. /**
  63873. * Defines the options related to the creation of an HtmlElementTexture
  63874. */
  63875. export interface IHtmlElementTextureOptions {
  63876. /**
  63877. * Defines wether mip maps should be created or not.
  63878. */
  63879. generateMipMaps?: boolean;
  63880. /**
  63881. * Defines the sampling mode of the texture.
  63882. */
  63883. samplingMode?: number;
  63884. /**
  63885. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  63886. */
  63887. engine: Nullable<ThinEngine>;
  63888. /**
  63889. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  63890. */
  63891. scene: Nullable<Scene>;
  63892. }
  63893. /**
  63894. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  63895. * To be as efficient as possible depending on your constraints nothing aside the first upload
  63896. * is automatically managed.
  63897. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  63898. * in your application.
  63899. *
  63900. * As the update is not automatic, you need to call them manually.
  63901. */
  63902. export class HtmlElementTexture extends BaseTexture {
  63903. /**
  63904. * The texture URL.
  63905. */
  63906. element: HTMLVideoElement | HTMLCanvasElement;
  63907. private static readonly DefaultOptions;
  63908. private _textureMatrix;
  63909. private _isVideo;
  63910. private _generateMipMaps;
  63911. private _samplingMode;
  63912. /**
  63913. * Instantiates a HtmlElementTexture from the following parameters.
  63914. *
  63915. * @param name Defines the name of the texture
  63916. * @param element Defines the video or canvas the texture is filled with
  63917. * @param options Defines the other none mandatory texture creation options
  63918. */
  63919. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  63920. private _createInternalTexture;
  63921. /**
  63922. * Returns the texture matrix used in most of the material.
  63923. */
  63924. getTextureMatrix(): Matrix;
  63925. /**
  63926. * Updates the content of the texture.
  63927. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  63928. */
  63929. update(invertY?: Nullable<boolean>): void;
  63930. }
  63931. }
  63932. declare module "babylonjs/Misc/tga" {
  63933. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63934. /**
  63935. * Based on jsTGALoader - Javascript loader for TGA file
  63936. * By Vincent Thibault
  63937. * @see http://blog.robrowser.com/javascript-tga-loader.html
  63938. */
  63939. export class TGATools {
  63940. private static _TYPE_INDEXED;
  63941. private static _TYPE_RGB;
  63942. private static _TYPE_GREY;
  63943. private static _TYPE_RLE_INDEXED;
  63944. private static _TYPE_RLE_RGB;
  63945. private static _TYPE_RLE_GREY;
  63946. private static _ORIGIN_MASK;
  63947. private static _ORIGIN_SHIFT;
  63948. private static _ORIGIN_BL;
  63949. private static _ORIGIN_BR;
  63950. private static _ORIGIN_UL;
  63951. private static _ORIGIN_UR;
  63952. /**
  63953. * Gets the header of a TGA file
  63954. * @param data defines the TGA data
  63955. * @returns the header
  63956. */
  63957. static GetTGAHeader(data: Uint8Array): any;
  63958. /**
  63959. * Uploads TGA content to a Babylon Texture
  63960. * @hidden
  63961. */
  63962. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  63963. /** @hidden */
  63964. 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;
  63965. /** @hidden */
  63966. 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;
  63967. /** @hidden */
  63968. 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;
  63969. /** @hidden */
  63970. 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;
  63971. /** @hidden */
  63972. 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;
  63973. /** @hidden */
  63974. 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;
  63975. }
  63976. }
  63977. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  63978. import { Nullable } from "babylonjs/types";
  63979. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63980. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  63981. /**
  63982. * Implementation of the TGA Texture Loader.
  63983. * @hidden
  63984. */
  63985. export class _TGATextureLoader implements IInternalTextureLoader {
  63986. /**
  63987. * Defines wether the loader supports cascade loading the different faces.
  63988. */
  63989. readonly supportCascades: boolean;
  63990. /**
  63991. * This returns if the loader support the current file information.
  63992. * @param extension defines the file extension of the file being loaded
  63993. * @returns true if the loader can load the specified file
  63994. */
  63995. canLoad(extension: string): boolean;
  63996. /**
  63997. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63998. * @param data contains the texture data
  63999. * @param texture defines the BabylonJS internal texture
  64000. * @param createPolynomials will be true if polynomials have been requested
  64001. * @param onLoad defines the callback to trigger once the texture is ready
  64002. * @param onError defines the callback to trigger in case of error
  64003. */
  64004. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64005. /**
  64006. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64007. * @param data contains the texture data
  64008. * @param texture defines the BabylonJS internal texture
  64009. * @param callback defines the method to call once ready to upload
  64010. */
  64011. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64012. }
  64013. }
  64014. declare module "babylonjs/Misc/basis" {
  64015. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64016. /**
  64017. * Info about the .basis files
  64018. */
  64019. class BasisFileInfo {
  64020. /**
  64021. * If the file has alpha
  64022. */
  64023. hasAlpha: boolean;
  64024. /**
  64025. * Info about each image of the basis file
  64026. */
  64027. images: Array<{
  64028. levels: Array<{
  64029. width: number;
  64030. height: number;
  64031. transcodedPixels: ArrayBufferView;
  64032. }>;
  64033. }>;
  64034. }
  64035. /**
  64036. * Result of transcoding a basis file
  64037. */
  64038. class TranscodeResult {
  64039. /**
  64040. * Info about the .basis file
  64041. */
  64042. fileInfo: BasisFileInfo;
  64043. /**
  64044. * Format to use when loading the file
  64045. */
  64046. format: number;
  64047. }
  64048. /**
  64049. * Configuration options for the Basis transcoder
  64050. */
  64051. export class BasisTranscodeConfiguration {
  64052. /**
  64053. * Supported compression formats used to determine the supported output format of the transcoder
  64054. */
  64055. supportedCompressionFormats?: {
  64056. /**
  64057. * etc1 compression format
  64058. */
  64059. etc1?: boolean;
  64060. /**
  64061. * s3tc compression format
  64062. */
  64063. s3tc?: boolean;
  64064. /**
  64065. * pvrtc compression format
  64066. */
  64067. pvrtc?: boolean;
  64068. /**
  64069. * etc2 compression format
  64070. */
  64071. etc2?: boolean;
  64072. };
  64073. /**
  64074. * If mipmap levels should be loaded for transcoded images (Default: true)
  64075. */
  64076. loadMipmapLevels?: boolean;
  64077. /**
  64078. * Index of a single image to load (Default: all images)
  64079. */
  64080. loadSingleImage?: number;
  64081. }
  64082. /**
  64083. * Used to load .Basis files
  64084. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64085. */
  64086. export class BasisTools {
  64087. private static _IgnoreSupportedFormats;
  64088. /**
  64089. * URL to use when loading the basis transcoder
  64090. */
  64091. static JSModuleURL: string;
  64092. /**
  64093. * URL to use when loading the wasm module for the transcoder
  64094. */
  64095. static WasmModuleURL: string;
  64096. /**
  64097. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64098. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64099. * @returns internal format corresponding to the Basis format
  64100. */
  64101. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64102. private static _WorkerPromise;
  64103. private static _Worker;
  64104. private static _actionId;
  64105. private static _CreateWorkerAsync;
  64106. /**
  64107. * Transcodes a loaded image file to compressed pixel data
  64108. * @param data image data to transcode
  64109. * @param config configuration options for the transcoding
  64110. * @returns a promise resulting in the transcoded image
  64111. */
  64112. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64113. /**
  64114. * Loads a texture from the transcode result
  64115. * @param texture texture load to
  64116. * @param transcodeResult the result of transcoding the basis file to load from
  64117. */
  64118. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64119. }
  64120. }
  64121. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64122. import { Nullable } from "babylonjs/types";
  64123. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64124. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64125. /**
  64126. * Loader for .basis file format
  64127. */
  64128. export class _BasisTextureLoader implements IInternalTextureLoader {
  64129. /**
  64130. * Defines whether the loader supports cascade loading the different faces.
  64131. */
  64132. readonly supportCascades: boolean;
  64133. /**
  64134. * This returns if the loader support the current file information.
  64135. * @param extension defines the file extension of the file being loaded
  64136. * @returns true if the loader can load the specified file
  64137. */
  64138. canLoad(extension: string): boolean;
  64139. /**
  64140. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64141. * @param data contains the texture data
  64142. * @param texture defines the BabylonJS internal texture
  64143. * @param createPolynomials will be true if polynomials have been requested
  64144. * @param onLoad defines the callback to trigger once the texture is ready
  64145. * @param onError defines the callback to trigger in case of error
  64146. */
  64147. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64148. /**
  64149. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64150. * @param data contains the texture data
  64151. * @param texture defines the BabylonJS internal texture
  64152. * @param callback defines the method to call once ready to upload
  64153. */
  64154. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64155. }
  64156. }
  64157. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64158. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64159. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64160. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64161. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64162. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64163. }
  64164. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64165. import { Vector2 } from "babylonjs/Maths/math.vector";
  64166. /**
  64167. * Defines the basic options interface of a TexturePacker Frame
  64168. */
  64169. export interface ITexturePackerFrame {
  64170. /**
  64171. * The frame ID
  64172. */
  64173. id: number;
  64174. /**
  64175. * The frames Scale
  64176. */
  64177. scale: Vector2;
  64178. /**
  64179. * The Frames offset
  64180. */
  64181. offset: Vector2;
  64182. }
  64183. /**
  64184. * This is a support class for frame Data on texture packer sets.
  64185. */
  64186. export class TexturePackerFrame implements ITexturePackerFrame {
  64187. /**
  64188. * The frame ID
  64189. */
  64190. id: number;
  64191. /**
  64192. * The frames Scale
  64193. */
  64194. scale: Vector2;
  64195. /**
  64196. * The Frames offset
  64197. */
  64198. offset: Vector2;
  64199. /**
  64200. * Initializes a texture package frame.
  64201. * @param id The numerical frame identifier
  64202. * @param scale Scalar Vector2 for UV frame
  64203. * @param offset Vector2 for the frame position in UV units.
  64204. * @returns TexturePackerFrame
  64205. */
  64206. constructor(id: number, scale: Vector2, offset: Vector2);
  64207. }
  64208. }
  64209. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64210. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64211. import { Scene } from "babylonjs/scene";
  64212. import { Nullable } from "babylonjs/types";
  64213. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64214. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64215. /**
  64216. * Defines the basic options interface of a TexturePacker
  64217. */
  64218. export interface ITexturePackerOptions {
  64219. /**
  64220. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64221. */
  64222. map?: string[];
  64223. /**
  64224. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64225. */
  64226. uvsIn?: string;
  64227. /**
  64228. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64229. */
  64230. uvsOut?: string;
  64231. /**
  64232. * number representing the layout style. Defaults to LAYOUT_STRIP
  64233. */
  64234. layout?: number;
  64235. /**
  64236. * number of columns if using custom column count layout(2). This defaults to 4.
  64237. */
  64238. colnum?: number;
  64239. /**
  64240. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64241. */
  64242. updateInputMeshes?: boolean;
  64243. /**
  64244. * boolean flag to dispose all the source textures. Defaults to true.
  64245. */
  64246. disposeSources?: boolean;
  64247. /**
  64248. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64249. */
  64250. fillBlanks?: boolean;
  64251. /**
  64252. * string value representing the context fill style color. Defaults to 'black'.
  64253. */
  64254. customFillColor?: string;
  64255. /**
  64256. * Width and Height Value of each Frame in the TexturePacker Sets
  64257. */
  64258. frameSize?: number;
  64259. /**
  64260. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64261. */
  64262. paddingRatio?: number;
  64263. /**
  64264. * Number that declares the fill method for the padding gutter.
  64265. */
  64266. paddingMode?: number;
  64267. /**
  64268. * If in SUBUV_COLOR padding mode what color to use.
  64269. */
  64270. paddingColor?: Color3 | Color4;
  64271. }
  64272. /**
  64273. * Defines the basic interface of a TexturePacker JSON File
  64274. */
  64275. export interface ITexturePackerJSON {
  64276. /**
  64277. * The frame ID
  64278. */
  64279. name: string;
  64280. /**
  64281. * The base64 channel data
  64282. */
  64283. sets: any;
  64284. /**
  64285. * The options of the Packer
  64286. */
  64287. options: ITexturePackerOptions;
  64288. /**
  64289. * The frame data of the Packer
  64290. */
  64291. frames: Array<number>;
  64292. }
  64293. /**
  64294. * This is a support class that generates a series of packed texture sets.
  64295. * @see https://doc.babylonjs.com/babylon101/materials
  64296. */
  64297. export class TexturePacker {
  64298. /** Packer Layout Constant 0 */
  64299. static readonly LAYOUT_STRIP: number;
  64300. /** Packer Layout Constant 1 */
  64301. static readonly LAYOUT_POWER2: number;
  64302. /** Packer Layout Constant 2 */
  64303. static readonly LAYOUT_COLNUM: number;
  64304. /** Packer Layout Constant 0 */
  64305. static readonly SUBUV_WRAP: number;
  64306. /** Packer Layout Constant 1 */
  64307. static readonly SUBUV_EXTEND: number;
  64308. /** Packer Layout Constant 2 */
  64309. static readonly SUBUV_COLOR: number;
  64310. /** The Name of the Texture Package */
  64311. name: string;
  64312. /** The scene scope of the TexturePacker */
  64313. scene: Scene;
  64314. /** The Meshes to target */
  64315. meshes: AbstractMesh[];
  64316. /** Arguments passed with the Constructor */
  64317. options: ITexturePackerOptions;
  64318. /** The promise that is started upon initialization */
  64319. promise: Nullable<Promise<TexturePacker | string>>;
  64320. /** The Container object for the channel sets that are generated */
  64321. sets: object;
  64322. /** The Container array for the frames that are generated */
  64323. frames: TexturePackerFrame[];
  64324. /** The expected number of textures the system is parsing. */
  64325. private _expecting;
  64326. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64327. private _paddingValue;
  64328. /**
  64329. * Initializes a texture package series from an array of meshes or a single mesh.
  64330. * @param name The name of the package
  64331. * @param meshes The target meshes to compose the package from
  64332. * @param options The arguments that texture packer should follow while building.
  64333. * @param scene The scene which the textures are scoped to.
  64334. * @returns TexturePacker
  64335. */
  64336. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64337. /**
  64338. * Starts the package process
  64339. * @param resolve The promises resolution function
  64340. * @returns TexturePacker
  64341. */
  64342. private _createFrames;
  64343. /**
  64344. * Calculates the Size of the Channel Sets
  64345. * @returns Vector2
  64346. */
  64347. private _calculateSize;
  64348. /**
  64349. * Calculates the UV data for the frames.
  64350. * @param baseSize the base frameSize
  64351. * @param padding the base frame padding
  64352. * @param dtSize size of the Dynamic Texture for that channel
  64353. * @param dtUnits is 1/dtSize
  64354. * @param update flag to update the input meshes
  64355. */
  64356. private _calculateMeshUVFrames;
  64357. /**
  64358. * Calculates the frames Offset.
  64359. * @param index of the frame
  64360. * @returns Vector2
  64361. */
  64362. private _getFrameOffset;
  64363. /**
  64364. * Updates a Mesh to the frame data
  64365. * @param mesh that is the target
  64366. * @param frameID or the frame index
  64367. */
  64368. private _updateMeshUV;
  64369. /**
  64370. * Updates a Meshes materials to use the texture packer channels
  64371. * @param m is the mesh to target
  64372. * @param force all channels on the packer to be set.
  64373. */
  64374. private _updateTextureReferences;
  64375. /**
  64376. * Public method to set a Mesh to a frame
  64377. * @param m that is the target
  64378. * @param frameID or the frame index
  64379. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64380. */
  64381. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64382. /**
  64383. * Starts the async promise to compile the texture packer.
  64384. * @returns Promise<void>
  64385. */
  64386. processAsync(): Promise<void>;
  64387. /**
  64388. * Disposes all textures associated with this packer
  64389. */
  64390. dispose(): void;
  64391. /**
  64392. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64393. * @param imageType is the image type to use.
  64394. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64395. */
  64396. download(imageType?: string, quality?: number): void;
  64397. /**
  64398. * Public method to load a texturePacker JSON file.
  64399. * @param data of the JSON file in string format.
  64400. */
  64401. updateFromJSON(data: string): void;
  64402. }
  64403. }
  64404. declare module "babylonjs/Materials/Textures/Packer/index" {
  64405. export * from "babylonjs/Materials/Textures/Packer/packer";
  64406. export * from "babylonjs/Materials/Textures/Packer/frame";
  64407. }
  64408. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64409. import { Scene } from "babylonjs/scene";
  64410. import { Texture } from "babylonjs/Materials/Textures/texture";
  64411. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64412. /**
  64413. * 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.
  64414. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64415. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64416. */
  64417. export class CustomProceduralTexture extends ProceduralTexture {
  64418. private _animate;
  64419. private _time;
  64420. private _config;
  64421. private _texturePath;
  64422. /**
  64423. * Instantiates a new Custom Procedural Texture.
  64424. * 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.
  64425. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64426. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64427. * @param name Define the name of the texture
  64428. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64429. * @param size Define the size of the texture to create
  64430. * @param scene Define the scene the texture belongs to
  64431. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64432. * @param generateMipMaps Define if the texture should creates mip maps or not
  64433. */
  64434. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64435. private _loadJson;
  64436. /**
  64437. * Is the texture ready to be used ? (rendered at least once)
  64438. * @returns true if ready, otherwise, false.
  64439. */
  64440. isReady(): boolean;
  64441. /**
  64442. * Render the texture to its associated render target.
  64443. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64444. */
  64445. render(useCameraPostProcess?: boolean): void;
  64446. /**
  64447. * Update the list of dependant textures samplers in the shader.
  64448. */
  64449. updateTextures(): void;
  64450. /**
  64451. * Update the uniform values of the procedural texture in the shader.
  64452. */
  64453. updateShaderUniforms(): void;
  64454. /**
  64455. * Define if the texture animates or not.
  64456. */
  64457. get animate(): boolean;
  64458. set animate(value: boolean);
  64459. }
  64460. }
  64461. declare module "babylonjs/Shaders/noise.fragment" {
  64462. /** @hidden */
  64463. export var noisePixelShader: {
  64464. name: string;
  64465. shader: string;
  64466. };
  64467. }
  64468. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64469. import { Nullable } from "babylonjs/types";
  64470. import { Scene } from "babylonjs/scene";
  64471. import { Texture } from "babylonjs/Materials/Textures/texture";
  64472. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64473. import "babylonjs/Shaders/noise.fragment";
  64474. /**
  64475. * Class used to generate noise procedural textures
  64476. */
  64477. export class NoiseProceduralTexture extends ProceduralTexture {
  64478. private _time;
  64479. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64480. brightness: number;
  64481. /** Defines the number of octaves to process */
  64482. octaves: number;
  64483. /** Defines the level of persistence (0.8 by default) */
  64484. persistence: number;
  64485. /** Gets or sets animation speed factor (default is 1) */
  64486. animationSpeedFactor: number;
  64487. /**
  64488. * Creates a new NoiseProceduralTexture
  64489. * @param name defines the name fo the texture
  64490. * @param size defines the size of the texture (default is 256)
  64491. * @param scene defines the hosting scene
  64492. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64493. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64494. */
  64495. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64496. private _updateShaderUniforms;
  64497. protected _getDefines(): string;
  64498. /** Generate the current state of the procedural texture */
  64499. render(useCameraPostProcess?: boolean): void;
  64500. /**
  64501. * Serializes this noise procedural texture
  64502. * @returns a serialized noise procedural texture object
  64503. */
  64504. serialize(): any;
  64505. /**
  64506. * Clone the texture.
  64507. * @returns the cloned texture
  64508. */
  64509. clone(): NoiseProceduralTexture;
  64510. /**
  64511. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64512. * @param parsedTexture defines parsed texture data
  64513. * @param scene defines the current scene
  64514. * @param rootUrl defines the root URL containing noise procedural texture information
  64515. * @returns a parsed NoiseProceduralTexture
  64516. */
  64517. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64518. }
  64519. }
  64520. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64521. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64522. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64523. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64524. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64525. }
  64526. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64527. import { Nullable } from "babylonjs/types";
  64528. import { Scene } from "babylonjs/scene";
  64529. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64530. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64531. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64532. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64533. /**
  64534. * Raw cube texture where the raw buffers are passed in
  64535. */
  64536. export class RawCubeTexture extends CubeTexture {
  64537. /**
  64538. * Creates a cube texture where the raw buffers are passed in.
  64539. * @param scene defines the scene the texture is attached to
  64540. * @param data defines the array of data to use to create each face
  64541. * @param size defines the size of the textures
  64542. * @param format defines the format of the data
  64543. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64544. * @param generateMipMaps defines if the engine should generate the mip levels
  64545. * @param invertY defines if data must be stored with Y axis inverted
  64546. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64547. * @param compression defines the compression used (null by default)
  64548. */
  64549. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64550. /**
  64551. * Updates the raw cube texture.
  64552. * @param data defines the data to store
  64553. * @param format defines the data format
  64554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64555. * @param invertY defines if data must be stored with Y axis inverted
  64556. * @param compression defines the compression used (null by default)
  64557. * @param level defines which level of the texture to update
  64558. */
  64559. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64560. /**
  64561. * Updates a raw cube texture with RGBD encoded data.
  64562. * @param data defines the array of data [mipmap][face] to use to create each face
  64563. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64564. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64565. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64566. * @returns a promsie that resolves when the operation is complete
  64567. */
  64568. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64569. /**
  64570. * Clones the raw cube texture.
  64571. * @return a new cube texture
  64572. */
  64573. clone(): CubeTexture;
  64574. /** @hidden */
  64575. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64576. }
  64577. }
  64578. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64579. import { Scene } from "babylonjs/scene";
  64580. import { Texture } from "babylonjs/Materials/Textures/texture";
  64581. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64582. /**
  64583. * Class used to store 2D array textures containing user data
  64584. */
  64585. export class RawTexture2DArray extends Texture {
  64586. /** Gets or sets the texture format to use */
  64587. format: number;
  64588. /**
  64589. * Create a new RawTexture2DArray
  64590. * @param data defines the data of the texture
  64591. * @param width defines the width of the texture
  64592. * @param height defines the height of the texture
  64593. * @param depth defines the number of layers of the texture
  64594. * @param format defines the texture format to use
  64595. * @param scene defines the hosting scene
  64596. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64597. * @param invertY defines if texture must be stored with Y axis inverted
  64598. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64599. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64600. */
  64601. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64602. /** Gets or sets the texture format to use */
  64603. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64604. /**
  64605. * Update the texture with new data
  64606. * @param data defines the data to store in the texture
  64607. */
  64608. update(data: ArrayBufferView): void;
  64609. }
  64610. }
  64611. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  64612. import { Scene } from "babylonjs/scene";
  64613. import { Texture } from "babylonjs/Materials/Textures/texture";
  64614. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64615. /**
  64616. * Class used to store 3D textures containing user data
  64617. */
  64618. export class RawTexture3D extends Texture {
  64619. /** Gets or sets the texture format to use */
  64620. format: number;
  64621. /**
  64622. * Create a new RawTexture3D
  64623. * @param data defines the data of the texture
  64624. * @param width defines the width of the texture
  64625. * @param height defines the height of the texture
  64626. * @param depth defines the depth of the texture
  64627. * @param format defines the texture format to use
  64628. * @param scene defines the hosting scene
  64629. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64630. * @param invertY defines if texture must be stored with Y axis inverted
  64631. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64632. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64633. */
  64634. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64635. /** Gets or sets the texture format to use */
  64636. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64637. /**
  64638. * Update the texture with new data
  64639. * @param data defines the data to store in the texture
  64640. */
  64641. update(data: ArrayBufferView): void;
  64642. }
  64643. }
  64644. declare module "babylonjs/Materials/Textures/refractionTexture" {
  64645. import { Scene } from "babylonjs/scene";
  64646. import { Plane } from "babylonjs/Maths/math.plane";
  64647. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  64648. /**
  64649. * Creates a refraction texture used by refraction channel of the standard material.
  64650. * It is like a mirror but to see through a material.
  64651. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64652. */
  64653. export class RefractionTexture extends RenderTargetTexture {
  64654. /**
  64655. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  64656. * 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.
  64657. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64658. */
  64659. refractionPlane: Plane;
  64660. /**
  64661. * Define how deep under the surface we should see.
  64662. */
  64663. depth: number;
  64664. /**
  64665. * Creates a refraction texture used by refraction channel of the standard material.
  64666. * It is like a mirror but to see through a material.
  64667. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64668. * @param name Define the texture name
  64669. * @param size Define the size of the underlying texture
  64670. * @param scene Define the scene the refraction belongs to
  64671. * @param generateMipMaps Define if we need to generate mips level for the refraction
  64672. */
  64673. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  64674. /**
  64675. * Clone the refraction texture.
  64676. * @returns the cloned texture
  64677. */
  64678. clone(): RefractionTexture;
  64679. /**
  64680. * Serialize the texture to a JSON representation you could use in Parse later on
  64681. * @returns the serialized JSON representation
  64682. */
  64683. serialize(): any;
  64684. }
  64685. }
  64686. declare module "babylonjs/Materials/Textures/index" {
  64687. export * from "babylonjs/Materials/Textures/baseTexture";
  64688. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  64689. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  64690. export * from "babylonjs/Materials/Textures/cubeTexture";
  64691. export * from "babylonjs/Materials/Textures/dynamicTexture";
  64692. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  64693. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  64694. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  64695. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  64696. export * from "babylonjs/Materials/Textures/internalTexture";
  64697. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  64698. export * from "babylonjs/Materials/Textures/Loaders/index";
  64699. export * from "babylonjs/Materials/Textures/mirrorTexture";
  64700. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  64701. export * from "babylonjs/Materials/Textures/Packer/index";
  64702. export * from "babylonjs/Materials/Textures/Procedurals/index";
  64703. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  64704. export * from "babylonjs/Materials/Textures/rawTexture";
  64705. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  64706. export * from "babylonjs/Materials/Textures/rawTexture3D";
  64707. export * from "babylonjs/Materials/Textures/refractionTexture";
  64708. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  64709. export * from "babylonjs/Materials/Textures/texture";
  64710. export * from "babylonjs/Materials/Textures/videoTexture";
  64711. }
  64712. declare module "babylonjs/Materials/Node/Enums/index" {
  64713. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  64714. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  64715. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  64716. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  64717. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  64718. }
  64719. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  64720. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64721. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64722. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64723. import { Mesh } from "babylonjs/Meshes/mesh";
  64724. import { Effect } from "babylonjs/Materials/effect";
  64725. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64726. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64727. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  64728. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  64729. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  64730. /**
  64731. * Block used to add support for vertex skinning (bones)
  64732. */
  64733. export class BonesBlock extends NodeMaterialBlock {
  64734. /**
  64735. * Creates a new BonesBlock
  64736. * @param name defines the block name
  64737. */
  64738. constructor(name: string);
  64739. /**
  64740. * Initialize the block and prepare the context for build
  64741. * @param state defines the state that will be used for the build
  64742. */
  64743. initialize(state: NodeMaterialBuildState): void;
  64744. /**
  64745. * Gets the current class name
  64746. * @returns the class name
  64747. */
  64748. getClassName(): string;
  64749. /**
  64750. * Gets the matrix indices input component
  64751. */
  64752. get matricesIndices(): NodeMaterialConnectionPoint;
  64753. /**
  64754. * Gets the matrix weights input component
  64755. */
  64756. get matricesWeights(): NodeMaterialConnectionPoint;
  64757. /**
  64758. * Gets the extra matrix indices input component
  64759. */
  64760. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  64761. /**
  64762. * Gets the extra matrix weights input component
  64763. */
  64764. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  64765. /**
  64766. * Gets the world input component
  64767. */
  64768. get world(): NodeMaterialConnectionPoint;
  64769. /**
  64770. * Gets the output component
  64771. */
  64772. get output(): NodeMaterialConnectionPoint;
  64773. autoConfigure(material: NodeMaterial): void;
  64774. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  64775. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64776. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64777. protected _buildBlock(state: NodeMaterialBuildState): this;
  64778. }
  64779. }
  64780. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  64781. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64782. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64783. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64784. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64785. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64786. import { SubMesh } from "babylonjs/Meshes/subMesh";
  64787. /**
  64788. * Block used to add support for instances
  64789. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  64790. */
  64791. export class InstancesBlock extends NodeMaterialBlock {
  64792. /**
  64793. * Creates a new InstancesBlock
  64794. * @param name defines the block name
  64795. */
  64796. constructor(name: string);
  64797. /**
  64798. * Gets the current class name
  64799. * @returns the class name
  64800. */
  64801. getClassName(): string;
  64802. /**
  64803. * Gets the first world row input component
  64804. */
  64805. get world0(): NodeMaterialConnectionPoint;
  64806. /**
  64807. * Gets the second world row input component
  64808. */
  64809. get world1(): NodeMaterialConnectionPoint;
  64810. /**
  64811. * Gets the third world row input component
  64812. */
  64813. get world2(): NodeMaterialConnectionPoint;
  64814. /**
  64815. * Gets the forth world row input component
  64816. */
  64817. get world3(): NodeMaterialConnectionPoint;
  64818. /**
  64819. * Gets the world input component
  64820. */
  64821. get world(): NodeMaterialConnectionPoint;
  64822. /**
  64823. * Gets the output component
  64824. */
  64825. get output(): NodeMaterialConnectionPoint;
  64826. /**
  64827. * Gets the isntanceID component
  64828. */
  64829. get instanceID(): NodeMaterialConnectionPoint;
  64830. autoConfigure(material: NodeMaterial): void;
  64831. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  64832. protected _buildBlock(state: NodeMaterialBuildState): this;
  64833. }
  64834. }
  64835. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  64836. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64837. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64838. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64839. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64840. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64841. import { Effect } from "babylonjs/Materials/effect";
  64842. import { Mesh } from "babylonjs/Meshes/mesh";
  64843. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  64844. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  64845. /**
  64846. * Block used to add morph targets support to vertex shader
  64847. */
  64848. export class MorphTargetsBlock extends NodeMaterialBlock {
  64849. private _repeatableContentAnchor;
  64850. /**
  64851. * Create a new MorphTargetsBlock
  64852. * @param name defines the block name
  64853. */
  64854. constructor(name: string);
  64855. /**
  64856. * Gets the current class name
  64857. * @returns the class name
  64858. */
  64859. getClassName(): string;
  64860. /**
  64861. * Gets the position input component
  64862. */
  64863. get position(): NodeMaterialConnectionPoint;
  64864. /**
  64865. * Gets the normal input component
  64866. */
  64867. get normal(): NodeMaterialConnectionPoint;
  64868. /**
  64869. * Gets the tangent input component
  64870. */
  64871. get tangent(): NodeMaterialConnectionPoint;
  64872. /**
  64873. * Gets the tangent input component
  64874. */
  64875. get uv(): NodeMaterialConnectionPoint;
  64876. /**
  64877. * Gets the position output component
  64878. */
  64879. get positionOutput(): NodeMaterialConnectionPoint;
  64880. /**
  64881. * Gets the normal output component
  64882. */
  64883. get normalOutput(): NodeMaterialConnectionPoint;
  64884. /**
  64885. * Gets the tangent output component
  64886. */
  64887. get tangentOutput(): NodeMaterialConnectionPoint;
  64888. /**
  64889. * Gets the tangent output component
  64890. */
  64891. get uvOutput(): NodeMaterialConnectionPoint;
  64892. initialize(state: NodeMaterialBuildState): void;
  64893. autoConfigure(material: NodeMaterial): void;
  64894. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64895. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64896. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  64897. protected _buildBlock(state: NodeMaterialBuildState): this;
  64898. }
  64899. }
  64900. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  64901. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64902. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64903. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64904. import { Nullable } from "babylonjs/types";
  64905. import { Scene } from "babylonjs/scene";
  64906. import { Effect } from "babylonjs/Materials/effect";
  64907. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64908. import { Mesh } from "babylonjs/Meshes/mesh";
  64909. import { Light } from "babylonjs/Lights/light";
  64910. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64911. /**
  64912. * Block used to get data information from a light
  64913. */
  64914. export class LightInformationBlock extends NodeMaterialBlock {
  64915. private _lightDataUniformName;
  64916. private _lightColorUniformName;
  64917. private _lightTypeDefineName;
  64918. /**
  64919. * Gets or sets the light associated with this block
  64920. */
  64921. light: Nullable<Light>;
  64922. /**
  64923. * Creates a new LightInformationBlock
  64924. * @param name defines the block name
  64925. */
  64926. constructor(name: string);
  64927. /**
  64928. * Gets the current class name
  64929. * @returns the class name
  64930. */
  64931. getClassName(): string;
  64932. /**
  64933. * Gets the world position input component
  64934. */
  64935. get worldPosition(): NodeMaterialConnectionPoint;
  64936. /**
  64937. * Gets the direction output component
  64938. */
  64939. get direction(): NodeMaterialConnectionPoint;
  64940. /**
  64941. * Gets the direction output component
  64942. */
  64943. get color(): NodeMaterialConnectionPoint;
  64944. /**
  64945. * Gets the direction output component
  64946. */
  64947. get intensity(): NodeMaterialConnectionPoint;
  64948. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64949. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64950. protected _buildBlock(state: NodeMaterialBuildState): this;
  64951. serialize(): any;
  64952. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64953. }
  64954. }
  64955. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  64956. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  64957. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  64958. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  64959. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  64960. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  64961. }
  64962. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  64963. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64964. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64965. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64966. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64967. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64968. import { Effect } from "babylonjs/Materials/effect";
  64969. import { Mesh } from "babylonjs/Meshes/mesh";
  64970. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64971. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  64972. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  64973. /**
  64974. * Block used to add image processing support to fragment shader
  64975. */
  64976. export class ImageProcessingBlock extends NodeMaterialBlock {
  64977. /**
  64978. * Create a new ImageProcessingBlock
  64979. * @param name defines the block name
  64980. */
  64981. constructor(name: string);
  64982. /**
  64983. * Gets the current class name
  64984. * @returns the class name
  64985. */
  64986. getClassName(): string;
  64987. /**
  64988. * Gets the color input component
  64989. */
  64990. get color(): NodeMaterialConnectionPoint;
  64991. /**
  64992. * Gets the output component
  64993. */
  64994. get output(): NodeMaterialConnectionPoint;
  64995. /**
  64996. * Initialize the block and prepare the context for build
  64997. * @param state defines the state that will be used for the build
  64998. */
  64999. initialize(state: NodeMaterialBuildState): void;
  65000. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65001. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65002. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65003. protected _buildBlock(state: NodeMaterialBuildState): this;
  65004. }
  65005. }
  65006. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65007. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65008. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65009. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65010. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65011. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65012. import { Effect } from "babylonjs/Materials/effect";
  65013. import { Mesh } from "babylonjs/Meshes/mesh";
  65014. import { Scene } from "babylonjs/scene";
  65015. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65016. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65017. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65018. /**
  65019. * Block used to pertub normals based on a normal map
  65020. */
  65021. export class PerturbNormalBlock extends NodeMaterialBlock {
  65022. private _tangentSpaceParameterName;
  65023. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65024. invertX: boolean;
  65025. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65026. invertY: boolean;
  65027. /**
  65028. * Create a new PerturbNormalBlock
  65029. * @param name defines the block name
  65030. */
  65031. constructor(name: string);
  65032. /**
  65033. * Gets the current class name
  65034. * @returns the class name
  65035. */
  65036. getClassName(): string;
  65037. /**
  65038. * Gets the world position input component
  65039. */
  65040. get worldPosition(): NodeMaterialConnectionPoint;
  65041. /**
  65042. * Gets the world normal input component
  65043. */
  65044. get worldNormal(): NodeMaterialConnectionPoint;
  65045. /**
  65046. * Gets the world tangent input component
  65047. */
  65048. get worldTangent(): NodeMaterialConnectionPoint;
  65049. /**
  65050. * Gets the uv input component
  65051. */
  65052. get uv(): NodeMaterialConnectionPoint;
  65053. /**
  65054. * Gets the normal map color input component
  65055. */
  65056. get normalMapColor(): NodeMaterialConnectionPoint;
  65057. /**
  65058. * Gets the strength input component
  65059. */
  65060. get strength(): NodeMaterialConnectionPoint;
  65061. /**
  65062. * Gets the output component
  65063. */
  65064. get output(): NodeMaterialConnectionPoint;
  65065. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65066. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65067. autoConfigure(material: NodeMaterial): void;
  65068. protected _buildBlock(state: NodeMaterialBuildState): this;
  65069. protected _dumpPropertiesCode(): string;
  65070. serialize(): any;
  65071. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65072. }
  65073. }
  65074. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65075. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65076. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65077. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65078. /**
  65079. * Block used to discard a pixel if a value is smaller than a cutoff
  65080. */
  65081. export class DiscardBlock extends NodeMaterialBlock {
  65082. /**
  65083. * Create a new DiscardBlock
  65084. * @param name defines the block name
  65085. */
  65086. constructor(name: string);
  65087. /**
  65088. * Gets the current class name
  65089. * @returns the class name
  65090. */
  65091. getClassName(): string;
  65092. /**
  65093. * Gets the color input component
  65094. */
  65095. get value(): NodeMaterialConnectionPoint;
  65096. /**
  65097. * Gets the cutoff input component
  65098. */
  65099. get cutoff(): NodeMaterialConnectionPoint;
  65100. protected _buildBlock(state: NodeMaterialBuildState): this;
  65101. }
  65102. }
  65103. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65104. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65105. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65106. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65107. /**
  65108. * Block used to test if the fragment shader is front facing
  65109. */
  65110. export class FrontFacingBlock extends NodeMaterialBlock {
  65111. /**
  65112. * Creates a new FrontFacingBlock
  65113. * @param name defines the block name
  65114. */
  65115. constructor(name: string);
  65116. /**
  65117. * Gets the current class name
  65118. * @returns the class name
  65119. */
  65120. getClassName(): string;
  65121. /**
  65122. * Gets the output component
  65123. */
  65124. get output(): NodeMaterialConnectionPoint;
  65125. protected _buildBlock(state: NodeMaterialBuildState): this;
  65126. }
  65127. }
  65128. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65129. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65130. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65131. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65132. /**
  65133. * Block used to get the derivative value on x and y of a given input
  65134. */
  65135. export class DerivativeBlock extends NodeMaterialBlock {
  65136. /**
  65137. * Create a new DerivativeBlock
  65138. * @param name defines the block name
  65139. */
  65140. constructor(name: string);
  65141. /**
  65142. * Gets the current class name
  65143. * @returns the class name
  65144. */
  65145. getClassName(): string;
  65146. /**
  65147. * Gets the input component
  65148. */
  65149. get input(): NodeMaterialConnectionPoint;
  65150. /**
  65151. * Gets the derivative output on x
  65152. */
  65153. get dx(): NodeMaterialConnectionPoint;
  65154. /**
  65155. * Gets the derivative output on y
  65156. */
  65157. get dy(): NodeMaterialConnectionPoint;
  65158. protected _buildBlock(state: NodeMaterialBuildState): this;
  65159. }
  65160. }
  65161. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65162. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65163. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65164. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65165. /**
  65166. * Block used to make gl_FragCoord available
  65167. */
  65168. export class FragCoordBlock extends NodeMaterialBlock {
  65169. /**
  65170. * Creates a new FragCoordBlock
  65171. * @param name defines the block name
  65172. */
  65173. constructor(name: string);
  65174. /**
  65175. * Gets the current class name
  65176. * @returns the class name
  65177. */
  65178. getClassName(): string;
  65179. /**
  65180. * Gets the xy component
  65181. */
  65182. get xy(): NodeMaterialConnectionPoint;
  65183. /**
  65184. * Gets the xyz component
  65185. */
  65186. get xyz(): NodeMaterialConnectionPoint;
  65187. /**
  65188. * Gets the xyzw component
  65189. */
  65190. get xyzw(): NodeMaterialConnectionPoint;
  65191. /**
  65192. * Gets the x component
  65193. */
  65194. get x(): NodeMaterialConnectionPoint;
  65195. /**
  65196. * Gets the y component
  65197. */
  65198. get y(): NodeMaterialConnectionPoint;
  65199. /**
  65200. * Gets the z component
  65201. */
  65202. get z(): NodeMaterialConnectionPoint;
  65203. /**
  65204. * Gets the w component
  65205. */
  65206. get output(): NodeMaterialConnectionPoint;
  65207. protected writeOutputs(state: NodeMaterialBuildState): string;
  65208. protected _buildBlock(state: NodeMaterialBuildState): this;
  65209. }
  65210. }
  65211. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65212. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65213. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65214. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65215. import { Effect } from "babylonjs/Materials/effect";
  65216. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65217. import { Mesh } from "babylonjs/Meshes/mesh";
  65218. /**
  65219. * Block used to get the screen sizes
  65220. */
  65221. export class ScreenSizeBlock extends NodeMaterialBlock {
  65222. private _varName;
  65223. private _scene;
  65224. /**
  65225. * Creates a new ScreenSizeBlock
  65226. * @param name defines the block name
  65227. */
  65228. constructor(name: string);
  65229. /**
  65230. * Gets the current class name
  65231. * @returns the class name
  65232. */
  65233. getClassName(): string;
  65234. /**
  65235. * Gets the xy component
  65236. */
  65237. get xy(): NodeMaterialConnectionPoint;
  65238. /**
  65239. * Gets the x component
  65240. */
  65241. get x(): NodeMaterialConnectionPoint;
  65242. /**
  65243. * Gets the y component
  65244. */
  65245. get y(): NodeMaterialConnectionPoint;
  65246. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65247. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65248. protected _buildBlock(state: NodeMaterialBuildState): this;
  65249. }
  65250. }
  65251. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65252. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65253. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65254. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65255. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65256. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65257. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65258. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65259. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65260. }
  65261. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65262. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65263. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65264. import { Mesh } from "babylonjs/Meshes/mesh";
  65265. import { Effect } from "babylonjs/Materials/effect";
  65266. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65267. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65268. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65269. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65270. /**
  65271. * Block used to add support for scene fog
  65272. */
  65273. export class FogBlock extends NodeMaterialBlock {
  65274. private _fogDistanceName;
  65275. private _fogParameters;
  65276. /**
  65277. * Create a new FogBlock
  65278. * @param name defines the block name
  65279. */
  65280. constructor(name: string);
  65281. /**
  65282. * Gets the current class name
  65283. * @returns the class name
  65284. */
  65285. getClassName(): string;
  65286. /**
  65287. * Gets the world position input component
  65288. */
  65289. get worldPosition(): NodeMaterialConnectionPoint;
  65290. /**
  65291. * Gets the view input component
  65292. */
  65293. get view(): NodeMaterialConnectionPoint;
  65294. /**
  65295. * Gets the color input component
  65296. */
  65297. get input(): NodeMaterialConnectionPoint;
  65298. /**
  65299. * Gets the fog color input component
  65300. */
  65301. get fogColor(): NodeMaterialConnectionPoint;
  65302. /**
  65303. * Gets the output component
  65304. */
  65305. get output(): NodeMaterialConnectionPoint;
  65306. autoConfigure(material: NodeMaterial): void;
  65307. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65308. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65309. protected _buildBlock(state: NodeMaterialBuildState): this;
  65310. }
  65311. }
  65312. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65313. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65314. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65315. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65317. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65318. import { Effect } from "babylonjs/Materials/effect";
  65319. import { Mesh } from "babylonjs/Meshes/mesh";
  65320. import { Light } from "babylonjs/Lights/light";
  65321. import { Nullable } from "babylonjs/types";
  65322. import { Scene } from "babylonjs/scene";
  65323. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65324. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65325. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65326. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65327. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65328. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65329. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65330. /**
  65331. * Block used to add light in the fragment shader
  65332. */
  65333. export class LightBlock extends NodeMaterialBlock {
  65334. private _lightId;
  65335. /**
  65336. * Gets or sets the light associated with this block
  65337. */
  65338. light: Nullable<Light>;
  65339. /**
  65340. * Create a new LightBlock
  65341. * @param name defines the block name
  65342. */
  65343. constructor(name: string);
  65344. /**
  65345. * Gets the current class name
  65346. * @returns the class name
  65347. */
  65348. getClassName(): string;
  65349. /**
  65350. * Gets the world position input component
  65351. */
  65352. get worldPosition(): NodeMaterialConnectionPoint;
  65353. /**
  65354. * Gets the world normal input component
  65355. */
  65356. get worldNormal(): NodeMaterialConnectionPoint;
  65357. /**
  65358. * Gets the camera (or eye) position component
  65359. */
  65360. get cameraPosition(): NodeMaterialConnectionPoint;
  65361. /**
  65362. * Gets the glossiness component
  65363. */
  65364. get glossiness(): NodeMaterialConnectionPoint;
  65365. /**
  65366. * Gets the glossinness power component
  65367. */
  65368. get glossPower(): NodeMaterialConnectionPoint;
  65369. /**
  65370. * Gets the diffuse color component
  65371. */
  65372. get diffuseColor(): NodeMaterialConnectionPoint;
  65373. /**
  65374. * Gets the specular color component
  65375. */
  65376. get specularColor(): NodeMaterialConnectionPoint;
  65377. /**
  65378. * Gets the diffuse output component
  65379. */
  65380. get diffuseOutput(): NodeMaterialConnectionPoint;
  65381. /**
  65382. * Gets the specular output component
  65383. */
  65384. get specularOutput(): NodeMaterialConnectionPoint;
  65385. /**
  65386. * Gets the shadow output component
  65387. */
  65388. get shadow(): NodeMaterialConnectionPoint;
  65389. autoConfigure(material: NodeMaterial): void;
  65390. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65391. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65392. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65393. private _injectVertexCode;
  65394. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65395. serialize(): any;
  65396. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65397. }
  65398. }
  65399. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65400. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65401. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65402. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65403. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65404. /**
  65405. * Block used to read a reflection texture from a sampler
  65406. */
  65407. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65408. /**
  65409. * Create a new ReflectionTextureBlock
  65410. * @param name defines the block name
  65411. */
  65412. constructor(name: string);
  65413. /**
  65414. * Gets the current class name
  65415. * @returns the class name
  65416. */
  65417. getClassName(): string;
  65418. /**
  65419. * Gets the world position input component
  65420. */
  65421. get position(): NodeMaterialConnectionPoint;
  65422. /**
  65423. * Gets the world position input component
  65424. */
  65425. get worldPosition(): NodeMaterialConnectionPoint;
  65426. /**
  65427. * Gets the world normal input component
  65428. */
  65429. get worldNormal(): NodeMaterialConnectionPoint;
  65430. /**
  65431. * Gets the world input component
  65432. */
  65433. get world(): NodeMaterialConnectionPoint;
  65434. /**
  65435. * Gets the camera (or eye) position component
  65436. */
  65437. get cameraPosition(): NodeMaterialConnectionPoint;
  65438. /**
  65439. * Gets the view input component
  65440. */
  65441. get view(): NodeMaterialConnectionPoint;
  65442. /**
  65443. * Gets the rgb output component
  65444. */
  65445. get rgb(): NodeMaterialConnectionPoint;
  65446. /**
  65447. * Gets the rgba output component
  65448. */
  65449. get rgba(): NodeMaterialConnectionPoint;
  65450. /**
  65451. * Gets the r output component
  65452. */
  65453. get r(): NodeMaterialConnectionPoint;
  65454. /**
  65455. * Gets the g output component
  65456. */
  65457. get g(): NodeMaterialConnectionPoint;
  65458. /**
  65459. * Gets the b output component
  65460. */
  65461. get b(): NodeMaterialConnectionPoint;
  65462. /**
  65463. * Gets the a output component
  65464. */
  65465. get a(): NodeMaterialConnectionPoint;
  65466. autoConfigure(material: NodeMaterial): void;
  65467. protected _buildBlock(state: NodeMaterialBuildState): this;
  65468. }
  65469. }
  65470. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65471. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65472. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65473. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65474. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65475. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65476. }
  65477. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65478. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65479. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65480. }
  65481. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65482. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65483. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65484. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65485. /**
  65486. * Block used to add 2 vectors
  65487. */
  65488. export class AddBlock extends NodeMaterialBlock {
  65489. /**
  65490. * Creates a new AddBlock
  65491. * @param name defines the block name
  65492. */
  65493. constructor(name: string);
  65494. /**
  65495. * Gets the current class name
  65496. * @returns the class name
  65497. */
  65498. getClassName(): string;
  65499. /**
  65500. * Gets the left operand input component
  65501. */
  65502. get left(): NodeMaterialConnectionPoint;
  65503. /**
  65504. * Gets the right operand input component
  65505. */
  65506. get right(): NodeMaterialConnectionPoint;
  65507. /**
  65508. * Gets the output component
  65509. */
  65510. get output(): NodeMaterialConnectionPoint;
  65511. protected _buildBlock(state: NodeMaterialBuildState): this;
  65512. }
  65513. }
  65514. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65515. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65516. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65517. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65518. /**
  65519. * Block used to scale a vector by a float
  65520. */
  65521. export class ScaleBlock extends NodeMaterialBlock {
  65522. /**
  65523. * Creates a new ScaleBlock
  65524. * @param name defines the block name
  65525. */
  65526. constructor(name: string);
  65527. /**
  65528. * Gets the current class name
  65529. * @returns the class name
  65530. */
  65531. getClassName(): string;
  65532. /**
  65533. * Gets the input component
  65534. */
  65535. get input(): NodeMaterialConnectionPoint;
  65536. /**
  65537. * Gets the factor input component
  65538. */
  65539. get factor(): NodeMaterialConnectionPoint;
  65540. /**
  65541. * Gets the output component
  65542. */
  65543. get output(): NodeMaterialConnectionPoint;
  65544. protected _buildBlock(state: NodeMaterialBuildState): this;
  65545. }
  65546. }
  65547. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65548. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65549. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65550. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65551. import { Scene } from "babylonjs/scene";
  65552. /**
  65553. * Block used to clamp a float
  65554. */
  65555. export class ClampBlock extends NodeMaterialBlock {
  65556. /** Gets or sets the minimum range */
  65557. minimum: number;
  65558. /** Gets or sets the maximum range */
  65559. maximum: number;
  65560. /**
  65561. * Creates a new ClampBlock
  65562. * @param name defines the block name
  65563. */
  65564. constructor(name: string);
  65565. /**
  65566. * Gets the current class name
  65567. * @returns the class name
  65568. */
  65569. getClassName(): string;
  65570. /**
  65571. * Gets the value input component
  65572. */
  65573. get value(): NodeMaterialConnectionPoint;
  65574. /**
  65575. * Gets the output component
  65576. */
  65577. get output(): NodeMaterialConnectionPoint;
  65578. protected _buildBlock(state: NodeMaterialBuildState): this;
  65579. protected _dumpPropertiesCode(): string;
  65580. serialize(): any;
  65581. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65582. }
  65583. }
  65584. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65585. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65586. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65587. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65588. /**
  65589. * Block used to apply a cross product between 2 vectors
  65590. */
  65591. export class CrossBlock extends NodeMaterialBlock {
  65592. /**
  65593. * Creates a new CrossBlock
  65594. * @param name defines the block name
  65595. */
  65596. constructor(name: string);
  65597. /**
  65598. * Gets the current class name
  65599. * @returns the class name
  65600. */
  65601. getClassName(): string;
  65602. /**
  65603. * Gets the left operand input component
  65604. */
  65605. get left(): NodeMaterialConnectionPoint;
  65606. /**
  65607. * Gets the right operand input component
  65608. */
  65609. get right(): NodeMaterialConnectionPoint;
  65610. /**
  65611. * Gets the output component
  65612. */
  65613. get output(): NodeMaterialConnectionPoint;
  65614. protected _buildBlock(state: NodeMaterialBuildState): this;
  65615. }
  65616. }
  65617. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  65618. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65619. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65620. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65621. /**
  65622. * Block used to apply a dot product between 2 vectors
  65623. */
  65624. export class DotBlock extends NodeMaterialBlock {
  65625. /**
  65626. * Creates a new DotBlock
  65627. * @param name defines the block name
  65628. */
  65629. constructor(name: string);
  65630. /**
  65631. * Gets the current class name
  65632. * @returns the class name
  65633. */
  65634. getClassName(): string;
  65635. /**
  65636. * Gets the left operand input component
  65637. */
  65638. get left(): NodeMaterialConnectionPoint;
  65639. /**
  65640. * Gets the right operand input component
  65641. */
  65642. get right(): NodeMaterialConnectionPoint;
  65643. /**
  65644. * Gets the output component
  65645. */
  65646. get output(): NodeMaterialConnectionPoint;
  65647. protected _buildBlock(state: NodeMaterialBuildState): this;
  65648. }
  65649. }
  65650. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  65651. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65652. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65653. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65654. /**
  65655. * Block used to normalize a vector
  65656. */
  65657. export class NormalizeBlock extends NodeMaterialBlock {
  65658. /**
  65659. * Creates a new NormalizeBlock
  65660. * @param name defines the block name
  65661. */
  65662. constructor(name: string);
  65663. /**
  65664. * Gets the current class name
  65665. * @returns the class name
  65666. */
  65667. getClassName(): string;
  65668. /**
  65669. * Gets the input component
  65670. */
  65671. get input(): NodeMaterialConnectionPoint;
  65672. /**
  65673. * Gets the output component
  65674. */
  65675. get output(): NodeMaterialConnectionPoint;
  65676. protected _buildBlock(state: NodeMaterialBuildState): this;
  65677. }
  65678. }
  65679. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  65680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65682. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65683. import { Scene } from "babylonjs/scene";
  65684. /**
  65685. * Operations supported by the Trigonometry block
  65686. */
  65687. export enum TrigonometryBlockOperations {
  65688. /** Cos */
  65689. Cos = 0,
  65690. /** Sin */
  65691. Sin = 1,
  65692. /** Abs */
  65693. Abs = 2,
  65694. /** Exp */
  65695. Exp = 3,
  65696. /** Exp2 */
  65697. Exp2 = 4,
  65698. /** Round */
  65699. Round = 5,
  65700. /** Floor */
  65701. Floor = 6,
  65702. /** Ceiling */
  65703. Ceiling = 7,
  65704. /** Square root */
  65705. Sqrt = 8,
  65706. /** Log */
  65707. Log = 9,
  65708. /** Tangent */
  65709. Tan = 10,
  65710. /** Arc tangent */
  65711. ArcTan = 11,
  65712. /** Arc cosinus */
  65713. ArcCos = 12,
  65714. /** Arc sinus */
  65715. ArcSin = 13,
  65716. /** Fraction */
  65717. Fract = 14,
  65718. /** Sign */
  65719. Sign = 15,
  65720. /** To radians (from degrees) */
  65721. Radians = 16,
  65722. /** To degrees (from radians) */
  65723. Degrees = 17
  65724. }
  65725. /**
  65726. * Block used to apply trigonometry operation to floats
  65727. */
  65728. export class TrigonometryBlock extends NodeMaterialBlock {
  65729. /**
  65730. * Gets or sets the operation applied by the block
  65731. */
  65732. operation: TrigonometryBlockOperations;
  65733. /**
  65734. * Creates a new TrigonometryBlock
  65735. * @param name defines the block name
  65736. */
  65737. constructor(name: string);
  65738. /**
  65739. * Gets the current class name
  65740. * @returns the class name
  65741. */
  65742. getClassName(): string;
  65743. /**
  65744. * Gets the input component
  65745. */
  65746. get input(): NodeMaterialConnectionPoint;
  65747. /**
  65748. * Gets the output component
  65749. */
  65750. get output(): NodeMaterialConnectionPoint;
  65751. protected _buildBlock(state: NodeMaterialBuildState): this;
  65752. serialize(): any;
  65753. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65754. protected _dumpPropertiesCode(): string;
  65755. }
  65756. }
  65757. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  65758. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65759. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65760. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65761. /**
  65762. * Block used to create a Color3/4 out of individual inputs (one for each component)
  65763. */
  65764. export class ColorMergerBlock extends NodeMaterialBlock {
  65765. /**
  65766. * Create a new ColorMergerBlock
  65767. * @param name defines the block name
  65768. */
  65769. constructor(name: string);
  65770. /**
  65771. * Gets the current class name
  65772. * @returns the class name
  65773. */
  65774. getClassName(): string;
  65775. /**
  65776. * Gets the rgb component (input)
  65777. */
  65778. get rgbIn(): NodeMaterialConnectionPoint;
  65779. /**
  65780. * Gets the r component (input)
  65781. */
  65782. get r(): NodeMaterialConnectionPoint;
  65783. /**
  65784. * Gets the g component (input)
  65785. */
  65786. get g(): NodeMaterialConnectionPoint;
  65787. /**
  65788. * Gets the b component (input)
  65789. */
  65790. get b(): NodeMaterialConnectionPoint;
  65791. /**
  65792. * Gets the a component (input)
  65793. */
  65794. get a(): NodeMaterialConnectionPoint;
  65795. /**
  65796. * Gets the rgba component (output)
  65797. */
  65798. get rgba(): NodeMaterialConnectionPoint;
  65799. /**
  65800. * Gets the rgb component (output)
  65801. */
  65802. get rgbOut(): NodeMaterialConnectionPoint;
  65803. /**
  65804. * Gets the rgb component (output)
  65805. * @deprecated Please use rgbOut instead.
  65806. */
  65807. get rgb(): NodeMaterialConnectionPoint;
  65808. protected _buildBlock(state: NodeMaterialBuildState): this;
  65809. }
  65810. }
  65811. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  65812. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65813. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65814. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65815. /**
  65816. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  65817. */
  65818. export class VectorSplitterBlock extends NodeMaterialBlock {
  65819. /**
  65820. * Create a new VectorSplitterBlock
  65821. * @param name defines the block name
  65822. */
  65823. constructor(name: string);
  65824. /**
  65825. * Gets the current class name
  65826. * @returns the class name
  65827. */
  65828. getClassName(): string;
  65829. /**
  65830. * Gets the xyzw component (input)
  65831. */
  65832. get xyzw(): NodeMaterialConnectionPoint;
  65833. /**
  65834. * Gets the xyz component (input)
  65835. */
  65836. get xyzIn(): NodeMaterialConnectionPoint;
  65837. /**
  65838. * Gets the xy component (input)
  65839. */
  65840. get xyIn(): NodeMaterialConnectionPoint;
  65841. /**
  65842. * Gets the xyz component (output)
  65843. */
  65844. get xyzOut(): NodeMaterialConnectionPoint;
  65845. /**
  65846. * Gets the xy component (output)
  65847. */
  65848. get xyOut(): NodeMaterialConnectionPoint;
  65849. /**
  65850. * Gets the x component (output)
  65851. */
  65852. get x(): NodeMaterialConnectionPoint;
  65853. /**
  65854. * Gets the y component (output)
  65855. */
  65856. get y(): NodeMaterialConnectionPoint;
  65857. /**
  65858. * Gets the z component (output)
  65859. */
  65860. get z(): NodeMaterialConnectionPoint;
  65861. /**
  65862. * Gets the w component (output)
  65863. */
  65864. get w(): NodeMaterialConnectionPoint;
  65865. protected _inputRename(name: string): string;
  65866. protected _outputRename(name: string): string;
  65867. protected _buildBlock(state: NodeMaterialBuildState): this;
  65868. }
  65869. }
  65870. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  65871. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65872. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65873. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65874. /**
  65875. * Block used to lerp between 2 values
  65876. */
  65877. export class LerpBlock extends NodeMaterialBlock {
  65878. /**
  65879. * Creates a new LerpBlock
  65880. * @param name defines the block name
  65881. */
  65882. constructor(name: string);
  65883. /**
  65884. * Gets the current class name
  65885. * @returns the class name
  65886. */
  65887. getClassName(): string;
  65888. /**
  65889. * Gets the left operand input component
  65890. */
  65891. get left(): NodeMaterialConnectionPoint;
  65892. /**
  65893. * Gets the right operand input component
  65894. */
  65895. get right(): NodeMaterialConnectionPoint;
  65896. /**
  65897. * Gets the gradient operand input component
  65898. */
  65899. get gradient(): NodeMaterialConnectionPoint;
  65900. /**
  65901. * Gets the output component
  65902. */
  65903. get output(): NodeMaterialConnectionPoint;
  65904. protected _buildBlock(state: NodeMaterialBuildState): this;
  65905. }
  65906. }
  65907. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  65908. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65909. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65910. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65911. /**
  65912. * Block used to divide 2 vectors
  65913. */
  65914. export class DivideBlock extends NodeMaterialBlock {
  65915. /**
  65916. * Creates a new DivideBlock
  65917. * @param name defines the block name
  65918. */
  65919. constructor(name: string);
  65920. /**
  65921. * Gets the current class name
  65922. * @returns the class name
  65923. */
  65924. getClassName(): string;
  65925. /**
  65926. * Gets the left operand input component
  65927. */
  65928. get left(): NodeMaterialConnectionPoint;
  65929. /**
  65930. * Gets the right operand input component
  65931. */
  65932. get right(): NodeMaterialConnectionPoint;
  65933. /**
  65934. * Gets the output component
  65935. */
  65936. get output(): NodeMaterialConnectionPoint;
  65937. protected _buildBlock(state: NodeMaterialBuildState): this;
  65938. }
  65939. }
  65940. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  65941. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65942. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65943. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65944. /**
  65945. * Block used to subtract 2 vectors
  65946. */
  65947. export class SubtractBlock extends NodeMaterialBlock {
  65948. /**
  65949. * Creates a new SubtractBlock
  65950. * @param name defines the block name
  65951. */
  65952. constructor(name: string);
  65953. /**
  65954. * Gets the current class name
  65955. * @returns the class name
  65956. */
  65957. getClassName(): string;
  65958. /**
  65959. * Gets the left operand input component
  65960. */
  65961. get left(): NodeMaterialConnectionPoint;
  65962. /**
  65963. * Gets the right operand input component
  65964. */
  65965. get right(): NodeMaterialConnectionPoint;
  65966. /**
  65967. * Gets the output component
  65968. */
  65969. get output(): NodeMaterialConnectionPoint;
  65970. protected _buildBlock(state: NodeMaterialBuildState): this;
  65971. }
  65972. }
  65973. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  65974. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65975. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65976. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65977. /**
  65978. * Block used to step a value
  65979. */
  65980. export class StepBlock extends NodeMaterialBlock {
  65981. /**
  65982. * Creates a new StepBlock
  65983. * @param name defines the block name
  65984. */
  65985. constructor(name: string);
  65986. /**
  65987. * Gets the current class name
  65988. * @returns the class name
  65989. */
  65990. getClassName(): string;
  65991. /**
  65992. * Gets the value operand input component
  65993. */
  65994. get value(): NodeMaterialConnectionPoint;
  65995. /**
  65996. * Gets the edge operand input component
  65997. */
  65998. get edge(): NodeMaterialConnectionPoint;
  65999. /**
  66000. * Gets the output component
  66001. */
  66002. get output(): NodeMaterialConnectionPoint;
  66003. protected _buildBlock(state: NodeMaterialBuildState): this;
  66004. }
  66005. }
  66006. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66007. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66008. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66009. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66010. /**
  66011. * Block used to get the opposite (1 - x) of a value
  66012. */
  66013. export class OneMinusBlock extends NodeMaterialBlock {
  66014. /**
  66015. * Creates a new OneMinusBlock
  66016. * @param name defines the block name
  66017. */
  66018. constructor(name: string);
  66019. /**
  66020. * Gets the current class name
  66021. * @returns the class name
  66022. */
  66023. getClassName(): string;
  66024. /**
  66025. * Gets the input component
  66026. */
  66027. get input(): NodeMaterialConnectionPoint;
  66028. /**
  66029. * Gets the output component
  66030. */
  66031. get output(): NodeMaterialConnectionPoint;
  66032. protected _buildBlock(state: NodeMaterialBuildState): this;
  66033. }
  66034. }
  66035. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66036. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66037. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66038. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66039. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66040. /**
  66041. * Block used to get the view direction
  66042. */
  66043. export class ViewDirectionBlock extends NodeMaterialBlock {
  66044. /**
  66045. * Creates a new ViewDirectionBlock
  66046. * @param name defines the block name
  66047. */
  66048. constructor(name: string);
  66049. /**
  66050. * Gets the current class name
  66051. * @returns the class name
  66052. */
  66053. getClassName(): string;
  66054. /**
  66055. * Gets the world position component
  66056. */
  66057. get worldPosition(): NodeMaterialConnectionPoint;
  66058. /**
  66059. * Gets the camera position component
  66060. */
  66061. get cameraPosition(): NodeMaterialConnectionPoint;
  66062. /**
  66063. * Gets the output component
  66064. */
  66065. get output(): NodeMaterialConnectionPoint;
  66066. autoConfigure(material: NodeMaterial): void;
  66067. protected _buildBlock(state: NodeMaterialBuildState): this;
  66068. }
  66069. }
  66070. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66071. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66072. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66073. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66074. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66075. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66076. /**
  66077. * Block used to compute fresnel value
  66078. */
  66079. export class FresnelBlock extends NodeMaterialBlock {
  66080. /**
  66081. * Create a new FresnelBlock
  66082. * @param name defines the block name
  66083. */
  66084. constructor(name: string);
  66085. /**
  66086. * Gets the current class name
  66087. * @returns the class name
  66088. */
  66089. getClassName(): string;
  66090. /**
  66091. * Gets the world normal input component
  66092. */
  66093. get worldNormal(): NodeMaterialConnectionPoint;
  66094. /**
  66095. * Gets the view direction input component
  66096. */
  66097. get viewDirection(): NodeMaterialConnectionPoint;
  66098. /**
  66099. * Gets the bias input component
  66100. */
  66101. get bias(): NodeMaterialConnectionPoint;
  66102. /**
  66103. * Gets the camera (or eye) position component
  66104. */
  66105. get power(): NodeMaterialConnectionPoint;
  66106. /**
  66107. * Gets the fresnel output component
  66108. */
  66109. get fresnel(): NodeMaterialConnectionPoint;
  66110. autoConfigure(material: NodeMaterial): void;
  66111. protected _buildBlock(state: NodeMaterialBuildState): this;
  66112. }
  66113. }
  66114. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66115. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66116. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66117. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66118. /**
  66119. * Block used to get the max of 2 values
  66120. */
  66121. export class MaxBlock extends NodeMaterialBlock {
  66122. /**
  66123. * Creates a new MaxBlock
  66124. * @param name defines the block name
  66125. */
  66126. constructor(name: string);
  66127. /**
  66128. * Gets the current class name
  66129. * @returns the class name
  66130. */
  66131. getClassName(): string;
  66132. /**
  66133. * Gets the left operand input component
  66134. */
  66135. get left(): NodeMaterialConnectionPoint;
  66136. /**
  66137. * Gets the right operand input component
  66138. */
  66139. get right(): NodeMaterialConnectionPoint;
  66140. /**
  66141. * Gets the output component
  66142. */
  66143. get output(): NodeMaterialConnectionPoint;
  66144. protected _buildBlock(state: NodeMaterialBuildState): this;
  66145. }
  66146. }
  66147. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66148. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66149. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66150. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66151. /**
  66152. * Block used to get the min of 2 values
  66153. */
  66154. export class MinBlock extends NodeMaterialBlock {
  66155. /**
  66156. * Creates a new MinBlock
  66157. * @param name defines the block name
  66158. */
  66159. constructor(name: string);
  66160. /**
  66161. * Gets the current class name
  66162. * @returns the class name
  66163. */
  66164. getClassName(): string;
  66165. /**
  66166. * Gets the left operand input component
  66167. */
  66168. get left(): NodeMaterialConnectionPoint;
  66169. /**
  66170. * Gets the right operand input component
  66171. */
  66172. get right(): NodeMaterialConnectionPoint;
  66173. /**
  66174. * Gets the output component
  66175. */
  66176. get output(): NodeMaterialConnectionPoint;
  66177. protected _buildBlock(state: NodeMaterialBuildState): this;
  66178. }
  66179. }
  66180. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66181. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66182. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66183. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66184. /**
  66185. * Block used to get the distance between 2 values
  66186. */
  66187. export class DistanceBlock extends NodeMaterialBlock {
  66188. /**
  66189. * Creates a new DistanceBlock
  66190. * @param name defines the block name
  66191. */
  66192. constructor(name: string);
  66193. /**
  66194. * Gets the current class name
  66195. * @returns the class name
  66196. */
  66197. getClassName(): string;
  66198. /**
  66199. * Gets the left operand input component
  66200. */
  66201. get left(): NodeMaterialConnectionPoint;
  66202. /**
  66203. * Gets the right operand input component
  66204. */
  66205. get right(): NodeMaterialConnectionPoint;
  66206. /**
  66207. * Gets the output component
  66208. */
  66209. get output(): NodeMaterialConnectionPoint;
  66210. protected _buildBlock(state: NodeMaterialBuildState): this;
  66211. }
  66212. }
  66213. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66214. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66215. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66216. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66217. /**
  66218. * Block used to get the length of a vector
  66219. */
  66220. export class LengthBlock extends NodeMaterialBlock {
  66221. /**
  66222. * Creates a new LengthBlock
  66223. * @param name defines the block name
  66224. */
  66225. constructor(name: string);
  66226. /**
  66227. * Gets the current class name
  66228. * @returns the class name
  66229. */
  66230. getClassName(): string;
  66231. /**
  66232. * Gets the value input component
  66233. */
  66234. get value(): NodeMaterialConnectionPoint;
  66235. /**
  66236. * Gets the output component
  66237. */
  66238. get output(): NodeMaterialConnectionPoint;
  66239. protected _buildBlock(state: NodeMaterialBuildState): this;
  66240. }
  66241. }
  66242. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66243. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66244. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66245. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66246. /**
  66247. * Block used to get negative version of a value (i.e. x * -1)
  66248. */
  66249. export class NegateBlock extends NodeMaterialBlock {
  66250. /**
  66251. * Creates a new NegateBlock
  66252. * @param name defines the block name
  66253. */
  66254. constructor(name: string);
  66255. /**
  66256. * Gets the current class name
  66257. * @returns the class name
  66258. */
  66259. getClassName(): string;
  66260. /**
  66261. * Gets the value input component
  66262. */
  66263. get value(): NodeMaterialConnectionPoint;
  66264. /**
  66265. * Gets the output component
  66266. */
  66267. get output(): NodeMaterialConnectionPoint;
  66268. protected _buildBlock(state: NodeMaterialBuildState): this;
  66269. }
  66270. }
  66271. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66272. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66273. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66274. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66275. /**
  66276. * Block used to get the value of the first parameter raised to the power of the second
  66277. */
  66278. export class PowBlock extends NodeMaterialBlock {
  66279. /**
  66280. * Creates a new PowBlock
  66281. * @param name defines the block name
  66282. */
  66283. constructor(name: string);
  66284. /**
  66285. * Gets the current class name
  66286. * @returns the class name
  66287. */
  66288. getClassName(): string;
  66289. /**
  66290. * Gets the value operand input component
  66291. */
  66292. get value(): NodeMaterialConnectionPoint;
  66293. /**
  66294. * Gets the power operand input component
  66295. */
  66296. get power(): NodeMaterialConnectionPoint;
  66297. /**
  66298. * Gets the output component
  66299. */
  66300. get output(): NodeMaterialConnectionPoint;
  66301. protected _buildBlock(state: NodeMaterialBuildState): this;
  66302. }
  66303. }
  66304. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66305. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66306. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66307. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66308. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66309. /**
  66310. * Block used to get a random number
  66311. */
  66312. export class RandomNumberBlock extends NodeMaterialBlock {
  66313. /**
  66314. * Creates a new RandomNumberBlock
  66315. * @param name defines the block name
  66316. */
  66317. constructor(name: string);
  66318. /**
  66319. * Gets the current class name
  66320. * @returns the class name
  66321. */
  66322. getClassName(): string;
  66323. /**
  66324. * Gets the seed input component
  66325. */
  66326. get seed(): NodeMaterialConnectionPoint;
  66327. /**
  66328. * Gets the output component
  66329. */
  66330. get output(): NodeMaterialConnectionPoint;
  66331. protected _buildBlock(state: NodeMaterialBuildState): this;
  66332. }
  66333. }
  66334. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66335. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66336. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66337. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66338. /**
  66339. * Block used to compute arc tangent of 2 values
  66340. */
  66341. export class ArcTan2Block extends NodeMaterialBlock {
  66342. /**
  66343. * Creates a new ArcTan2Block
  66344. * @param name defines the block name
  66345. */
  66346. constructor(name: string);
  66347. /**
  66348. * Gets the current class name
  66349. * @returns the class name
  66350. */
  66351. getClassName(): string;
  66352. /**
  66353. * Gets the x operand input component
  66354. */
  66355. get x(): NodeMaterialConnectionPoint;
  66356. /**
  66357. * Gets the y operand input component
  66358. */
  66359. get y(): NodeMaterialConnectionPoint;
  66360. /**
  66361. * Gets the output component
  66362. */
  66363. get output(): NodeMaterialConnectionPoint;
  66364. protected _buildBlock(state: NodeMaterialBuildState): this;
  66365. }
  66366. }
  66367. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66368. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66369. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66370. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66371. /**
  66372. * Block used to smooth step a value
  66373. */
  66374. export class SmoothStepBlock extends NodeMaterialBlock {
  66375. /**
  66376. * Creates a new SmoothStepBlock
  66377. * @param name defines the block name
  66378. */
  66379. constructor(name: string);
  66380. /**
  66381. * Gets the current class name
  66382. * @returns the class name
  66383. */
  66384. getClassName(): string;
  66385. /**
  66386. * Gets the value operand input component
  66387. */
  66388. get value(): NodeMaterialConnectionPoint;
  66389. /**
  66390. * Gets the first edge operand input component
  66391. */
  66392. get edge0(): NodeMaterialConnectionPoint;
  66393. /**
  66394. * Gets the second edge operand input component
  66395. */
  66396. get edge1(): NodeMaterialConnectionPoint;
  66397. /**
  66398. * Gets the output component
  66399. */
  66400. get output(): NodeMaterialConnectionPoint;
  66401. protected _buildBlock(state: NodeMaterialBuildState): this;
  66402. }
  66403. }
  66404. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66407. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66408. /**
  66409. * Block used to get the reciprocal (1 / x) of a value
  66410. */
  66411. export class ReciprocalBlock extends NodeMaterialBlock {
  66412. /**
  66413. * Creates a new ReciprocalBlock
  66414. * @param name defines the block name
  66415. */
  66416. constructor(name: string);
  66417. /**
  66418. * Gets the current class name
  66419. * @returns the class name
  66420. */
  66421. getClassName(): string;
  66422. /**
  66423. * Gets the input component
  66424. */
  66425. get input(): NodeMaterialConnectionPoint;
  66426. /**
  66427. * Gets the output component
  66428. */
  66429. get output(): NodeMaterialConnectionPoint;
  66430. protected _buildBlock(state: NodeMaterialBuildState): this;
  66431. }
  66432. }
  66433. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66434. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66435. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66436. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66437. /**
  66438. * Block used to replace a color by another one
  66439. */
  66440. export class ReplaceColorBlock extends NodeMaterialBlock {
  66441. /**
  66442. * Creates a new ReplaceColorBlock
  66443. * @param name defines the block name
  66444. */
  66445. constructor(name: string);
  66446. /**
  66447. * Gets the current class name
  66448. * @returns the class name
  66449. */
  66450. getClassName(): string;
  66451. /**
  66452. * Gets the value input component
  66453. */
  66454. get value(): NodeMaterialConnectionPoint;
  66455. /**
  66456. * Gets the reference input component
  66457. */
  66458. get reference(): NodeMaterialConnectionPoint;
  66459. /**
  66460. * Gets the distance input component
  66461. */
  66462. get distance(): NodeMaterialConnectionPoint;
  66463. /**
  66464. * Gets the replacement input component
  66465. */
  66466. get replacement(): NodeMaterialConnectionPoint;
  66467. /**
  66468. * Gets the output component
  66469. */
  66470. get output(): NodeMaterialConnectionPoint;
  66471. protected _buildBlock(state: NodeMaterialBuildState): this;
  66472. }
  66473. }
  66474. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66475. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66476. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66477. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66478. /**
  66479. * Block used to posterize a value
  66480. * @see https://en.wikipedia.org/wiki/Posterization
  66481. */
  66482. export class PosterizeBlock extends NodeMaterialBlock {
  66483. /**
  66484. * Creates a new PosterizeBlock
  66485. * @param name defines the block name
  66486. */
  66487. constructor(name: string);
  66488. /**
  66489. * Gets the current class name
  66490. * @returns the class name
  66491. */
  66492. getClassName(): string;
  66493. /**
  66494. * Gets the value input component
  66495. */
  66496. get value(): NodeMaterialConnectionPoint;
  66497. /**
  66498. * Gets the steps input component
  66499. */
  66500. get steps(): NodeMaterialConnectionPoint;
  66501. /**
  66502. * Gets the output component
  66503. */
  66504. get output(): NodeMaterialConnectionPoint;
  66505. protected _buildBlock(state: NodeMaterialBuildState): this;
  66506. }
  66507. }
  66508. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66509. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66510. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66511. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66512. import { Scene } from "babylonjs/scene";
  66513. /**
  66514. * Operations supported by the Wave block
  66515. */
  66516. export enum WaveBlockKind {
  66517. /** SawTooth */
  66518. SawTooth = 0,
  66519. /** Square */
  66520. Square = 1,
  66521. /** Triangle */
  66522. Triangle = 2
  66523. }
  66524. /**
  66525. * Block used to apply wave operation to floats
  66526. */
  66527. export class WaveBlock extends NodeMaterialBlock {
  66528. /**
  66529. * Gets or sets the kibnd of wave to be applied by the block
  66530. */
  66531. kind: WaveBlockKind;
  66532. /**
  66533. * Creates a new WaveBlock
  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 input component
  66544. */
  66545. get input(): NodeMaterialConnectionPoint;
  66546. /**
  66547. * Gets the output component
  66548. */
  66549. get output(): NodeMaterialConnectionPoint;
  66550. protected _buildBlock(state: NodeMaterialBuildState): this;
  66551. serialize(): any;
  66552. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66553. }
  66554. }
  66555. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66556. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66557. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66558. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66559. import { Color3 } from "babylonjs/Maths/math.color";
  66560. import { Scene } from "babylonjs/scene";
  66561. /**
  66562. * Class used to store a color step for the GradientBlock
  66563. */
  66564. export class GradientBlockColorStep {
  66565. /**
  66566. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66567. */
  66568. step: number;
  66569. /**
  66570. * Gets or sets the color associated with this step
  66571. */
  66572. color: Color3;
  66573. /**
  66574. * Creates a new GradientBlockColorStep
  66575. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66576. * @param color defines the color associated with this step
  66577. */
  66578. constructor(
  66579. /**
  66580. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66581. */
  66582. step: number,
  66583. /**
  66584. * Gets or sets the color associated with this step
  66585. */
  66586. color: Color3);
  66587. }
  66588. /**
  66589. * Block used to return a color from a gradient based on an input value between 0 and 1
  66590. */
  66591. export class GradientBlock extends NodeMaterialBlock {
  66592. /**
  66593. * Gets or sets the list of color steps
  66594. */
  66595. colorSteps: GradientBlockColorStep[];
  66596. /**
  66597. * Creates a new GradientBlock
  66598. * @param name defines the block name
  66599. */
  66600. constructor(name: string);
  66601. /**
  66602. * Gets the current class name
  66603. * @returns the class name
  66604. */
  66605. getClassName(): string;
  66606. /**
  66607. * Gets the gradient input component
  66608. */
  66609. get gradient(): NodeMaterialConnectionPoint;
  66610. /**
  66611. * Gets the output component
  66612. */
  66613. get output(): NodeMaterialConnectionPoint;
  66614. private _writeColorConstant;
  66615. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66616. serialize(): any;
  66617. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66618. protected _dumpPropertiesCode(): string;
  66619. }
  66620. }
  66621. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  66622. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66623. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66624. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66625. /**
  66626. * Block used to normalize lerp between 2 values
  66627. */
  66628. export class NLerpBlock extends NodeMaterialBlock {
  66629. /**
  66630. * Creates a new NLerpBlock
  66631. * @param name defines the block name
  66632. */
  66633. constructor(name: string);
  66634. /**
  66635. * Gets the current class name
  66636. * @returns the class name
  66637. */
  66638. getClassName(): string;
  66639. /**
  66640. * Gets the left operand input component
  66641. */
  66642. get left(): NodeMaterialConnectionPoint;
  66643. /**
  66644. * Gets the right operand input component
  66645. */
  66646. get right(): NodeMaterialConnectionPoint;
  66647. /**
  66648. * Gets the gradient operand input component
  66649. */
  66650. get gradient(): NodeMaterialConnectionPoint;
  66651. /**
  66652. * Gets the output component
  66653. */
  66654. get output(): NodeMaterialConnectionPoint;
  66655. protected _buildBlock(state: NodeMaterialBuildState): this;
  66656. }
  66657. }
  66658. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  66659. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66660. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66661. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66662. import { Scene } from "babylonjs/scene";
  66663. /**
  66664. * block used to Generate a Worley Noise 3D Noise Pattern
  66665. */
  66666. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  66667. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  66668. manhattanDistance: boolean;
  66669. /**
  66670. * Creates a new WorleyNoise3DBlock
  66671. * @param name defines the block name
  66672. */
  66673. constructor(name: string);
  66674. /**
  66675. * Gets the current class name
  66676. * @returns the class name
  66677. */
  66678. getClassName(): string;
  66679. /**
  66680. * Gets the seed input component
  66681. */
  66682. get seed(): NodeMaterialConnectionPoint;
  66683. /**
  66684. * Gets the jitter input component
  66685. */
  66686. get jitter(): NodeMaterialConnectionPoint;
  66687. /**
  66688. * Gets the output component
  66689. */
  66690. get output(): NodeMaterialConnectionPoint;
  66691. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66692. /**
  66693. * Exposes the properties to the UI?
  66694. */
  66695. protected _dumpPropertiesCode(): string;
  66696. /**
  66697. * Exposes the properties to the Seralize?
  66698. */
  66699. serialize(): any;
  66700. /**
  66701. * Exposes the properties to the deseralize?
  66702. */
  66703. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66704. }
  66705. }
  66706. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  66707. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66708. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66709. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66710. /**
  66711. * block used to Generate a Simplex Perlin 3d Noise Pattern
  66712. */
  66713. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  66714. /**
  66715. * Creates a new SimplexPerlin3DBlock
  66716. * @param name defines the block name
  66717. */
  66718. constructor(name: string);
  66719. /**
  66720. * Gets the current class name
  66721. * @returns the class name
  66722. */
  66723. getClassName(): string;
  66724. /**
  66725. * Gets the seed operand input component
  66726. */
  66727. get seed(): NodeMaterialConnectionPoint;
  66728. /**
  66729. * Gets the output component
  66730. */
  66731. get output(): NodeMaterialConnectionPoint;
  66732. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66733. }
  66734. }
  66735. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  66736. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66737. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66738. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66739. /**
  66740. * Block used to blend normals
  66741. */
  66742. export class NormalBlendBlock extends NodeMaterialBlock {
  66743. /**
  66744. * Creates a new NormalBlendBlock
  66745. * @param name defines the block name
  66746. */
  66747. constructor(name: string);
  66748. /**
  66749. * Gets the current class name
  66750. * @returns the class name
  66751. */
  66752. getClassName(): string;
  66753. /**
  66754. * Gets the first input component
  66755. */
  66756. get normalMap0(): NodeMaterialConnectionPoint;
  66757. /**
  66758. * Gets the second input component
  66759. */
  66760. get normalMap1(): NodeMaterialConnectionPoint;
  66761. /**
  66762. * Gets the output component
  66763. */
  66764. get output(): NodeMaterialConnectionPoint;
  66765. protected _buildBlock(state: NodeMaterialBuildState): this;
  66766. }
  66767. }
  66768. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  66769. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66770. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66771. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66772. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66773. /**
  66774. * Block used to rotate a 2d vector by a given angle
  66775. */
  66776. export class Rotate2dBlock extends NodeMaterialBlock {
  66777. /**
  66778. * Creates a new Rotate2dBlock
  66779. * @param name defines the block name
  66780. */
  66781. constructor(name: string);
  66782. /**
  66783. * Gets the current class name
  66784. * @returns the class name
  66785. */
  66786. getClassName(): string;
  66787. /**
  66788. * Gets the input vector
  66789. */
  66790. get input(): NodeMaterialConnectionPoint;
  66791. /**
  66792. * Gets the input angle
  66793. */
  66794. get angle(): NodeMaterialConnectionPoint;
  66795. /**
  66796. * Gets the output component
  66797. */
  66798. get output(): NodeMaterialConnectionPoint;
  66799. autoConfigure(material: NodeMaterial): void;
  66800. protected _buildBlock(state: NodeMaterialBuildState): this;
  66801. }
  66802. }
  66803. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  66804. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66805. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66806. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66807. /**
  66808. * Block used to get the reflected vector from a direction and a normal
  66809. */
  66810. export class ReflectBlock extends NodeMaterialBlock {
  66811. /**
  66812. * Creates a new ReflectBlock
  66813. * @param name defines the block name
  66814. */
  66815. constructor(name: string);
  66816. /**
  66817. * Gets the current class name
  66818. * @returns the class name
  66819. */
  66820. getClassName(): string;
  66821. /**
  66822. * Gets the incident component
  66823. */
  66824. get incident(): NodeMaterialConnectionPoint;
  66825. /**
  66826. * Gets the normal component
  66827. */
  66828. get normal(): NodeMaterialConnectionPoint;
  66829. /**
  66830. * Gets the output component
  66831. */
  66832. get output(): NodeMaterialConnectionPoint;
  66833. protected _buildBlock(state: NodeMaterialBuildState): this;
  66834. }
  66835. }
  66836. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  66837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66840. /**
  66841. * Block used to get the refracted vector from a direction and a normal
  66842. */
  66843. export class RefractBlock extends NodeMaterialBlock {
  66844. /**
  66845. * Creates a new RefractBlock
  66846. * @param name defines the block name
  66847. */
  66848. constructor(name: string);
  66849. /**
  66850. * Gets the current class name
  66851. * @returns the class name
  66852. */
  66853. getClassName(): string;
  66854. /**
  66855. * Gets the incident component
  66856. */
  66857. get incident(): NodeMaterialConnectionPoint;
  66858. /**
  66859. * Gets the normal component
  66860. */
  66861. get normal(): NodeMaterialConnectionPoint;
  66862. /**
  66863. * Gets the index of refraction component
  66864. */
  66865. get ior(): NodeMaterialConnectionPoint;
  66866. /**
  66867. * Gets the output component
  66868. */
  66869. get output(): NodeMaterialConnectionPoint;
  66870. protected _buildBlock(state: NodeMaterialBuildState): this;
  66871. }
  66872. }
  66873. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  66874. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66875. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66876. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66877. /**
  66878. * Block used to desaturate a color
  66879. */
  66880. export class DesaturateBlock extends NodeMaterialBlock {
  66881. /**
  66882. * Creates a new DesaturateBlock
  66883. * @param name defines the block name
  66884. */
  66885. constructor(name: string);
  66886. /**
  66887. * Gets the current class name
  66888. * @returns the class name
  66889. */
  66890. getClassName(): string;
  66891. /**
  66892. * Gets the color operand input component
  66893. */
  66894. get color(): NodeMaterialConnectionPoint;
  66895. /**
  66896. * Gets the level operand input component
  66897. */
  66898. get level(): NodeMaterialConnectionPoint;
  66899. /**
  66900. * Gets the output component
  66901. */
  66902. get output(): NodeMaterialConnectionPoint;
  66903. protected _buildBlock(state: NodeMaterialBuildState): this;
  66904. }
  66905. }
  66906. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  66907. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66908. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66909. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66910. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66911. import { Nullable } from "babylonjs/types";
  66912. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66913. import { Scene } from "babylonjs/scene";
  66914. /**
  66915. * Block used to implement the ambient occlusion module of the PBR material
  66916. */
  66917. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  66918. /**
  66919. * Create a new AmbientOcclusionBlock
  66920. * @param name defines the block name
  66921. */
  66922. constructor(name: string);
  66923. /**
  66924. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  66925. */
  66926. useAmbientInGrayScale: boolean;
  66927. /**
  66928. * Initialize the block and prepare the context for build
  66929. * @param state defines the state that will be used for the build
  66930. */
  66931. initialize(state: NodeMaterialBuildState): void;
  66932. /**
  66933. * Gets the current class name
  66934. * @returns the class name
  66935. */
  66936. getClassName(): string;
  66937. /**
  66938. * Gets the texture input component
  66939. */
  66940. get texture(): NodeMaterialConnectionPoint;
  66941. /**
  66942. * Gets the texture intensity component
  66943. */
  66944. get intensity(): NodeMaterialConnectionPoint;
  66945. /**
  66946. * Gets the direct light intensity input component
  66947. */
  66948. get directLightIntensity(): NodeMaterialConnectionPoint;
  66949. /**
  66950. * Gets the ambient occlusion object output component
  66951. */
  66952. get ambientOcclusion(): NodeMaterialConnectionPoint;
  66953. /**
  66954. * Gets the main code of the block (fragment side)
  66955. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  66956. * @returns the shader code
  66957. */
  66958. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  66959. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66960. protected _buildBlock(state: NodeMaterialBuildState): this;
  66961. protected _dumpPropertiesCode(): string;
  66962. serialize(): any;
  66963. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66964. }
  66965. }
  66966. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  66967. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66968. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66969. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66970. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66971. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66972. import { Nullable } from "babylonjs/types";
  66973. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66974. import { Mesh } from "babylonjs/Meshes/mesh";
  66975. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66976. import { Effect } from "babylonjs/Materials/effect";
  66977. import { Scene } from "babylonjs/scene";
  66978. /**
  66979. * Block used to implement the reflection module of the PBR material
  66980. */
  66981. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  66982. /** @hidden */
  66983. _defineLODReflectionAlpha: string;
  66984. /** @hidden */
  66985. _defineLinearSpecularReflection: string;
  66986. private _vEnvironmentIrradianceName;
  66987. /** @hidden */
  66988. _vReflectionMicrosurfaceInfosName: string;
  66989. /** @hidden */
  66990. _vReflectionInfosName: string;
  66991. /** @hidden */
  66992. _vReflectionFilteringInfoName: string;
  66993. private _scene;
  66994. /**
  66995. * The three properties below are set by the main PBR block prior to calling methods of this class.
  66996. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  66997. * It's less burden on the user side in the editor part.
  66998. */
  66999. /** @hidden */
  67000. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67001. /** @hidden */
  67002. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67003. /** @hidden */
  67004. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67005. /**
  67006. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67007. * diffuse part of the IBL.
  67008. */
  67009. useSphericalHarmonics: boolean;
  67010. /**
  67011. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67012. */
  67013. forceIrradianceInFragment: boolean;
  67014. /**
  67015. * Create a new ReflectionBlock
  67016. * @param name defines the block name
  67017. */
  67018. constructor(name: string);
  67019. /**
  67020. * Gets the current class name
  67021. * @returns the class name
  67022. */
  67023. getClassName(): string;
  67024. /**
  67025. * Gets the position input component
  67026. */
  67027. get position(): NodeMaterialConnectionPoint;
  67028. /**
  67029. * Gets the world position input component
  67030. */
  67031. get worldPosition(): NodeMaterialConnectionPoint;
  67032. /**
  67033. * Gets the world normal input component
  67034. */
  67035. get worldNormal(): NodeMaterialConnectionPoint;
  67036. /**
  67037. * Gets the world input component
  67038. */
  67039. get world(): NodeMaterialConnectionPoint;
  67040. /**
  67041. * Gets the camera (or eye) position component
  67042. */
  67043. get cameraPosition(): NodeMaterialConnectionPoint;
  67044. /**
  67045. * Gets the view input component
  67046. */
  67047. get view(): NodeMaterialConnectionPoint;
  67048. /**
  67049. * Gets the color input component
  67050. */
  67051. get color(): NodeMaterialConnectionPoint;
  67052. /**
  67053. * Gets the reflection object output component
  67054. */
  67055. get reflection(): NodeMaterialConnectionPoint;
  67056. /**
  67057. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67058. */
  67059. get hasTexture(): boolean;
  67060. /**
  67061. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67062. */
  67063. get reflectionColor(): string;
  67064. protected _getTexture(): Nullable<BaseTexture>;
  67065. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67066. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67067. /**
  67068. * Gets the code to inject in the vertex shader
  67069. * @param state current state of the node material building
  67070. * @returns the shader code
  67071. */
  67072. handleVertexSide(state: NodeMaterialBuildState): string;
  67073. /**
  67074. * Gets the main code of the block (fragment side)
  67075. * @param state current state of the node material building
  67076. * @param normalVarName name of the existing variable corresponding to the normal
  67077. * @returns the shader code
  67078. */
  67079. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67080. protected _buildBlock(state: NodeMaterialBuildState): this;
  67081. protected _dumpPropertiesCode(): string;
  67082. serialize(): any;
  67083. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67084. }
  67085. }
  67086. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67087. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67088. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67089. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67090. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67091. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67092. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67093. import { Scene } from "babylonjs/scene";
  67094. import { Nullable } from "babylonjs/types";
  67095. /**
  67096. * Block used to implement the sheen module of the PBR material
  67097. */
  67098. export class SheenBlock extends NodeMaterialBlock {
  67099. /**
  67100. * Create a new SheenBlock
  67101. * @param name defines the block name
  67102. */
  67103. constructor(name: string);
  67104. /**
  67105. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67106. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67107. * making it easier to setup and tweak the effect
  67108. */
  67109. albedoScaling: boolean;
  67110. /**
  67111. * Defines if the sheen is linked to the sheen color.
  67112. */
  67113. linkSheenWithAlbedo: boolean;
  67114. /**
  67115. * Initialize the block and prepare the context for build
  67116. * @param state defines the state that will be used for the build
  67117. */
  67118. initialize(state: NodeMaterialBuildState): void;
  67119. /**
  67120. * Gets the current class name
  67121. * @returns the class name
  67122. */
  67123. getClassName(): string;
  67124. /**
  67125. * Gets the intensity input component
  67126. */
  67127. get intensity(): NodeMaterialConnectionPoint;
  67128. /**
  67129. * Gets the color input component
  67130. */
  67131. get color(): NodeMaterialConnectionPoint;
  67132. /**
  67133. * Gets the roughness input component
  67134. */
  67135. get roughness(): NodeMaterialConnectionPoint;
  67136. /**
  67137. * Gets the sheen object output component
  67138. */
  67139. get sheen(): NodeMaterialConnectionPoint;
  67140. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67141. /**
  67142. * Gets the main code of the block (fragment side)
  67143. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67144. * @returns the shader code
  67145. */
  67146. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67147. protected _buildBlock(state: NodeMaterialBuildState): this;
  67148. protected _dumpPropertiesCode(): string;
  67149. serialize(): any;
  67150. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67151. }
  67152. }
  67153. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67154. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67155. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67156. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67157. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67158. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67159. import { Scene } from "babylonjs/scene";
  67160. import { Nullable } from "babylonjs/types";
  67161. import { Mesh } from "babylonjs/Meshes/mesh";
  67162. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67163. import { Effect } from "babylonjs/Materials/effect";
  67164. /**
  67165. * Block used to implement the reflectivity module of the PBR material
  67166. */
  67167. export class ReflectivityBlock extends NodeMaterialBlock {
  67168. private _metallicReflectanceColor;
  67169. private _metallicF0Factor;
  67170. /** @hidden */
  67171. _vMetallicReflectanceFactorsName: string;
  67172. /**
  67173. * The property below is set by the main PBR block prior to calling methods of this class.
  67174. */
  67175. /** @hidden */
  67176. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67177. /**
  67178. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67179. */
  67180. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67181. /**
  67182. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67183. */
  67184. useMetallnessFromMetallicTextureBlue: boolean;
  67185. /**
  67186. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67187. */
  67188. useRoughnessFromMetallicTextureAlpha: boolean;
  67189. /**
  67190. * Specifies if the metallic texture contains the roughness information in its green channel.
  67191. */
  67192. useRoughnessFromMetallicTextureGreen: boolean;
  67193. /**
  67194. * Create a new ReflectivityBlock
  67195. * @param name defines the block name
  67196. */
  67197. constructor(name: string);
  67198. /**
  67199. * Initialize the block and prepare the context for build
  67200. * @param state defines the state that will be used for the build
  67201. */
  67202. initialize(state: NodeMaterialBuildState): void;
  67203. /**
  67204. * Gets the current class name
  67205. * @returns the class name
  67206. */
  67207. getClassName(): string;
  67208. /**
  67209. * Gets the metallic input component
  67210. */
  67211. get metallic(): NodeMaterialConnectionPoint;
  67212. /**
  67213. * Gets the roughness input component
  67214. */
  67215. get roughness(): NodeMaterialConnectionPoint;
  67216. /**
  67217. * Gets the texture input component
  67218. */
  67219. get texture(): NodeMaterialConnectionPoint;
  67220. /**
  67221. * Gets the reflectivity object output component
  67222. */
  67223. get reflectivity(): NodeMaterialConnectionPoint;
  67224. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67225. /**
  67226. * Gets the main code of the block (fragment side)
  67227. * @param state current state of the node material building
  67228. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67229. * @returns the shader code
  67230. */
  67231. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67232. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67233. protected _buildBlock(state: NodeMaterialBuildState): this;
  67234. protected _dumpPropertiesCode(): string;
  67235. serialize(): any;
  67236. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67237. }
  67238. }
  67239. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67240. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67241. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67242. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67243. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67245. /**
  67246. * Block used to implement the anisotropy module of the PBR material
  67247. */
  67248. export class AnisotropyBlock extends NodeMaterialBlock {
  67249. /**
  67250. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67251. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67252. * It's less burden on the user side in the editor part.
  67253. */
  67254. /** @hidden */
  67255. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67256. /** @hidden */
  67257. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67258. /**
  67259. * Create a new AnisotropyBlock
  67260. * @param name defines the block name
  67261. */
  67262. constructor(name: string);
  67263. /**
  67264. * Initialize the block and prepare the context for build
  67265. * @param state defines the state that will be used for the build
  67266. */
  67267. initialize(state: NodeMaterialBuildState): void;
  67268. /**
  67269. * Gets the current class name
  67270. * @returns the class name
  67271. */
  67272. getClassName(): string;
  67273. /**
  67274. * Gets the intensity input component
  67275. */
  67276. get intensity(): NodeMaterialConnectionPoint;
  67277. /**
  67278. * Gets the direction input component
  67279. */
  67280. get direction(): NodeMaterialConnectionPoint;
  67281. /**
  67282. * Gets the texture input component
  67283. */
  67284. get texture(): NodeMaterialConnectionPoint;
  67285. /**
  67286. * Gets the uv input component
  67287. */
  67288. get uv(): NodeMaterialConnectionPoint;
  67289. /**
  67290. * Gets the worldTangent input component
  67291. */
  67292. get worldTangent(): NodeMaterialConnectionPoint;
  67293. /**
  67294. * Gets the anisotropy object output component
  67295. */
  67296. get anisotropy(): NodeMaterialConnectionPoint;
  67297. private _generateTBNSpace;
  67298. /**
  67299. * Gets the main code of the block (fragment side)
  67300. * @param state current state of the node material building
  67301. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67302. * @returns the shader code
  67303. */
  67304. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67305. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67306. protected _buildBlock(state: NodeMaterialBuildState): this;
  67307. }
  67308. }
  67309. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67310. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67311. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67312. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67313. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67314. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67315. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67316. import { Nullable } from "babylonjs/types";
  67317. import { Mesh } from "babylonjs/Meshes/mesh";
  67318. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67319. import { Effect } from "babylonjs/Materials/effect";
  67320. /**
  67321. * Block used to implement the clear coat module of the PBR material
  67322. */
  67323. export class ClearCoatBlock extends NodeMaterialBlock {
  67324. private _scene;
  67325. /**
  67326. * Create a new ClearCoatBlock
  67327. * @param name defines the block name
  67328. */
  67329. constructor(name: string);
  67330. /**
  67331. * Initialize the block and prepare the context for build
  67332. * @param state defines the state that will be used for the build
  67333. */
  67334. initialize(state: NodeMaterialBuildState): void;
  67335. /**
  67336. * Gets the current class name
  67337. * @returns the class name
  67338. */
  67339. getClassName(): string;
  67340. /**
  67341. * Gets the intensity input component
  67342. */
  67343. get intensity(): NodeMaterialConnectionPoint;
  67344. /**
  67345. * Gets the roughness input component
  67346. */
  67347. get roughness(): NodeMaterialConnectionPoint;
  67348. /**
  67349. * Gets the ior input component
  67350. */
  67351. get ior(): NodeMaterialConnectionPoint;
  67352. /**
  67353. * Gets the texture input component
  67354. */
  67355. get texture(): NodeMaterialConnectionPoint;
  67356. /**
  67357. * Gets the bump texture input component
  67358. */
  67359. get bumpTexture(): NodeMaterialConnectionPoint;
  67360. /**
  67361. * Gets the uv input component
  67362. */
  67363. get uv(): NodeMaterialConnectionPoint;
  67364. /**
  67365. * Gets the tint color input component
  67366. */
  67367. get tintColor(): NodeMaterialConnectionPoint;
  67368. /**
  67369. * Gets the tint "at distance" input component
  67370. */
  67371. get tintAtDistance(): NodeMaterialConnectionPoint;
  67372. /**
  67373. * Gets the tint thickness input component
  67374. */
  67375. get tintThickness(): NodeMaterialConnectionPoint;
  67376. /**
  67377. * Gets the world tangent input component
  67378. */
  67379. get worldTangent(): NodeMaterialConnectionPoint;
  67380. /**
  67381. * Gets the clear coat object output component
  67382. */
  67383. get clearcoat(): NodeMaterialConnectionPoint;
  67384. autoConfigure(material: NodeMaterial): void;
  67385. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67386. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67387. private _generateTBNSpace;
  67388. /**
  67389. * Gets the main code of the block (fragment side)
  67390. * @param state current state of the node material building
  67391. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67392. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67393. * @param worldPosVarName name of the variable holding the world position
  67394. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67395. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67396. * @param worldNormalVarName name of the variable holding the world normal
  67397. * @returns the shader code
  67398. */
  67399. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67400. protected _buildBlock(state: NodeMaterialBuildState): this;
  67401. }
  67402. }
  67403. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67404. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67405. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67407. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67408. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67409. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67410. import { Nullable } from "babylonjs/types";
  67411. /**
  67412. * Block used to implement the sub surface module of the PBR material
  67413. */
  67414. export class SubSurfaceBlock extends NodeMaterialBlock {
  67415. /**
  67416. * Create a new SubSurfaceBlock
  67417. * @param name defines the block name
  67418. */
  67419. constructor(name: string);
  67420. /**
  67421. * Stores the intensity of the different subsurface effects in the thickness texture.
  67422. * * the green channel is the translucency intensity.
  67423. * * the blue channel is the scattering intensity.
  67424. * * the alpha channel is the refraction intensity.
  67425. */
  67426. useMaskFromThicknessTexture: boolean;
  67427. /**
  67428. * Initialize the block and prepare the context for build
  67429. * @param state defines the state that will be used for the build
  67430. */
  67431. initialize(state: NodeMaterialBuildState): void;
  67432. /**
  67433. * Gets the current class name
  67434. * @returns the class name
  67435. */
  67436. getClassName(): string;
  67437. /**
  67438. * Gets the min thickness input component
  67439. */
  67440. get minThickness(): NodeMaterialConnectionPoint;
  67441. /**
  67442. * Gets the max thickness input component
  67443. */
  67444. get maxThickness(): NodeMaterialConnectionPoint;
  67445. /**
  67446. * Gets the thickness texture component
  67447. */
  67448. get thicknessTexture(): NodeMaterialConnectionPoint;
  67449. /**
  67450. * Gets the tint color input component
  67451. */
  67452. get tintColor(): NodeMaterialConnectionPoint;
  67453. /**
  67454. * Gets the translucency intensity input component
  67455. */
  67456. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67457. /**
  67458. * Gets the translucency diffusion distance input component
  67459. */
  67460. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67461. /**
  67462. * Gets the refraction object parameters
  67463. */
  67464. get refraction(): NodeMaterialConnectionPoint;
  67465. /**
  67466. * Gets the sub surface object output component
  67467. */
  67468. get subsurface(): NodeMaterialConnectionPoint;
  67469. autoConfigure(material: NodeMaterial): void;
  67470. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67471. /**
  67472. * Gets the main code of the block (fragment side)
  67473. * @param state current state of the node material building
  67474. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67475. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67476. * @param worldPosVarName name of the variable holding the world position
  67477. * @returns the shader code
  67478. */
  67479. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67480. protected _buildBlock(state: NodeMaterialBuildState): this;
  67481. }
  67482. }
  67483. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67484. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67485. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67486. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67487. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67488. import { Light } from "babylonjs/Lights/light";
  67489. import { Nullable } from "babylonjs/types";
  67490. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67491. import { Effect } from "babylonjs/Materials/effect";
  67492. import { Mesh } from "babylonjs/Meshes/mesh";
  67493. import { Scene } from "babylonjs/scene";
  67494. /**
  67495. * Block used to implement the PBR metallic/roughness model
  67496. */
  67497. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67498. /**
  67499. * Gets or sets the light associated with this block
  67500. */
  67501. light: Nullable<Light>;
  67502. private _lightId;
  67503. private _scene;
  67504. private _environmentBRDFTexture;
  67505. private _environmentBrdfSamplerName;
  67506. private _vNormalWName;
  67507. private _invertNormalName;
  67508. /**
  67509. * Create a new ReflectionBlock
  67510. * @param name defines the block name
  67511. */
  67512. constructor(name: string);
  67513. /**
  67514. * Intensity of the direct lights e.g. the four lights available in your scene.
  67515. * This impacts both the direct diffuse and specular highlights.
  67516. */
  67517. directIntensity: number;
  67518. /**
  67519. * Intensity of the environment e.g. how much the environment will light the object
  67520. * either through harmonics for rough material or through the refelction for shiny ones.
  67521. */
  67522. environmentIntensity: number;
  67523. /**
  67524. * This is a special control allowing the reduction of the specular highlights coming from the
  67525. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67526. */
  67527. specularIntensity: number;
  67528. /**
  67529. * Defines the falloff type used in this material.
  67530. * It by default is Physical.
  67531. */
  67532. lightFalloff: number;
  67533. /**
  67534. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67535. */
  67536. useAlphaFromAlbedoTexture: boolean;
  67537. /**
  67538. * Specifies that alpha test should be used
  67539. */
  67540. useAlphaTest: boolean;
  67541. /**
  67542. * Defines the alpha limits in alpha test mode.
  67543. */
  67544. alphaTestCutoff: number;
  67545. /**
  67546. * Specifies that alpha blending should be used
  67547. */
  67548. useAlphaBlending: boolean;
  67549. /**
  67550. * Defines if the alpha value should be determined via the rgb values.
  67551. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67552. */
  67553. opacityRGB: boolean;
  67554. /**
  67555. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67556. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67557. */
  67558. useRadianceOverAlpha: boolean;
  67559. /**
  67560. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67561. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67562. */
  67563. useSpecularOverAlpha: boolean;
  67564. /**
  67565. * Enables specular anti aliasing in the PBR shader.
  67566. * It will both interacts on the Geometry for analytical and IBL lighting.
  67567. * It also prefilter the roughness map based on the bump values.
  67568. */
  67569. enableSpecularAntiAliasing: boolean;
  67570. /**
  67571. * Enables realtime filtering on the texture.
  67572. */
  67573. realTimeFiltering: boolean;
  67574. /**
  67575. * Quality switch for realtime filtering
  67576. */
  67577. realTimeFilteringQuality: number;
  67578. /**
  67579. * Defines if the material uses energy conservation.
  67580. */
  67581. useEnergyConservation: boolean;
  67582. /**
  67583. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67584. * too much the area relying on ambient texture to define their ambient occlusion.
  67585. */
  67586. useRadianceOcclusion: boolean;
  67587. /**
  67588. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67589. * makes the reflect vector face the model (under horizon).
  67590. */
  67591. useHorizonOcclusion: boolean;
  67592. /**
  67593. * If set to true, no lighting calculations will be applied.
  67594. */
  67595. unlit: boolean;
  67596. /**
  67597. * Force normal to face away from face.
  67598. */
  67599. forceNormalForward: boolean;
  67600. /**
  67601. * Defines the material debug mode.
  67602. * It helps seeing only some components of the material while troubleshooting.
  67603. */
  67604. debugMode: number;
  67605. /**
  67606. * Specify from where on screen the debug mode should start.
  67607. * The value goes from -1 (full screen) to 1 (not visible)
  67608. * It helps with side by side comparison against the final render
  67609. * This defaults to 0
  67610. */
  67611. debugLimit: number;
  67612. /**
  67613. * As the default viewing range might not be enough (if the ambient is really small for instance)
  67614. * You can use the factor to better multiply the final value.
  67615. */
  67616. debugFactor: number;
  67617. /**
  67618. * Initialize the block and prepare the context for build
  67619. * @param state defines the state that will be used for the build
  67620. */
  67621. initialize(state: NodeMaterialBuildState): void;
  67622. /**
  67623. * Gets the current class name
  67624. * @returns the class name
  67625. */
  67626. getClassName(): string;
  67627. /**
  67628. * Gets the world position input component
  67629. */
  67630. get worldPosition(): NodeMaterialConnectionPoint;
  67631. /**
  67632. * Gets the world normal input component
  67633. */
  67634. get worldNormal(): NodeMaterialConnectionPoint;
  67635. /**
  67636. * Gets the perturbed normal input component
  67637. */
  67638. get perturbedNormal(): NodeMaterialConnectionPoint;
  67639. /**
  67640. * Gets the camera position input component
  67641. */
  67642. get cameraPosition(): NodeMaterialConnectionPoint;
  67643. /**
  67644. * Gets the base color input component
  67645. */
  67646. get baseColor(): NodeMaterialConnectionPoint;
  67647. /**
  67648. * Gets the opacity texture input component
  67649. */
  67650. get opacityTexture(): NodeMaterialConnectionPoint;
  67651. /**
  67652. * Gets the ambient color input component
  67653. */
  67654. get ambientColor(): NodeMaterialConnectionPoint;
  67655. /**
  67656. * Gets the reflectivity object parameters
  67657. */
  67658. get reflectivity(): NodeMaterialConnectionPoint;
  67659. /**
  67660. * Gets the ambient occlusion object parameters
  67661. */
  67662. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67663. /**
  67664. * Gets the reflection object parameters
  67665. */
  67666. get reflection(): NodeMaterialConnectionPoint;
  67667. /**
  67668. * Gets the sheen object parameters
  67669. */
  67670. get sheen(): NodeMaterialConnectionPoint;
  67671. /**
  67672. * Gets the clear coat object parameters
  67673. */
  67674. get clearcoat(): NodeMaterialConnectionPoint;
  67675. /**
  67676. * Gets the sub surface object parameters
  67677. */
  67678. get subsurface(): NodeMaterialConnectionPoint;
  67679. /**
  67680. * Gets the anisotropy object parameters
  67681. */
  67682. get anisotropy(): NodeMaterialConnectionPoint;
  67683. /**
  67684. * Gets the ambient output component
  67685. */
  67686. get ambient(): NodeMaterialConnectionPoint;
  67687. /**
  67688. * Gets the diffuse output component
  67689. */
  67690. get diffuse(): NodeMaterialConnectionPoint;
  67691. /**
  67692. * Gets the specular output component
  67693. */
  67694. get specular(): NodeMaterialConnectionPoint;
  67695. /**
  67696. * Gets the sheen output component
  67697. */
  67698. get sheenDir(): NodeMaterialConnectionPoint;
  67699. /**
  67700. * Gets the clear coat output component
  67701. */
  67702. get clearcoatDir(): NodeMaterialConnectionPoint;
  67703. /**
  67704. * Gets the indirect diffuse output component
  67705. */
  67706. get diffuseIndirect(): NodeMaterialConnectionPoint;
  67707. /**
  67708. * Gets the indirect specular output component
  67709. */
  67710. get specularIndirect(): NodeMaterialConnectionPoint;
  67711. /**
  67712. * Gets the indirect sheen output component
  67713. */
  67714. get sheenIndirect(): NodeMaterialConnectionPoint;
  67715. /**
  67716. * Gets the indirect clear coat output component
  67717. */
  67718. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  67719. /**
  67720. * Gets the refraction output component
  67721. */
  67722. get refraction(): NodeMaterialConnectionPoint;
  67723. /**
  67724. * Gets the global lighting output component
  67725. */
  67726. get lighting(): NodeMaterialConnectionPoint;
  67727. /**
  67728. * Gets the shadow output component
  67729. */
  67730. get shadow(): NodeMaterialConnectionPoint;
  67731. /**
  67732. * Gets the alpha output component
  67733. */
  67734. get alpha(): NodeMaterialConnectionPoint;
  67735. autoConfigure(material: NodeMaterial): void;
  67736. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67737. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  67738. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  67739. private _injectVertexCode;
  67740. /**
  67741. * Gets the code corresponding to the albedo/opacity module
  67742. * @returns the shader code
  67743. */
  67744. getAlbedoOpacityCode(): string;
  67745. protected _buildBlock(state: NodeMaterialBuildState): this;
  67746. protected _dumpPropertiesCode(): string;
  67747. serialize(): any;
  67748. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67749. }
  67750. }
  67751. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  67752. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  67753. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  67754. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  67755. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  67756. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  67757. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67758. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  67759. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  67760. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  67761. }
  67762. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  67763. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  67764. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  67765. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  67766. }
  67767. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  67768. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67769. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67770. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67771. /**
  67772. * Block used to compute value of one parameter modulo another
  67773. */
  67774. export class ModBlock extends NodeMaterialBlock {
  67775. /**
  67776. * Creates a new ModBlock
  67777. * @param name defines the block name
  67778. */
  67779. constructor(name: string);
  67780. /**
  67781. * Gets the current class name
  67782. * @returns the class name
  67783. */
  67784. getClassName(): string;
  67785. /**
  67786. * Gets the left operand input component
  67787. */
  67788. get left(): NodeMaterialConnectionPoint;
  67789. /**
  67790. * Gets the right operand input component
  67791. */
  67792. get right(): NodeMaterialConnectionPoint;
  67793. /**
  67794. * Gets the output component
  67795. */
  67796. get output(): NodeMaterialConnectionPoint;
  67797. protected _buildBlock(state: NodeMaterialBuildState): this;
  67798. }
  67799. }
  67800. declare module "babylonjs/Materials/Node/Blocks/index" {
  67801. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  67802. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  67803. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  67804. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  67805. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  67806. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  67807. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  67808. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  67809. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  67810. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  67811. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  67812. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  67813. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  67814. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  67815. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  67816. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  67817. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  67818. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  67819. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  67820. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  67821. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  67822. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  67823. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  67824. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  67825. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  67826. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  67827. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  67828. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  67829. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  67830. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  67831. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  67832. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  67833. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  67834. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  67835. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  67836. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  67837. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  67838. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  67839. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  67840. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  67841. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  67842. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  67843. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  67844. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  67845. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  67846. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  67847. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  67848. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  67849. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  67850. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  67851. }
  67852. declare module "babylonjs/Materials/Node/Optimizers/index" {
  67853. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  67854. }
  67855. declare module "babylonjs/Materials/Node/index" {
  67856. export * from "babylonjs/Materials/Node/Enums/index";
  67857. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67858. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  67859. export * from "babylonjs/Materials/Node/nodeMaterial";
  67860. export * from "babylonjs/Materials/Node/Blocks/index";
  67861. export * from "babylonjs/Materials/Node/Optimizers/index";
  67862. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  67863. }
  67864. declare module "babylonjs/Materials/index" {
  67865. export * from "babylonjs/Materials/Background/index";
  67866. export * from "babylonjs/Materials/colorCurves";
  67867. export * from "babylonjs/Materials/iEffectFallbacks";
  67868. export * from "babylonjs/Materials/effectFallbacks";
  67869. export * from "babylonjs/Materials/effect";
  67870. export * from "babylonjs/Materials/fresnelParameters";
  67871. export * from "babylonjs/Materials/imageProcessingConfiguration";
  67872. export * from "babylonjs/Materials/material";
  67873. export * from "babylonjs/Materials/materialDefines";
  67874. export * from "babylonjs/Materials/materialHelper";
  67875. export * from "babylonjs/Materials/multiMaterial";
  67876. export * from "babylonjs/Materials/PBR/index";
  67877. export * from "babylonjs/Materials/pushMaterial";
  67878. export * from "babylonjs/Materials/shaderMaterial";
  67879. export * from "babylonjs/Materials/standardMaterial";
  67880. export * from "babylonjs/Materials/Textures/index";
  67881. export * from "babylonjs/Materials/uniformBuffer";
  67882. export * from "babylonjs/Materials/materialFlags";
  67883. export * from "babylonjs/Materials/Node/index";
  67884. export * from "babylonjs/Materials/effectRenderer";
  67885. export * from "babylonjs/Materials/shadowDepthWrapper";
  67886. }
  67887. declare module "babylonjs/Maths/index" {
  67888. export * from "babylonjs/Maths/math.scalar";
  67889. export * from "babylonjs/Maths/math";
  67890. export * from "babylonjs/Maths/sphericalPolynomial";
  67891. }
  67892. declare module "babylonjs/Misc/workerPool" {
  67893. import { IDisposable } from "babylonjs/scene";
  67894. /**
  67895. * Helper class to push actions to a pool of workers.
  67896. */
  67897. export class WorkerPool implements IDisposable {
  67898. private _workerInfos;
  67899. private _pendingActions;
  67900. /**
  67901. * Constructor
  67902. * @param workers Array of workers to use for actions
  67903. */
  67904. constructor(workers: Array<Worker>);
  67905. /**
  67906. * Terminates all workers and clears any pending actions.
  67907. */
  67908. dispose(): void;
  67909. /**
  67910. * Pushes an action to the worker pool. If all the workers are active, the action will be
  67911. * pended until a worker has completed its action.
  67912. * @param action The action to perform. Call onComplete when the action is complete.
  67913. */
  67914. push(action: (worker: Worker, onComplete: () => void) => void): void;
  67915. private _execute;
  67916. }
  67917. }
  67918. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  67919. import { IDisposable } from "babylonjs/scene";
  67920. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  67921. /**
  67922. * Configuration for Draco compression
  67923. */
  67924. export interface IDracoCompressionConfiguration {
  67925. /**
  67926. * Configuration for the decoder.
  67927. */
  67928. decoder: {
  67929. /**
  67930. * The url to the WebAssembly module.
  67931. */
  67932. wasmUrl?: string;
  67933. /**
  67934. * The url to the WebAssembly binary.
  67935. */
  67936. wasmBinaryUrl?: string;
  67937. /**
  67938. * The url to the fallback JavaScript module.
  67939. */
  67940. fallbackUrl?: string;
  67941. };
  67942. }
  67943. /**
  67944. * Draco compression (https://google.github.io/draco/)
  67945. *
  67946. * This class wraps the Draco module.
  67947. *
  67948. * **Encoder**
  67949. *
  67950. * The encoder is not currently implemented.
  67951. *
  67952. * **Decoder**
  67953. *
  67954. * 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.
  67955. *
  67956. * To update the configuration, use the following code:
  67957. * ```javascript
  67958. * DracoCompression.Configuration = {
  67959. * decoder: {
  67960. * wasmUrl: "<url to the WebAssembly library>",
  67961. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  67962. * fallbackUrl: "<url to the fallback JavaScript library>",
  67963. * }
  67964. * };
  67965. * ```
  67966. *
  67967. * 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.
  67968. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  67969. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  67970. *
  67971. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  67972. * ```javascript
  67973. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  67974. * ```
  67975. *
  67976. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  67977. */
  67978. export class DracoCompression implements IDisposable {
  67979. private _workerPoolPromise?;
  67980. private _decoderModulePromise?;
  67981. /**
  67982. * The configuration. Defaults to the following urls:
  67983. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  67984. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  67985. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  67986. */
  67987. static Configuration: IDracoCompressionConfiguration;
  67988. /**
  67989. * Returns true if the decoder configuration is available.
  67990. */
  67991. static get DecoderAvailable(): boolean;
  67992. /**
  67993. * Default number of workers to create when creating the draco compression object.
  67994. */
  67995. static DefaultNumWorkers: number;
  67996. private static GetDefaultNumWorkers;
  67997. private static _Default;
  67998. /**
  67999. * Default instance for the draco compression object.
  68000. */
  68001. static get Default(): DracoCompression;
  68002. /**
  68003. * Constructor
  68004. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68005. */
  68006. constructor(numWorkers?: number);
  68007. /**
  68008. * Stop all async operations and release resources.
  68009. */
  68010. dispose(): void;
  68011. /**
  68012. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68013. * @returns a promise that resolves when ready
  68014. */
  68015. whenReadyAsync(): Promise<void>;
  68016. /**
  68017. * Decode Draco compressed mesh data to vertex data.
  68018. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68019. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68020. * @returns A promise that resolves with the decoded vertex data
  68021. */
  68022. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68023. [kind: string]: number;
  68024. }): Promise<VertexData>;
  68025. }
  68026. }
  68027. declare module "babylonjs/Meshes/Compression/index" {
  68028. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68029. }
  68030. declare module "babylonjs/Meshes/csg" {
  68031. import { Nullable } from "babylonjs/types";
  68032. import { Scene } from "babylonjs/scene";
  68033. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68034. import { Mesh } from "babylonjs/Meshes/mesh";
  68035. import { Material } from "babylonjs/Materials/material";
  68036. /**
  68037. * Class for building Constructive Solid Geometry
  68038. */
  68039. export class CSG {
  68040. private polygons;
  68041. /**
  68042. * The world matrix
  68043. */
  68044. matrix: Matrix;
  68045. /**
  68046. * Stores the position
  68047. */
  68048. position: Vector3;
  68049. /**
  68050. * Stores the rotation
  68051. */
  68052. rotation: Vector3;
  68053. /**
  68054. * Stores the rotation quaternion
  68055. */
  68056. rotationQuaternion: Nullable<Quaternion>;
  68057. /**
  68058. * Stores the scaling vector
  68059. */
  68060. scaling: Vector3;
  68061. /**
  68062. * Convert the Mesh to CSG
  68063. * @param mesh The Mesh to convert to CSG
  68064. * @returns A new CSG from the Mesh
  68065. */
  68066. static FromMesh(mesh: Mesh): CSG;
  68067. /**
  68068. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68069. * @param polygons Polygons used to construct a CSG solid
  68070. */
  68071. private static FromPolygons;
  68072. /**
  68073. * Clones, or makes a deep copy, of the CSG
  68074. * @returns A new CSG
  68075. */
  68076. clone(): CSG;
  68077. /**
  68078. * Unions this CSG with another CSG
  68079. * @param csg The CSG to union against this CSG
  68080. * @returns The unioned CSG
  68081. */
  68082. union(csg: CSG): CSG;
  68083. /**
  68084. * Unions this CSG with another CSG in place
  68085. * @param csg The CSG to union against this CSG
  68086. */
  68087. unionInPlace(csg: CSG): void;
  68088. /**
  68089. * Subtracts this CSG with another CSG
  68090. * @param csg The CSG to subtract against this CSG
  68091. * @returns A new CSG
  68092. */
  68093. subtract(csg: CSG): CSG;
  68094. /**
  68095. * Subtracts this CSG with another CSG in place
  68096. * @param csg The CSG to subtact against this CSG
  68097. */
  68098. subtractInPlace(csg: CSG): void;
  68099. /**
  68100. * Intersect this CSG with another CSG
  68101. * @param csg The CSG to intersect against this CSG
  68102. * @returns A new CSG
  68103. */
  68104. intersect(csg: CSG): CSG;
  68105. /**
  68106. * Intersects this CSG with another CSG in place
  68107. * @param csg The CSG to intersect against this CSG
  68108. */
  68109. intersectInPlace(csg: CSG): void;
  68110. /**
  68111. * Return a new CSG solid with solid and empty space switched. This solid is
  68112. * not modified.
  68113. * @returns A new CSG solid with solid and empty space switched
  68114. */
  68115. inverse(): CSG;
  68116. /**
  68117. * Inverses the CSG in place
  68118. */
  68119. inverseInPlace(): void;
  68120. /**
  68121. * This is used to keep meshes transformations so they can be restored
  68122. * when we build back a Babylon Mesh
  68123. * NB : All CSG operations are performed in world coordinates
  68124. * @param csg The CSG to copy the transform attributes from
  68125. * @returns This CSG
  68126. */
  68127. copyTransformAttributes(csg: CSG): CSG;
  68128. /**
  68129. * Build Raw mesh from CSG
  68130. * Coordinates here are in world space
  68131. * @param name The name of the mesh geometry
  68132. * @param scene The Scene
  68133. * @param keepSubMeshes Specifies if the submeshes should be kept
  68134. * @returns A new Mesh
  68135. */
  68136. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68137. /**
  68138. * Build Mesh from CSG taking material and transforms into account
  68139. * @param name The name of the Mesh
  68140. * @param material The material of the Mesh
  68141. * @param scene The Scene
  68142. * @param keepSubMeshes Specifies if submeshes should be kept
  68143. * @returns The new Mesh
  68144. */
  68145. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68146. }
  68147. }
  68148. declare module "babylonjs/Meshes/trailMesh" {
  68149. import { Mesh } from "babylonjs/Meshes/mesh";
  68150. import { Scene } from "babylonjs/scene";
  68151. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68152. /**
  68153. * Class used to create a trail following a mesh
  68154. */
  68155. export class TrailMesh extends Mesh {
  68156. private _generator;
  68157. private _autoStart;
  68158. private _running;
  68159. private _diameter;
  68160. private _length;
  68161. private _sectionPolygonPointsCount;
  68162. private _sectionVectors;
  68163. private _sectionNormalVectors;
  68164. private _beforeRenderObserver;
  68165. /**
  68166. * @constructor
  68167. * @param name The value used by scene.getMeshByName() to do a lookup.
  68168. * @param generator The mesh or transform node to generate a trail.
  68169. * @param scene The scene to add this mesh to.
  68170. * @param diameter Diameter of trailing mesh. Default is 1.
  68171. * @param length Length of trailing mesh. Default is 60.
  68172. * @param autoStart Automatically start trailing mesh. Default true.
  68173. */
  68174. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68175. /**
  68176. * "TrailMesh"
  68177. * @returns "TrailMesh"
  68178. */
  68179. getClassName(): string;
  68180. private _createMesh;
  68181. /**
  68182. * Start trailing mesh.
  68183. */
  68184. start(): void;
  68185. /**
  68186. * Stop trailing mesh.
  68187. */
  68188. stop(): void;
  68189. /**
  68190. * Update trailing mesh geometry.
  68191. */
  68192. update(): void;
  68193. /**
  68194. * Returns a new TrailMesh object.
  68195. * @param name is a string, the name given to the new mesh
  68196. * @param newGenerator use new generator object for cloned trail mesh
  68197. * @returns a new mesh
  68198. */
  68199. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68200. /**
  68201. * Serializes this trail mesh
  68202. * @param serializationObject object to write serialization to
  68203. */
  68204. serialize(serializationObject: any): void;
  68205. /**
  68206. * Parses a serialized trail mesh
  68207. * @param parsedMesh the serialized mesh
  68208. * @param scene the scene to create the trail mesh in
  68209. * @returns the created trail mesh
  68210. */
  68211. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68212. }
  68213. }
  68214. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68215. import { Nullable } from "babylonjs/types";
  68216. import { Scene } from "babylonjs/scene";
  68217. import { Vector4 } from "babylonjs/Maths/math.vector";
  68218. import { Color4 } from "babylonjs/Maths/math.color";
  68219. import { Mesh } from "babylonjs/Meshes/mesh";
  68220. /**
  68221. * Class containing static functions to help procedurally build meshes
  68222. */
  68223. export class TiledBoxBuilder {
  68224. /**
  68225. * Creates a box mesh
  68226. * 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)
  68227. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68228. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68229. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68230. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68231. * @param name defines the name of the mesh
  68232. * @param options defines the options used to create the mesh
  68233. * @param scene defines the hosting scene
  68234. * @returns the box mesh
  68235. */
  68236. static CreateTiledBox(name: string, options: {
  68237. pattern?: number;
  68238. width?: number;
  68239. height?: number;
  68240. depth?: number;
  68241. tileSize?: number;
  68242. tileWidth?: number;
  68243. tileHeight?: number;
  68244. alignHorizontal?: number;
  68245. alignVertical?: number;
  68246. faceUV?: Vector4[];
  68247. faceColors?: Color4[];
  68248. sideOrientation?: number;
  68249. updatable?: boolean;
  68250. }, scene?: Nullable<Scene>): Mesh;
  68251. }
  68252. }
  68253. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68254. import { Vector4 } from "babylonjs/Maths/math.vector";
  68255. import { Mesh } from "babylonjs/Meshes/mesh";
  68256. /**
  68257. * Class containing static functions to help procedurally build meshes
  68258. */
  68259. export class TorusKnotBuilder {
  68260. /**
  68261. * Creates a torus knot mesh
  68262. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68263. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68264. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68265. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68266. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68267. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68268. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68269. * @param name defines the name of the mesh
  68270. * @param options defines the options used to create the mesh
  68271. * @param scene defines the hosting scene
  68272. * @returns the torus knot mesh
  68273. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68274. */
  68275. static CreateTorusKnot(name: string, options: {
  68276. radius?: number;
  68277. tube?: number;
  68278. radialSegments?: number;
  68279. tubularSegments?: number;
  68280. p?: number;
  68281. q?: number;
  68282. updatable?: boolean;
  68283. sideOrientation?: number;
  68284. frontUVs?: Vector4;
  68285. backUVs?: Vector4;
  68286. }, scene: any): Mesh;
  68287. }
  68288. }
  68289. declare module "babylonjs/Meshes/polygonMesh" {
  68290. import { Scene } from "babylonjs/scene";
  68291. import { Vector2 } from "babylonjs/Maths/math.vector";
  68292. import { Mesh } from "babylonjs/Meshes/mesh";
  68293. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68294. import { Path2 } from "babylonjs/Maths/math.path";
  68295. /**
  68296. * Polygon
  68297. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68298. */
  68299. export class Polygon {
  68300. /**
  68301. * Creates a rectangle
  68302. * @param xmin bottom X coord
  68303. * @param ymin bottom Y coord
  68304. * @param xmax top X coord
  68305. * @param ymax top Y coord
  68306. * @returns points that make the resulting rectation
  68307. */
  68308. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68309. /**
  68310. * Creates a circle
  68311. * @param radius radius of circle
  68312. * @param cx scale in x
  68313. * @param cy scale in y
  68314. * @param numberOfSides number of sides that make up the circle
  68315. * @returns points that make the resulting circle
  68316. */
  68317. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68318. /**
  68319. * Creates a polygon from input string
  68320. * @param input Input polygon data
  68321. * @returns the parsed points
  68322. */
  68323. static Parse(input: string): Vector2[];
  68324. /**
  68325. * Starts building a polygon from x and y coordinates
  68326. * @param x x coordinate
  68327. * @param y y coordinate
  68328. * @returns the started path2
  68329. */
  68330. static StartingAt(x: number, y: number): Path2;
  68331. }
  68332. /**
  68333. * Builds a polygon
  68334. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68335. */
  68336. export class PolygonMeshBuilder {
  68337. private _points;
  68338. private _outlinepoints;
  68339. private _holes;
  68340. private _name;
  68341. private _scene;
  68342. private _epoints;
  68343. private _eholes;
  68344. private _addToepoint;
  68345. /**
  68346. * Babylon reference to the earcut plugin.
  68347. */
  68348. bjsEarcut: any;
  68349. /**
  68350. * Creates a PolygonMeshBuilder
  68351. * @param name name of the builder
  68352. * @param contours Path of the polygon
  68353. * @param scene scene to add to when creating the mesh
  68354. * @param earcutInjection can be used to inject your own earcut reference
  68355. */
  68356. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68357. /**
  68358. * Adds a whole within the polygon
  68359. * @param hole Array of points defining the hole
  68360. * @returns this
  68361. */
  68362. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68363. /**
  68364. * Creates the polygon
  68365. * @param updatable If the mesh should be updatable
  68366. * @param depth The depth of the mesh created
  68367. * @returns the created mesh
  68368. */
  68369. build(updatable?: boolean, depth?: number): Mesh;
  68370. /**
  68371. * Creates the polygon
  68372. * @param depth The depth of the mesh created
  68373. * @returns the created VertexData
  68374. */
  68375. buildVertexData(depth?: number): VertexData;
  68376. /**
  68377. * Adds a side to the polygon
  68378. * @param positions points that make the polygon
  68379. * @param normals normals of the polygon
  68380. * @param uvs uvs of the polygon
  68381. * @param indices indices of the polygon
  68382. * @param bounds bounds of the polygon
  68383. * @param points points of the polygon
  68384. * @param depth depth of the polygon
  68385. * @param flip flip of the polygon
  68386. */
  68387. private addSide;
  68388. }
  68389. }
  68390. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68391. import { Scene } from "babylonjs/scene";
  68392. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68393. import { Color4 } from "babylonjs/Maths/math.color";
  68394. import { Mesh } from "babylonjs/Meshes/mesh";
  68395. import { Nullable } from "babylonjs/types";
  68396. /**
  68397. * Class containing static functions to help procedurally build meshes
  68398. */
  68399. export class PolygonBuilder {
  68400. /**
  68401. * Creates a polygon mesh
  68402. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68403. * * 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
  68404. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68405. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68406. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68407. * * Remember you can only change the shape positions, not their number when updating a polygon
  68408. * @param name defines the name of the mesh
  68409. * @param options defines the options used to create the mesh
  68410. * @param scene defines the hosting scene
  68411. * @param earcutInjection can be used to inject your own earcut reference
  68412. * @returns the polygon mesh
  68413. */
  68414. static CreatePolygon(name: string, options: {
  68415. shape: Vector3[];
  68416. holes?: Vector3[][];
  68417. depth?: number;
  68418. faceUV?: Vector4[];
  68419. faceColors?: Color4[];
  68420. updatable?: boolean;
  68421. sideOrientation?: number;
  68422. frontUVs?: Vector4;
  68423. backUVs?: Vector4;
  68424. wrap?: boolean;
  68425. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68426. /**
  68427. * Creates an extruded polygon mesh, with depth in the Y direction.
  68428. * * 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)
  68429. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68430. * @param name defines the name of the mesh
  68431. * @param options defines the options used to create the mesh
  68432. * @param scene defines the hosting scene
  68433. * @param earcutInjection can be used to inject your own earcut reference
  68434. * @returns the polygon mesh
  68435. */
  68436. static ExtrudePolygon(name: string, options: {
  68437. shape: Vector3[];
  68438. holes?: Vector3[][];
  68439. depth?: number;
  68440. faceUV?: Vector4[];
  68441. faceColors?: Color4[];
  68442. updatable?: boolean;
  68443. sideOrientation?: number;
  68444. frontUVs?: Vector4;
  68445. backUVs?: Vector4;
  68446. wrap?: boolean;
  68447. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68448. }
  68449. }
  68450. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68451. import { Scene } from "babylonjs/scene";
  68452. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68453. import { Mesh } from "babylonjs/Meshes/mesh";
  68454. import { Nullable } from "babylonjs/types";
  68455. /**
  68456. * Class containing static functions to help procedurally build meshes
  68457. */
  68458. export class LatheBuilder {
  68459. /**
  68460. * Creates lathe mesh.
  68461. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68462. * * 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
  68463. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68464. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68465. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68466. * * 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
  68467. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68468. * * 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
  68469. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68470. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68471. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68472. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68473. * @param name defines the name of the mesh
  68474. * @param options defines the options used to create the mesh
  68475. * @param scene defines the hosting scene
  68476. * @returns the lathe mesh
  68477. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68478. */
  68479. static CreateLathe(name: string, options: {
  68480. shape: Vector3[];
  68481. radius?: number;
  68482. tessellation?: number;
  68483. clip?: number;
  68484. arc?: number;
  68485. closed?: boolean;
  68486. updatable?: boolean;
  68487. sideOrientation?: number;
  68488. frontUVs?: Vector4;
  68489. backUVs?: Vector4;
  68490. cap?: number;
  68491. invertUV?: boolean;
  68492. }, scene?: Nullable<Scene>): Mesh;
  68493. }
  68494. }
  68495. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68496. import { Nullable } from "babylonjs/types";
  68497. import { Scene } from "babylonjs/scene";
  68498. import { Vector4 } from "babylonjs/Maths/math.vector";
  68499. import { Mesh } from "babylonjs/Meshes/mesh";
  68500. /**
  68501. * Class containing static functions to help procedurally build meshes
  68502. */
  68503. export class TiledPlaneBuilder {
  68504. /**
  68505. * Creates a tiled plane mesh
  68506. * * The parameter `pattern` will, depending on value, do nothing or
  68507. * * * flip (reflect about central vertical) alternate tiles across and up
  68508. * * * flip every tile on alternate rows
  68509. * * * rotate (180 degs) alternate tiles across and up
  68510. * * * rotate every tile on alternate rows
  68511. * * * flip and rotate alternate tiles across and up
  68512. * * * flip and rotate every tile on alternate rows
  68513. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68514. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68515. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68516. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68517. * * 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)
  68518. * * 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)
  68519. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68520. * @param name defines the name of the mesh
  68521. * @param options defines the options used to create the mesh
  68522. * @param scene defines the hosting scene
  68523. * @returns the box mesh
  68524. */
  68525. static CreateTiledPlane(name: string, options: {
  68526. pattern?: number;
  68527. tileSize?: number;
  68528. tileWidth?: number;
  68529. tileHeight?: number;
  68530. size?: number;
  68531. width?: number;
  68532. height?: number;
  68533. alignHorizontal?: number;
  68534. alignVertical?: number;
  68535. sideOrientation?: number;
  68536. frontUVs?: Vector4;
  68537. backUVs?: Vector4;
  68538. updatable?: boolean;
  68539. }, scene?: Nullable<Scene>): Mesh;
  68540. }
  68541. }
  68542. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68543. import { Nullable } from "babylonjs/types";
  68544. import { Scene } from "babylonjs/scene";
  68545. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68546. import { Mesh } from "babylonjs/Meshes/mesh";
  68547. /**
  68548. * Class containing static functions to help procedurally build meshes
  68549. */
  68550. export class TubeBuilder {
  68551. /**
  68552. * Creates a tube mesh.
  68553. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68554. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68555. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68556. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68557. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68558. * * 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)
  68559. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68560. * * 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
  68561. * * 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
  68562. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68563. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68564. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68565. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68566. * @param name defines the name of the mesh
  68567. * @param options defines the options used to create the mesh
  68568. * @param scene defines the hosting scene
  68569. * @returns the tube mesh
  68570. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68571. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68572. */
  68573. static CreateTube(name: string, options: {
  68574. path: Vector3[];
  68575. radius?: number;
  68576. tessellation?: number;
  68577. radiusFunction?: {
  68578. (i: number, distance: number): number;
  68579. };
  68580. cap?: number;
  68581. arc?: number;
  68582. updatable?: boolean;
  68583. sideOrientation?: number;
  68584. frontUVs?: Vector4;
  68585. backUVs?: Vector4;
  68586. instance?: Mesh;
  68587. invertUV?: boolean;
  68588. }, scene?: Nullable<Scene>): Mesh;
  68589. }
  68590. }
  68591. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  68592. import { Scene } from "babylonjs/scene";
  68593. import { Vector4 } from "babylonjs/Maths/math.vector";
  68594. import { Mesh } from "babylonjs/Meshes/mesh";
  68595. import { Nullable } from "babylonjs/types";
  68596. /**
  68597. * Class containing static functions to help procedurally build meshes
  68598. */
  68599. export class IcoSphereBuilder {
  68600. /**
  68601. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68602. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68603. * * 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`)
  68604. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68605. * * 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
  68606. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68607. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68608. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68609. * @param name defines the name of the mesh
  68610. * @param options defines the options used to create the mesh
  68611. * @param scene defines the hosting scene
  68612. * @returns the icosahedron mesh
  68613. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68614. */
  68615. static CreateIcoSphere(name: string, options: {
  68616. radius?: number;
  68617. radiusX?: number;
  68618. radiusY?: number;
  68619. radiusZ?: number;
  68620. flat?: boolean;
  68621. subdivisions?: number;
  68622. sideOrientation?: number;
  68623. frontUVs?: Vector4;
  68624. backUVs?: Vector4;
  68625. updatable?: boolean;
  68626. }, scene?: Nullable<Scene>): Mesh;
  68627. }
  68628. }
  68629. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  68630. import { Vector3 } from "babylonjs/Maths/math.vector";
  68631. import { Mesh } from "babylonjs/Meshes/mesh";
  68632. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68633. /**
  68634. * Class containing static functions to help procedurally build meshes
  68635. */
  68636. export class DecalBuilder {
  68637. /**
  68638. * Creates a decal mesh.
  68639. * 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
  68640. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  68641. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  68642. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  68643. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  68644. * @param name defines the name of the mesh
  68645. * @param sourceMesh defines the mesh where the decal must be applied
  68646. * @param options defines the options used to create the mesh
  68647. * @param scene defines the hosting scene
  68648. * @returns the decal mesh
  68649. * @see https://doc.babylonjs.com/how_to/decals
  68650. */
  68651. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  68652. position?: Vector3;
  68653. normal?: Vector3;
  68654. size?: Vector3;
  68655. angle?: number;
  68656. }): Mesh;
  68657. }
  68658. }
  68659. declare module "babylonjs/Meshes/meshBuilder" {
  68660. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  68661. import { Nullable } from "babylonjs/types";
  68662. import { Scene } from "babylonjs/scene";
  68663. import { Mesh } from "babylonjs/Meshes/mesh";
  68664. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  68665. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  68666. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68667. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  68668. import { Plane } from "babylonjs/Maths/math.plane";
  68669. /**
  68670. * Class containing static functions to help procedurally build meshes
  68671. */
  68672. export class MeshBuilder {
  68673. /**
  68674. * Creates a box mesh
  68675. * * The parameter `size` sets the size (float) of each box side (default 1)
  68676. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  68677. * * 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)
  68678. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68679. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68680. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68681. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68682. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68683. * @param name defines the name of the mesh
  68684. * @param options defines the options used to create the mesh
  68685. * @param scene defines the hosting scene
  68686. * @returns the box mesh
  68687. */
  68688. static CreateBox(name: string, options: {
  68689. size?: number;
  68690. width?: number;
  68691. height?: number;
  68692. depth?: number;
  68693. faceUV?: Vector4[];
  68694. faceColors?: Color4[];
  68695. sideOrientation?: number;
  68696. frontUVs?: Vector4;
  68697. backUVs?: Vector4;
  68698. wrap?: boolean;
  68699. topBaseAt?: number;
  68700. bottomBaseAt?: number;
  68701. updatable?: boolean;
  68702. }, scene?: Nullable<Scene>): Mesh;
  68703. /**
  68704. * Creates a tiled box mesh
  68705. * * faceTiles sets the pattern, tile size and number of tiles for a face
  68706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68707. * @param name defines the name of the mesh
  68708. * @param options defines the options used to create the mesh
  68709. * @param scene defines the hosting scene
  68710. * @returns the tiled box mesh
  68711. */
  68712. static CreateTiledBox(name: string, options: {
  68713. pattern?: number;
  68714. size?: number;
  68715. width?: number;
  68716. height?: number;
  68717. depth: number;
  68718. tileSize?: number;
  68719. tileWidth?: number;
  68720. tileHeight?: number;
  68721. faceUV?: Vector4[];
  68722. faceColors?: Color4[];
  68723. alignHorizontal?: number;
  68724. alignVertical?: number;
  68725. sideOrientation?: number;
  68726. updatable?: boolean;
  68727. }, scene?: Nullable<Scene>): Mesh;
  68728. /**
  68729. * Creates a sphere mesh
  68730. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  68731. * * 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`)
  68732. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  68733. * * 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
  68734. * * 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)
  68735. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68736. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68738. * @param name defines the name of the mesh
  68739. * @param options defines the options used to create the mesh
  68740. * @param scene defines the hosting scene
  68741. * @returns the sphere mesh
  68742. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  68743. */
  68744. static CreateSphere(name: string, options: {
  68745. segments?: number;
  68746. diameter?: number;
  68747. diameterX?: number;
  68748. diameterY?: number;
  68749. diameterZ?: number;
  68750. arc?: number;
  68751. slice?: number;
  68752. sideOrientation?: number;
  68753. frontUVs?: Vector4;
  68754. backUVs?: Vector4;
  68755. updatable?: boolean;
  68756. }, scene?: Nullable<Scene>): Mesh;
  68757. /**
  68758. * Creates a plane polygonal mesh. By default, this is a disc
  68759. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  68760. * * 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
  68761. * * 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
  68762. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68763. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68764. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68765. * @param name defines the name of the mesh
  68766. * @param options defines the options used to create the mesh
  68767. * @param scene defines the hosting scene
  68768. * @returns the plane polygonal mesh
  68769. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  68770. */
  68771. static CreateDisc(name: string, options: {
  68772. radius?: number;
  68773. tessellation?: number;
  68774. arc?: number;
  68775. updatable?: boolean;
  68776. sideOrientation?: number;
  68777. frontUVs?: Vector4;
  68778. backUVs?: Vector4;
  68779. }, scene?: Nullable<Scene>): Mesh;
  68780. /**
  68781. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68782. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68783. * * 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`)
  68784. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68785. * * 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
  68786. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68787. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68788. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68789. * @param name defines the name of the mesh
  68790. * @param options defines the options used to create the mesh
  68791. * @param scene defines the hosting scene
  68792. * @returns the icosahedron mesh
  68793. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68794. */
  68795. static CreateIcoSphere(name: string, options: {
  68796. radius?: number;
  68797. radiusX?: number;
  68798. radiusY?: number;
  68799. radiusZ?: number;
  68800. flat?: boolean;
  68801. subdivisions?: number;
  68802. sideOrientation?: number;
  68803. frontUVs?: Vector4;
  68804. backUVs?: Vector4;
  68805. updatable?: boolean;
  68806. }, scene?: Nullable<Scene>): Mesh;
  68807. /**
  68808. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68809. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  68810. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  68811. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  68812. * * 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
  68813. * * 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
  68814. * * 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
  68815. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68816. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68817. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68818. * * 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
  68819. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  68820. * * 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
  68821. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  68822. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68823. * @param name defines the name of the mesh
  68824. * @param options defines the options used to create the mesh
  68825. * @param scene defines the hosting scene
  68826. * @returns the ribbon mesh
  68827. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  68828. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68829. */
  68830. static CreateRibbon(name: string, options: {
  68831. pathArray: Vector3[][];
  68832. closeArray?: boolean;
  68833. closePath?: boolean;
  68834. offset?: number;
  68835. updatable?: boolean;
  68836. sideOrientation?: number;
  68837. frontUVs?: Vector4;
  68838. backUVs?: Vector4;
  68839. instance?: Mesh;
  68840. invertUV?: boolean;
  68841. uvs?: Vector2[];
  68842. colors?: Color4[];
  68843. }, scene?: Nullable<Scene>): Mesh;
  68844. /**
  68845. * Creates a cylinder or a cone mesh
  68846. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  68847. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  68848. * * 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.
  68849. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  68850. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  68851. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  68852. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  68853. * * 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).
  68854. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  68855. * * 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).
  68856. * * 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
  68857. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  68858. * * 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
  68859. * * 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.
  68860. * * If `enclose` is false, a ring surface is one element.
  68861. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  68862. * * 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
  68863. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68864. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68865. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68866. * @param name defines the name of the mesh
  68867. * @param options defines the options used to create the mesh
  68868. * @param scene defines the hosting scene
  68869. * @returns the cylinder mesh
  68870. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  68871. */
  68872. static CreateCylinder(name: string, options: {
  68873. height?: number;
  68874. diameterTop?: number;
  68875. diameterBottom?: number;
  68876. diameter?: number;
  68877. tessellation?: number;
  68878. subdivisions?: number;
  68879. arc?: number;
  68880. faceColors?: Color4[];
  68881. faceUV?: Vector4[];
  68882. updatable?: boolean;
  68883. hasRings?: boolean;
  68884. enclose?: boolean;
  68885. cap?: number;
  68886. sideOrientation?: number;
  68887. frontUVs?: Vector4;
  68888. backUVs?: Vector4;
  68889. }, scene?: Nullable<Scene>): Mesh;
  68890. /**
  68891. * Creates a torus mesh
  68892. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  68893. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  68894. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  68895. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68896. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68897. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68898. * @param name defines the name of the mesh
  68899. * @param options defines the options used to create the mesh
  68900. * @param scene defines the hosting scene
  68901. * @returns the torus mesh
  68902. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  68903. */
  68904. static CreateTorus(name: string, options: {
  68905. diameter?: number;
  68906. thickness?: number;
  68907. tessellation?: number;
  68908. updatable?: boolean;
  68909. sideOrientation?: number;
  68910. frontUVs?: Vector4;
  68911. backUVs?: Vector4;
  68912. }, scene?: Nullable<Scene>): Mesh;
  68913. /**
  68914. * Creates a torus knot mesh
  68915. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68916. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68917. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68918. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68919. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68920. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68921. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68922. * @param name defines the name of the mesh
  68923. * @param options defines the options used to create the mesh
  68924. * @param scene defines the hosting scene
  68925. * @returns the torus knot mesh
  68926. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68927. */
  68928. static CreateTorusKnot(name: string, options: {
  68929. radius?: number;
  68930. tube?: number;
  68931. radialSegments?: number;
  68932. tubularSegments?: number;
  68933. p?: number;
  68934. q?: number;
  68935. updatable?: boolean;
  68936. sideOrientation?: number;
  68937. frontUVs?: Vector4;
  68938. backUVs?: Vector4;
  68939. }, scene?: Nullable<Scene>): Mesh;
  68940. /**
  68941. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  68942. * * 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
  68943. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  68944. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  68945. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  68946. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  68947. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  68948. * * 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
  68949. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  68950. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68951. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  68952. * @param name defines the name of the new line system
  68953. * @param options defines the options used to create the line system
  68954. * @param scene defines the hosting scene
  68955. * @returns a new line system mesh
  68956. */
  68957. static CreateLineSystem(name: string, options: {
  68958. lines: Vector3[][];
  68959. updatable?: boolean;
  68960. instance?: Nullable<LinesMesh>;
  68961. colors?: Nullable<Color4[][]>;
  68962. useVertexAlpha?: boolean;
  68963. }, scene: Nullable<Scene>): LinesMesh;
  68964. /**
  68965. * Creates a line mesh
  68966. * 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
  68967. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68968. * * The parameter `points` is an array successive Vector3
  68969. * * 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
  68970. * * The optional parameter `colors` is an array of successive Color4, one per line point
  68971. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  68972. * * When updating an instance, remember that only point positions can change, not the number of points
  68973. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68974. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  68975. * @param name defines the name of the new line system
  68976. * @param options defines the options used to create the line system
  68977. * @param scene defines the hosting scene
  68978. * @returns a new line mesh
  68979. */
  68980. static CreateLines(name: string, options: {
  68981. points: Vector3[];
  68982. updatable?: boolean;
  68983. instance?: Nullable<LinesMesh>;
  68984. colors?: Color4[];
  68985. useVertexAlpha?: boolean;
  68986. }, scene?: Nullable<Scene>): LinesMesh;
  68987. /**
  68988. * Creates a dashed line mesh
  68989. * * 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
  68990. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68991. * * The parameter `points` is an array successive Vector3
  68992. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  68993. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  68994. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  68995. * * 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
  68996. * * When updating an instance, remember that only point positions can change, not the number of points
  68997. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68998. * @param name defines the name of the mesh
  68999. * @param options defines the options used to create the mesh
  69000. * @param scene defines the hosting scene
  69001. * @returns the dashed line mesh
  69002. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69003. */
  69004. static CreateDashedLines(name: string, options: {
  69005. points: Vector3[];
  69006. dashSize?: number;
  69007. gapSize?: number;
  69008. dashNb?: number;
  69009. updatable?: boolean;
  69010. instance?: LinesMesh;
  69011. }, scene?: Nullable<Scene>): LinesMesh;
  69012. /**
  69013. * 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.
  69014. * * 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.
  69015. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69016. * * 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.
  69017. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69018. * * 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
  69019. * * 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
  69020. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69021. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69022. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69023. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69024. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69025. * @param name defines the name of the mesh
  69026. * @param options defines the options used to create the mesh
  69027. * @param scene defines the hosting scene
  69028. * @returns the extruded shape mesh
  69029. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69030. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69031. */
  69032. static ExtrudeShape(name: string, options: {
  69033. shape: Vector3[];
  69034. path: Vector3[];
  69035. scale?: number;
  69036. rotation?: number;
  69037. cap?: number;
  69038. updatable?: boolean;
  69039. sideOrientation?: number;
  69040. frontUVs?: Vector4;
  69041. backUVs?: Vector4;
  69042. instance?: Mesh;
  69043. invertUV?: boolean;
  69044. }, scene?: Nullable<Scene>): Mesh;
  69045. /**
  69046. * Creates an custom extruded shape mesh.
  69047. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69048. * * 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.
  69049. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69050. * * 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
  69051. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69052. * * 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
  69053. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69054. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69055. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69056. * * 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
  69057. * * 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
  69058. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69059. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69060. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69061. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69062. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69063. * @param name defines the name of the mesh
  69064. * @param options defines the options used to create the mesh
  69065. * @param scene defines the hosting scene
  69066. * @returns the custom extruded shape mesh
  69067. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69068. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69069. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69070. */
  69071. static ExtrudeShapeCustom(name: string, options: {
  69072. shape: Vector3[];
  69073. path: Vector3[];
  69074. scaleFunction?: any;
  69075. rotationFunction?: any;
  69076. ribbonCloseArray?: boolean;
  69077. ribbonClosePath?: boolean;
  69078. cap?: number;
  69079. updatable?: boolean;
  69080. sideOrientation?: number;
  69081. frontUVs?: Vector4;
  69082. backUVs?: Vector4;
  69083. instance?: Mesh;
  69084. invertUV?: boolean;
  69085. }, scene?: Nullable<Scene>): Mesh;
  69086. /**
  69087. * Creates lathe mesh.
  69088. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69089. * * 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
  69090. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69091. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69092. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69093. * * 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
  69094. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69095. * * 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
  69096. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69097. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69098. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69099. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69100. * @param name defines the name of the mesh
  69101. * @param options defines the options used to create the mesh
  69102. * @param scene defines the hosting scene
  69103. * @returns the lathe mesh
  69104. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69105. */
  69106. static CreateLathe(name: string, options: {
  69107. shape: Vector3[];
  69108. radius?: number;
  69109. tessellation?: number;
  69110. clip?: number;
  69111. arc?: number;
  69112. closed?: boolean;
  69113. updatable?: boolean;
  69114. sideOrientation?: number;
  69115. frontUVs?: Vector4;
  69116. backUVs?: Vector4;
  69117. cap?: number;
  69118. invertUV?: boolean;
  69119. }, scene?: Nullable<Scene>): Mesh;
  69120. /**
  69121. * Creates a tiled plane mesh
  69122. * * You can set a limited pattern arrangement with the tiles
  69123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69125. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69126. * @param name defines the name of the mesh
  69127. * @param options defines the options used to create the mesh
  69128. * @param scene defines the hosting scene
  69129. * @returns the plane mesh
  69130. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69131. */
  69132. static CreateTiledPlane(name: string, options: {
  69133. pattern?: number;
  69134. tileSize?: number;
  69135. tileWidth?: number;
  69136. tileHeight?: number;
  69137. size?: number;
  69138. width?: number;
  69139. height?: number;
  69140. alignHorizontal?: number;
  69141. alignVertical?: number;
  69142. sideOrientation?: number;
  69143. frontUVs?: Vector4;
  69144. backUVs?: Vector4;
  69145. updatable?: boolean;
  69146. }, scene?: Nullable<Scene>): Mesh;
  69147. /**
  69148. * Creates a plane mesh
  69149. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69150. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69151. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69152. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69153. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69155. * @param name defines the name of the mesh
  69156. * @param options defines the options used to create the mesh
  69157. * @param scene defines the hosting scene
  69158. * @returns the plane mesh
  69159. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69160. */
  69161. static CreatePlane(name: string, options: {
  69162. size?: number;
  69163. width?: number;
  69164. height?: number;
  69165. sideOrientation?: number;
  69166. frontUVs?: Vector4;
  69167. backUVs?: Vector4;
  69168. updatable?: boolean;
  69169. sourcePlane?: Plane;
  69170. }, scene?: Nullable<Scene>): Mesh;
  69171. /**
  69172. * Creates a ground mesh
  69173. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69174. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  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 ground mesh
  69180. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69181. */
  69182. static CreateGround(name: string, options: {
  69183. width?: number;
  69184. height?: number;
  69185. subdivisions?: number;
  69186. subdivisionsX?: number;
  69187. subdivisionsY?: number;
  69188. updatable?: boolean;
  69189. }, scene?: Nullable<Scene>): Mesh;
  69190. /**
  69191. * Creates a tiled ground mesh
  69192. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69193. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69194. * * 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
  69195. * * 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
  69196. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69197. * @param name defines the name of the mesh
  69198. * @param options defines the options used to create the mesh
  69199. * @param scene defines the hosting scene
  69200. * @returns the tiled ground mesh
  69201. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69202. */
  69203. static CreateTiledGround(name: string, options: {
  69204. xmin: number;
  69205. zmin: number;
  69206. xmax: number;
  69207. zmax: number;
  69208. subdivisions?: {
  69209. w: number;
  69210. h: number;
  69211. };
  69212. precision?: {
  69213. w: number;
  69214. h: number;
  69215. };
  69216. updatable?: boolean;
  69217. }, scene?: Nullable<Scene>): Mesh;
  69218. /**
  69219. * Creates a ground mesh from a height map
  69220. * * The parameter `url` sets the URL of the height map image resource.
  69221. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69222. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69223. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69224. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69225. * * 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.
  69226. * * 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).
  69227. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69228. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69229. * @param name defines the name of the mesh
  69230. * @param url defines the url to the height map
  69231. * @param options defines the options used to create the mesh
  69232. * @param scene defines the hosting scene
  69233. * @returns the ground mesh
  69234. * @see https://doc.babylonjs.com/babylon101/height_map
  69235. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69236. */
  69237. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69238. width?: number;
  69239. height?: number;
  69240. subdivisions?: number;
  69241. minHeight?: number;
  69242. maxHeight?: number;
  69243. colorFilter?: Color3;
  69244. alphaFilter?: number;
  69245. updatable?: boolean;
  69246. onReady?: (mesh: GroundMesh) => void;
  69247. }, scene?: Nullable<Scene>): GroundMesh;
  69248. /**
  69249. * Creates a polygon mesh
  69250. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69251. * * 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
  69252. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69253. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69254. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69255. * * Remember you can only change the shape positions, not their number when updating a polygon
  69256. * @param name defines the name of the mesh
  69257. * @param options defines the options used to create the mesh
  69258. * @param scene defines the hosting scene
  69259. * @param earcutInjection can be used to inject your own earcut reference
  69260. * @returns the polygon mesh
  69261. */
  69262. static CreatePolygon(name: string, options: {
  69263. shape: Vector3[];
  69264. holes?: Vector3[][];
  69265. depth?: number;
  69266. faceUV?: Vector4[];
  69267. faceColors?: Color4[];
  69268. updatable?: boolean;
  69269. sideOrientation?: number;
  69270. frontUVs?: Vector4;
  69271. backUVs?: Vector4;
  69272. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69273. /**
  69274. * Creates an extruded polygon mesh, with depth in the Y direction.
  69275. * * 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)
  69276. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  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. * @param earcutInjection can be used to inject your own earcut reference
  69281. * @returns the polygon mesh
  69282. */
  69283. static ExtrudePolygon(name: string, options: {
  69284. shape: Vector3[];
  69285. holes?: Vector3[][];
  69286. depth?: number;
  69287. faceUV?: Vector4[];
  69288. faceColors?: Color4[];
  69289. updatable?: boolean;
  69290. sideOrientation?: number;
  69291. frontUVs?: Vector4;
  69292. backUVs?: Vector4;
  69293. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69294. /**
  69295. * Creates a tube mesh.
  69296. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69297. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69298. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69299. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69300. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69301. * * 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)
  69302. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69303. * * 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
  69304. * * 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
  69305. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69306. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69307. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  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 tube mesh
  69313. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69314. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69315. */
  69316. static CreateTube(name: string, options: {
  69317. path: Vector3[];
  69318. radius?: number;
  69319. tessellation?: number;
  69320. radiusFunction?: {
  69321. (i: number, distance: number): number;
  69322. };
  69323. cap?: number;
  69324. arc?: number;
  69325. updatable?: boolean;
  69326. sideOrientation?: number;
  69327. frontUVs?: Vector4;
  69328. backUVs?: Vector4;
  69329. instance?: Mesh;
  69330. invertUV?: boolean;
  69331. }, scene?: Nullable<Scene>): Mesh;
  69332. /**
  69333. * Creates a polyhedron mesh
  69334. * * 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
  69335. * * The parameter `size` (positive float, default 1) sets the polygon size
  69336. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69337. * * 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`
  69338. * * 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
  69339. * * 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)`)
  69340. * * 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
  69341. * * 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
  69342. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69343. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69344. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69345. * @param name defines the name of the mesh
  69346. * @param options defines the options used to create the mesh
  69347. * @param scene defines the hosting scene
  69348. * @returns the polyhedron mesh
  69349. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69350. */
  69351. static CreatePolyhedron(name: string, options: {
  69352. type?: number;
  69353. size?: number;
  69354. sizeX?: number;
  69355. sizeY?: number;
  69356. sizeZ?: number;
  69357. custom?: any;
  69358. faceUV?: Vector4[];
  69359. faceColors?: Color4[];
  69360. flat?: boolean;
  69361. updatable?: boolean;
  69362. sideOrientation?: number;
  69363. frontUVs?: Vector4;
  69364. backUVs?: Vector4;
  69365. }, scene?: Nullable<Scene>): Mesh;
  69366. /**
  69367. * Creates a decal mesh.
  69368. * 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
  69369. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69370. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69371. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69372. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69373. * @param name defines the name of the mesh
  69374. * @param sourceMesh defines the mesh where the decal must be applied
  69375. * @param options defines the options used to create the mesh
  69376. * @param scene defines the hosting scene
  69377. * @returns the decal mesh
  69378. * @see https://doc.babylonjs.com/how_to/decals
  69379. */
  69380. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69381. position?: Vector3;
  69382. normal?: Vector3;
  69383. size?: Vector3;
  69384. angle?: number;
  69385. }): Mesh;
  69386. }
  69387. }
  69388. declare module "babylonjs/Meshes/meshSimplification" {
  69389. import { Mesh } from "babylonjs/Meshes/mesh";
  69390. /**
  69391. * A simplifier interface for future simplification implementations
  69392. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69393. */
  69394. export interface ISimplifier {
  69395. /**
  69396. * Simplification of a given mesh according to the given settings.
  69397. * Since this requires computation, it is assumed that the function runs async.
  69398. * @param settings The settings of the simplification, including quality and distance
  69399. * @param successCallback A callback that will be called after the mesh was simplified.
  69400. * @param errorCallback in case of an error, this callback will be called. optional.
  69401. */
  69402. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69403. }
  69404. /**
  69405. * Expected simplification settings.
  69406. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69407. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69408. */
  69409. export interface ISimplificationSettings {
  69410. /**
  69411. * Gets or sets the expected quality
  69412. */
  69413. quality: number;
  69414. /**
  69415. * Gets or sets the distance when this optimized version should be used
  69416. */
  69417. distance: number;
  69418. /**
  69419. * Gets an already optimized mesh
  69420. */
  69421. optimizeMesh?: boolean;
  69422. }
  69423. /**
  69424. * Class used to specify simplification options
  69425. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69426. */
  69427. export class SimplificationSettings implements ISimplificationSettings {
  69428. /** expected quality */
  69429. quality: number;
  69430. /** distance when this optimized version should be used */
  69431. distance: number;
  69432. /** already optimized mesh */
  69433. optimizeMesh?: boolean | undefined;
  69434. /**
  69435. * Creates a SimplificationSettings
  69436. * @param quality expected quality
  69437. * @param distance distance when this optimized version should be used
  69438. * @param optimizeMesh already optimized mesh
  69439. */
  69440. constructor(
  69441. /** expected quality */
  69442. quality: number,
  69443. /** distance when this optimized version should be used */
  69444. distance: number,
  69445. /** already optimized mesh */
  69446. optimizeMesh?: boolean | undefined);
  69447. }
  69448. /**
  69449. * Interface used to define a simplification task
  69450. */
  69451. export interface ISimplificationTask {
  69452. /**
  69453. * Array of settings
  69454. */
  69455. settings: Array<ISimplificationSettings>;
  69456. /**
  69457. * Simplification type
  69458. */
  69459. simplificationType: SimplificationType;
  69460. /**
  69461. * Mesh to simplify
  69462. */
  69463. mesh: Mesh;
  69464. /**
  69465. * Callback called on success
  69466. */
  69467. successCallback?: () => void;
  69468. /**
  69469. * Defines if parallel processing can be used
  69470. */
  69471. parallelProcessing: boolean;
  69472. }
  69473. /**
  69474. * Queue used to order the simplification tasks
  69475. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69476. */
  69477. export class SimplificationQueue {
  69478. private _simplificationArray;
  69479. /**
  69480. * Gets a boolean indicating that the process is still running
  69481. */
  69482. running: boolean;
  69483. /**
  69484. * Creates a new queue
  69485. */
  69486. constructor();
  69487. /**
  69488. * Adds a new simplification task
  69489. * @param task defines a task to add
  69490. */
  69491. addTask(task: ISimplificationTask): void;
  69492. /**
  69493. * Execute next task
  69494. */
  69495. executeNext(): void;
  69496. /**
  69497. * Execute a simplification task
  69498. * @param task defines the task to run
  69499. */
  69500. runSimplification(task: ISimplificationTask): void;
  69501. private getSimplifier;
  69502. }
  69503. /**
  69504. * The implemented types of simplification
  69505. * At the moment only Quadratic Error Decimation is implemented
  69506. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69507. */
  69508. export enum SimplificationType {
  69509. /** Quadratic error decimation */
  69510. QUADRATIC = 0
  69511. }
  69512. /**
  69513. * An implementation of the Quadratic Error simplification algorithm.
  69514. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69515. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69516. * @author RaananW
  69517. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69518. */
  69519. export class QuadraticErrorSimplification implements ISimplifier {
  69520. private _mesh;
  69521. private triangles;
  69522. private vertices;
  69523. private references;
  69524. private _reconstructedMesh;
  69525. /** Gets or sets the number pf sync interations */
  69526. syncIterations: number;
  69527. /** Gets or sets the aggressiveness of the simplifier */
  69528. aggressiveness: number;
  69529. /** Gets or sets the number of allowed iterations for decimation */
  69530. decimationIterations: number;
  69531. /** Gets or sets the espilon to use for bounding box computation */
  69532. boundingBoxEpsilon: number;
  69533. /**
  69534. * Creates a new QuadraticErrorSimplification
  69535. * @param _mesh defines the target mesh
  69536. */
  69537. constructor(_mesh: Mesh);
  69538. /**
  69539. * Simplification of a given mesh according to the given settings.
  69540. * Since this requires computation, it is assumed that the function runs async.
  69541. * @param settings The settings of the simplification, including quality and distance
  69542. * @param successCallback A callback that will be called after the mesh was simplified.
  69543. */
  69544. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69545. private runDecimation;
  69546. private initWithMesh;
  69547. private init;
  69548. private reconstructMesh;
  69549. private initDecimatedMesh;
  69550. private isFlipped;
  69551. private updateTriangles;
  69552. private identifyBorder;
  69553. private updateMesh;
  69554. private vertexError;
  69555. private calculateError;
  69556. }
  69557. }
  69558. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69559. import { Scene } from "babylonjs/scene";
  69560. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69561. import { ISceneComponent } from "babylonjs/sceneComponent";
  69562. module "babylonjs/scene" {
  69563. interface Scene {
  69564. /** @hidden (Backing field) */
  69565. _simplificationQueue: SimplificationQueue;
  69566. /**
  69567. * Gets or sets the simplification queue attached to the scene
  69568. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69569. */
  69570. simplificationQueue: SimplificationQueue;
  69571. }
  69572. }
  69573. module "babylonjs/Meshes/mesh" {
  69574. interface Mesh {
  69575. /**
  69576. * Simplify the mesh according to the given array of settings.
  69577. * Function will return immediately and will simplify async
  69578. * @param settings a collection of simplification settings
  69579. * @param parallelProcessing should all levels calculate parallel or one after the other
  69580. * @param simplificationType the type of simplification to run
  69581. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69582. * @returns the current mesh
  69583. */
  69584. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69585. }
  69586. }
  69587. /**
  69588. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  69589. * created in a scene
  69590. */
  69591. export class SimplicationQueueSceneComponent implements ISceneComponent {
  69592. /**
  69593. * The component name helpfull to identify the component in the list of scene components.
  69594. */
  69595. readonly name: string;
  69596. /**
  69597. * The scene the component belongs to.
  69598. */
  69599. scene: Scene;
  69600. /**
  69601. * Creates a new instance of the component for the given scene
  69602. * @param scene Defines the scene to register the component in
  69603. */
  69604. constructor(scene: Scene);
  69605. /**
  69606. * Registers the component in a given scene
  69607. */
  69608. register(): void;
  69609. /**
  69610. * Rebuilds the elements related to this component in case of
  69611. * context lost for instance.
  69612. */
  69613. rebuild(): void;
  69614. /**
  69615. * Disposes the component and the associated ressources
  69616. */
  69617. dispose(): void;
  69618. private _beforeCameraUpdate;
  69619. }
  69620. }
  69621. declare module "babylonjs/Meshes/Builders/index" {
  69622. export * from "babylonjs/Meshes/Builders/boxBuilder";
  69623. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  69624. export * from "babylonjs/Meshes/Builders/discBuilder";
  69625. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  69626. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  69627. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  69628. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  69629. export * from "babylonjs/Meshes/Builders/torusBuilder";
  69630. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  69631. export * from "babylonjs/Meshes/Builders/linesBuilder";
  69632. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  69633. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  69634. export * from "babylonjs/Meshes/Builders/latheBuilder";
  69635. export * from "babylonjs/Meshes/Builders/planeBuilder";
  69636. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  69637. export * from "babylonjs/Meshes/Builders/groundBuilder";
  69638. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  69639. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  69640. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  69641. export * from "babylonjs/Meshes/Builders/decalBuilder";
  69642. }
  69643. declare module "babylonjs/Meshes/thinInstanceMesh" {
  69644. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  69645. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  69646. import { Matrix } from "babylonjs/Maths/math.vector";
  69647. module "babylonjs/Meshes/mesh" {
  69648. interface Mesh {
  69649. /**
  69650. * Creates a new thin instance
  69651. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  69652. * @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
  69653. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  69654. */
  69655. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  69656. /**
  69657. * Adds the transformation (matrix) of the current mesh as a thin instance
  69658. * @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
  69659. * @returns the thin instance index number
  69660. */
  69661. thinInstanceAddSelf(refresh: boolean): number;
  69662. /**
  69663. * Registers a custom attribute to be used with thin instances
  69664. * @param kind name of the attribute
  69665. * @param stride size in floats of the attribute
  69666. */
  69667. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  69668. /**
  69669. * Sets the matrix of a thin instance
  69670. * @param index index of the thin instance
  69671. * @param matrix matrix to set
  69672. * @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
  69673. */
  69674. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  69675. /**
  69676. * Sets the value of a custom attribute for a thin instance
  69677. * @param kind name of the attribute
  69678. * @param index index of the thin instance
  69679. * @param value value to set
  69680. * @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
  69681. */
  69682. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  69683. /**
  69684. * 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.
  69685. */
  69686. thinInstanceCount: number;
  69687. /**
  69688. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  69689. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  69690. * @param buffer buffer to set
  69691. * @param stride size in floats of each value of the buffer
  69692. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  69693. */
  69694. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  69695. /**
  69696. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  69697. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  69698. */
  69699. thinInstanceBufferUpdated(kind: string): void;
  69700. /**
  69701. * Refreshes the bounding info, taking into account all the thin instances defined
  69702. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  69703. */
  69704. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  69705. /** @hidden */
  69706. _thinInstanceInitializeUserStorage(): void;
  69707. /** @hidden */
  69708. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  69709. /** @hidden */
  69710. _userThinInstanceBuffersStorage: {
  69711. data: {
  69712. [key: string]: Float32Array;
  69713. };
  69714. sizes: {
  69715. [key: string]: number;
  69716. };
  69717. vertexBuffers: {
  69718. [key: string]: Nullable<VertexBuffer>;
  69719. };
  69720. strides: {
  69721. [key: string]: number;
  69722. };
  69723. };
  69724. }
  69725. }
  69726. }
  69727. declare module "babylonjs/Meshes/index" {
  69728. export * from "babylonjs/Meshes/abstractMesh";
  69729. export * from "babylonjs/Meshes/buffer";
  69730. export * from "babylonjs/Meshes/Compression/index";
  69731. export * from "babylonjs/Meshes/csg";
  69732. export * from "babylonjs/Meshes/geometry";
  69733. export * from "babylonjs/Meshes/groundMesh";
  69734. export * from "babylonjs/Meshes/trailMesh";
  69735. export * from "babylonjs/Meshes/instancedMesh";
  69736. export * from "babylonjs/Meshes/linesMesh";
  69737. export * from "babylonjs/Meshes/mesh";
  69738. export * from "babylonjs/Meshes/mesh.vertexData";
  69739. export * from "babylonjs/Meshes/meshBuilder";
  69740. export * from "babylonjs/Meshes/meshSimplification";
  69741. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  69742. export * from "babylonjs/Meshes/polygonMesh";
  69743. export * from "babylonjs/Meshes/subMesh";
  69744. export * from "babylonjs/Meshes/meshLODLevel";
  69745. export * from "babylonjs/Meshes/transformNode";
  69746. export * from "babylonjs/Meshes/Builders/index";
  69747. export * from "babylonjs/Meshes/dataBuffer";
  69748. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  69749. import "babylonjs/Meshes/thinInstanceMesh";
  69750. export * from "babylonjs/Meshes/thinInstanceMesh";
  69751. }
  69752. declare module "babylonjs/Morph/index" {
  69753. export * from "babylonjs/Morph/morphTarget";
  69754. export * from "babylonjs/Morph/morphTargetManager";
  69755. }
  69756. declare module "babylonjs/Navigation/INavigationEngine" {
  69757. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69758. import { Vector3 } from "babylonjs/Maths/math";
  69759. import { Mesh } from "babylonjs/Meshes/mesh";
  69760. import { Scene } from "babylonjs/scene";
  69761. /**
  69762. * Navigation plugin interface to add navigation constrained by a navigation mesh
  69763. */
  69764. export interface INavigationEnginePlugin {
  69765. /**
  69766. * plugin name
  69767. */
  69768. name: string;
  69769. /**
  69770. * Creates a navigation mesh
  69771. * @param meshes array of all the geometry used to compute the navigatio mesh
  69772. * @param parameters bunch of parameters used to filter geometry
  69773. */
  69774. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  69775. /**
  69776. * Create a navigation mesh debug mesh
  69777. * @param scene is where the mesh will be added
  69778. * @returns debug display mesh
  69779. */
  69780. createDebugNavMesh(scene: Scene): Mesh;
  69781. /**
  69782. * Get a navigation mesh constrained position, closest to the parameter position
  69783. * @param position world position
  69784. * @returns the closest point to position constrained by the navigation mesh
  69785. */
  69786. getClosestPoint(position: Vector3): Vector3;
  69787. /**
  69788. * Get a navigation mesh constrained position, closest to the parameter position
  69789. * @param position world position
  69790. * @param result output the closest point to position constrained by the navigation mesh
  69791. */
  69792. getClosestPointToRef(position: Vector3, result: Vector3): void;
  69793. /**
  69794. * Get a navigation mesh constrained position, within a particular radius
  69795. * @param position world position
  69796. * @param maxRadius the maximum distance to the constrained world position
  69797. * @returns the closest point to position constrained by the navigation mesh
  69798. */
  69799. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  69800. /**
  69801. * Get a navigation mesh constrained position, within a particular radius
  69802. * @param position world position
  69803. * @param maxRadius the maximum distance to the constrained world position
  69804. * @param result output the closest point to position constrained by the navigation mesh
  69805. */
  69806. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  69807. /**
  69808. * Compute the final position from a segment made of destination-position
  69809. * @param position world position
  69810. * @param destination world position
  69811. * @returns the resulting point along the navmesh
  69812. */
  69813. moveAlong(position: Vector3, destination: Vector3): Vector3;
  69814. /**
  69815. * Compute the final position from a segment made of destination-position
  69816. * @param position world position
  69817. * @param destination world position
  69818. * @param result output the resulting point along the navmesh
  69819. */
  69820. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  69821. /**
  69822. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  69823. * @param start world position
  69824. * @param end world position
  69825. * @returns array containing world position composing the path
  69826. */
  69827. computePath(start: Vector3, end: Vector3): Vector3[];
  69828. /**
  69829. * If this plugin is supported
  69830. * @returns true if plugin is supported
  69831. */
  69832. isSupported(): boolean;
  69833. /**
  69834. * Create a new Crowd so you can add agents
  69835. * @param maxAgents the maximum agent count in the crowd
  69836. * @param maxAgentRadius the maximum radius an agent can have
  69837. * @param scene to attach the crowd to
  69838. * @returns the crowd you can add agents to
  69839. */
  69840. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  69841. /**
  69842. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69843. * The queries will try to find a solution within those bounds
  69844. * default is (1,1,1)
  69845. * @param extent x,y,z value that define the extent around the queries point of reference
  69846. */
  69847. setDefaultQueryExtent(extent: Vector3): void;
  69848. /**
  69849. * Get the Bounding box extent specified by setDefaultQueryExtent
  69850. * @returns the box extent values
  69851. */
  69852. getDefaultQueryExtent(): Vector3;
  69853. /**
  69854. * build the navmesh from a previously saved state using getNavmeshData
  69855. * @param data the Uint8Array returned by getNavmeshData
  69856. */
  69857. buildFromNavmeshData(data: Uint8Array): void;
  69858. /**
  69859. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  69860. * @returns data the Uint8Array that can be saved and reused
  69861. */
  69862. getNavmeshData(): Uint8Array;
  69863. /**
  69864. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69865. * @param result output the box extent values
  69866. */
  69867. getDefaultQueryExtentToRef(result: Vector3): void;
  69868. /**
  69869. * Release all resources
  69870. */
  69871. dispose(): void;
  69872. }
  69873. /**
  69874. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  69875. */
  69876. export interface ICrowd {
  69877. /**
  69878. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  69879. * You can attach anything to that node. The node position is updated in the scene update tick.
  69880. * @param pos world position that will be constrained by the navigation mesh
  69881. * @param parameters agent parameters
  69882. * @param transform hooked to the agent that will be update by the scene
  69883. * @returns agent index
  69884. */
  69885. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  69886. /**
  69887. * Returns the agent position in world space
  69888. * @param index agent index returned by addAgent
  69889. * @returns world space position
  69890. */
  69891. getAgentPosition(index: number): Vector3;
  69892. /**
  69893. * Gets the agent position result in world space
  69894. * @param index agent index returned by addAgent
  69895. * @param result output world space position
  69896. */
  69897. getAgentPositionToRef(index: number, result: Vector3): void;
  69898. /**
  69899. * Gets the agent velocity in world space
  69900. * @param index agent index returned by addAgent
  69901. * @returns world space velocity
  69902. */
  69903. getAgentVelocity(index: number): Vector3;
  69904. /**
  69905. * Gets the agent velocity result in world space
  69906. * @param index agent index returned by addAgent
  69907. * @param result output world space velocity
  69908. */
  69909. getAgentVelocityToRef(index: number, result: Vector3): void;
  69910. /**
  69911. * remove a particular agent previously created
  69912. * @param index agent index returned by addAgent
  69913. */
  69914. removeAgent(index: number): void;
  69915. /**
  69916. * get the list of all agents attached to this crowd
  69917. * @returns list of agent indices
  69918. */
  69919. getAgents(): number[];
  69920. /**
  69921. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  69922. * @param deltaTime in seconds
  69923. */
  69924. update(deltaTime: number): void;
  69925. /**
  69926. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  69927. * @param index agent index returned by addAgent
  69928. * @param destination targeted world position
  69929. */
  69930. agentGoto(index: number, destination: Vector3): void;
  69931. /**
  69932. * Teleport the agent to a new position
  69933. * @param index agent index returned by addAgent
  69934. * @param destination targeted world position
  69935. */
  69936. agentTeleport(index: number, destination: Vector3): void;
  69937. /**
  69938. * Update agent parameters
  69939. * @param index agent index returned by addAgent
  69940. * @param parameters agent parameters
  69941. */
  69942. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  69943. /**
  69944. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69945. * The queries will try to find a solution within those bounds
  69946. * default is (1,1,1)
  69947. * @param extent x,y,z value that define the extent around the queries point of reference
  69948. */
  69949. setDefaultQueryExtent(extent: Vector3): void;
  69950. /**
  69951. * Get the Bounding box extent specified by setDefaultQueryExtent
  69952. * @returns the box extent values
  69953. */
  69954. getDefaultQueryExtent(): Vector3;
  69955. /**
  69956. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69957. * @param result output the box extent values
  69958. */
  69959. getDefaultQueryExtentToRef(result: Vector3): void;
  69960. /**
  69961. * Release all resources
  69962. */
  69963. dispose(): void;
  69964. }
  69965. /**
  69966. * Configures an agent
  69967. */
  69968. export interface IAgentParameters {
  69969. /**
  69970. * Agent radius. [Limit: >= 0]
  69971. */
  69972. radius: number;
  69973. /**
  69974. * Agent height. [Limit: > 0]
  69975. */
  69976. height: number;
  69977. /**
  69978. * Maximum allowed acceleration. [Limit: >= 0]
  69979. */
  69980. maxAcceleration: number;
  69981. /**
  69982. * Maximum allowed speed. [Limit: >= 0]
  69983. */
  69984. maxSpeed: number;
  69985. /**
  69986. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  69987. */
  69988. collisionQueryRange: number;
  69989. /**
  69990. * The path visibility optimization range. [Limit: > 0]
  69991. */
  69992. pathOptimizationRange: number;
  69993. /**
  69994. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  69995. */
  69996. separationWeight: number;
  69997. }
  69998. /**
  69999. * Configures the navigation mesh creation
  70000. */
  70001. export interface INavMeshParameters {
  70002. /**
  70003. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70004. */
  70005. cs: number;
  70006. /**
  70007. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70008. */
  70009. ch: number;
  70010. /**
  70011. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70012. */
  70013. walkableSlopeAngle: number;
  70014. /**
  70015. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70016. * be considered walkable. [Limit: >= 3] [Units: vx]
  70017. */
  70018. walkableHeight: number;
  70019. /**
  70020. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70021. */
  70022. walkableClimb: number;
  70023. /**
  70024. * The distance to erode/shrink the walkable area of the heightfield away from
  70025. * obstructions. [Limit: >=0] [Units: vx]
  70026. */
  70027. walkableRadius: number;
  70028. /**
  70029. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70030. */
  70031. maxEdgeLen: number;
  70032. /**
  70033. * The maximum distance a simplfied contour's border edges should deviate
  70034. * the original raw contour. [Limit: >=0] [Units: vx]
  70035. */
  70036. maxSimplificationError: number;
  70037. /**
  70038. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70039. */
  70040. minRegionArea: number;
  70041. /**
  70042. * Any regions with a span count smaller than this value will, if possible,
  70043. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70044. */
  70045. mergeRegionArea: number;
  70046. /**
  70047. * The maximum number of vertices allowed for polygons generated during the
  70048. * contour to polygon conversion process. [Limit: >= 3]
  70049. */
  70050. maxVertsPerPoly: number;
  70051. /**
  70052. * Sets the sampling distance to use when generating the detail mesh.
  70053. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70054. */
  70055. detailSampleDist: number;
  70056. /**
  70057. * The maximum distance the detail mesh surface should deviate from heightfield
  70058. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70059. */
  70060. detailSampleMaxError: number;
  70061. }
  70062. }
  70063. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70064. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70065. import { Mesh } from "babylonjs/Meshes/mesh";
  70066. import { Scene } from "babylonjs/scene";
  70067. import { Vector3 } from "babylonjs/Maths/math";
  70068. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70069. /**
  70070. * RecastJS navigation plugin
  70071. */
  70072. export class RecastJSPlugin implements INavigationEnginePlugin {
  70073. /**
  70074. * Reference to the Recast library
  70075. */
  70076. bjsRECAST: any;
  70077. /**
  70078. * plugin name
  70079. */
  70080. name: string;
  70081. /**
  70082. * the first navmesh created. We might extend this to support multiple navmeshes
  70083. */
  70084. navMesh: any;
  70085. /**
  70086. * Initializes the recastJS plugin
  70087. * @param recastInjection can be used to inject your own recast reference
  70088. */
  70089. constructor(recastInjection?: any);
  70090. /**
  70091. * Creates a navigation mesh
  70092. * @param meshes array of all the geometry used to compute the navigatio mesh
  70093. * @param parameters bunch of parameters used to filter geometry
  70094. */
  70095. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70096. /**
  70097. * Create a navigation mesh debug mesh
  70098. * @param scene is where the mesh will be added
  70099. * @returns debug display mesh
  70100. */
  70101. createDebugNavMesh(scene: Scene): Mesh;
  70102. /**
  70103. * Get a navigation mesh constrained position, closest to the parameter position
  70104. * @param position world position
  70105. * @returns the closest point to position constrained by the navigation mesh
  70106. */
  70107. getClosestPoint(position: Vector3): Vector3;
  70108. /**
  70109. * Get a navigation mesh constrained position, closest to the parameter position
  70110. * @param position world position
  70111. * @param result output the closest point to position constrained by the navigation mesh
  70112. */
  70113. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70114. /**
  70115. * Get a navigation mesh constrained position, within a particular radius
  70116. * @param position world position
  70117. * @param maxRadius the maximum distance to the constrained world position
  70118. * @returns the closest point to position constrained by the navigation mesh
  70119. */
  70120. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70121. /**
  70122. * Get a navigation mesh constrained position, within a particular radius
  70123. * @param position world position
  70124. * @param maxRadius the maximum distance to the constrained world position
  70125. * @param result output the closest point to position constrained by the navigation mesh
  70126. */
  70127. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70128. /**
  70129. * Compute the final position from a segment made of destination-position
  70130. * @param position world position
  70131. * @param destination world position
  70132. * @returns the resulting point along the navmesh
  70133. */
  70134. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70135. /**
  70136. * Compute the final position from a segment made of destination-position
  70137. * @param position world position
  70138. * @param destination world position
  70139. * @param result output the resulting point along the navmesh
  70140. */
  70141. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70142. /**
  70143. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70144. * @param start world position
  70145. * @param end world position
  70146. * @returns array containing world position composing the path
  70147. */
  70148. computePath(start: Vector3, end: Vector3): Vector3[];
  70149. /**
  70150. * Create a new Crowd so you can add agents
  70151. * @param maxAgents the maximum agent count in the crowd
  70152. * @param maxAgentRadius the maximum radius an agent can have
  70153. * @param scene to attach the crowd to
  70154. * @returns the crowd you can add agents to
  70155. */
  70156. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70157. /**
  70158. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70159. * The queries will try to find a solution within those bounds
  70160. * default is (1,1,1)
  70161. * @param extent x,y,z value that define the extent around the queries point of reference
  70162. */
  70163. setDefaultQueryExtent(extent: Vector3): void;
  70164. /**
  70165. * Get the Bounding box extent specified by setDefaultQueryExtent
  70166. * @returns the box extent values
  70167. */
  70168. getDefaultQueryExtent(): Vector3;
  70169. /**
  70170. * build the navmesh from a previously saved state using getNavmeshData
  70171. * @param data the Uint8Array returned by getNavmeshData
  70172. */
  70173. buildFromNavmeshData(data: Uint8Array): void;
  70174. /**
  70175. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70176. * @returns data the Uint8Array that can be saved and reused
  70177. */
  70178. getNavmeshData(): Uint8Array;
  70179. /**
  70180. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70181. * @param result output the box extent values
  70182. */
  70183. getDefaultQueryExtentToRef(result: Vector3): void;
  70184. /**
  70185. * Disposes
  70186. */
  70187. dispose(): void;
  70188. /**
  70189. * If this plugin is supported
  70190. * @returns true if plugin is supported
  70191. */
  70192. isSupported(): boolean;
  70193. }
  70194. /**
  70195. * Recast detour crowd implementation
  70196. */
  70197. export class RecastJSCrowd implements ICrowd {
  70198. /**
  70199. * Recast/detour plugin
  70200. */
  70201. bjsRECASTPlugin: RecastJSPlugin;
  70202. /**
  70203. * Link to the detour crowd
  70204. */
  70205. recastCrowd: any;
  70206. /**
  70207. * One transform per agent
  70208. */
  70209. transforms: TransformNode[];
  70210. /**
  70211. * All agents created
  70212. */
  70213. agents: number[];
  70214. /**
  70215. * Link to the scene is kept to unregister the crowd from the scene
  70216. */
  70217. private _scene;
  70218. /**
  70219. * Observer for crowd updates
  70220. */
  70221. private _onBeforeAnimationsObserver;
  70222. /**
  70223. * Constructor
  70224. * @param plugin recastJS plugin
  70225. * @param maxAgents the maximum agent count in the crowd
  70226. * @param maxAgentRadius the maximum radius an agent can have
  70227. * @param scene to attach the crowd to
  70228. * @returns the crowd you can add agents to
  70229. */
  70230. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70231. /**
  70232. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70233. * You can attach anything to that node. The node position is updated in the scene update tick.
  70234. * @param pos world position that will be constrained by the navigation mesh
  70235. * @param parameters agent parameters
  70236. * @param transform hooked to the agent that will be update by the scene
  70237. * @returns agent index
  70238. */
  70239. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70240. /**
  70241. * Returns the agent position in world space
  70242. * @param index agent index returned by addAgent
  70243. * @returns world space position
  70244. */
  70245. getAgentPosition(index: number): Vector3;
  70246. /**
  70247. * Returns the agent position result in world space
  70248. * @param index agent index returned by addAgent
  70249. * @param result output world space position
  70250. */
  70251. getAgentPositionToRef(index: number, result: Vector3): void;
  70252. /**
  70253. * Returns the agent velocity in world space
  70254. * @param index agent index returned by addAgent
  70255. * @returns world space velocity
  70256. */
  70257. getAgentVelocity(index: number): Vector3;
  70258. /**
  70259. * Returns the agent velocity result in world space
  70260. * @param index agent index returned by addAgent
  70261. * @param result output world space velocity
  70262. */
  70263. getAgentVelocityToRef(index: number, result: Vector3): void;
  70264. /**
  70265. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70266. * @param index agent index returned by addAgent
  70267. * @param destination targeted world position
  70268. */
  70269. agentGoto(index: number, destination: Vector3): void;
  70270. /**
  70271. * Teleport the agent to a new position
  70272. * @param index agent index returned by addAgent
  70273. * @param destination targeted world position
  70274. */
  70275. agentTeleport(index: number, destination: Vector3): void;
  70276. /**
  70277. * Update agent parameters
  70278. * @param index agent index returned by addAgent
  70279. * @param parameters agent parameters
  70280. */
  70281. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70282. /**
  70283. * remove a particular agent previously created
  70284. * @param index agent index returned by addAgent
  70285. */
  70286. removeAgent(index: number): void;
  70287. /**
  70288. * get the list of all agents attached to this crowd
  70289. * @returns list of agent indices
  70290. */
  70291. getAgents(): number[];
  70292. /**
  70293. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70294. * @param deltaTime in seconds
  70295. */
  70296. update(deltaTime: number): void;
  70297. /**
  70298. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70299. * The queries will try to find a solution within those bounds
  70300. * default is (1,1,1)
  70301. * @param extent x,y,z value that define the extent around the queries point of reference
  70302. */
  70303. setDefaultQueryExtent(extent: Vector3): void;
  70304. /**
  70305. * Get the Bounding box extent specified by setDefaultQueryExtent
  70306. * @returns the box extent values
  70307. */
  70308. getDefaultQueryExtent(): Vector3;
  70309. /**
  70310. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70311. * @param result output the box extent values
  70312. */
  70313. getDefaultQueryExtentToRef(result: Vector3): void;
  70314. /**
  70315. * Release all resources
  70316. */
  70317. dispose(): void;
  70318. }
  70319. }
  70320. declare module "babylonjs/Navigation/Plugins/index" {
  70321. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70322. }
  70323. declare module "babylonjs/Navigation/index" {
  70324. export * from "babylonjs/Navigation/INavigationEngine";
  70325. export * from "babylonjs/Navigation/Plugins/index";
  70326. }
  70327. declare module "babylonjs/Offline/database" {
  70328. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70329. /**
  70330. * Class used to enable access to IndexedDB
  70331. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70332. */
  70333. export class Database implements IOfflineProvider {
  70334. private _callbackManifestChecked;
  70335. private _currentSceneUrl;
  70336. private _db;
  70337. private _enableSceneOffline;
  70338. private _enableTexturesOffline;
  70339. private _manifestVersionFound;
  70340. private _mustUpdateRessources;
  70341. private _hasReachedQuota;
  70342. private _isSupported;
  70343. private _idbFactory;
  70344. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70345. private static IsUASupportingBlobStorage;
  70346. /**
  70347. * Gets a boolean indicating if Database storate is enabled (off by default)
  70348. */
  70349. static IDBStorageEnabled: boolean;
  70350. /**
  70351. * Gets a boolean indicating if scene must be saved in the database
  70352. */
  70353. get enableSceneOffline(): boolean;
  70354. /**
  70355. * Gets a boolean indicating if textures must be saved in the database
  70356. */
  70357. get enableTexturesOffline(): boolean;
  70358. /**
  70359. * Creates a new Database
  70360. * @param urlToScene defines the url to load the scene
  70361. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70362. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70363. */
  70364. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70365. private static _ParseURL;
  70366. private static _ReturnFullUrlLocation;
  70367. private _checkManifestFile;
  70368. /**
  70369. * Open the database and make it available
  70370. * @param successCallback defines the callback to call on success
  70371. * @param errorCallback defines the callback to call on error
  70372. */
  70373. open(successCallback: () => void, errorCallback: () => void): void;
  70374. /**
  70375. * Loads an image from the database
  70376. * @param url defines the url to load from
  70377. * @param image defines the target DOM image
  70378. */
  70379. loadImage(url: string, image: HTMLImageElement): void;
  70380. private _loadImageFromDBAsync;
  70381. private _saveImageIntoDBAsync;
  70382. private _checkVersionFromDB;
  70383. private _loadVersionFromDBAsync;
  70384. private _saveVersionIntoDBAsync;
  70385. /**
  70386. * Loads a file from database
  70387. * @param url defines the URL to load from
  70388. * @param sceneLoaded defines a callback to call on success
  70389. * @param progressCallBack defines a callback to call when progress changed
  70390. * @param errorCallback defines a callback to call on error
  70391. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70392. */
  70393. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70394. private _loadFileAsync;
  70395. private _saveFileAsync;
  70396. /**
  70397. * Validates if xhr data is correct
  70398. * @param xhr defines the request to validate
  70399. * @param dataType defines the expected data type
  70400. * @returns true if data is correct
  70401. */
  70402. private static _ValidateXHRData;
  70403. }
  70404. }
  70405. declare module "babylonjs/Offline/index" {
  70406. export * from "babylonjs/Offline/database";
  70407. export * from "babylonjs/Offline/IOfflineProvider";
  70408. }
  70409. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70410. /** @hidden */
  70411. export var gpuUpdateParticlesPixelShader: {
  70412. name: string;
  70413. shader: string;
  70414. };
  70415. }
  70416. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70417. /** @hidden */
  70418. export var gpuUpdateParticlesVertexShader: {
  70419. name: string;
  70420. shader: string;
  70421. };
  70422. }
  70423. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70424. /** @hidden */
  70425. export var clipPlaneFragmentDeclaration2: {
  70426. name: string;
  70427. shader: string;
  70428. };
  70429. }
  70430. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70431. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70432. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70433. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70434. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70435. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70436. /** @hidden */
  70437. export var gpuRenderParticlesPixelShader: {
  70438. name: string;
  70439. shader: string;
  70440. };
  70441. }
  70442. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70443. /** @hidden */
  70444. export var clipPlaneVertexDeclaration2: {
  70445. name: string;
  70446. shader: string;
  70447. };
  70448. }
  70449. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70450. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70451. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70452. /** @hidden */
  70453. export var gpuRenderParticlesVertexShader: {
  70454. name: string;
  70455. shader: string;
  70456. };
  70457. }
  70458. declare module "babylonjs/Particles/gpuParticleSystem" {
  70459. import { Nullable } from "babylonjs/types";
  70460. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70461. import { Observable } from "babylonjs/Misc/observable";
  70462. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70463. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70464. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70465. import { Scene, IDisposable } from "babylonjs/scene";
  70466. import { Effect } from "babylonjs/Materials/effect";
  70467. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70468. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70469. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70470. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70471. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70472. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70473. /**
  70474. * This represents a GPU particle system in Babylon
  70475. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70476. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70477. */
  70478. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70479. /**
  70480. * The layer mask we are rendering the particles through.
  70481. */
  70482. layerMask: number;
  70483. private _capacity;
  70484. private _activeCount;
  70485. private _currentActiveCount;
  70486. private _accumulatedCount;
  70487. private _renderEffect;
  70488. private _updateEffect;
  70489. private _buffer0;
  70490. private _buffer1;
  70491. private _spriteBuffer;
  70492. private _updateVAO;
  70493. private _renderVAO;
  70494. private _targetIndex;
  70495. private _sourceBuffer;
  70496. private _targetBuffer;
  70497. private _engine;
  70498. private _currentRenderId;
  70499. private _started;
  70500. private _stopped;
  70501. private _timeDelta;
  70502. private _randomTexture;
  70503. private _randomTexture2;
  70504. private _attributesStrideSize;
  70505. private _updateEffectOptions;
  70506. private _randomTextureSize;
  70507. private _actualFrame;
  70508. private _customEffect;
  70509. private readonly _rawTextureWidth;
  70510. /**
  70511. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70512. */
  70513. static get IsSupported(): boolean;
  70514. /**
  70515. * An event triggered when the system is disposed.
  70516. */
  70517. onDisposeObservable: Observable<IParticleSystem>;
  70518. /**
  70519. * Gets the maximum number of particles active at the same time.
  70520. * @returns The max number of active particles.
  70521. */
  70522. getCapacity(): number;
  70523. /**
  70524. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70525. * to override the particles.
  70526. */
  70527. forceDepthWrite: boolean;
  70528. /**
  70529. * Gets or set the number of active particles
  70530. */
  70531. get activeParticleCount(): number;
  70532. set activeParticleCount(value: number);
  70533. private _preWarmDone;
  70534. /**
  70535. * Specifies if the particles are updated in emitter local space or world space.
  70536. */
  70537. isLocal: boolean;
  70538. /**
  70539. * Is this system ready to be used/rendered
  70540. * @return true if the system is ready
  70541. */
  70542. isReady(): boolean;
  70543. /**
  70544. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70545. * @returns True if it has been started, otherwise false.
  70546. */
  70547. isStarted(): boolean;
  70548. /**
  70549. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70550. * @returns True if it has been stopped, otherwise false.
  70551. */
  70552. isStopped(): boolean;
  70553. /**
  70554. * Gets a boolean indicating that the system is stopping
  70555. * @returns true if the system is currently stopping
  70556. */
  70557. isStopping(): boolean;
  70558. /**
  70559. * Gets the number of particles active at the same time.
  70560. * @returns The number of active particles.
  70561. */
  70562. getActiveCount(): number;
  70563. /**
  70564. * Starts the particle system and begins to emit
  70565. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70566. */
  70567. start(delay?: number): void;
  70568. /**
  70569. * Stops the particle system.
  70570. */
  70571. stop(): void;
  70572. /**
  70573. * Remove all active particles
  70574. */
  70575. reset(): void;
  70576. /**
  70577. * Returns the string "GPUParticleSystem"
  70578. * @returns a string containing the class name
  70579. */
  70580. getClassName(): string;
  70581. /**
  70582. * Gets the custom effect used to render the particles
  70583. * @param blendMode Blend mode for which the effect should be retrieved
  70584. * @returns The effect
  70585. */
  70586. getCustomEffect(blendMode?: number): Nullable<Effect>;
  70587. /**
  70588. * Sets the custom effect used to render the particles
  70589. * @param effect The effect to set
  70590. * @param blendMode Blend mode for which the effect should be set
  70591. */
  70592. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  70593. /** @hidden */
  70594. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  70595. /**
  70596. * Observable that will be called just before the particles are drawn
  70597. */
  70598. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  70599. /**
  70600. * Gets the name of the particle vertex shader
  70601. */
  70602. get vertexShaderName(): string;
  70603. private _colorGradientsTexture;
  70604. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  70605. /**
  70606. * Adds a new color gradient
  70607. * @param gradient defines the gradient to use (between 0 and 1)
  70608. * @param color1 defines the color to affect to the specified gradient
  70609. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  70610. * @returns the current particle system
  70611. */
  70612. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  70613. private _refreshColorGradient;
  70614. /** Force the system to rebuild all gradients that need to be resync */
  70615. forceRefreshGradients(): void;
  70616. /**
  70617. * Remove a specific color gradient
  70618. * @param gradient defines the gradient to remove
  70619. * @returns the current particle system
  70620. */
  70621. removeColorGradient(gradient: number): GPUParticleSystem;
  70622. private _angularSpeedGradientsTexture;
  70623. private _sizeGradientsTexture;
  70624. private _velocityGradientsTexture;
  70625. private _limitVelocityGradientsTexture;
  70626. private _dragGradientsTexture;
  70627. private _addFactorGradient;
  70628. /**
  70629. * Adds a new size gradient
  70630. * @param gradient defines the gradient to use (between 0 and 1)
  70631. * @param factor defines the size factor to affect to the specified gradient
  70632. * @returns the current particle system
  70633. */
  70634. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  70635. /**
  70636. * Remove a specific size gradient
  70637. * @param gradient defines the gradient to remove
  70638. * @returns the current particle system
  70639. */
  70640. removeSizeGradient(gradient: number): GPUParticleSystem;
  70641. private _refreshFactorGradient;
  70642. /**
  70643. * Adds a new angular speed gradient
  70644. * @param gradient defines the gradient to use (between 0 and 1)
  70645. * @param factor defines the angular speed to affect to the specified gradient
  70646. * @returns the current particle system
  70647. */
  70648. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  70649. /**
  70650. * Remove a specific angular speed gradient
  70651. * @param gradient defines the gradient to remove
  70652. * @returns the current particle system
  70653. */
  70654. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  70655. /**
  70656. * Adds a new velocity gradient
  70657. * @param gradient defines the gradient to use (between 0 and 1)
  70658. * @param factor defines the velocity to affect to the specified gradient
  70659. * @returns the current particle system
  70660. */
  70661. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70662. /**
  70663. * Remove a specific velocity gradient
  70664. * @param gradient defines the gradient to remove
  70665. * @returns the current particle system
  70666. */
  70667. removeVelocityGradient(gradient: number): GPUParticleSystem;
  70668. /**
  70669. * Adds a new limit velocity gradient
  70670. * @param gradient defines the gradient to use (between 0 and 1)
  70671. * @param factor defines the limit velocity value to affect to the specified gradient
  70672. * @returns the current particle system
  70673. */
  70674. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70675. /**
  70676. * Remove a specific limit velocity gradient
  70677. * @param gradient defines the gradient to remove
  70678. * @returns the current particle system
  70679. */
  70680. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  70681. /**
  70682. * Adds a new drag gradient
  70683. * @param gradient defines the gradient to use (between 0 and 1)
  70684. * @param factor defines the drag value to affect to the specified gradient
  70685. * @returns the current particle system
  70686. */
  70687. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  70688. /**
  70689. * Remove a specific drag gradient
  70690. * @param gradient defines the gradient to remove
  70691. * @returns the current particle system
  70692. */
  70693. removeDragGradient(gradient: number): GPUParticleSystem;
  70694. /**
  70695. * Not supported by GPUParticleSystem
  70696. * @param gradient defines the gradient to use (between 0 and 1)
  70697. * @param factor defines the emit rate value to affect to the specified gradient
  70698. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70699. * @returns the current particle system
  70700. */
  70701. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70702. /**
  70703. * Not supported by GPUParticleSystem
  70704. * @param gradient defines the gradient to remove
  70705. * @returns the current particle system
  70706. */
  70707. removeEmitRateGradient(gradient: number): IParticleSystem;
  70708. /**
  70709. * Not supported by GPUParticleSystem
  70710. * @param gradient defines the gradient to use (between 0 and 1)
  70711. * @param factor defines the start size value to affect to the specified gradient
  70712. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70713. * @returns the current particle system
  70714. */
  70715. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70716. /**
  70717. * Not supported by GPUParticleSystem
  70718. * @param gradient defines the gradient to remove
  70719. * @returns the current particle system
  70720. */
  70721. removeStartSizeGradient(gradient: number): IParticleSystem;
  70722. /**
  70723. * Not supported by GPUParticleSystem
  70724. * @param gradient defines the gradient to use (between 0 and 1)
  70725. * @param min defines the color remap minimal range
  70726. * @param max defines the color remap maximal range
  70727. * @returns the current particle system
  70728. */
  70729. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70730. /**
  70731. * Not supported by GPUParticleSystem
  70732. * @param gradient defines the gradient to remove
  70733. * @returns the current particle system
  70734. */
  70735. removeColorRemapGradient(): IParticleSystem;
  70736. /**
  70737. * Not supported by GPUParticleSystem
  70738. * @param gradient defines the gradient to use (between 0 and 1)
  70739. * @param min defines the alpha remap minimal range
  70740. * @param max defines the alpha remap maximal range
  70741. * @returns the current particle system
  70742. */
  70743. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70744. /**
  70745. * Not supported by GPUParticleSystem
  70746. * @param gradient defines the gradient to remove
  70747. * @returns the current particle system
  70748. */
  70749. removeAlphaRemapGradient(): IParticleSystem;
  70750. /**
  70751. * Not supported by GPUParticleSystem
  70752. * @param gradient defines the gradient to use (between 0 and 1)
  70753. * @param color defines the color to affect to the specified gradient
  70754. * @returns the current particle system
  70755. */
  70756. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  70757. /**
  70758. * Not supported by GPUParticleSystem
  70759. * @param gradient defines the gradient to remove
  70760. * @returns the current particle system
  70761. */
  70762. removeRampGradient(): IParticleSystem;
  70763. /**
  70764. * Not supported by GPUParticleSystem
  70765. * @returns the list of ramp gradients
  70766. */
  70767. getRampGradients(): Nullable<Array<Color3Gradient>>;
  70768. /**
  70769. * Not supported by GPUParticleSystem
  70770. * Gets or sets a boolean indicating that ramp gradients must be used
  70771. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  70772. */
  70773. get useRampGradients(): boolean;
  70774. set useRampGradients(value: boolean);
  70775. /**
  70776. * Not supported by GPUParticleSystem
  70777. * @param gradient defines the gradient to use (between 0 and 1)
  70778. * @param factor defines the life time factor to affect to the specified gradient
  70779. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70780. * @returns the current particle system
  70781. */
  70782. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70783. /**
  70784. * Not supported by GPUParticleSystem
  70785. * @param gradient defines the gradient to remove
  70786. * @returns the current particle system
  70787. */
  70788. removeLifeTimeGradient(gradient: number): IParticleSystem;
  70789. /**
  70790. * Instantiates a GPU particle system.
  70791. * 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.
  70792. * @param name The name of the particle system
  70793. * @param options The options used to create the system
  70794. * @param scene The scene the particle system belongs to
  70795. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  70796. * @param customEffect a custom effect used to change the way particles are rendered by default
  70797. */
  70798. constructor(name: string, options: Partial<{
  70799. capacity: number;
  70800. randomTextureSize: number;
  70801. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  70802. protected _reset(): void;
  70803. private _createUpdateVAO;
  70804. private _createRenderVAO;
  70805. private _initialize;
  70806. /** @hidden */
  70807. _recreateUpdateEffect(): void;
  70808. private _getEffect;
  70809. /**
  70810. * Fill the defines array according to the current settings of the particle system
  70811. * @param defines Array to be updated
  70812. * @param blendMode blend mode to take into account when updating the array
  70813. */
  70814. fillDefines(defines: Array<string>, blendMode?: number): void;
  70815. /**
  70816. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  70817. * @param uniforms Uniforms array to fill
  70818. * @param attributes Attributes array to fill
  70819. * @param samplers Samplers array to fill
  70820. */
  70821. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  70822. /** @hidden */
  70823. _recreateRenderEffect(): Effect;
  70824. /**
  70825. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  70826. * @param preWarm defines if we are in the pre-warmimg phase
  70827. */
  70828. animate(preWarm?: boolean): void;
  70829. private _createFactorGradientTexture;
  70830. private _createSizeGradientTexture;
  70831. private _createAngularSpeedGradientTexture;
  70832. private _createVelocityGradientTexture;
  70833. private _createLimitVelocityGradientTexture;
  70834. private _createDragGradientTexture;
  70835. private _createColorGradientTexture;
  70836. /**
  70837. * Renders the particle system in its current state
  70838. * @param preWarm defines if the system should only update the particles but not render them
  70839. * @returns the current number of particles
  70840. */
  70841. render(preWarm?: boolean): number;
  70842. /**
  70843. * Rebuilds the particle system
  70844. */
  70845. rebuild(): void;
  70846. private _releaseBuffers;
  70847. private _releaseVAOs;
  70848. /**
  70849. * Disposes the particle system and free the associated resources
  70850. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  70851. */
  70852. dispose(disposeTexture?: boolean): void;
  70853. /**
  70854. * Clones the particle system.
  70855. * @param name The name of the cloned object
  70856. * @param newEmitter The new emitter to use
  70857. * @returns the cloned particle system
  70858. */
  70859. clone(name: string, newEmitter: any): GPUParticleSystem;
  70860. /**
  70861. * Serializes the particle system to a JSON object
  70862. * @param serializeTexture defines if the texture must be serialized as well
  70863. * @returns the JSON object
  70864. */
  70865. serialize(serializeTexture?: boolean): any;
  70866. /**
  70867. * Parses a JSON object to create a GPU particle system.
  70868. * @param parsedParticleSystem The JSON object to parse
  70869. * @param scene The scene to create the particle system in
  70870. * @param rootUrl The root url to use to load external dependencies like texture
  70871. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  70872. * @returns the parsed GPU particle system
  70873. */
  70874. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  70875. }
  70876. }
  70877. declare module "babylonjs/Particles/particleSystemSet" {
  70878. import { Nullable } from "babylonjs/types";
  70879. import { Color3 } from "babylonjs/Maths/math.color";
  70880. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70881. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70882. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70883. import { Scene, IDisposable } from "babylonjs/scene";
  70884. /**
  70885. * Represents a set of particle systems working together to create a specific effect
  70886. */
  70887. export class ParticleSystemSet implements IDisposable {
  70888. /**
  70889. * Gets or sets base Assets URL
  70890. */
  70891. static BaseAssetsUrl: string;
  70892. private _emitterCreationOptions;
  70893. private _emitterNode;
  70894. /**
  70895. * Gets the particle system list
  70896. */
  70897. systems: IParticleSystem[];
  70898. /**
  70899. * Gets the emitter node used with this set
  70900. */
  70901. get emitterNode(): Nullable<TransformNode>;
  70902. /**
  70903. * Creates a new emitter mesh as a sphere
  70904. * @param options defines the options used to create the sphere
  70905. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  70906. * @param scene defines the hosting scene
  70907. */
  70908. setEmitterAsSphere(options: {
  70909. diameter: number;
  70910. segments: number;
  70911. color: Color3;
  70912. }, renderingGroupId: number, scene: Scene): void;
  70913. /**
  70914. * Starts all particle systems of the set
  70915. * @param emitter defines an optional mesh to use as emitter for the particle systems
  70916. */
  70917. start(emitter?: AbstractMesh): void;
  70918. /**
  70919. * Release all associated resources
  70920. */
  70921. dispose(): void;
  70922. /**
  70923. * Serialize the set into a JSON compatible object
  70924. * @param serializeTexture defines if the texture must be serialized as well
  70925. * @returns a JSON compatible representation of the set
  70926. */
  70927. serialize(serializeTexture?: boolean): any;
  70928. /**
  70929. * Parse a new ParticleSystemSet from a serialized source
  70930. * @param data defines a JSON compatible representation of the set
  70931. * @param scene defines the hosting scene
  70932. * @param gpu defines if we want GPU particles or CPU particles
  70933. * @returns a new ParticleSystemSet
  70934. */
  70935. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  70936. }
  70937. }
  70938. declare module "babylonjs/Particles/particleHelper" {
  70939. import { Nullable } from "babylonjs/types";
  70940. import { Scene } from "babylonjs/scene";
  70941. import { Vector3 } from "babylonjs/Maths/math.vector";
  70942. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70943. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70944. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  70945. /**
  70946. * This class is made for on one-liner static method to help creating particle system set.
  70947. */
  70948. export class ParticleHelper {
  70949. /**
  70950. * Gets or sets base Assets URL
  70951. */
  70952. static BaseAssetsUrl: string;
  70953. /** Define the Url to load snippets */
  70954. static SnippetUrl: string;
  70955. /**
  70956. * Create a default particle system that you can tweak
  70957. * @param emitter defines the emitter to use
  70958. * @param capacity defines the system capacity (default is 500 particles)
  70959. * @param scene defines the hosting scene
  70960. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  70961. * @returns the new Particle system
  70962. */
  70963. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  70964. /**
  70965. * This is the main static method (one-liner) of this helper to create different particle systems
  70966. * @param type This string represents the type to the particle system to create
  70967. * @param scene The scene where the particle system should live
  70968. * @param gpu If the system will use gpu
  70969. * @returns the ParticleSystemSet created
  70970. */
  70971. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  70972. /**
  70973. * Static function used to export a particle system to a ParticleSystemSet variable.
  70974. * Please note that the emitter shape is not exported
  70975. * @param systems defines the particle systems to export
  70976. * @returns the created particle system set
  70977. */
  70978. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  70979. /**
  70980. * Creates a particle system from a snippet saved in a remote file
  70981. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  70982. * @param url defines the url to load from
  70983. * @param scene defines the hosting scene
  70984. * @param gpu If the system will use gpu
  70985. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70986. * @returns a promise that will resolve to the new particle system
  70987. */
  70988. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70989. /**
  70990. * Creates a particle system from a snippet saved by the particle system editor
  70991. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  70992. * @param scene defines the hosting scene
  70993. * @param gpu If the system will use gpu
  70994. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70995. * @returns a promise that will resolve to the new particle system
  70996. */
  70997. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70998. }
  70999. }
  71000. declare module "babylonjs/Particles/particleSystemComponent" {
  71001. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71002. import { Effect } from "babylonjs/Materials/effect";
  71003. import "babylonjs/Shaders/particles.vertex";
  71004. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71005. module "babylonjs/Engines/engine" {
  71006. interface Engine {
  71007. /**
  71008. * Create an effect to use with particle systems.
  71009. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71010. * the particle system for which you want to create a custom effect in the last parameter
  71011. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71012. * @param uniformsNames defines a list of attribute names
  71013. * @param samplers defines an array of string used to represent textures
  71014. * @param defines defines the string containing the defines to use to compile the shaders
  71015. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71016. * @param onCompiled defines a function to call when the effect creation is successful
  71017. * @param onError defines a function to call when the effect creation has failed
  71018. * @param particleSystem the particle system you want to create the effect for
  71019. * @returns the new Effect
  71020. */
  71021. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71022. }
  71023. }
  71024. module "babylonjs/Meshes/mesh" {
  71025. interface Mesh {
  71026. /**
  71027. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71028. * @returns an array of IParticleSystem
  71029. */
  71030. getEmittedParticleSystems(): IParticleSystem[];
  71031. /**
  71032. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71033. * @returns an array of IParticleSystem
  71034. */
  71035. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71036. }
  71037. }
  71038. }
  71039. declare module "babylonjs/Particles/pointsCloudSystem" {
  71040. import { Color4 } from "babylonjs/Maths/math";
  71041. import { Mesh } from "babylonjs/Meshes/mesh";
  71042. import { Scene, IDisposable } from "babylonjs/scene";
  71043. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71044. /** Defines the 4 color options */
  71045. export enum PointColor {
  71046. /** color value */
  71047. Color = 2,
  71048. /** uv value */
  71049. UV = 1,
  71050. /** random value */
  71051. Random = 0,
  71052. /** stated value */
  71053. Stated = 3
  71054. }
  71055. /**
  71056. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71057. * 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.
  71058. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71059. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71060. *
  71061. * Full documentation here : TO BE ENTERED
  71062. */
  71063. export class PointsCloudSystem implements IDisposable {
  71064. /**
  71065. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71066. * Example : var p = SPS.particles[i];
  71067. */
  71068. particles: CloudPoint[];
  71069. /**
  71070. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71071. */
  71072. nbParticles: number;
  71073. /**
  71074. * This a counter for your own usage. It's not set by any SPS functions.
  71075. */
  71076. counter: number;
  71077. /**
  71078. * The PCS name. This name is also given to the underlying mesh.
  71079. */
  71080. name: string;
  71081. /**
  71082. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71083. */
  71084. mesh: Mesh;
  71085. /**
  71086. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71087. * Please read :
  71088. */
  71089. vars: any;
  71090. /**
  71091. * @hidden
  71092. */
  71093. _size: number;
  71094. private _scene;
  71095. private _promises;
  71096. private _positions;
  71097. private _indices;
  71098. private _normals;
  71099. private _colors;
  71100. private _uvs;
  71101. private _indices32;
  71102. private _positions32;
  71103. private _colors32;
  71104. private _uvs32;
  71105. private _updatable;
  71106. private _isVisibilityBoxLocked;
  71107. private _alwaysVisible;
  71108. private _groups;
  71109. private _groupCounter;
  71110. private _computeParticleColor;
  71111. private _computeParticleTexture;
  71112. private _computeParticleRotation;
  71113. private _computeBoundingBox;
  71114. private _isReady;
  71115. /**
  71116. * Creates a PCS (Points Cloud System) object
  71117. * @param name (String) is the PCS name, this will be the underlying mesh name
  71118. * @param pointSize (number) is the size for each point
  71119. * @param scene (Scene) is the scene in which the PCS is added
  71120. * @param options defines the options of the PCS e.g.
  71121. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71122. */
  71123. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71124. updatable?: boolean;
  71125. });
  71126. /**
  71127. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71128. * If no points were added to the PCS, the returned mesh is just a single point.
  71129. * @returns a promise for the created mesh
  71130. */
  71131. buildMeshAsync(): Promise<Mesh>;
  71132. /**
  71133. * @hidden
  71134. */
  71135. private _buildMesh;
  71136. private _addParticle;
  71137. private _randomUnitVector;
  71138. private _getColorIndicesForCoord;
  71139. private _setPointsColorOrUV;
  71140. private _colorFromTexture;
  71141. private _calculateDensity;
  71142. /**
  71143. * Adds points to the PCS in random positions within a unit sphere
  71144. * @param nb (positive integer) the number of particles to be created from this model
  71145. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71146. * @returns the number of groups in the system
  71147. */
  71148. addPoints(nb: number, pointFunction?: any): number;
  71149. /**
  71150. * Adds points to the PCS from the surface of the model shape
  71151. * @param mesh is any Mesh object that will be used as a surface model for the points
  71152. * @param nb (positive integer) the number of particles to be created from this model
  71153. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71154. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71155. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71156. * @returns the number of groups in the system
  71157. */
  71158. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71159. /**
  71160. * Adds points to the PCS inside the model shape
  71161. * @param mesh is any Mesh object that will be used as a surface model for the points
  71162. * @param nb (positive integer) the number of particles to be created from this model
  71163. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71164. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71165. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71166. * @returns the number of groups in the system
  71167. */
  71168. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71169. /**
  71170. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71171. * This method calls `updateParticle()` for each particle of the SPS.
  71172. * For an animated SPS, it is usually called within the render loop.
  71173. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71174. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71175. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71176. * @returns the PCS.
  71177. */
  71178. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71179. /**
  71180. * Disposes the PCS.
  71181. */
  71182. dispose(): void;
  71183. /**
  71184. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71185. * doc :
  71186. * @returns the PCS.
  71187. */
  71188. refreshVisibleSize(): PointsCloudSystem;
  71189. /**
  71190. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71191. * @param size the size (float) of the visibility box
  71192. * note : this doesn't lock the PCS mesh bounding box.
  71193. * doc :
  71194. */
  71195. setVisibilityBox(size: number): void;
  71196. /**
  71197. * Gets whether the PCS is always visible or not
  71198. * doc :
  71199. */
  71200. get isAlwaysVisible(): boolean;
  71201. /**
  71202. * Sets the PCS as always visible or not
  71203. * doc :
  71204. */
  71205. set isAlwaysVisible(val: boolean);
  71206. /**
  71207. * Tells to `setParticles()` to compute the particle rotations or not
  71208. * Default value : false. The PCS is faster when it's set to false
  71209. * Note : particle rotations are only applied to parent particles
  71210. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71211. */
  71212. set computeParticleRotation(val: boolean);
  71213. /**
  71214. * Tells to `setParticles()` to compute the particle colors or not.
  71215. * Default value : true. The PCS is faster when it's set to false.
  71216. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71217. */
  71218. set computeParticleColor(val: boolean);
  71219. set computeParticleTexture(val: boolean);
  71220. /**
  71221. * Gets if `setParticles()` computes the particle colors or not.
  71222. * Default value : false. The PCS is faster when it's set to false.
  71223. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71224. */
  71225. get computeParticleColor(): boolean;
  71226. /**
  71227. * Gets if `setParticles()` computes the particle textures or not.
  71228. * Default value : false. The PCS is faster when it's set to false.
  71229. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71230. */
  71231. get computeParticleTexture(): boolean;
  71232. /**
  71233. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71234. */
  71235. set computeBoundingBox(val: boolean);
  71236. /**
  71237. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71238. */
  71239. get computeBoundingBox(): boolean;
  71240. /**
  71241. * This function does nothing. It may be overwritten to set all the particle first values.
  71242. * The PCS doesn't call this function, you may have to call it by your own.
  71243. * doc :
  71244. */
  71245. initParticles(): void;
  71246. /**
  71247. * This function does nothing. It may be overwritten to recycle a particle
  71248. * The PCS doesn't call this function, you can to call it
  71249. * doc :
  71250. * @param particle The particle to recycle
  71251. * @returns the recycled particle
  71252. */
  71253. recycleParticle(particle: CloudPoint): CloudPoint;
  71254. /**
  71255. * Updates a particle : this function should be overwritten by the user.
  71256. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71257. * doc :
  71258. * @example : just set a particle position or velocity and recycle conditions
  71259. * @param particle The particle to update
  71260. * @returns the updated particle
  71261. */
  71262. updateParticle(particle: CloudPoint): CloudPoint;
  71263. /**
  71264. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71265. * This does nothing and may be overwritten by the user.
  71266. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71267. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71268. * @param update the boolean update value actually passed to setParticles()
  71269. */
  71270. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71271. /**
  71272. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71273. * This will be passed three parameters.
  71274. * This does nothing and may be overwritten by the user.
  71275. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71276. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71277. * @param update the boolean update value actually passed to setParticles()
  71278. */
  71279. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71280. }
  71281. }
  71282. declare module "babylonjs/Particles/cloudPoint" {
  71283. import { Nullable } from "babylonjs/types";
  71284. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71285. import { Mesh } from "babylonjs/Meshes/mesh";
  71286. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71287. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71288. /**
  71289. * Represents one particle of a points cloud system.
  71290. */
  71291. export class CloudPoint {
  71292. /**
  71293. * particle global index
  71294. */
  71295. idx: number;
  71296. /**
  71297. * The color of the particle
  71298. */
  71299. color: Nullable<Color4>;
  71300. /**
  71301. * The world space position of the particle.
  71302. */
  71303. position: Vector3;
  71304. /**
  71305. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71306. */
  71307. rotation: Vector3;
  71308. /**
  71309. * The world space rotation quaternion of the particle.
  71310. */
  71311. rotationQuaternion: Nullable<Quaternion>;
  71312. /**
  71313. * The uv of the particle.
  71314. */
  71315. uv: Nullable<Vector2>;
  71316. /**
  71317. * The current speed of the particle.
  71318. */
  71319. velocity: Vector3;
  71320. /**
  71321. * The pivot point in the particle local space.
  71322. */
  71323. pivot: Vector3;
  71324. /**
  71325. * Must the particle be translated from its pivot point in its local space ?
  71326. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71327. * Default : false
  71328. */
  71329. translateFromPivot: boolean;
  71330. /**
  71331. * Index of this particle in the global "positions" array (Internal use)
  71332. * @hidden
  71333. */
  71334. _pos: number;
  71335. /**
  71336. * @hidden Index of this particle in the global "indices" array (Internal use)
  71337. */
  71338. _ind: number;
  71339. /**
  71340. * Group this particle belongs to
  71341. */
  71342. _group: PointsGroup;
  71343. /**
  71344. * Group id of this particle
  71345. */
  71346. groupId: number;
  71347. /**
  71348. * Index of the particle in its group id (Internal use)
  71349. */
  71350. idxInGroup: number;
  71351. /**
  71352. * @hidden Particle BoundingInfo object (Internal use)
  71353. */
  71354. _boundingInfo: BoundingInfo;
  71355. /**
  71356. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71357. */
  71358. _pcs: PointsCloudSystem;
  71359. /**
  71360. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71361. */
  71362. _stillInvisible: boolean;
  71363. /**
  71364. * @hidden Last computed particle rotation matrix
  71365. */
  71366. _rotationMatrix: number[];
  71367. /**
  71368. * Parent particle Id, if any.
  71369. * Default null.
  71370. */
  71371. parentId: Nullable<number>;
  71372. /**
  71373. * @hidden Internal global position in the PCS.
  71374. */
  71375. _globalPosition: Vector3;
  71376. /**
  71377. * Creates a Point Cloud object.
  71378. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71379. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71380. * @param group (PointsGroup) is the group the particle belongs to
  71381. * @param groupId (integer) is the group identifier in the PCS.
  71382. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71383. * @param pcs defines the PCS it is associated to
  71384. */
  71385. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71386. /**
  71387. * get point size
  71388. */
  71389. get size(): Vector3;
  71390. /**
  71391. * Set point size
  71392. */
  71393. set size(scale: Vector3);
  71394. /**
  71395. * Legacy support, changed quaternion to rotationQuaternion
  71396. */
  71397. get quaternion(): Nullable<Quaternion>;
  71398. /**
  71399. * Legacy support, changed quaternion to rotationQuaternion
  71400. */
  71401. set quaternion(q: Nullable<Quaternion>);
  71402. /**
  71403. * Returns a boolean. True if the particle intersects a mesh, else false
  71404. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71405. * @param target is the object (point or mesh) what the intersection is computed against
  71406. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71407. * @returns true if it intersects
  71408. */
  71409. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71410. /**
  71411. * get the rotation matrix of the particle
  71412. * @hidden
  71413. */
  71414. getRotationMatrix(m: Matrix): void;
  71415. }
  71416. /**
  71417. * Represents a group of points in a points cloud system
  71418. * * PCS internal tool, don't use it manually.
  71419. */
  71420. export class PointsGroup {
  71421. /**
  71422. * The group id
  71423. * @hidden
  71424. */
  71425. groupID: number;
  71426. /**
  71427. * image data for group (internal use)
  71428. * @hidden
  71429. */
  71430. _groupImageData: Nullable<ArrayBufferView>;
  71431. /**
  71432. * Image Width (internal use)
  71433. * @hidden
  71434. */
  71435. _groupImgWidth: number;
  71436. /**
  71437. * Image Height (internal use)
  71438. * @hidden
  71439. */
  71440. _groupImgHeight: number;
  71441. /**
  71442. * Custom position function (internal use)
  71443. * @hidden
  71444. */
  71445. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71446. /**
  71447. * density per facet for surface points
  71448. * @hidden
  71449. */
  71450. _groupDensity: number[];
  71451. /**
  71452. * Only when points are colored by texture carries pointer to texture list array
  71453. * @hidden
  71454. */
  71455. _textureNb: number;
  71456. /**
  71457. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71458. * PCS internal tool, don't use it manually.
  71459. * @hidden
  71460. */
  71461. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71462. }
  71463. }
  71464. declare module "babylonjs/Particles/index" {
  71465. export * from "babylonjs/Particles/baseParticleSystem";
  71466. export * from "babylonjs/Particles/EmitterTypes/index";
  71467. export * from "babylonjs/Particles/gpuParticleSystem";
  71468. export * from "babylonjs/Particles/IParticleSystem";
  71469. export * from "babylonjs/Particles/particle";
  71470. export * from "babylonjs/Particles/particleHelper";
  71471. export * from "babylonjs/Particles/particleSystem";
  71472. import "babylonjs/Particles/particleSystemComponent";
  71473. export * from "babylonjs/Particles/particleSystemComponent";
  71474. export * from "babylonjs/Particles/particleSystemSet";
  71475. export * from "babylonjs/Particles/solidParticle";
  71476. export * from "babylonjs/Particles/solidParticleSystem";
  71477. export * from "babylonjs/Particles/cloudPoint";
  71478. export * from "babylonjs/Particles/pointsCloudSystem";
  71479. export * from "babylonjs/Particles/subEmitter";
  71480. }
  71481. declare module "babylonjs/Physics/physicsEngineComponent" {
  71482. import { Nullable } from "babylonjs/types";
  71483. import { Observable, Observer } from "babylonjs/Misc/observable";
  71484. import { Vector3 } from "babylonjs/Maths/math.vector";
  71485. import { Mesh } from "babylonjs/Meshes/mesh";
  71486. import { ISceneComponent } from "babylonjs/sceneComponent";
  71487. import { Scene } from "babylonjs/scene";
  71488. import { Node } from "babylonjs/node";
  71489. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71490. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71491. module "babylonjs/scene" {
  71492. interface Scene {
  71493. /** @hidden (Backing field) */
  71494. _physicsEngine: Nullable<IPhysicsEngine>;
  71495. /** @hidden */
  71496. _physicsTimeAccumulator: number;
  71497. /**
  71498. * Gets the current physics engine
  71499. * @returns a IPhysicsEngine or null if none attached
  71500. */
  71501. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71502. /**
  71503. * Enables physics to the current scene
  71504. * @param gravity defines the scene's gravity for the physics engine
  71505. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71506. * @return a boolean indicating if the physics engine was initialized
  71507. */
  71508. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71509. /**
  71510. * Disables and disposes the physics engine associated with the scene
  71511. */
  71512. disablePhysicsEngine(): void;
  71513. /**
  71514. * Gets a boolean indicating if there is an active physics engine
  71515. * @returns a boolean indicating if there is an active physics engine
  71516. */
  71517. isPhysicsEnabled(): boolean;
  71518. /**
  71519. * Deletes a physics compound impostor
  71520. * @param compound defines the compound to delete
  71521. */
  71522. deleteCompoundImpostor(compound: any): void;
  71523. /**
  71524. * An event triggered when physic simulation is about to be run
  71525. */
  71526. onBeforePhysicsObservable: Observable<Scene>;
  71527. /**
  71528. * An event triggered when physic simulation has been done
  71529. */
  71530. onAfterPhysicsObservable: Observable<Scene>;
  71531. }
  71532. }
  71533. module "babylonjs/Meshes/abstractMesh" {
  71534. interface AbstractMesh {
  71535. /** @hidden */
  71536. _physicsImpostor: Nullable<PhysicsImpostor>;
  71537. /**
  71538. * Gets or sets impostor used for physic simulation
  71539. * @see https://doc.babylonjs.com/features/physics_engine
  71540. */
  71541. physicsImpostor: Nullable<PhysicsImpostor>;
  71542. /**
  71543. * Gets the current physics impostor
  71544. * @see https://doc.babylonjs.com/features/physics_engine
  71545. * @returns a physics impostor or null
  71546. */
  71547. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71548. /** Apply a physic impulse to the mesh
  71549. * @param force defines the force to apply
  71550. * @param contactPoint defines where to apply the force
  71551. * @returns the current mesh
  71552. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71553. */
  71554. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71555. /**
  71556. * Creates a physic joint between two meshes
  71557. * @param otherMesh defines the other mesh to use
  71558. * @param pivot1 defines the pivot to use on this mesh
  71559. * @param pivot2 defines the pivot to use on the other mesh
  71560. * @param options defines additional options (can be plugin dependent)
  71561. * @returns the current mesh
  71562. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71563. */
  71564. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71565. /** @hidden */
  71566. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71567. }
  71568. }
  71569. /**
  71570. * Defines the physics engine scene component responsible to manage a physics engine
  71571. */
  71572. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71573. /**
  71574. * The component name helpful to identify the component in the list of scene components.
  71575. */
  71576. readonly name: string;
  71577. /**
  71578. * The scene the component belongs to.
  71579. */
  71580. scene: Scene;
  71581. /**
  71582. * Creates a new instance of the component for the given scene
  71583. * @param scene Defines the scene to register the component in
  71584. */
  71585. constructor(scene: Scene);
  71586. /**
  71587. * Registers the component in a given scene
  71588. */
  71589. register(): void;
  71590. /**
  71591. * Rebuilds the elements related to this component in case of
  71592. * context lost for instance.
  71593. */
  71594. rebuild(): void;
  71595. /**
  71596. * Disposes the component and the associated ressources
  71597. */
  71598. dispose(): void;
  71599. }
  71600. }
  71601. declare module "babylonjs/Physics/physicsHelper" {
  71602. import { Nullable } from "babylonjs/types";
  71603. import { Vector3 } from "babylonjs/Maths/math.vector";
  71604. import { Mesh } from "babylonjs/Meshes/mesh";
  71605. import { Scene } from "babylonjs/scene";
  71606. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71607. /**
  71608. * A helper for physics simulations
  71609. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71610. */
  71611. export class PhysicsHelper {
  71612. private _scene;
  71613. private _physicsEngine;
  71614. /**
  71615. * Initializes the Physics helper
  71616. * @param scene Babylon.js scene
  71617. */
  71618. constructor(scene: Scene);
  71619. /**
  71620. * Applies a radial explosion impulse
  71621. * @param origin the origin of the explosion
  71622. * @param radiusOrEventOptions the radius or the options of radial explosion
  71623. * @param strength the explosion strength
  71624. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71625. * @returns A physics radial explosion event, or null
  71626. */
  71627. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  71628. /**
  71629. * Applies a radial explosion force
  71630. * @param origin the origin of the explosion
  71631. * @param radiusOrEventOptions the radius or the options of radial explosion
  71632. * @param strength the explosion strength
  71633. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71634. * @returns A physics radial explosion event, or null
  71635. */
  71636. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  71637. /**
  71638. * Creates a gravitational field
  71639. * @param origin the origin of the explosion
  71640. * @param radiusOrEventOptions the radius or the options of radial explosion
  71641. * @param strength the explosion strength
  71642. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71643. * @returns A physics gravitational field event, or null
  71644. */
  71645. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  71646. /**
  71647. * Creates a physics updraft event
  71648. * @param origin the origin of the updraft
  71649. * @param radiusOrEventOptions the radius or the options of the updraft
  71650. * @param strength the strength of the updraft
  71651. * @param height the height of the updraft
  71652. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  71653. * @returns A physics updraft event, or null
  71654. */
  71655. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  71656. /**
  71657. * Creates a physics vortex event
  71658. * @param origin the of the vortex
  71659. * @param radiusOrEventOptions the radius or the options of the vortex
  71660. * @param strength the strength of the vortex
  71661. * @param height the height of the vortex
  71662. * @returns a Physics vortex event, or null
  71663. * A physics vortex event or null
  71664. */
  71665. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  71666. }
  71667. /**
  71668. * Represents a physics radial explosion event
  71669. */
  71670. class PhysicsRadialExplosionEvent {
  71671. private _scene;
  71672. private _options;
  71673. private _sphere;
  71674. private _dataFetched;
  71675. /**
  71676. * Initializes a radial explosioin event
  71677. * @param _scene BabylonJS scene
  71678. * @param _options The options for the vortex event
  71679. */
  71680. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  71681. /**
  71682. * Returns the data related to the radial explosion event (sphere).
  71683. * @returns The radial explosion event data
  71684. */
  71685. getData(): PhysicsRadialExplosionEventData;
  71686. /**
  71687. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  71688. * @param impostor A physics imposter
  71689. * @param origin the origin of the explosion
  71690. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  71691. */
  71692. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  71693. /**
  71694. * Triggers affecterd impostors callbacks
  71695. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  71696. */
  71697. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  71698. /**
  71699. * Disposes the sphere.
  71700. * @param force Specifies if the sphere should be disposed by force
  71701. */
  71702. dispose(force?: boolean): void;
  71703. /*** Helpers ***/
  71704. private _prepareSphere;
  71705. private _intersectsWithSphere;
  71706. }
  71707. /**
  71708. * Represents a gravitational field event
  71709. */
  71710. class PhysicsGravitationalFieldEvent {
  71711. private _physicsHelper;
  71712. private _scene;
  71713. private _origin;
  71714. private _options;
  71715. private _tickCallback;
  71716. private _sphere;
  71717. private _dataFetched;
  71718. /**
  71719. * Initializes the physics gravitational field event
  71720. * @param _physicsHelper A physics helper
  71721. * @param _scene BabylonJS scene
  71722. * @param _origin The origin position of the gravitational field event
  71723. * @param _options The options for the vortex event
  71724. */
  71725. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  71726. /**
  71727. * Returns the data related to the gravitational field event (sphere).
  71728. * @returns A gravitational field event
  71729. */
  71730. getData(): PhysicsGravitationalFieldEventData;
  71731. /**
  71732. * Enables the gravitational field.
  71733. */
  71734. enable(): void;
  71735. /**
  71736. * Disables the gravitational field.
  71737. */
  71738. disable(): void;
  71739. /**
  71740. * Disposes the sphere.
  71741. * @param force The force to dispose from the gravitational field event
  71742. */
  71743. dispose(force?: boolean): void;
  71744. private _tick;
  71745. }
  71746. /**
  71747. * Represents a physics updraft event
  71748. */
  71749. class PhysicsUpdraftEvent {
  71750. private _scene;
  71751. private _origin;
  71752. private _options;
  71753. private _physicsEngine;
  71754. private _originTop;
  71755. private _originDirection;
  71756. private _tickCallback;
  71757. private _cylinder;
  71758. private _cylinderPosition;
  71759. private _dataFetched;
  71760. /**
  71761. * Initializes the physics updraft event
  71762. * @param _scene BabylonJS scene
  71763. * @param _origin The origin position of the updraft
  71764. * @param _options The options for the updraft event
  71765. */
  71766. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  71767. /**
  71768. * Returns the data related to the updraft event (cylinder).
  71769. * @returns A physics updraft event
  71770. */
  71771. getData(): PhysicsUpdraftEventData;
  71772. /**
  71773. * Enables the updraft.
  71774. */
  71775. enable(): void;
  71776. /**
  71777. * Disables the updraft.
  71778. */
  71779. disable(): void;
  71780. /**
  71781. * Disposes the cylinder.
  71782. * @param force Specifies if the updraft should be disposed by force
  71783. */
  71784. dispose(force?: boolean): void;
  71785. private getImpostorHitData;
  71786. private _tick;
  71787. /*** Helpers ***/
  71788. private _prepareCylinder;
  71789. private _intersectsWithCylinder;
  71790. }
  71791. /**
  71792. * Represents a physics vortex event
  71793. */
  71794. class PhysicsVortexEvent {
  71795. private _scene;
  71796. private _origin;
  71797. private _options;
  71798. private _physicsEngine;
  71799. private _originTop;
  71800. private _tickCallback;
  71801. private _cylinder;
  71802. private _cylinderPosition;
  71803. private _dataFetched;
  71804. /**
  71805. * Initializes the physics vortex event
  71806. * @param _scene The BabylonJS scene
  71807. * @param _origin The origin position of the vortex
  71808. * @param _options The options for the vortex event
  71809. */
  71810. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  71811. /**
  71812. * Returns the data related to the vortex event (cylinder).
  71813. * @returns The physics vortex event data
  71814. */
  71815. getData(): PhysicsVortexEventData;
  71816. /**
  71817. * Enables the vortex.
  71818. */
  71819. enable(): void;
  71820. /**
  71821. * Disables the cortex.
  71822. */
  71823. disable(): void;
  71824. /**
  71825. * Disposes the sphere.
  71826. * @param force
  71827. */
  71828. dispose(force?: boolean): void;
  71829. private getImpostorHitData;
  71830. private _tick;
  71831. /*** Helpers ***/
  71832. private _prepareCylinder;
  71833. private _intersectsWithCylinder;
  71834. }
  71835. /**
  71836. * Options fot the radial explosion event
  71837. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71838. */
  71839. export class PhysicsRadialExplosionEventOptions {
  71840. /**
  71841. * The radius of the sphere for the radial explosion.
  71842. */
  71843. radius: number;
  71844. /**
  71845. * The strenth of the explosion.
  71846. */
  71847. strength: number;
  71848. /**
  71849. * The strenght of the force in correspondence to the distance of the affected object
  71850. */
  71851. falloff: PhysicsRadialImpulseFalloff;
  71852. /**
  71853. * Sphere options for the radial explosion.
  71854. */
  71855. sphere: {
  71856. segments: number;
  71857. diameter: number;
  71858. };
  71859. /**
  71860. * Sphere options for the radial explosion.
  71861. */
  71862. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  71863. }
  71864. /**
  71865. * Options fot the updraft event
  71866. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71867. */
  71868. export class PhysicsUpdraftEventOptions {
  71869. /**
  71870. * The radius of the cylinder for the vortex
  71871. */
  71872. radius: number;
  71873. /**
  71874. * The strenth of the updraft.
  71875. */
  71876. strength: number;
  71877. /**
  71878. * The height of the cylinder for the updraft.
  71879. */
  71880. height: number;
  71881. /**
  71882. * The mode for the the updraft.
  71883. */
  71884. updraftMode: PhysicsUpdraftMode;
  71885. }
  71886. /**
  71887. * Options fot the vortex event
  71888. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71889. */
  71890. export class PhysicsVortexEventOptions {
  71891. /**
  71892. * The radius of the cylinder for the vortex
  71893. */
  71894. radius: number;
  71895. /**
  71896. * The strenth of the vortex.
  71897. */
  71898. strength: number;
  71899. /**
  71900. * The height of the cylinder for the vortex.
  71901. */
  71902. height: number;
  71903. /**
  71904. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  71905. */
  71906. centripetalForceThreshold: number;
  71907. /**
  71908. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  71909. */
  71910. centripetalForceMultiplier: number;
  71911. /**
  71912. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  71913. */
  71914. centrifugalForceMultiplier: number;
  71915. /**
  71916. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  71917. */
  71918. updraftForceMultiplier: number;
  71919. }
  71920. /**
  71921. * The strenght of the force in correspondence to the distance of the affected object
  71922. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71923. */
  71924. export enum PhysicsRadialImpulseFalloff {
  71925. /** Defines that impulse is constant in strength across it's whole radius */
  71926. Constant = 0,
  71927. /** Defines that impulse gets weaker if it's further from the origin */
  71928. Linear = 1
  71929. }
  71930. /**
  71931. * The strength of the force in correspondence to the distance of the affected object
  71932. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71933. */
  71934. export enum PhysicsUpdraftMode {
  71935. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  71936. Center = 0,
  71937. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  71938. Perpendicular = 1
  71939. }
  71940. /**
  71941. * Interface for a physics hit data
  71942. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71943. */
  71944. export interface PhysicsHitData {
  71945. /**
  71946. * The force applied at the contact point
  71947. */
  71948. force: Vector3;
  71949. /**
  71950. * The contact point
  71951. */
  71952. contactPoint: Vector3;
  71953. /**
  71954. * The distance from the origin to the contact point
  71955. */
  71956. distanceFromOrigin: number;
  71957. }
  71958. /**
  71959. * Interface for radial explosion event data
  71960. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71961. */
  71962. export interface PhysicsRadialExplosionEventData {
  71963. /**
  71964. * A sphere used for the radial explosion event
  71965. */
  71966. sphere: Mesh;
  71967. }
  71968. /**
  71969. * Interface for gravitational field event data
  71970. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71971. */
  71972. export interface PhysicsGravitationalFieldEventData {
  71973. /**
  71974. * A sphere mesh used for the gravitational field event
  71975. */
  71976. sphere: Mesh;
  71977. }
  71978. /**
  71979. * Interface for updraft event data
  71980. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71981. */
  71982. export interface PhysicsUpdraftEventData {
  71983. /**
  71984. * A cylinder used for the updraft event
  71985. */
  71986. cylinder: Mesh;
  71987. }
  71988. /**
  71989. * Interface for vortex event data
  71990. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71991. */
  71992. export interface PhysicsVortexEventData {
  71993. /**
  71994. * A cylinder used for the vortex event
  71995. */
  71996. cylinder: Mesh;
  71997. }
  71998. /**
  71999. * Interface for an affected physics impostor
  72000. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72001. */
  72002. export interface PhysicsAffectedImpostorWithData {
  72003. /**
  72004. * The impostor affected by the effect
  72005. */
  72006. impostor: PhysicsImpostor;
  72007. /**
  72008. * The data about the hit/horce from the explosion
  72009. */
  72010. hitData: PhysicsHitData;
  72011. }
  72012. }
  72013. declare module "babylonjs/Physics/Plugins/index" {
  72014. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72015. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72016. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72017. }
  72018. declare module "babylonjs/Physics/index" {
  72019. export * from "babylonjs/Physics/IPhysicsEngine";
  72020. export * from "babylonjs/Physics/physicsEngine";
  72021. export * from "babylonjs/Physics/physicsEngineComponent";
  72022. export * from "babylonjs/Physics/physicsHelper";
  72023. export * from "babylonjs/Physics/physicsImpostor";
  72024. export * from "babylonjs/Physics/physicsJoint";
  72025. export * from "babylonjs/Physics/Plugins/index";
  72026. }
  72027. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72028. /** @hidden */
  72029. export var blackAndWhitePixelShader: {
  72030. name: string;
  72031. shader: string;
  72032. };
  72033. }
  72034. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72035. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72036. import { Camera } from "babylonjs/Cameras/camera";
  72037. import { Engine } from "babylonjs/Engines/engine";
  72038. import "babylonjs/Shaders/blackAndWhite.fragment";
  72039. /**
  72040. * Post process used to render in black and white
  72041. */
  72042. export class BlackAndWhitePostProcess extends PostProcess {
  72043. /**
  72044. * Linear about to convert he result to black and white (default: 1)
  72045. */
  72046. degree: number;
  72047. /**
  72048. * Creates a black and white post process
  72049. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72050. * @param name The name of the effect.
  72051. * @param options The required width/height ratio to downsize to before computing the render pass.
  72052. * @param camera The camera to apply the render pass to.
  72053. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72054. * @param engine The engine which the post process will be applied. (default: current engine)
  72055. * @param reusable If the post process can be reused on the same frame. (default: false)
  72056. */
  72057. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72058. }
  72059. }
  72060. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72061. import { Nullable } from "babylonjs/types";
  72062. import { Camera } from "babylonjs/Cameras/camera";
  72063. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72064. import { Engine } from "babylonjs/Engines/engine";
  72065. /**
  72066. * This represents a set of one or more post processes in Babylon.
  72067. * A post process can be used to apply a shader to a texture after it is rendered.
  72068. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72069. */
  72070. export class PostProcessRenderEffect {
  72071. private _postProcesses;
  72072. private _getPostProcesses;
  72073. private _singleInstance;
  72074. private _cameras;
  72075. private _indicesForCamera;
  72076. /**
  72077. * Name of the effect
  72078. * @hidden
  72079. */
  72080. _name: string;
  72081. /**
  72082. * Instantiates a post process render effect.
  72083. * A post process can be used to apply a shader to a texture after it is rendered.
  72084. * @param engine The engine the effect is tied to
  72085. * @param name The name of the effect
  72086. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72087. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72088. */
  72089. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72090. /**
  72091. * Checks if all the post processes in the effect are supported.
  72092. */
  72093. get isSupported(): boolean;
  72094. /**
  72095. * Updates the current state of the effect
  72096. * @hidden
  72097. */
  72098. _update(): void;
  72099. /**
  72100. * Attaches the effect on cameras
  72101. * @param cameras The camera to attach to.
  72102. * @hidden
  72103. */
  72104. _attachCameras(cameras: Camera): void;
  72105. /**
  72106. * Attaches the effect on cameras
  72107. * @param cameras The camera to attach to.
  72108. * @hidden
  72109. */
  72110. _attachCameras(cameras: Camera[]): void;
  72111. /**
  72112. * Detaches the effect on cameras
  72113. * @param cameras The camera to detatch from.
  72114. * @hidden
  72115. */
  72116. _detachCameras(cameras: Camera): void;
  72117. /**
  72118. * Detatches the effect on cameras
  72119. * @param cameras The camera to detatch from.
  72120. * @hidden
  72121. */
  72122. _detachCameras(cameras: Camera[]): void;
  72123. /**
  72124. * Enables the effect on given cameras
  72125. * @param cameras The camera to enable.
  72126. * @hidden
  72127. */
  72128. _enable(cameras: Camera): void;
  72129. /**
  72130. * Enables the effect on given cameras
  72131. * @param cameras The camera to enable.
  72132. * @hidden
  72133. */
  72134. _enable(cameras: Nullable<Camera[]>): void;
  72135. /**
  72136. * Disables the effect on the given cameras
  72137. * @param cameras The camera to disable.
  72138. * @hidden
  72139. */
  72140. _disable(cameras: Camera): void;
  72141. /**
  72142. * Disables the effect on the given cameras
  72143. * @param cameras The camera to disable.
  72144. * @hidden
  72145. */
  72146. _disable(cameras: Nullable<Camera[]>): void;
  72147. /**
  72148. * Gets a list of the post processes contained in the effect.
  72149. * @param camera The camera to get the post processes on.
  72150. * @returns The list of the post processes in the effect.
  72151. */
  72152. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72153. }
  72154. }
  72155. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72156. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72157. /** @hidden */
  72158. export var extractHighlightsPixelShader: {
  72159. name: string;
  72160. shader: string;
  72161. };
  72162. }
  72163. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72164. import { Nullable } from "babylonjs/types";
  72165. import { Camera } from "babylonjs/Cameras/camera";
  72166. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72167. import { Engine } from "babylonjs/Engines/engine";
  72168. import "babylonjs/Shaders/extractHighlights.fragment";
  72169. /**
  72170. * 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.
  72171. */
  72172. export class ExtractHighlightsPostProcess extends PostProcess {
  72173. /**
  72174. * The luminance threshold, pixels below this value will be set to black.
  72175. */
  72176. threshold: number;
  72177. /** @hidden */
  72178. _exposure: number;
  72179. /**
  72180. * Post process which has the input texture to be used when performing highlight extraction
  72181. * @hidden
  72182. */
  72183. _inputPostProcess: Nullable<PostProcess>;
  72184. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72185. }
  72186. }
  72187. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72188. /** @hidden */
  72189. export var bloomMergePixelShader: {
  72190. name: string;
  72191. shader: string;
  72192. };
  72193. }
  72194. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72195. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72196. import { Nullable } from "babylonjs/types";
  72197. import { Engine } from "babylonjs/Engines/engine";
  72198. import { Camera } from "babylonjs/Cameras/camera";
  72199. import "babylonjs/Shaders/bloomMerge.fragment";
  72200. /**
  72201. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72202. */
  72203. export class BloomMergePostProcess extends PostProcess {
  72204. /** Weight of the bloom to be added to the original input. */
  72205. weight: number;
  72206. /**
  72207. * Creates a new instance of @see BloomMergePostProcess
  72208. * @param name The name of the effect.
  72209. * @param originalFromInput Post process which's input will be used for the merge.
  72210. * @param blurred Blurred highlights post process which's output will be used.
  72211. * @param weight Weight of the bloom to be added to the original input.
  72212. * @param options The required width/height ratio to downsize to before computing the render pass.
  72213. * @param camera The camera to apply the render pass to.
  72214. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72215. * @param engine The engine which the post process will be applied. (default: current engine)
  72216. * @param reusable If the post process can be reused on the same frame. (default: false)
  72217. * @param textureType Type of textures used when performing the post process. (default: 0)
  72218. * @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)
  72219. */
  72220. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72221. /** Weight of the bloom to be added to the original input. */
  72222. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72223. }
  72224. }
  72225. declare module "babylonjs/PostProcesses/bloomEffect" {
  72226. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72227. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72228. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72229. import { Camera } from "babylonjs/Cameras/camera";
  72230. import { Scene } from "babylonjs/scene";
  72231. /**
  72232. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72233. */
  72234. export class BloomEffect extends PostProcessRenderEffect {
  72235. private bloomScale;
  72236. /**
  72237. * @hidden Internal
  72238. */
  72239. _effects: Array<PostProcess>;
  72240. /**
  72241. * @hidden Internal
  72242. */
  72243. _downscale: ExtractHighlightsPostProcess;
  72244. private _blurX;
  72245. private _blurY;
  72246. private _merge;
  72247. /**
  72248. * The luminance threshold to find bright areas of the image to bloom.
  72249. */
  72250. get threshold(): number;
  72251. set threshold(value: number);
  72252. /**
  72253. * The strength of the bloom.
  72254. */
  72255. get weight(): number;
  72256. set weight(value: number);
  72257. /**
  72258. * Specifies the size of the bloom blur kernel, relative to the final output size
  72259. */
  72260. get kernel(): number;
  72261. set kernel(value: number);
  72262. /**
  72263. * Creates a new instance of @see BloomEffect
  72264. * @param scene The scene the effect belongs to.
  72265. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72266. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72267. * @param bloomWeight The the strength of bloom.
  72268. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72269. * @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)
  72270. */
  72271. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72272. /**
  72273. * Disposes each of the internal effects for a given camera.
  72274. * @param camera The camera to dispose the effect on.
  72275. */
  72276. disposeEffects(camera: Camera): void;
  72277. /**
  72278. * @hidden Internal
  72279. */
  72280. _updateEffects(): void;
  72281. /**
  72282. * Internal
  72283. * @returns if all the contained post processes are ready.
  72284. * @hidden
  72285. */
  72286. _isReady(): boolean;
  72287. }
  72288. }
  72289. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72290. /** @hidden */
  72291. export var chromaticAberrationPixelShader: {
  72292. name: string;
  72293. shader: string;
  72294. };
  72295. }
  72296. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72297. import { Vector2 } from "babylonjs/Maths/math.vector";
  72298. import { Nullable } from "babylonjs/types";
  72299. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72300. import { Camera } from "babylonjs/Cameras/camera";
  72301. import { Engine } from "babylonjs/Engines/engine";
  72302. import "babylonjs/Shaders/chromaticAberration.fragment";
  72303. /**
  72304. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72305. */
  72306. export class ChromaticAberrationPostProcess extends PostProcess {
  72307. /**
  72308. * The amount of seperation of rgb channels (default: 30)
  72309. */
  72310. aberrationAmount: number;
  72311. /**
  72312. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72313. */
  72314. radialIntensity: number;
  72315. /**
  72316. * 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))
  72317. */
  72318. direction: Vector2;
  72319. /**
  72320. * 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))
  72321. */
  72322. centerPosition: Vector2;
  72323. /**
  72324. * Creates a new instance ChromaticAberrationPostProcess
  72325. * @param name The name of the effect.
  72326. * @param screenWidth The width of the screen to apply the effect on.
  72327. * @param screenHeight The height of the screen to apply the effect on.
  72328. * @param options The required width/height ratio to downsize to before computing the render pass.
  72329. * @param camera The camera to apply the render pass to.
  72330. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72331. * @param engine The engine which the post process will be applied. (default: current engine)
  72332. * @param reusable If the post process can be reused on the same frame. (default: false)
  72333. * @param textureType Type of textures used when performing the post process. (default: 0)
  72334. * @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)
  72335. */
  72336. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72337. }
  72338. }
  72339. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72340. /** @hidden */
  72341. export var circleOfConfusionPixelShader: {
  72342. name: string;
  72343. shader: string;
  72344. };
  72345. }
  72346. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72347. import { Nullable } from "babylonjs/types";
  72348. import { Engine } from "babylonjs/Engines/engine";
  72349. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72350. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72351. import { Camera } from "babylonjs/Cameras/camera";
  72352. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72353. /**
  72354. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72355. */
  72356. export class CircleOfConfusionPostProcess extends PostProcess {
  72357. /**
  72358. * 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.
  72359. */
  72360. lensSize: number;
  72361. /**
  72362. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72363. */
  72364. fStop: number;
  72365. /**
  72366. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72367. */
  72368. focusDistance: number;
  72369. /**
  72370. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72371. */
  72372. focalLength: number;
  72373. private _depthTexture;
  72374. /**
  72375. * Creates a new instance CircleOfConfusionPostProcess
  72376. * @param name The name of the effect.
  72377. * @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.
  72378. * @param options The required width/height ratio to downsize to before computing the render pass.
  72379. * @param camera The camera to apply the render pass to.
  72380. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72381. * @param engine The engine which the post process will be applied. (default: current engine)
  72382. * @param reusable If the post process can be reused on the same frame. (default: false)
  72383. * @param textureType Type of textures used when performing the post process. (default: 0)
  72384. * @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)
  72385. */
  72386. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72387. /**
  72388. * 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.
  72389. */
  72390. set depthTexture(value: RenderTargetTexture);
  72391. }
  72392. }
  72393. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72394. /** @hidden */
  72395. export var colorCorrectionPixelShader: {
  72396. name: string;
  72397. shader: string;
  72398. };
  72399. }
  72400. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72401. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72402. import { Engine } from "babylonjs/Engines/engine";
  72403. import { Camera } from "babylonjs/Cameras/camera";
  72404. import "babylonjs/Shaders/colorCorrection.fragment";
  72405. /**
  72406. *
  72407. * This post-process allows the modification of rendered colors by using
  72408. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72409. *
  72410. * The object needs to be provided an url to a texture containing the color
  72411. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72412. * Use an image editing software to tweak the LUT to match your needs.
  72413. *
  72414. * For an example of a color LUT, see here:
  72415. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72416. * For explanations on color grading, see here:
  72417. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72418. *
  72419. */
  72420. export class ColorCorrectionPostProcess extends PostProcess {
  72421. private _colorTableTexture;
  72422. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72423. }
  72424. }
  72425. declare module "babylonjs/Shaders/convolution.fragment" {
  72426. /** @hidden */
  72427. export var convolutionPixelShader: {
  72428. name: string;
  72429. shader: string;
  72430. };
  72431. }
  72432. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72433. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72434. import { Nullable } from "babylonjs/types";
  72435. import { Camera } from "babylonjs/Cameras/camera";
  72436. import { Engine } from "babylonjs/Engines/engine";
  72437. import "babylonjs/Shaders/convolution.fragment";
  72438. /**
  72439. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72440. * input texture to perform effects such as edge detection or sharpening
  72441. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72442. */
  72443. export class ConvolutionPostProcess extends PostProcess {
  72444. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72445. kernel: number[];
  72446. /**
  72447. * Creates a new instance ConvolutionPostProcess
  72448. * @param name The name of the effect.
  72449. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72450. * @param options The required width/height ratio to downsize to before computing the render pass.
  72451. * @param camera The camera to apply the render pass to.
  72452. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72453. * @param engine The engine which the post process will be applied. (default: current engine)
  72454. * @param reusable If the post process can be reused on the same frame. (default: false)
  72455. * @param textureType Type of textures used when performing the post process. (default: 0)
  72456. */
  72457. constructor(name: string,
  72458. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72459. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72460. /**
  72461. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72462. */
  72463. static EdgeDetect0Kernel: number[];
  72464. /**
  72465. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72466. */
  72467. static EdgeDetect1Kernel: number[];
  72468. /**
  72469. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72470. */
  72471. static EdgeDetect2Kernel: number[];
  72472. /**
  72473. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72474. */
  72475. static SharpenKernel: number[];
  72476. /**
  72477. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72478. */
  72479. static EmbossKernel: number[];
  72480. /**
  72481. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72482. */
  72483. static GaussianKernel: number[];
  72484. }
  72485. }
  72486. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72487. import { Nullable } from "babylonjs/types";
  72488. import { Vector2 } from "babylonjs/Maths/math.vector";
  72489. import { Camera } from "babylonjs/Cameras/camera";
  72490. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72491. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72492. import { Engine } from "babylonjs/Engines/engine";
  72493. import { Scene } from "babylonjs/scene";
  72494. /**
  72495. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72496. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72497. * based on samples that have a large difference in distance than the center pixel.
  72498. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72499. */
  72500. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72501. direction: Vector2;
  72502. /**
  72503. * Creates a new instance CircleOfConfusionPostProcess
  72504. * @param name The name of the effect.
  72505. * @param scene The scene the effect belongs to.
  72506. * @param direction The direction the blur should be applied.
  72507. * @param kernel The size of the kernel used to blur.
  72508. * @param options The required width/height ratio to downsize to before computing the render pass.
  72509. * @param camera The camera to apply the render pass to.
  72510. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72511. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72512. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72513. * @param engine The engine which the post process will be applied. (default: current engine)
  72514. * @param reusable If the post process can be reused on the same frame. (default: false)
  72515. * @param textureType Type of textures used when performing the post process. (default: 0)
  72516. * @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)
  72517. */
  72518. 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);
  72519. }
  72520. }
  72521. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  72522. /** @hidden */
  72523. export var depthOfFieldMergePixelShader: {
  72524. name: string;
  72525. shader: string;
  72526. };
  72527. }
  72528. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  72529. import { Nullable } from "babylonjs/types";
  72530. import { Camera } from "babylonjs/Cameras/camera";
  72531. import { Effect } from "babylonjs/Materials/effect";
  72532. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72533. import { Engine } from "babylonjs/Engines/engine";
  72534. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  72535. /**
  72536. * Options to be set when merging outputs from the default pipeline.
  72537. */
  72538. export class DepthOfFieldMergePostProcessOptions {
  72539. /**
  72540. * The original image to merge on top of
  72541. */
  72542. originalFromInput: PostProcess;
  72543. /**
  72544. * Parameters to perform the merge of the depth of field effect
  72545. */
  72546. depthOfField?: {
  72547. circleOfConfusion: PostProcess;
  72548. blurSteps: Array<PostProcess>;
  72549. };
  72550. /**
  72551. * Parameters to perform the merge of bloom effect
  72552. */
  72553. bloom?: {
  72554. blurred: PostProcess;
  72555. weight: number;
  72556. };
  72557. }
  72558. /**
  72559. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72560. */
  72561. export class DepthOfFieldMergePostProcess extends PostProcess {
  72562. private blurSteps;
  72563. /**
  72564. * Creates a new instance of DepthOfFieldMergePostProcess
  72565. * @param name The name of the effect.
  72566. * @param originalFromInput Post process which's input will be used for the merge.
  72567. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  72568. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  72569. * @param options The required width/height ratio to downsize to before computing the render pass.
  72570. * @param camera The camera to apply the render pass to.
  72571. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72572. * @param engine The engine which the post process will be applied. (default: current engine)
  72573. * @param reusable If the post process can be reused on the same frame. (default: false)
  72574. * @param textureType Type of textures used when performing the post process. (default: 0)
  72575. * @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)
  72576. */
  72577. 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);
  72578. /**
  72579. * Updates the effect with the current post process compile time values and recompiles the shader.
  72580. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  72581. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  72582. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  72583. * @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
  72584. * @param onCompiled Called when the shader has been compiled.
  72585. * @param onError Called if there is an error when compiling a shader.
  72586. */
  72587. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  72588. }
  72589. }
  72590. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  72591. import { Nullable } from "babylonjs/types";
  72592. import { Camera } from "babylonjs/Cameras/camera";
  72593. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72594. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72595. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72596. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  72597. import { Scene } from "babylonjs/scene";
  72598. /**
  72599. * Specifies the level of max blur that should be applied when using the depth of field effect
  72600. */
  72601. export enum DepthOfFieldEffectBlurLevel {
  72602. /**
  72603. * Subtle blur
  72604. */
  72605. Low = 0,
  72606. /**
  72607. * Medium blur
  72608. */
  72609. Medium = 1,
  72610. /**
  72611. * Large blur
  72612. */
  72613. High = 2
  72614. }
  72615. /**
  72616. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  72617. */
  72618. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  72619. private _circleOfConfusion;
  72620. /**
  72621. * @hidden Internal, blurs from high to low
  72622. */
  72623. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  72624. private _depthOfFieldBlurY;
  72625. private _dofMerge;
  72626. /**
  72627. * @hidden Internal post processes in depth of field effect
  72628. */
  72629. _effects: Array<PostProcess>;
  72630. /**
  72631. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  72632. */
  72633. set focalLength(value: number);
  72634. get focalLength(): number;
  72635. /**
  72636. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72637. */
  72638. set fStop(value: number);
  72639. get fStop(): number;
  72640. /**
  72641. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72642. */
  72643. set focusDistance(value: number);
  72644. get focusDistance(): number;
  72645. /**
  72646. * 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.
  72647. */
  72648. set lensSize(value: number);
  72649. get lensSize(): number;
  72650. /**
  72651. * Creates a new instance DepthOfFieldEffect
  72652. * @param scene The scene the effect belongs to.
  72653. * @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.
  72654. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72655. * @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)
  72656. */
  72657. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  72658. /**
  72659. * Get the current class name of the current effet
  72660. * @returns "DepthOfFieldEffect"
  72661. */
  72662. getClassName(): string;
  72663. /**
  72664. * 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.
  72665. */
  72666. set depthTexture(value: RenderTargetTexture);
  72667. /**
  72668. * Disposes each of the internal effects for a given camera.
  72669. * @param camera The camera to dispose the effect on.
  72670. */
  72671. disposeEffects(camera: Camera): void;
  72672. /**
  72673. * @hidden Internal
  72674. */
  72675. _updateEffects(): void;
  72676. /**
  72677. * Internal
  72678. * @returns if all the contained post processes are ready.
  72679. * @hidden
  72680. */
  72681. _isReady(): boolean;
  72682. }
  72683. }
  72684. declare module "babylonjs/Shaders/displayPass.fragment" {
  72685. /** @hidden */
  72686. export var displayPassPixelShader: {
  72687. name: string;
  72688. shader: string;
  72689. };
  72690. }
  72691. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  72692. import { Nullable } from "babylonjs/types";
  72693. import { Camera } from "babylonjs/Cameras/camera";
  72694. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72695. import { Engine } from "babylonjs/Engines/engine";
  72696. import "babylonjs/Shaders/displayPass.fragment";
  72697. /**
  72698. * DisplayPassPostProcess which produces an output the same as it's input
  72699. */
  72700. export class DisplayPassPostProcess extends PostProcess {
  72701. /**
  72702. * Creates the DisplayPassPostProcess
  72703. * @param name The name of the effect.
  72704. * @param options The required width/height ratio to downsize to before computing the render pass.
  72705. * @param camera The camera to apply the render pass to.
  72706. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72707. * @param engine The engine which the post process will be applied. (default: current engine)
  72708. * @param reusable If the post process can be reused on the same frame. (default: false)
  72709. */
  72710. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72711. }
  72712. }
  72713. declare module "babylonjs/Shaders/filter.fragment" {
  72714. /** @hidden */
  72715. export var filterPixelShader: {
  72716. name: string;
  72717. shader: string;
  72718. };
  72719. }
  72720. declare module "babylonjs/PostProcesses/filterPostProcess" {
  72721. import { Nullable } from "babylonjs/types";
  72722. import { Matrix } from "babylonjs/Maths/math.vector";
  72723. import { Camera } from "babylonjs/Cameras/camera";
  72724. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72725. import { Engine } from "babylonjs/Engines/engine";
  72726. import "babylonjs/Shaders/filter.fragment";
  72727. /**
  72728. * Applies a kernel filter to the image
  72729. */
  72730. export class FilterPostProcess extends PostProcess {
  72731. /** The matrix to be applied to the image */
  72732. kernelMatrix: Matrix;
  72733. /**
  72734. *
  72735. * @param name The name of the effect.
  72736. * @param kernelMatrix The matrix to be applied to the image
  72737. * @param options The required width/height ratio to downsize to before computing the render pass.
  72738. * @param camera The camera to apply the render pass to.
  72739. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72740. * @param engine The engine which the post process will be applied. (default: current engine)
  72741. * @param reusable If the post process can be reused on the same frame. (default: false)
  72742. */
  72743. constructor(name: string,
  72744. /** The matrix to be applied to the image */
  72745. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72746. }
  72747. }
  72748. declare module "babylonjs/Shaders/fxaa.fragment" {
  72749. /** @hidden */
  72750. export var fxaaPixelShader: {
  72751. name: string;
  72752. shader: string;
  72753. };
  72754. }
  72755. declare module "babylonjs/Shaders/fxaa.vertex" {
  72756. /** @hidden */
  72757. export var fxaaVertexShader: {
  72758. name: string;
  72759. shader: string;
  72760. };
  72761. }
  72762. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  72763. import { Nullable } from "babylonjs/types";
  72764. import { Camera } from "babylonjs/Cameras/camera";
  72765. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72766. import { Engine } from "babylonjs/Engines/engine";
  72767. import "babylonjs/Shaders/fxaa.fragment";
  72768. import "babylonjs/Shaders/fxaa.vertex";
  72769. /**
  72770. * Fxaa post process
  72771. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  72772. */
  72773. export class FxaaPostProcess extends PostProcess {
  72774. /** @hidden */
  72775. texelWidth: number;
  72776. /** @hidden */
  72777. texelHeight: number;
  72778. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72779. private _getDefines;
  72780. }
  72781. }
  72782. declare module "babylonjs/Shaders/grain.fragment" {
  72783. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72784. /** @hidden */
  72785. export var grainPixelShader: {
  72786. name: string;
  72787. shader: string;
  72788. };
  72789. }
  72790. declare module "babylonjs/PostProcesses/grainPostProcess" {
  72791. import { Nullable } from "babylonjs/types";
  72792. import { Camera } from "babylonjs/Cameras/camera";
  72793. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72794. import { Engine } from "babylonjs/Engines/engine";
  72795. import "babylonjs/Shaders/grain.fragment";
  72796. /**
  72797. * The GrainPostProcess adds noise to the image at mid luminance levels
  72798. */
  72799. export class GrainPostProcess extends PostProcess {
  72800. /**
  72801. * The intensity of the grain added (default: 30)
  72802. */
  72803. intensity: number;
  72804. /**
  72805. * If the grain should be randomized on every frame
  72806. */
  72807. animated: boolean;
  72808. /**
  72809. * Creates a new instance of @see GrainPostProcess
  72810. * @param name The name of the effect.
  72811. * @param options The required width/height ratio to downsize to before computing the render pass.
  72812. * @param camera The camera to apply the render pass to.
  72813. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72814. * @param engine The engine which the post process will be applied. (default: current engine)
  72815. * @param reusable If the post process can be reused on the same frame. (default: false)
  72816. * @param textureType Type of textures used when performing the post process. (default: 0)
  72817. * @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)
  72818. */
  72819. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72820. }
  72821. }
  72822. declare module "babylonjs/Shaders/highlights.fragment" {
  72823. /** @hidden */
  72824. export var highlightsPixelShader: {
  72825. name: string;
  72826. shader: string;
  72827. };
  72828. }
  72829. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  72830. import { Nullable } from "babylonjs/types";
  72831. import { Camera } from "babylonjs/Cameras/camera";
  72832. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72833. import { Engine } from "babylonjs/Engines/engine";
  72834. import "babylonjs/Shaders/highlights.fragment";
  72835. /**
  72836. * Extracts highlights from the image
  72837. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72838. */
  72839. export class HighlightsPostProcess extends PostProcess {
  72840. /**
  72841. * Extracts highlights from the image
  72842. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72843. * @param name The name of the effect.
  72844. * @param options The required width/height ratio to downsize to before computing the render pass.
  72845. * @param camera The camera to apply the render pass to.
  72846. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72847. * @param engine The engine which the post process will be applied. (default: current engine)
  72848. * @param reusable If the post process can be reused on the same frame. (default: false)
  72849. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  72850. */
  72851. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72852. }
  72853. }
  72854. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  72855. /** @hidden */
  72856. export var mrtFragmentDeclaration: {
  72857. name: string;
  72858. shader: string;
  72859. };
  72860. }
  72861. declare module "babylonjs/Shaders/geometry.fragment" {
  72862. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  72863. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  72864. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  72865. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  72866. /** @hidden */
  72867. export var geometryPixelShader: {
  72868. name: string;
  72869. shader: string;
  72870. };
  72871. }
  72872. declare module "babylonjs/Shaders/geometry.vertex" {
  72873. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  72874. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  72875. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  72876. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  72877. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  72878. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  72879. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  72880. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  72881. /** @hidden */
  72882. export var geometryVertexShader: {
  72883. name: string;
  72884. shader: string;
  72885. };
  72886. }
  72887. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  72888. import { Matrix } from "babylonjs/Maths/math.vector";
  72889. import { SubMesh } from "babylonjs/Meshes/subMesh";
  72890. import { Mesh } from "babylonjs/Meshes/mesh";
  72891. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  72892. import { Effect } from "babylonjs/Materials/effect";
  72893. import { Scene } from "babylonjs/scene";
  72894. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72895. import "babylonjs/Shaders/geometry.fragment";
  72896. import "babylonjs/Shaders/geometry.vertex";
  72897. /** @hidden */
  72898. interface ISavedTransformationMatrix {
  72899. world: Matrix;
  72900. viewProjection: Matrix;
  72901. }
  72902. /**
  72903. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  72904. */
  72905. export class GeometryBufferRenderer {
  72906. /**
  72907. * Constant used to retrieve the position texture index in the G-Buffer textures array
  72908. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  72909. */
  72910. static readonly POSITION_TEXTURE_TYPE: number;
  72911. /**
  72912. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  72913. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  72914. */
  72915. static readonly VELOCITY_TEXTURE_TYPE: number;
  72916. /**
  72917. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  72918. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  72919. */
  72920. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  72921. /**
  72922. * Dictionary used to store the previous transformation matrices of each rendered mesh
  72923. * in order to compute objects velocities when enableVelocity is set to "true"
  72924. * @hidden
  72925. */
  72926. _previousTransformationMatrices: {
  72927. [index: number]: ISavedTransformationMatrix;
  72928. };
  72929. /**
  72930. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  72931. * in order to compute objects velocities when enableVelocity is set to "true"
  72932. * @hidden
  72933. */
  72934. _previousBonesTransformationMatrices: {
  72935. [index: number]: Float32Array;
  72936. };
  72937. /**
  72938. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  72939. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  72940. */
  72941. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  72942. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  72943. renderTransparentMeshes: boolean;
  72944. private _scene;
  72945. private _resizeObserver;
  72946. private _multiRenderTarget;
  72947. private _ratio;
  72948. private _enablePosition;
  72949. private _enableVelocity;
  72950. private _enableReflectivity;
  72951. private _positionIndex;
  72952. private _velocityIndex;
  72953. private _reflectivityIndex;
  72954. protected _effect: Effect;
  72955. protected _cachedDefines: string;
  72956. /**
  72957. * Set the render list (meshes to be rendered) used in the G buffer.
  72958. */
  72959. set renderList(meshes: Mesh[]);
  72960. /**
  72961. * Gets wether or not G buffer are supported by the running hardware.
  72962. * This requires draw buffer supports
  72963. */
  72964. get isSupported(): boolean;
  72965. /**
  72966. * Returns the index of the given texture type in the G-Buffer textures array
  72967. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  72968. * @returns the index of the given texture type in the G-Buffer textures array
  72969. */
  72970. getTextureIndex(textureType: number): number;
  72971. /**
  72972. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  72973. */
  72974. get enablePosition(): boolean;
  72975. /**
  72976. * Sets whether or not objects positions are enabled for the G buffer.
  72977. */
  72978. set enablePosition(enable: boolean);
  72979. /**
  72980. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  72981. */
  72982. get enableVelocity(): boolean;
  72983. /**
  72984. * Sets wether or not objects velocities are enabled for the G buffer.
  72985. */
  72986. set enableVelocity(enable: boolean);
  72987. /**
  72988. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  72989. */
  72990. get enableReflectivity(): boolean;
  72991. /**
  72992. * Sets wether or not objects roughness are enabled for the G buffer.
  72993. */
  72994. set enableReflectivity(enable: boolean);
  72995. /**
  72996. * Gets the scene associated with the buffer.
  72997. */
  72998. get scene(): Scene;
  72999. /**
  73000. * Gets the ratio used by the buffer during its creation.
  73001. * How big is the buffer related to the main canvas.
  73002. */
  73003. get ratio(): number;
  73004. /** @hidden */
  73005. static _SceneComponentInitialization: (scene: Scene) => void;
  73006. /**
  73007. * Creates a new G Buffer for the scene
  73008. * @param scene The scene the buffer belongs to
  73009. * @param ratio How big is the buffer related to the main canvas.
  73010. */
  73011. constructor(scene: Scene, ratio?: number);
  73012. /**
  73013. * Checks wether everything is ready to render a submesh to the G buffer.
  73014. * @param subMesh the submesh to check readiness for
  73015. * @param useInstances is the mesh drawn using instance or not
  73016. * @returns true if ready otherwise false
  73017. */
  73018. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73019. /**
  73020. * Gets the current underlying G Buffer.
  73021. * @returns the buffer
  73022. */
  73023. getGBuffer(): MultiRenderTarget;
  73024. /**
  73025. * Gets the number of samples used to render the buffer (anti aliasing).
  73026. */
  73027. get samples(): number;
  73028. /**
  73029. * Sets the number of samples used to render the buffer (anti aliasing).
  73030. */
  73031. set samples(value: number);
  73032. /**
  73033. * Disposes the renderer and frees up associated resources.
  73034. */
  73035. dispose(): void;
  73036. protected _createRenderTargets(): void;
  73037. private _copyBonesTransformationMatrices;
  73038. }
  73039. }
  73040. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73041. import { Nullable } from "babylonjs/types";
  73042. import { Scene } from "babylonjs/scene";
  73043. import { ISceneComponent } from "babylonjs/sceneComponent";
  73044. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73045. module "babylonjs/scene" {
  73046. interface Scene {
  73047. /** @hidden (Backing field) */
  73048. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73049. /**
  73050. * Gets or Sets the current geometry buffer associated to the scene.
  73051. */
  73052. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73053. /**
  73054. * Enables a GeometryBufferRender and associates it with the scene
  73055. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73056. * @returns the GeometryBufferRenderer
  73057. */
  73058. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73059. /**
  73060. * Disables the GeometryBufferRender associated with the scene
  73061. */
  73062. disableGeometryBufferRenderer(): void;
  73063. }
  73064. }
  73065. /**
  73066. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73067. * in several rendering techniques.
  73068. */
  73069. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73070. /**
  73071. * The component name helpful to identify the component in the list of scene components.
  73072. */
  73073. readonly name: string;
  73074. /**
  73075. * The scene the component belongs to.
  73076. */
  73077. scene: Scene;
  73078. /**
  73079. * Creates a new instance of the component for the given scene
  73080. * @param scene Defines the scene to register the component in
  73081. */
  73082. constructor(scene: Scene);
  73083. /**
  73084. * Registers the component in a given scene
  73085. */
  73086. register(): void;
  73087. /**
  73088. * Rebuilds the elements related to this component in case of
  73089. * context lost for instance.
  73090. */
  73091. rebuild(): void;
  73092. /**
  73093. * Disposes the component and the associated ressources
  73094. */
  73095. dispose(): void;
  73096. private _gatherRenderTargets;
  73097. }
  73098. }
  73099. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73100. /** @hidden */
  73101. export var motionBlurPixelShader: {
  73102. name: string;
  73103. shader: string;
  73104. };
  73105. }
  73106. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73107. import { Nullable } from "babylonjs/types";
  73108. import { Camera } from "babylonjs/Cameras/camera";
  73109. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73110. import { Scene } from "babylonjs/scene";
  73111. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73112. import "babylonjs/Animations/animatable";
  73113. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73114. import "babylonjs/Shaders/motionBlur.fragment";
  73115. import { Engine } from "babylonjs/Engines/engine";
  73116. /**
  73117. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73118. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73119. * As an example, all you have to do is to create the post-process:
  73120. * var mb = new BABYLON.MotionBlurPostProcess(
  73121. * 'mb', // The name of the effect.
  73122. * scene, // The scene containing the objects to blur according to their velocity.
  73123. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73124. * camera // The camera to apply the render pass to.
  73125. * );
  73126. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73127. */
  73128. export class MotionBlurPostProcess extends PostProcess {
  73129. /**
  73130. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73131. */
  73132. motionStrength: number;
  73133. /**
  73134. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73135. */
  73136. get motionBlurSamples(): number;
  73137. /**
  73138. * Sets the number of iterations to be used for motion blur quality
  73139. */
  73140. set motionBlurSamples(samples: number);
  73141. private _motionBlurSamples;
  73142. private _geometryBufferRenderer;
  73143. /**
  73144. * Creates a new instance MotionBlurPostProcess
  73145. * @param name The name of the effect.
  73146. * @param scene The scene containing the objects to blur according to their velocity.
  73147. * @param options The required width/height ratio to downsize to before computing the render pass.
  73148. * @param camera The camera to apply the render pass to.
  73149. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73150. * @param engine The engine which the post process will be applied. (default: current engine)
  73151. * @param reusable If the post process can be reused on the same frame. (default: false)
  73152. * @param textureType Type of textures used when performing the post process. (default: 0)
  73153. * @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)
  73154. */
  73155. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73156. /**
  73157. * Excludes the given skinned mesh from computing bones velocities.
  73158. * 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.
  73159. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73160. */
  73161. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73162. /**
  73163. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73164. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73165. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73166. */
  73167. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73168. /**
  73169. * Disposes the post process.
  73170. * @param camera The camera to dispose the post process on.
  73171. */
  73172. dispose(camera?: Camera): void;
  73173. }
  73174. }
  73175. declare module "babylonjs/Shaders/refraction.fragment" {
  73176. /** @hidden */
  73177. export var refractionPixelShader: {
  73178. name: string;
  73179. shader: string;
  73180. };
  73181. }
  73182. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73183. import { Color3 } from "babylonjs/Maths/math.color";
  73184. import { Camera } from "babylonjs/Cameras/camera";
  73185. import { Texture } from "babylonjs/Materials/Textures/texture";
  73186. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73187. import { Engine } from "babylonjs/Engines/engine";
  73188. import "babylonjs/Shaders/refraction.fragment";
  73189. /**
  73190. * Post process which applies a refractin texture
  73191. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73192. */
  73193. export class RefractionPostProcess extends PostProcess {
  73194. /** the base color of the refraction (used to taint the rendering) */
  73195. color: Color3;
  73196. /** simulated refraction depth */
  73197. depth: number;
  73198. /** the coefficient of the base color (0 to remove base color tainting) */
  73199. colorLevel: number;
  73200. private _refTexture;
  73201. private _ownRefractionTexture;
  73202. /**
  73203. * Gets or sets the refraction texture
  73204. * Please note that you are responsible for disposing the texture if you set it manually
  73205. */
  73206. get refractionTexture(): Texture;
  73207. set refractionTexture(value: Texture);
  73208. /**
  73209. * Initializes the RefractionPostProcess
  73210. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73211. * @param name The name of the effect.
  73212. * @param refractionTextureUrl Url of the refraction texture to use
  73213. * @param color the base color of the refraction (used to taint the rendering)
  73214. * @param depth simulated refraction depth
  73215. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73216. * @param camera The camera to apply the render pass to.
  73217. * @param options The required width/height ratio to downsize to before computing the render pass.
  73218. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73219. * @param engine The engine which the post process will be applied. (default: current engine)
  73220. * @param reusable If the post process can be reused on the same frame. (default: false)
  73221. */
  73222. constructor(name: string, refractionTextureUrl: string,
  73223. /** the base color of the refraction (used to taint the rendering) */
  73224. color: Color3,
  73225. /** simulated refraction depth */
  73226. depth: number,
  73227. /** the coefficient of the base color (0 to remove base color tainting) */
  73228. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73229. /**
  73230. * Disposes of the post process
  73231. * @param camera Camera to dispose post process on
  73232. */
  73233. dispose(camera: Camera): void;
  73234. }
  73235. }
  73236. declare module "babylonjs/Shaders/sharpen.fragment" {
  73237. /** @hidden */
  73238. export var sharpenPixelShader: {
  73239. name: string;
  73240. shader: string;
  73241. };
  73242. }
  73243. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73244. import { Nullable } from "babylonjs/types";
  73245. import { Camera } from "babylonjs/Cameras/camera";
  73246. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73247. import "babylonjs/Shaders/sharpen.fragment";
  73248. import { Engine } from "babylonjs/Engines/engine";
  73249. /**
  73250. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73251. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73252. */
  73253. export class SharpenPostProcess extends PostProcess {
  73254. /**
  73255. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73256. */
  73257. colorAmount: number;
  73258. /**
  73259. * How much sharpness should be applied (default: 0.3)
  73260. */
  73261. edgeAmount: number;
  73262. /**
  73263. * Creates a new instance ConvolutionPostProcess
  73264. * @param name The name of the effect.
  73265. * @param options The required width/height ratio to downsize to before computing the render pass.
  73266. * @param camera The camera to apply the render pass to.
  73267. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73268. * @param engine The engine which the post process will be applied. (default: current engine)
  73269. * @param reusable If the post process can be reused on the same frame. (default: false)
  73270. * @param textureType Type of textures used when performing the post process. (default: 0)
  73271. * @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)
  73272. */
  73273. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73274. }
  73275. }
  73276. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73277. import { Nullable } from "babylonjs/types";
  73278. import { Camera } from "babylonjs/Cameras/camera";
  73279. import { Engine } from "babylonjs/Engines/engine";
  73280. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73281. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73282. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73283. /**
  73284. * PostProcessRenderPipeline
  73285. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73286. */
  73287. export class PostProcessRenderPipeline {
  73288. private engine;
  73289. private _renderEffects;
  73290. private _renderEffectsForIsolatedPass;
  73291. /**
  73292. * List of inspectable custom properties (used by the Inspector)
  73293. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73294. */
  73295. inspectableCustomProperties: IInspectable[];
  73296. /**
  73297. * @hidden
  73298. */
  73299. protected _cameras: Camera[];
  73300. /** @hidden */
  73301. _name: string;
  73302. /**
  73303. * Gets pipeline name
  73304. */
  73305. get name(): string;
  73306. /** Gets the list of attached cameras */
  73307. get cameras(): Camera[];
  73308. /**
  73309. * Initializes a PostProcessRenderPipeline
  73310. * @param engine engine to add the pipeline to
  73311. * @param name name of the pipeline
  73312. */
  73313. constructor(engine: Engine, name: string);
  73314. /**
  73315. * Gets the class name
  73316. * @returns "PostProcessRenderPipeline"
  73317. */
  73318. getClassName(): string;
  73319. /**
  73320. * If all the render effects in the pipeline are supported
  73321. */
  73322. get isSupported(): boolean;
  73323. /**
  73324. * Adds an effect to the pipeline
  73325. * @param renderEffect the effect to add
  73326. */
  73327. addEffect(renderEffect: PostProcessRenderEffect): void;
  73328. /** @hidden */
  73329. _rebuild(): void;
  73330. /** @hidden */
  73331. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73332. /** @hidden */
  73333. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73334. /** @hidden */
  73335. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73336. /** @hidden */
  73337. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73338. /** @hidden */
  73339. _attachCameras(cameras: Camera, unique: boolean): void;
  73340. /** @hidden */
  73341. _attachCameras(cameras: Camera[], unique: boolean): void;
  73342. /** @hidden */
  73343. _detachCameras(cameras: Camera): void;
  73344. /** @hidden */
  73345. _detachCameras(cameras: Nullable<Camera[]>): void;
  73346. /** @hidden */
  73347. _update(): void;
  73348. /** @hidden */
  73349. _reset(): void;
  73350. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73351. /**
  73352. * Sets the required values to the prepass renderer.
  73353. * @param prePassRenderer defines the prepass renderer to setup.
  73354. * @returns true if the pre pass is needed.
  73355. */
  73356. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73357. /**
  73358. * Disposes of the pipeline
  73359. */
  73360. dispose(): void;
  73361. }
  73362. }
  73363. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73364. import { Camera } from "babylonjs/Cameras/camera";
  73365. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73366. /**
  73367. * PostProcessRenderPipelineManager class
  73368. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73369. */
  73370. export class PostProcessRenderPipelineManager {
  73371. private _renderPipelines;
  73372. /**
  73373. * Initializes a PostProcessRenderPipelineManager
  73374. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73375. */
  73376. constructor();
  73377. /**
  73378. * Gets the list of supported render pipelines
  73379. */
  73380. get supportedPipelines(): PostProcessRenderPipeline[];
  73381. /**
  73382. * Adds a pipeline to the manager
  73383. * @param renderPipeline The pipeline to add
  73384. */
  73385. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73386. /**
  73387. * Attaches a camera to the pipeline
  73388. * @param renderPipelineName The name of the pipeline to attach to
  73389. * @param cameras the camera to attach
  73390. * @param unique if the camera can be attached multiple times to the pipeline
  73391. */
  73392. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73393. /**
  73394. * Detaches a camera from the pipeline
  73395. * @param renderPipelineName The name of the pipeline to detach from
  73396. * @param cameras the camera to detach
  73397. */
  73398. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73399. /**
  73400. * Enables an effect by name on a pipeline
  73401. * @param renderPipelineName the name of the pipeline to enable the effect in
  73402. * @param renderEffectName the name of the effect to enable
  73403. * @param cameras the cameras that the effect should be enabled on
  73404. */
  73405. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73406. /**
  73407. * Disables an effect by name on a pipeline
  73408. * @param renderPipelineName the name of the pipeline to disable the effect in
  73409. * @param renderEffectName the name of the effect to disable
  73410. * @param cameras the cameras that the effect should be disabled on
  73411. */
  73412. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73413. /**
  73414. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73415. */
  73416. update(): void;
  73417. /** @hidden */
  73418. _rebuild(): void;
  73419. /**
  73420. * Disposes of the manager and pipelines
  73421. */
  73422. dispose(): void;
  73423. }
  73424. }
  73425. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73426. import { ISceneComponent } from "babylonjs/sceneComponent";
  73427. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73428. import { Scene } from "babylonjs/scene";
  73429. module "babylonjs/scene" {
  73430. interface Scene {
  73431. /** @hidden (Backing field) */
  73432. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73433. /**
  73434. * Gets the postprocess render pipeline manager
  73435. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73436. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73437. */
  73438. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73439. }
  73440. }
  73441. /**
  73442. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73443. */
  73444. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73445. /**
  73446. * The component name helpfull to identify the component in the list of scene components.
  73447. */
  73448. readonly name: string;
  73449. /**
  73450. * The scene the component belongs to.
  73451. */
  73452. scene: Scene;
  73453. /**
  73454. * Creates a new instance of the component for the given scene
  73455. * @param scene Defines the scene to register the component in
  73456. */
  73457. constructor(scene: Scene);
  73458. /**
  73459. * Registers the component in a given scene
  73460. */
  73461. register(): void;
  73462. /**
  73463. * Rebuilds the elements related to this component in case of
  73464. * context lost for instance.
  73465. */
  73466. rebuild(): void;
  73467. /**
  73468. * Disposes the component and the associated ressources
  73469. */
  73470. dispose(): void;
  73471. private _gatherRenderTargets;
  73472. }
  73473. }
  73474. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  73475. import { Nullable } from "babylonjs/types";
  73476. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  73477. import { Camera } from "babylonjs/Cameras/camera";
  73478. import { IDisposable } from "babylonjs/scene";
  73479. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  73480. import { Scene } from "babylonjs/scene";
  73481. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  73482. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  73483. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  73484. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  73485. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  73486. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73487. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  73488. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73489. import { Animation } from "babylonjs/Animations/animation";
  73490. /**
  73491. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  73492. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73493. */
  73494. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  73495. private _scene;
  73496. private _camerasToBeAttached;
  73497. /**
  73498. * ID of the sharpen post process,
  73499. */
  73500. private readonly SharpenPostProcessId;
  73501. /**
  73502. * @ignore
  73503. * ID of the image processing post process;
  73504. */
  73505. readonly ImageProcessingPostProcessId: string;
  73506. /**
  73507. * @ignore
  73508. * ID of the Fast Approximate Anti-Aliasing post process;
  73509. */
  73510. readonly FxaaPostProcessId: string;
  73511. /**
  73512. * ID of the chromatic aberration post process,
  73513. */
  73514. private readonly ChromaticAberrationPostProcessId;
  73515. /**
  73516. * ID of the grain post process
  73517. */
  73518. private readonly GrainPostProcessId;
  73519. /**
  73520. * Sharpen post process which will apply a sharpen convolution to enhance edges
  73521. */
  73522. sharpen: SharpenPostProcess;
  73523. private _sharpenEffect;
  73524. private bloom;
  73525. /**
  73526. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  73527. */
  73528. depthOfField: DepthOfFieldEffect;
  73529. /**
  73530. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  73531. */
  73532. fxaa: FxaaPostProcess;
  73533. /**
  73534. * Image post processing pass used to perform operations such as tone mapping or color grading.
  73535. */
  73536. imageProcessing: ImageProcessingPostProcess;
  73537. /**
  73538. * Chromatic aberration post process which will shift rgb colors in the image
  73539. */
  73540. chromaticAberration: ChromaticAberrationPostProcess;
  73541. private _chromaticAberrationEffect;
  73542. /**
  73543. * Grain post process which add noise to the image
  73544. */
  73545. grain: GrainPostProcess;
  73546. private _grainEffect;
  73547. /**
  73548. * Glow post process which adds a glow to emissive areas of the image
  73549. */
  73550. private _glowLayer;
  73551. /**
  73552. * Animations which can be used to tweak settings over a period of time
  73553. */
  73554. animations: Animation[];
  73555. private _imageProcessingConfigurationObserver;
  73556. private _sharpenEnabled;
  73557. private _bloomEnabled;
  73558. private _depthOfFieldEnabled;
  73559. private _depthOfFieldBlurLevel;
  73560. private _fxaaEnabled;
  73561. private _imageProcessingEnabled;
  73562. private _defaultPipelineTextureType;
  73563. private _bloomScale;
  73564. private _chromaticAberrationEnabled;
  73565. private _grainEnabled;
  73566. private _buildAllowed;
  73567. /**
  73568. * Gets active scene
  73569. */
  73570. get scene(): Scene;
  73571. /**
  73572. * Enable or disable the sharpen process from the pipeline
  73573. */
  73574. set sharpenEnabled(enabled: boolean);
  73575. get sharpenEnabled(): boolean;
  73576. private _resizeObserver;
  73577. private _hardwareScaleLevel;
  73578. private _bloomKernel;
  73579. /**
  73580. * Specifies the size of the bloom blur kernel, relative to the final output size
  73581. */
  73582. get bloomKernel(): number;
  73583. set bloomKernel(value: number);
  73584. /**
  73585. * Specifies the weight of the bloom in the final rendering
  73586. */
  73587. private _bloomWeight;
  73588. /**
  73589. * Specifies the luma threshold for the area that will be blurred by the bloom
  73590. */
  73591. private _bloomThreshold;
  73592. private _hdr;
  73593. /**
  73594. * The strength of the bloom.
  73595. */
  73596. set bloomWeight(value: number);
  73597. get bloomWeight(): number;
  73598. /**
  73599. * The strength of the bloom.
  73600. */
  73601. set bloomThreshold(value: number);
  73602. get bloomThreshold(): number;
  73603. /**
  73604. * The scale of the bloom, lower value will provide better performance.
  73605. */
  73606. set bloomScale(value: number);
  73607. get bloomScale(): number;
  73608. /**
  73609. * Enable or disable the bloom from the pipeline
  73610. */
  73611. set bloomEnabled(enabled: boolean);
  73612. get bloomEnabled(): boolean;
  73613. private _rebuildBloom;
  73614. /**
  73615. * If the depth of field is enabled.
  73616. */
  73617. get depthOfFieldEnabled(): boolean;
  73618. set depthOfFieldEnabled(enabled: boolean);
  73619. /**
  73620. * Blur level of the depth of field effect. (Higher blur will effect performance)
  73621. */
  73622. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  73623. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  73624. /**
  73625. * If the anti aliasing is enabled.
  73626. */
  73627. set fxaaEnabled(enabled: boolean);
  73628. get fxaaEnabled(): boolean;
  73629. private _samples;
  73630. /**
  73631. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  73632. */
  73633. set samples(sampleCount: number);
  73634. get samples(): number;
  73635. /**
  73636. * If image processing is enabled.
  73637. */
  73638. set imageProcessingEnabled(enabled: boolean);
  73639. get imageProcessingEnabled(): boolean;
  73640. /**
  73641. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  73642. */
  73643. set glowLayerEnabled(enabled: boolean);
  73644. get glowLayerEnabled(): boolean;
  73645. /**
  73646. * Gets the glow layer (or null if not defined)
  73647. */
  73648. get glowLayer(): Nullable<GlowLayer>;
  73649. /**
  73650. * Enable or disable the chromaticAberration process from the pipeline
  73651. */
  73652. set chromaticAberrationEnabled(enabled: boolean);
  73653. get chromaticAberrationEnabled(): boolean;
  73654. /**
  73655. * Enable or disable the grain process from the pipeline
  73656. */
  73657. set grainEnabled(enabled: boolean);
  73658. get grainEnabled(): boolean;
  73659. /**
  73660. * @constructor
  73661. * @param name - The rendering pipeline name (default: "")
  73662. * @param hdr - If high dynamic range textures should be used (default: true)
  73663. * @param scene - The scene linked to this pipeline (default: the last created scene)
  73664. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  73665. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  73666. */
  73667. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  73668. /**
  73669. * Get the class name
  73670. * @returns "DefaultRenderingPipeline"
  73671. */
  73672. getClassName(): string;
  73673. /**
  73674. * Force the compilation of the entire pipeline.
  73675. */
  73676. prepare(): void;
  73677. private _hasCleared;
  73678. private _prevPostProcess;
  73679. private _prevPrevPostProcess;
  73680. private _setAutoClearAndTextureSharing;
  73681. private _depthOfFieldSceneObserver;
  73682. private _buildPipeline;
  73683. private _disposePostProcesses;
  73684. /**
  73685. * Adds a camera to the pipeline
  73686. * @param camera the camera to be added
  73687. */
  73688. addCamera(camera: Camera): void;
  73689. /**
  73690. * Removes a camera from the pipeline
  73691. * @param camera the camera to remove
  73692. */
  73693. removeCamera(camera: Camera): void;
  73694. /**
  73695. * Dispose of the pipeline and stop all post processes
  73696. */
  73697. dispose(): void;
  73698. /**
  73699. * Serialize the rendering pipeline (Used when exporting)
  73700. * @returns the serialized object
  73701. */
  73702. serialize(): any;
  73703. /**
  73704. * Parse the serialized pipeline
  73705. * @param source Source pipeline.
  73706. * @param scene The scene to load the pipeline to.
  73707. * @param rootUrl The URL of the serialized pipeline.
  73708. * @returns An instantiated pipeline from the serialized object.
  73709. */
  73710. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  73711. }
  73712. }
  73713. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  73714. /** @hidden */
  73715. export var lensHighlightsPixelShader: {
  73716. name: string;
  73717. shader: string;
  73718. };
  73719. }
  73720. declare module "babylonjs/Shaders/depthOfField.fragment" {
  73721. /** @hidden */
  73722. export var depthOfFieldPixelShader: {
  73723. name: string;
  73724. shader: string;
  73725. };
  73726. }
  73727. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  73728. import { Camera } from "babylonjs/Cameras/camera";
  73729. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73730. import { Scene } from "babylonjs/scene";
  73731. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73732. import "babylonjs/Shaders/chromaticAberration.fragment";
  73733. import "babylonjs/Shaders/lensHighlights.fragment";
  73734. import "babylonjs/Shaders/depthOfField.fragment";
  73735. /**
  73736. * BABYLON.JS Chromatic Aberration GLSL Shader
  73737. * Author: Olivier Guyot
  73738. * Separates very slightly R, G and B colors on the edges of the screen
  73739. * Inspired by Francois Tarlier & Martins Upitis
  73740. */
  73741. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  73742. /**
  73743. * @ignore
  73744. * The chromatic aberration PostProcess id in the pipeline
  73745. */
  73746. LensChromaticAberrationEffect: string;
  73747. /**
  73748. * @ignore
  73749. * The highlights enhancing PostProcess id in the pipeline
  73750. */
  73751. HighlightsEnhancingEffect: string;
  73752. /**
  73753. * @ignore
  73754. * The depth-of-field PostProcess id in the pipeline
  73755. */
  73756. LensDepthOfFieldEffect: string;
  73757. private _scene;
  73758. private _depthTexture;
  73759. private _grainTexture;
  73760. private _chromaticAberrationPostProcess;
  73761. private _highlightsPostProcess;
  73762. private _depthOfFieldPostProcess;
  73763. private _edgeBlur;
  73764. private _grainAmount;
  73765. private _chromaticAberration;
  73766. private _distortion;
  73767. private _highlightsGain;
  73768. private _highlightsThreshold;
  73769. private _dofDistance;
  73770. private _dofAperture;
  73771. private _dofDarken;
  73772. private _dofPentagon;
  73773. private _blurNoise;
  73774. /**
  73775. * @constructor
  73776. *
  73777. * Effect parameters are as follow:
  73778. * {
  73779. * chromatic_aberration: number; // from 0 to x (1 for realism)
  73780. * edge_blur: number; // from 0 to x (1 for realism)
  73781. * distortion: number; // from 0 to x (1 for realism)
  73782. * grain_amount: number; // from 0 to 1
  73783. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  73784. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  73785. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  73786. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  73787. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  73788. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  73789. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  73790. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  73791. * }
  73792. * Note: if an effect parameter is unset, effect is disabled
  73793. *
  73794. * @param name The rendering pipeline name
  73795. * @param parameters - An object containing all parameters (see above)
  73796. * @param scene The scene linked to this pipeline
  73797. * @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)
  73798. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73799. */
  73800. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  73801. /**
  73802. * Get the class name
  73803. * @returns "LensRenderingPipeline"
  73804. */
  73805. getClassName(): string;
  73806. /**
  73807. * Gets associated scene
  73808. */
  73809. get scene(): Scene;
  73810. /**
  73811. * Gets or sets the edge blur
  73812. */
  73813. get edgeBlur(): number;
  73814. set edgeBlur(value: number);
  73815. /**
  73816. * Gets or sets the grain amount
  73817. */
  73818. get grainAmount(): number;
  73819. set grainAmount(value: number);
  73820. /**
  73821. * Gets or sets the chromatic aberration amount
  73822. */
  73823. get chromaticAberration(): number;
  73824. set chromaticAberration(value: number);
  73825. /**
  73826. * Gets or sets the depth of field aperture
  73827. */
  73828. get dofAperture(): number;
  73829. set dofAperture(value: number);
  73830. /**
  73831. * Gets or sets the edge distortion
  73832. */
  73833. get edgeDistortion(): number;
  73834. set edgeDistortion(value: number);
  73835. /**
  73836. * Gets or sets the depth of field distortion
  73837. */
  73838. get dofDistortion(): number;
  73839. set dofDistortion(value: number);
  73840. /**
  73841. * Gets or sets the darken out of focus amount
  73842. */
  73843. get darkenOutOfFocus(): number;
  73844. set darkenOutOfFocus(value: number);
  73845. /**
  73846. * Gets or sets a boolean indicating if blur noise is enabled
  73847. */
  73848. get blurNoise(): boolean;
  73849. set blurNoise(value: boolean);
  73850. /**
  73851. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  73852. */
  73853. get pentagonBokeh(): boolean;
  73854. set pentagonBokeh(value: boolean);
  73855. /**
  73856. * Gets or sets the highlight grain amount
  73857. */
  73858. get highlightsGain(): number;
  73859. set highlightsGain(value: number);
  73860. /**
  73861. * Gets or sets the highlight threshold
  73862. */
  73863. get highlightsThreshold(): number;
  73864. set highlightsThreshold(value: number);
  73865. /**
  73866. * Sets the amount of blur at the edges
  73867. * @param amount blur amount
  73868. */
  73869. setEdgeBlur(amount: number): void;
  73870. /**
  73871. * Sets edge blur to 0
  73872. */
  73873. disableEdgeBlur(): void;
  73874. /**
  73875. * Sets the amout of grain
  73876. * @param amount Amount of grain
  73877. */
  73878. setGrainAmount(amount: number): void;
  73879. /**
  73880. * Set grain amount to 0
  73881. */
  73882. disableGrain(): void;
  73883. /**
  73884. * Sets the chromatic aberration amount
  73885. * @param amount amount of chromatic aberration
  73886. */
  73887. setChromaticAberration(amount: number): void;
  73888. /**
  73889. * Sets chromatic aberration amount to 0
  73890. */
  73891. disableChromaticAberration(): void;
  73892. /**
  73893. * Sets the EdgeDistortion amount
  73894. * @param amount amount of EdgeDistortion
  73895. */
  73896. setEdgeDistortion(amount: number): void;
  73897. /**
  73898. * Sets edge distortion to 0
  73899. */
  73900. disableEdgeDistortion(): void;
  73901. /**
  73902. * Sets the FocusDistance amount
  73903. * @param amount amount of FocusDistance
  73904. */
  73905. setFocusDistance(amount: number): void;
  73906. /**
  73907. * Disables depth of field
  73908. */
  73909. disableDepthOfField(): void;
  73910. /**
  73911. * Sets the Aperture amount
  73912. * @param amount amount of Aperture
  73913. */
  73914. setAperture(amount: number): void;
  73915. /**
  73916. * Sets the DarkenOutOfFocus amount
  73917. * @param amount amount of DarkenOutOfFocus
  73918. */
  73919. setDarkenOutOfFocus(amount: number): void;
  73920. private _pentagonBokehIsEnabled;
  73921. /**
  73922. * Creates a pentagon bokeh effect
  73923. */
  73924. enablePentagonBokeh(): void;
  73925. /**
  73926. * Disables the pentagon bokeh effect
  73927. */
  73928. disablePentagonBokeh(): void;
  73929. /**
  73930. * Enables noise blur
  73931. */
  73932. enableNoiseBlur(): void;
  73933. /**
  73934. * Disables noise blur
  73935. */
  73936. disableNoiseBlur(): void;
  73937. /**
  73938. * Sets the HighlightsGain amount
  73939. * @param amount amount of HighlightsGain
  73940. */
  73941. setHighlightsGain(amount: number): void;
  73942. /**
  73943. * Sets the HighlightsThreshold amount
  73944. * @param amount amount of HighlightsThreshold
  73945. */
  73946. setHighlightsThreshold(amount: number): void;
  73947. /**
  73948. * Disables highlights
  73949. */
  73950. disableHighlights(): void;
  73951. /**
  73952. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  73953. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  73954. */
  73955. dispose(disableDepthRender?: boolean): void;
  73956. private _createChromaticAberrationPostProcess;
  73957. private _createHighlightsPostProcess;
  73958. private _createDepthOfFieldPostProcess;
  73959. private _createGrainTexture;
  73960. }
  73961. }
  73962. declare module "babylonjs/Shaders/ssao2.fragment" {
  73963. /** @hidden */
  73964. export var ssao2PixelShader: {
  73965. name: string;
  73966. shader: string;
  73967. };
  73968. }
  73969. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  73970. /** @hidden */
  73971. export var ssaoCombinePixelShader: {
  73972. name: string;
  73973. shader: string;
  73974. };
  73975. }
  73976. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  73977. import { Camera } from "babylonjs/Cameras/camera";
  73978. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73979. import { Scene } from "babylonjs/scene";
  73980. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73981. import "babylonjs/Shaders/ssao2.fragment";
  73982. import "babylonjs/Shaders/ssaoCombine.fragment";
  73983. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73984. /**
  73985. * Render pipeline to produce ssao effect
  73986. */
  73987. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  73988. /**
  73989. * @ignore
  73990. * The PassPostProcess id in the pipeline that contains the original scene color
  73991. */
  73992. SSAOOriginalSceneColorEffect: string;
  73993. /**
  73994. * @ignore
  73995. * The SSAO PostProcess id in the pipeline
  73996. */
  73997. SSAORenderEffect: string;
  73998. /**
  73999. * @ignore
  74000. * The horizontal blur PostProcess id in the pipeline
  74001. */
  74002. SSAOBlurHRenderEffect: string;
  74003. /**
  74004. * @ignore
  74005. * The vertical blur PostProcess id in the pipeline
  74006. */
  74007. SSAOBlurVRenderEffect: string;
  74008. /**
  74009. * @ignore
  74010. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74011. */
  74012. SSAOCombineRenderEffect: string;
  74013. /**
  74014. * The output strength of the SSAO post-process. Default value is 1.0.
  74015. */
  74016. totalStrength: number;
  74017. /**
  74018. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74019. */
  74020. maxZ: number;
  74021. /**
  74022. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74023. */
  74024. minZAspect: number;
  74025. private _samples;
  74026. /**
  74027. * Number of samples used for the SSAO calculations. Default value is 8
  74028. */
  74029. set samples(n: number);
  74030. get samples(): number;
  74031. private _textureSamples;
  74032. /**
  74033. * Number of samples to use for antialiasing
  74034. */
  74035. set textureSamples(n: number);
  74036. get textureSamples(): number;
  74037. /**
  74038. * Force rendering the geometry through geometry buffer
  74039. */
  74040. private _forceGeometryBuffer;
  74041. /**
  74042. * Ratio object used for SSAO ratio and blur ratio
  74043. */
  74044. private _ratio;
  74045. /**
  74046. * Dynamically generated sphere sampler.
  74047. */
  74048. private _sampleSphere;
  74049. /**
  74050. * Blur filter offsets
  74051. */
  74052. private _samplerOffsets;
  74053. private _expensiveBlur;
  74054. /**
  74055. * If bilateral blur should be used
  74056. */
  74057. set expensiveBlur(b: boolean);
  74058. get expensiveBlur(): boolean;
  74059. /**
  74060. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74061. */
  74062. radius: number;
  74063. /**
  74064. * The base color of the SSAO post-process
  74065. * The final result is "base + ssao" between [0, 1]
  74066. */
  74067. base: number;
  74068. /**
  74069. * Support test.
  74070. */
  74071. static get IsSupported(): boolean;
  74072. private _scene;
  74073. private _randomTexture;
  74074. private _originalColorPostProcess;
  74075. private _ssaoPostProcess;
  74076. private _blurHPostProcess;
  74077. private _blurVPostProcess;
  74078. private _ssaoCombinePostProcess;
  74079. private _prePassRenderer;
  74080. /**
  74081. * Gets active scene
  74082. */
  74083. get scene(): Scene;
  74084. /**
  74085. * @constructor
  74086. * @param name The rendering pipeline name
  74087. * @param scene The scene linked to this pipeline
  74088. * @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 }
  74089. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74090. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74091. */
  74092. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74093. /**
  74094. * Get the class name
  74095. * @returns "SSAO2RenderingPipeline"
  74096. */
  74097. getClassName(): string;
  74098. /**
  74099. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74100. */
  74101. dispose(disableGeometryBufferRenderer?: boolean): void;
  74102. private _createBlurPostProcess;
  74103. /** @hidden */
  74104. _rebuild(): void;
  74105. private _bits;
  74106. private _radicalInverse_VdC;
  74107. private _hammersley;
  74108. private _hemisphereSample_uniform;
  74109. private _generateHemisphere;
  74110. private _getDefinesForSSAO;
  74111. private _createSSAOPostProcess;
  74112. private _createSSAOCombinePostProcess;
  74113. private _createRandomTexture;
  74114. /**
  74115. * Serialize the rendering pipeline (Used when exporting)
  74116. * @returns the serialized object
  74117. */
  74118. serialize(): any;
  74119. /**
  74120. * Parse the serialized pipeline
  74121. * @param source Source pipeline.
  74122. * @param scene The scene to load the pipeline to.
  74123. * @param rootUrl The URL of the serialized pipeline.
  74124. * @returns An instantiated pipeline from the serialized object.
  74125. */
  74126. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74127. /**
  74128. * Sets the required values to the prepass renderer.
  74129. * @param prePassRenderer defines the prepass renderer to setup
  74130. * @returns true if the pre pass is needed.
  74131. */
  74132. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74133. }
  74134. }
  74135. declare module "babylonjs/Shaders/ssao.fragment" {
  74136. /** @hidden */
  74137. export var ssaoPixelShader: {
  74138. name: string;
  74139. shader: string;
  74140. };
  74141. }
  74142. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74143. import { Camera } from "babylonjs/Cameras/camera";
  74144. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74145. import { Scene } from "babylonjs/scene";
  74146. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74147. import "babylonjs/Shaders/ssao.fragment";
  74148. import "babylonjs/Shaders/ssaoCombine.fragment";
  74149. /**
  74150. * Render pipeline to produce ssao effect
  74151. */
  74152. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74153. /**
  74154. * @ignore
  74155. * The PassPostProcess id in the pipeline that contains the original scene color
  74156. */
  74157. SSAOOriginalSceneColorEffect: string;
  74158. /**
  74159. * @ignore
  74160. * The SSAO PostProcess id in the pipeline
  74161. */
  74162. SSAORenderEffect: string;
  74163. /**
  74164. * @ignore
  74165. * The horizontal blur PostProcess id in the pipeline
  74166. */
  74167. SSAOBlurHRenderEffect: string;
  74168. /**
  74169. * @ignore
  74170. * The vertical blur PostProcess id in the pipeline
  74171. */
  74172. SSAOBlurVRenderEffect: string;
  74173. /**
  74174. * @ignore
  74175. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74176. */
  74177. SSAOCombineRenderEffect: string;
  74178. /**
  74179. * The output strength of the SSAO post-process. Default value is 1.0.
  74180. */
  74181. totalStrength: number;
  74182. /**
  74183. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74184. */
  74185. radius: number;
  74186. /**
  74187. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74188. * Must not be equal to fallOff and superior to fallOff.
  74189. * Default value is 0.0075
  74190. */
  74191. area: number;
  74192. /**
  74193. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74194. * Must not be equal to area and inferior to area.
  74195. * Default value is 0.000001
  74196. */
  74197. fallOff: number;
  74198. /**
  74199. * The base color of the SSAO post-process
  74200. * The final result is "base + ssao" between [0, 1]
  74201. */
  74202. base: number;
  74203. private _scene;
  74204. private _depthTexture;
  74205. private _randomTexture;
  74206. private _originalColorPostProcess;
  74207. private _ssaoPostProcess;
  74208. private _blurHPostProcess;
  74209. private _blurVPostProcess;
  74210. private _ssaoCombinePostProcess;
  74211. private _firstUpdate;
  74212. /**
  74213. * Gets active scene
  74214. */
  74215. get scene(): Scene;
  74216. /**
  74217. * @constructor
  74218. * @param name - The rendering pipeline name
  74219. * @param scene - The scene linked to this pipeline
  74220. * @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 }
  74221. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74222. */
  74223. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74224. /**
  74225. * Get the class name
  74226. * @returns "SSAORenderingPipeline"
  74227. */
  74228. getClassName(): string;
  74229. /**
  74230. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74231. */
  74232. dispose(disableDepthRender?: boolean): void;
  74233. private _createBlurPostProcess;
  74234. /** @hidden */
  74235. _rebuild(): void;
  74236. private _createSSAOPostProcess;
  74237. private _createSSAOCombinePostProcess;
  74238. private _createRandomTexture;
  74239. }
  74240. }
  74241. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74242. /** @hidden */
  74243. export var screenSpaceReflectionPixelShader: {
  74244. name: string;
  74245. shader: string;
  74246. };
  74247. }
  74248. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74249. import { Nullable } from "babylonjs/types";
  74250. import { Camera } from "babylonjs/Cameras/camera";
  74251. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74252. import { Scene } from "babylonjs/scene";
  74253. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74254. import { Engine } from "babylonjs/Engines/engine";
  74255. /**
  74256. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74257. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74258. */
  74259. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74260. /**
  74261. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74262. */
  74263. threshold: number;
  74264. /**
  74265. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74266. */
  74267. strength: number;
  74268. /**
  74269. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74270. */
  74271. reflectionSpecularFalloffExponent: number;
  74272. /**
  74273. * 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]
  74274. */
  74275. step: number;
  74276. /**
  74277. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74278. */
  74279. roughnessFactor: number;
  74280. private _geometryBufferRenderer;
  74281. private _enableSmoothReflections;
  74282. private _reflectionSamples;
  74283. private _smoothSteps;
  74284. /**
  74285. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74286. * @param name The name of the effect.
  74287. * @param scene The scene containing the objects to calculate reflections.
  74288. * @param options The required width/height ratio to downsize to before computing the render pass.
  74289. * @param camera The camera to apply the render pass to.
  74290. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74291. * @param engine The engine which the post process will be applied. (default: current engine)
  74292. * @param reusable If the post process can be reused on the same frame. (default: false)
  74293. * @param textureType Type of textures used when performing the post process. (default: 0)
  74294. * @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)
  74295. */
  74296. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74297. /**
  74298. * Gets wether or not smoothing reflections is enabled.
  74299. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74300. */
  74301. get enableSmoothReflections(): boolean;
  74302. /**
  74303. * Sets wether or not smoothing reflections is enabled.
  74304. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74305. */
  74306. set enableSmoothReflections(enabled: boolean);
  74307. /**
  74308. * Gets the number of samples taken while computing reflections. More samples count is high,
  74309. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74310. */
  74311. get reflectionSamples(): number;
  74312. /**
  74313. * Sets the number of samples taken while computing reflections. More samples count is high,
  74314. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74315. */
  74316. set reflectionSamples(samples: number);
  74317. /**
  74318. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74319. * more the post-process will require GPU power and can generate a drop in FPS.
  74320. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74321. */
  74322. get smoothSteps(): number;
  74323. set smoothSteps(steps: number);
  74324. private _updateEffectDefines;
  74325. }
  74326. }
  74327. declare module "babylonjs/Shaders/standard.fragment" {
  74328. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74329. /** @hidden */
  74330. export var standardPixelShader: {
  74331. name: string;
  74332. shader: string;
  74333. };
  74334. }
  74335. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74336. import { Nullable } from "babylonjs/types";
  74337. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74338. import { Camera } from "babylonjs/Cameras/camera";
  74339. import { Texture } from "babylonjs/Materials/Textures/texture";
  74340. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74341. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74342. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74343. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74344. import { IDisposable } from "babylonjs/scene";
  74345. import { SpotLight } from "babylonjs/Lights/spotLight";
  74346. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74347. import { Scene } from "babylonjs/scene";
  74348. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74349. import { Animation } from "babylonjs/Animations/animation";
  74350. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74351. import "babylonjs/Shaders/standard.fragment";
  74352. /**
  74353. * Standard rendering pipeline
  74354. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74355. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74356. */
  74357. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74358. /**
  74359. * Public members
  74360. */
  74361. /**
  74362. * Post-process which contains the original scene color before the pipeline applies all the effects
  74363. */
  74364. originalPostProcess: Nullable<PostProcess>;
  74365. /**
  74366. * Post-process used to down scale an image x4
  74367. */
  74368. downSampleX4PostProcess: Nullable<PostProcess>;
  74369. /**
  74370. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74371. */
  74372. brightPassPostProcess: Nullable<PostProcess>;
  74373. /**
  74374. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74375. */
  74376. blurHPostProcesses: PostProcess[];
  74377. /**
  74378. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74379. */
  74380. blurVPostProcesses: PostProcess[];
  74381. /**
  74382. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74383. */
  74384. textureAdderPostProcess: Nullable<PostProcess>;
  74385. /**
  74386. * Post-process used to create volumetric lighting effect
  74387. */
  74388. volumetricLightPostProcess: Nullable<PostProcess>;
  74389. /**
  74390. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74391. */
  74392. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74393. /**
  74394. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74395. */
  74396. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74397. /**
  74398. * Post-process used to merge the volumetric light effect and the real scene color
  74399. */
  74400. volumetricLightMergePostProces: Nullable<PostProcess>;
  74401. /**
  74402. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74403. */
  74404. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74405. /**
  74406. * Base post-process used to calculate the average luminance of the final image for HDR
  74407. */
  74408. luminancePostProcess: Nullable<PostProcess>;
  74409. /**
  74410. * Post-processes used to create down sample post-processes in order to get
  74411. * the average luminance of the final image for HDR
  74412. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74413. */
  74414. luminanceDownSamplePostProcesses: PostProcess[];
  74415. /**
  74416. * Post-process used to create a HDR effect (light adaptation)
  74417. */
  74418. hdrPostProcess: Nullable<PostProcess>;
  74419. /**
  74420. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74421. */
  74422. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74423. /**
  74424. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74425. */
  74426. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74427. /**
  74428. * Post-process used to merge the final HDR post-process and the real scene color
  74429. */
  74430. hdrFinalPostProcess: Nullable<PostProcess>;
  74431. /**
  74432. * Post-process used to create a lens flare effect
  74433. */
  74434. lensFlarePostProcess: Nullable<PostProcess>;
  74435. /**
  74436. * Post-process that merges the result of the lens flare post-process and the real scene color
  74437. */
  74438. lensFlareComposePostProcess: Nullable<PostProcess>;
  74439. /**
  74440. * Post-process used to create a motion blur effect
  74441. */
  74442. motionBlurPostProcess: Nullable<PostProcess>;
  74443. /**
  74444. * Post-process used to create a depth of field effect
  74445. */
  74446. depthOfFieldPostProcess: Nullable<PostProcess>;
  74447. /**
  74448. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74449. */
  74450. fxaaPostProcess: Nullable<FxaaPostProcess>;
  74451. /**
  74452. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  74453. */
  74454. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  74455. /**
  74456. * Represents the brightness threshold in order to configure the illuminated surfaces
  74457. */
  74458. brightThreshold: number;
  74459. /**
  74460. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  74461. */
  74462. blurWidth: number;
  74463. /**
  74464. * Sets if the blur for highlighted surfaces must be only horizontal
  74465. */
  74466. horizontalBlur: boolean;
  74467. /**
  74468. * Gets the overall exposure used by the pipeline
  74469. */
  74470. get exposure(): number;
  74471. /**
  74472. * Sets the overall exposure used by the pipeline
  74473. */
  74474. set exposure(value: number);
  74475. /**
  74476. * Texture used typically to simulate "dirty" on camera lens
  74477. */
  74478. lensTexture: Nullable<Texture>;
  74479. /**
  74480. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  74481. */
  74482. volumetricLightCoefficient: number;
  74483. /**
  74484. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  74485. */
  74486. volumetricLightPower: number;
  74487. /**
  74488. * Used the set the blur intensity to smooth the volumetric lights
  74489. */
  74490. volumetricLightBlurScale: number;
  74491. /**
  74492. * Light (spot or directional) used to generate the volumetric lights rays
  74493. * The source light must have a shadow generate so the pipeline can get its
  74494. * depth map
  74495. */
  74496. sourceLight: Nullable<SpotLight | DirectionalLight>;
  74497. /**
  74498. * For eye adaptation, represents the minimum luminance the eye can see
  74499. */
  74500. hdrMinimumLuminance: number;
  74501. /**
  74502. * For eye adaptation, represents the decrease luminance speed
  74503. */
  74504. hdrDecreaseRate: number;
  74505. /**
  74506. * For eye adaptation, represents the increase luminance speed
  74507. */
  74508. hdrIncreaseRate: number;
  74509. /**
  74510. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  74511. */
  74512. get hdrAutoExposure(): boolean;
  74513. /**
  74514. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  74515. */
  74516. set hdrAutoExposure(value: boolean);
  74517. /**
  74518. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  74519. */
  74520. lensColorTexture: Nullable<Texture>;
  74521. /**
  74522. * The overall strengh for the lens flare effect
  74523. */
  74524. lensFlareStrength: number;
  74525. /**
  74526. * Dispersion coefficient for lens flare ghosts
  74527. */
  74528. lensFlareGhostDispersal: number;
  74529. /**
  74530. * Main lens flare halo width
  74531. */
  74532. lensFlareHaloWidth: number;
  74533. /**
  74534. * Based on the lens distortion effect, defines how much the lens flare result
  74535. * is distorted
  74536. */
  74537. lensFlareDistortionStrength: number;
  74538. /**
  74539. * Configures the blur intensity used for for lens flare (halo)
  74540. */
  74541. lensFlareBlurWidth: number;
  74542. /**
  74543. * Lens star texture must be used to simulate rays on the flares and is available
  74544. * in the documentation
  74545. */
  74546. lensStarTexture: Nullable<Texture>;
  74547. /**
  74548. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  74549. * flare effect by taking account of the dirt texture
  74550. */
  74551. lensFlareDirtTexture: Nullable<Texture>;
  74552. /**
  74553. * Represents the focal length for the depth of field effect
  74554. */
  74555. depthOfFieldDistance: number;
  74556. /**
  74557. * Represents the blur intensity for the blurred part of the depth of field effect
  74558. */
  74559. depthOfFieldBlurWidth: number;
  74560. /**
  74561. * Gets how much the image is blurred by the movement while using the motion blur post-process
  74562. */
  74563. get motionStrength(): number;
  74564. /**
  74565. * Sets how much the image is blurred by the movement while using the motion blur post-process
  74566. */
  74567. set motionStrength(strength: number);
  74568. /**
  74569. * Gets wether or not the motion blur post-process is object based or screen based.
  74570. */
  74571. get objectBasedMotionBlur(): boolean;
  74572. /**
  74573. * Sets wether or not the motion blur post-process should be object based or screen based
  74574. */
  74575. set objectBasedMotionBlur(value: boolean);
  74576. /**
  74577. * List of animations for the pipeline (IAnimatable implementation)
  74578. */
  74579. animations: Animation[];
  74580. /**
  74581. * Private members
  74582. */
  74583. private _scene;
  74584. private _currentDepthOfFieldSource;
  74585. private _basePostProcess;
  74586. private _fixedExposure;
  74587. private _currentExposure;
  74588. private _hdrAutoExposure;
  74589. private _hdrCurrentLuminance;
  74590. private _motionStrength;
  74591. private _isObjectBasedMotionBlur;
  74592. private _floatTextureType;
  74593. private _camerasToBeAttached;
  74594. private _ratio;
  74595. private _bloomEnabled;
  74596. private _depthOfFieldEnabled;
  74597. private _vlsEnabled;
  74598. private _lensFlareEnabled;
  74599. private _hdrEnabled;
  74600. private _motionBlurEnabled;
  74601. private _fxaaEnabled;
  74602. private _screenSpaceReflectionsEnabled;
  74603. private _motionBlurSamples;
  74604. private _volumetricLightStepsCount;
  74605. private _samples;
  74606. /**
  74607. * @ignore
  74608. * Specifies if the bloom pipeline is enabled
  74609. */
  74610. get BloomEnabled(): boolean;
  74611. set BloomEnabled(enabled: boolean);
  74612. /**
  74613. * @ignore
  74614. * Specifies if the depth of field pipeline is enabed
  74615. */
  74616. get DepthOfFieldEnabled(): boolean;
  74617. set DepthOfFieldEnabled(enabled: boolean);
  74618. /**
  74619. * @ignore
  74620. * Specifies if the lens flare pipeline is enabed
  74621. */
  74622. get LensFlareEnabled(): boolean;
  74623. set LensFlareEnabled(enabled: boolean);
  74624. /**
  74625. * @ignore
  74626. * Specifies if the HDR pipeline is enabled
  74627. */
  74628. get HDREnabled(): boolean;
  74629. set HDREnabled(enabled: boolean);
  74630. /**
  74631. * @ignore
  74632. * Specifies if the volumetric lights scattering effect is enabled
  74633. */
  74634. get VLSEnabled(): boolean;
  74635. set VLSEnabled(enabled: boolean);
  74636. /**
  74637. * @ignore
  74638. * Specifies if the motion blur effect is enabled
  74639. */
  74640. get MotionBlurEnabled(): boolean;
  74641. set MotionBlurEnabled(enabled: boolean);
  74642. /**
  74643. * Specifies if anti-aliasing is enabled
  74644. */
  74645. get fxaaEnabled(): boolean;
  74646. set fxaaEnabled(enabled: boolean);
  74647. /**
  74648. * Specifies if screen space reflections are enabled.
  74649. */
  74650. get screenSpaceReflectionsEnabled(): boolean;
  74651. set screenSpaceReflectionsEnabled(enabled: boolean);
  74652. /**
  74653. * Specifies the number of steps used to calculate the volumetric lights
  74654. * Typically in interval [50, 200]
  74655. */
  74656. get volumetricLightStepsCount(): number;
  74657. set volumetricLightStepsCount(count: number);
  74658. /**
  74659. * Specifies the number of samples used for the motion blur effect
  74660. * Typically in interval [16, 64]
  74661. */
  74662. get motionBlurSamples(): number;
  74663. set motionBlurSamples(samples: number);
  74664. /**
  74665. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74666. */
  74667. get samples(): number;
  74668. set samples(sampleCount: number);
  74669. /**
  74670. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74671. * @constructor
  74672. * @param name The rendering pipeline name
  74673. * @param scene The scene linked to this pipeline
  74674. * @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)
  74675. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  74676. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74677. */
  74678. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  74679. private _buildPipeline;
  74680. private _createDownSampleX4PostProcess;
  74681. private _createBrightPassPostProcess;
  74682. private _createBlurPostProcesses;
  74683. private _createTextureAdderPostProcess;
  74684. private _createVolumetricLightPostProcess;
  74685. private _createLuminancePostProcesses;
  74686. private _createHdrPostProcess;
  74687. private _createLensFlarePostProcess;
  74688. private _createDepthOfFieldPostProcess;
  74689. private _createMotionBlurPostProcess;
  74690. private _getDepthTexture;
  74691. private _disposePostProcesses;
  74692. /**
  74693. * Dispose of the pipeline and stop all post processes
  74694. */
  74695. dispose(): void;
  74696. /**
  74697. * Serialize the rendering pipeline (Used when exporting)
  74698. * @returns the serialized object
  74699. */
  74700. serialize(): any;
  74701. /**
  74702. * Parse the serialized pipeline
  74703. * @param source Source pipeline.
  74704. * @param scene The scene to load the pipeline to.
  74705. * @param rootUrl The URL of the serialized pipeline.
  74706. * @returns An instantiated pipeline from the serialized object.
  74707. */
  74708. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  74709. /**
  74710. * Luminance steps
  74711. */
  74712. static LuminanceSteps: number;
  74713. }
  74714. }
  74715. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  74716. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  74717. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  74718. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  74719. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  74720. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  74721. }
  74722. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  74723. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  74724. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74725. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74726. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74727. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74728. }
  74729. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  74730. /** @hidden */
  74731. export var stereoscopicInterlacePixelShader: {
  74732. name: string;
  74733. shader: string;
  74734. };
  74735. }
  74736. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  74737. import { Camera } from "babylonjs/Cameras/camera";
  74738. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74739. import { Engine } from "babylonjs/Engines/engine";
  74740. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  74741. /**
  74742. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  74743. */
  74744. export class StereoscopicInterlacePostProcessI extends PostProcess {
  74745. private _stepSize;
  74746. private _passedProcess;
  74747. /**
  74748. * Initializes a StereoscopicInterlacePostProcessI
  74749. * @param name The name of the effect.
  74750. * @param rigCameras The rig cameras to be appled to the post process
  74751. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  74752. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  74753. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74754. * @param engine The engine which the post process will be applied. (default: current engine)
  74755. * @param reusable If the post process can be reused on the same frame. (default: false)
  74756. */
  74757. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74758. }
  74759. /**
  74760. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  74761. */
  74762. export class StereoscopicInterlacePostProcess extends PostProcess {
  74763. private _stepSize;
  74764. private _passedProcess;
  74765. /**
  74766. * Initializes a StereoscopicInterlacePostProcess
  74767. * @param name The name of the effect.
  74768. * @param rigCameras The rig cameras to be appled to the post process
  74769. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  74770. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74771. * @param engine The engine which the post process will be applied. (default: current engine)
  74772. * @param reusable If the post process can be reused on the same frame. (default: false)
  74773. */
  74774. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74775. }
  74776. }
  74777. declare module "babylonjs/Shaders/tonemap.fragment" {
  74778. /** @hidden */
  74779. export var tonemapPixelShader: {
  74780. name: string;
  74781. shader: string;
  74782. };
  74783. }
  74784. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  74785. import { Camera } from "babylonjs/Cameras/camera";
  74786. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74787. import "babylonjs/Shaders/tonemap.fragment";
  74788. import { Engine } from "babylonjs/Engines/engine";
  74789. /** Defines operator used for tonemapping */
  74790. export enum TonemappingOperator {
  74791. /** Hable */
  74792. Hable = 0,
  74793. /** Reinhard */
  74794. Reinhard = 1,
  74795. /** HejiDawson */
  74796. HejiDawson = 2,
  74797. /** Photographic */
  74798. Photographic = 3
  74799. }
  74800. /**
  74801. * Defines a post process to apply tone mapping
  74802. */
  74803. export class TonemapPostProcess extends PostProcess {
  74804. private _operator;
  74805. /** Defines the required exposure adjustement */
  74806. exposureAdjustment: number;
  74807. /**
  74808. * Creates a new TonemapPostProcess
  74809. * @param name defines the name of the postprocess
  74810. * @param _operator defines the operator to use
  74811. * @param exposureAdjustment defines the required exposure adjustement
  74812. * @param camera defines the camera to use (can be null)
  74813. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  74814. * @param engine defines the hosting engine (can be ignore if camera is set)
  74815. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  74816. */
  74817. constructor(name: string, _operator: TonemappingOperator,
  74818. /** Defines the required exposure adjustement */
  74819. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  74820. }
  74821. }
  74822. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  74823. /** @hidden */
  74824. export var volumetricLightScatteringPixelShader: {
  74825. name: string;
  74826. shader: string;
  74827. };
  74828. }
  74829. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  74830. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  74831. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  74832. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  74833. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  74834. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  74835. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  74836. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  74837. /** @hidden */
  74838. export var volumetricLightScatteringPassVertexShader: {
  74839. name: string;
  74840. shader: string;
  74841. };
  74842. }
  74843. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  74844. /** @hidden */
  74845. export var volumetricLightScatteringPassPixelShader: {
  74846. name: string;
  74847. shader: string;
  74848. };
  74849. }
  74850. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  74851. import { Vector3 } from "babylonjs/Maths/math.vector";
  74852. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74853. import { Mesh } from "babylonjs/Meshes/mesh";
  74854. import { Camera } from "babylonjs/Cameras/camera";
  74855. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  74856. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74857. import { Scene } from "babylonjs/scene";
  74858. import "babylonjs/Meshes/Builders/planeBuilder";
  74859. import "babylonjs/Shaders/depth.vertex";
  74860. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  74861. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  74862. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  74863. import { Engine } from "babylonjs/Engines/engine";
  74864. /**
  74865. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  74866. */
  74867. export class VolumetricLightScatteringPostProcess extends PostProcess {
  74868. private _volumetricLightScatteringPass;
  74869. private _volumetricLightScatteringRTT;
  74870. private _viewPort;
  74871. private _screenCoordinates;
  74872. private _cachedDefines;
  74873. /**
  74874. * If not undefined, the mesh position is computed from the attached node position
  74875. */
  74876. attachedNode: {
  74877. position: Vector3;
  74878. };
  74879. /**
  74880. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  74881. */
  74882. customMeshPosition: Vector3;
  74883. /**
  74884. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  74885. */
  74886. useCustomMeshPosition: boolean;
  74887. /**
  74888. * If the post-process should inverse the light scattering direction
  74889. */
  74890. invert: boolean;
  74891. /**
  74892. * The internal mesh used by the post-process
  74893. */
  74894. mesh: Mesh;
  74895. /**
  74896. * @hidden
  74897. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  74898. */
  74899. get useDiffuseColor(): boolean;
  74900. set useDiffuseColor(useDiffuseColor: boolean);
  74901. /**
  74902. * Array containing the excluded meshes not rendered in the internal pass
  74903. */
  74904. excludedMeshes: AbstractMesh[];
  74905. /**
  74906. * Controls the overall intensity of the post-process
  74907. */
  74908. exposure: number;
  74909. /**
  74910. * Dissipates each sample's contribution in range [0, 1]
  74911. */
  74912. decay: number;
  74913. /**
  74914. * Controls the overall intensity of each sample
  74915. */
  74916. weight: number;
  74917. /**
  74918. * Controls the density of each sample
  74919. */
  74920. density: number;
  74921. /**
  74922. * @constructor
  74923. * @param name The post-process name
  74924. * @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)
  74925. * @param camera The camera that the post-process will be attached to
  74926. * @param mesh The mesh used to create the light scattering
  74927. * @param samples The post-process quality, default 100
  74928. * @param samplingModeThe post-process filtering mode
  74929. * @param engine The babylon engine
  74930. * @param reusable If the post-process is reusable
  74931. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  74932. */
  74933. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  74934. /**
  74935. * Returns the string "VolumetricLightScatteringPostProcess"
  74936. * @returns "VolumetricLightScatteringPostProcess"
  74937. */
  74938. getClassName(): string;
  74939. private _isReady;
  74940. /**
  74941. * Sets the new light position for light scattering effect
  74942. * @param position The new custom light position
  74943. */
  74944. setCustomMeshPosition(position: Vector3): void;
  74945. /**
  74946. * Returns the light position for light scattering effect
  74947. * @return Vector3 The custom light position
  74948. */
  74949. getCustomMeshPosition(): Vector3;
  74950. /**
  74951. * Disposes the internal assets and detaches the post-process from the camera
  74952. */
  74953. dispose(camera: Camera): void;
  74954. /**
  74955. * Returns the render target texture used by the post-process
  74956. * @return the render target texture used by the post-process
  74957. */
  74958. getPass(): RenderTargetTexture;
  74959. private _meshExcluded;
  74960. private _createPass;
  74961. private _updateMeshScreenCoordinates;
  74962. /**
  74963. * Creates a default mesh for the Volumeric Light Scattering post-process
  74964. * @param name The mesh name
  74965. * @param scene The scene where to create the mesh
  74966. * @return the default mesh
  74967. */
  74968. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  74969. }
  74970. }
  74971. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  74972. /** @hidden */
  74973. export var screenSpaceCurvaturePixelShader: {
  74974. name: string;
  74975. shader: string;
  74976. };
  74977. }
  74978. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  74979. import { Nullable } from "babylonjs/types";
  74980. import { Camera } from "babylonjs/Cameras/camera";
  74981. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74982. import { Scene } from "babylonjs/scene";
  74983. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  74984. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  74985. import { Engine } from "babylonjs/Engines/engine";
  74986. /**
  74987. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  74988. */
  74989. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  74990. /**
  74991. * Defines how much ridge the curvature effect displays.
  74992. */
  74993. ridge: number;
  74994. /**
  74995. * Defines how much valley the curvature effect displays.
  74996. */
  74997. valley: number;
  74998. private _geometryBufferRenderer;
  74999. /**
  75000. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75001. * @param name The name of the effect.
  75002. * @param scene The scene containing the objects to blur according to their velocity.
  75003. * @param options The required width/height ratio to downsize to before computing the render pass.
  75004. * @param camera The camera to apply the render pass to.
  75005. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75006. * @param engine The engine which the post process will be applied. (default: current engine)
  75007. * @param reusable If the post process can be reused on the same frame. (default: false)
  75008. * @param textureType Type of textures used when performing the post process. (default: 0)
  75009. * @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)
  75010. */
  75011. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75012. /**
  75013. * Support test.
  75014. */
  75015. static get IsSupported(): boolean;
  75016. }
  75017. }
  75018. declare module "babylonjs/PostProcesses/index" {
  75019. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75020. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75021. export * from "babylonjs/PostProcesses/bloomEffect";
  75022. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75023. export * from "babylonjs/PostProcesses/blurPostProcess";
  75024. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75025. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75026. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75027. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75028. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75029. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75030. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75031. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75032. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75033. export * from "babylonjs/PostProcesses/filterPostProcess";
  75034. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75035. export * from "babylonjs/PostProcesses/grainPostProcess";
  75036. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75037. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75038. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75039. export * from "babylonjs/PostProcesses/passPostProcess";
  75040. export * from "babylonjs/PostProcesses/postProcess";
  75041. export * from "babylonjs/PostProcesses/postProcessManager";
  75042. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75043. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75044. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75045. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75046. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75047. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75048. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75049. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75050. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75051. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75052. }
  75053. declare module "babylonjs/Probes/index" {
  75054. export * from "babylonjs/Probes/reflectionProbe";
  75055. }
  75056. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75057. import { Scene } from "babylonjs/scene";
  75058. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75059. import { SmartArray } from "babylonjs/Misc/smartArray";
  75060. import { ISceneComponent } from "babylonjs/sceneComponent";
  75061. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75062. import "babylonjs/Meshes/Builders/boxBuilder";
  75063. import "babylonjs/Shaders/color.fragment";
  75064. import "babylonjs/Shaders/color.vertex";
  75065. import { Color3 } from "babylonjs/Maths/math.color";
  75066. import { Observable } from "babylonjs/Misc/observable";
  75067. module "babylonjs/scene" {
  75068. interface Scene {
  75069. /** @hidden (Backing field) */
  75070. _boundingBoxRenderer: BoundingBoxRenderer;
  75071. /** @hidden (Backing field) */
  75072. _forceShowBoundingBoxes: boolean;
  75073. /**
  75074. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75075. */
  75076. forceShowBoundingBoxes: boolean;
  75077. /**
  75078. * Gets the bounding box renderer associated with the scene
  75079. * @returns a BoundingBoxRenderer
  75080. */
  75081. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75082. }
  75083. }
  75084. module "babylonjs/Meshes/abstractMesh" {
  75085. interface AbstractMesh {
  75086. /** @hidden (Backing field) */
  75087. _showBoundingBox: boolean;
  75088. /**
  75089. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75090. */
  75091. showBoundingBox: boolean;
  75092. }
  75093. }
  75094. /**
  75095. * Component responsible of rendering the bounding box of the meshes in a scene.
  75096. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75097. */
  75098. export class BoundingBoxRenderer implements ISceneComponent {
  75099. /**
  75100. * The component name helpfull to identify the component in the list of scene components.
  75101. */
  75102. readonly name: string;
  75103. /**
  75104. * The scene the component belongs to.
  75105. */
  75106. scene: Scene;
  75107. /**
  75108. * Color of the bounding box lines placed in front of an object
  75109. */
  75110. frontColor: Color3;
  75111. /**
  75112. * Color of the bounding box lines placed behind an object
  75113. */
  75114. backColor: Color3;
  75115. /**
  75116. * Defines if the renderer should show the back lines or not
  75117. */
  75118. showBackLines: boolean;
  75119. /**
  75120. * Observable raised before rendering a bounding box
  75121. */
  75122. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75123. /**
  75124. * Observable raised after rendering a bounding box
  75125. */
  75126. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75127. /**
  75128. * @hidden
  75129. */
  75130. renderList: SmartArray<BoundingBox>;
  75131. private _colorShader;
  75132. private _vertexBuffers;
  75133. private _indexBuffer;
  75134. private _fillIndexBuffer;
  75135. private _fillIndexData;
  75136. /**
  75137. * Instantiates a new bounding box renderer in a scene.
  75138. * @param scene the scene the renderer renders in
  75139. */
  75140. constructor(scene: Scene);
  75141. /**
  75142. * Registers the component in a given scene
  75143. */
  75144. register(): void;
  75145. private _evaluateSubMesh;
  75146. private _activeMesh;
  75147. private _prepareRessources;
  75148. private _createIndexBuffer;
  75149. /**
  75150. * Rebuilds the elements related to this component in case of
  75151. * context lost for instance.
  75152. */
  75153. rebuild(): void;
  75154. /**
  75155. * @hidden
  75156. */
  75157. reset(): void;
  75158. /**
  75159. * Render the bounding boxes of a specific rendering group
  75160. * @param renderingGroupId defines the rendering group to render
  75161. */
  75162. render(renderingGroupId: number): void;
  75163. /**
  75164. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75165. * @param mesh Define the mesh to render the occlusion bounding box for
  75166. */
  75167. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75168. /**
  75169. * Dispose and release the resources attached to this renderer.
  75170. */
  75171. dispose(): void;
  75172. }
  75173. }
  75174. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75175. import { Nullable } from "babylonjs/types";
  75176. import { Scene } from "babylonjs/scene";
  75177. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75178. import { Camera } from "babylonjs/Cameras/camera";
  75179. import { ISceneComponent } from "babylonjs/sceneComponent";
  75180. module "babylonjs/scene" {
  75181. interface Scene {
  75182. /** @hidden (Backing field) */
  75183. _depthRenderer: {
  75184. [id: string]: DepthRenderer;
  75185. };
  75186. /**
  75187. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75188. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75189. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75190. * @returns the created depth renderer
  75191. */
  75192. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75193. /**
  75194. * Disables a depth renderer for a given camera
  75195. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75196. */
  75197. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75198. }
  75199. }
  75200. /**
  75201. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75202. * in several rendering techniques.
  75203. */
  75204. export class DepthRendererSceneComponent implements ISceneComponent {
  75205. /**
  75206. * The component name helpfull to identify the component in the list of scene components.
  75207. */
  75208. readonly name: string;
  75209. /**
  75210. * The scene the component belongs to.
  75211. */
  75212. scene: Scene;
  75213. /**
  75214. * Creates a new instance of the component for the given scene
  75215. * @param scene Defines the scene to register the component in
  75216. */
  75217. constructor(scene: Scene);
  75218. /**
  75219. * Registers the component in a given scene
  75220. */
  75221. register(): void;
  75222. /**
  75223. * Rebuilds the elements related to this component in case of
  75224. * context lost for instance.
  75225. */
  75226. rebuild(): void;
  75227. /**
  75228. * Disposes the component and the associated ressources
  75229. */
  75230. dispose(): void;
  75231. private _gatherRenderTargets;
  75232. private _gatherActiveCameraRenderTargets;
  75233. }
  75234. }
  75235. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75236. import { Nullable } from "babylonjs/types";
  75237. import { Scene } from "babylonjs/scene";
  75238. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75239. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75240. import { AbstractScene } from "babylonjs/abstractScene";
  75241. module "babylonjs/abstractScene" {
  75242. interface AbstractScene {
  75243. /** @hidden (Backing field) */
  75244. _prePassRenderer: Nullable<PrePassRenderer>;
  75245. /**
  75246. * Gets or Sets the current prepass renderer associated to the scene.
  75247. */
  75248. prePassRenderer: Nullable<PrePassRenderer>;
  75249. /**
  75250. * Enables the prepass and associates it with the scene
  75251. * @returns the PrePassRenderer
  75252. */
  75253. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75254. /**
  75255. * Disables the prepass associated with the scene
  75256. */
  75257. disablePrePassRenderer(): void;
  75258. }
  75259. }
  75260. /**
  75261. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75262. * in several rendering techniques.
  75263. */
  75264. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75265. /**
  75266. * The component name helpful to identify the component in the list of scene components.
  75267. */
  75268. readonly name: string;
  75269. /**
  75270. * The scene the component belongs to.
  75271. */
  75272. scene: Scene;
  75273. /**
  75274. * Creates a new instance of the component for the given scene
  75275. * @param scene Defines the scene to register the component in
  75276. */
  75277. constructor(scene: Scene);
  75278. /**
  75279. * Registers the component in a given scene
  75280. */
  75281. register(): void;
  75282. private _beforeCameraDraw;
  75283. private _afterCameraDraw;
  75284. private _beforeClearStage;
  75285. /**
  75286. * Serializes the component data to the specified json object
  75287. * @param serializationObject The object to serialize to
  75288. */
  75289. serialize(serializationObject: any): void;
  75290. /**
  75291. * Adds all the elements from the container to the scene
  75292. * @param container the container holding the elements
  75293. */
  75294. addFromContainer(container: AbstractScene): void;
  75295. /**
  75296. * Removes all the elements in the container from the scene
  75297. * @param container contains the elements to remove
  75298. * @param dispose if the removed element should be disposed (default: false)
  75299. */
  75300. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75301. /**
  75302. * Rebuilds the elements related to this component in case of
  75303. * context lost for instance.
  75304. */
  75305. rebuild(): void;
  75306. /**
  75307. * Disposes the component and the associated ressources
  75308. */
  75309. dispose(): void;
  75310. }
  75311. }
  75312. declare module "babylonjs/Shaders/outline.fragment" {
  75313. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75314. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75315. /** @hidden */
  75316. export var outlinePixelShader: {
  75317. name: string;
  75318. shader: string;
  75319. };
  75320. }
  75321. declare module "babylonjs/Shaders/outline.vertex" {
  75322. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75323. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75324. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75325. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75326. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75328. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75329. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75330. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75331. /** @hidden */
  75332. export var outlineVertexShader: {
  75333. name: string;
  75334. shader: string;
  75335. };
  75336. }
  75337. declare module "babylonjs/Rendering/outlineRenderer" {
  75338. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75339. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75340. import { Scene } from "babylonjs/scene";
  75341. import { ISceneComponent } from "babylonjs/sceneComponent";
  75342. import "babylonjs/Shaders/outline.fragment";
  75343. import "babylonjs/Shaders/outline.vertex";
  75344. module "babylonjs/scene" {
  75345. interface Scene {
  75346. /** @hidden */
  75347. _outlineRenderer: OutlineRenderer;
  75348. /**
  75349. * Gets the outline renderer associated with the scene
  75350. * @returns a OutlineRenderer
  75351. */
  75352. getOutlineRenderer(): OutlineRenderer;
  75353. }
  75354. }
  75355. module "babylonjs/Meshes/abstractMesh" {
  75356. interface AbstractMesh {
  75357. /** @hidden (Backing field) */
  75358. _renderOutline: boolean;
  75359. /**
  75360. * Gets or sets a boolean indicating if the outline must be rendered as well
  75361. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75362. */
  75363. renderOutline: boolean;
  75364. /** @hidden (Backing field) */
  75365. _renderOverlay: boolean;
  75366. /**
  75367. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75368. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75369. */
  75370. renderOverlay: boolean;
  75371. }
  75372. }
  75373. /**
  75374. * This class is responsible to draw bothe outline/overlay of meshes.
  75375. * It should not be used directly but through the available method on mesh.
  75376. */
  75377. export class OutlineRenderer implements ISceneComponent {
  75378. /**
  75379. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75380. */
  75381. private static _StencilReference;
  75382. /**
  75383. * The name of the component. Each component must have a unique name.
  75384. */
  75385. name: string;
  75386. /**
  75387. * The scene the component belongs to.
  75388. */
  75389. scene: Scene;
  75390. /**
  75391. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75392. */
  75393. zOffset: number;
  75394. private _engine;
  75395. private _effect;
  75396. private _cachedDefines;
  75397. private _savedDepthWrite;
  75398. /**
  75399. * Instantiates a new outline renderer. (There could be only one per scene).
  75400. * @param scene Defines the scene it belongs to
  75401. */
  75402. constructor(scene: Scene);
  75403. /**
  75404. * Register the component to one instance of a scene.
  75405. */
  75406. register(): void;
  75407. /**
  75408. * Rebuilds the elements related to this component in case of
  75409. * context lost for instance.
  75410. */
  75411. rebuild(): void;
  75412. /**
  75413. * Disposes the component and the associated ressources.
  75414. */
  75415. dispose(): void;
  75416. /**
  75417. * Renders the outline in the canvas.
  75418. * @param subMesh Defines the sumesh to render
  75419. * @param batch Defines the batch of meshes in case of instances
  75420. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75421. */
  75422. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75423. /**
  75424. * Returns whether or not the outline renderer is ready for a given submesh.
  75425. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75426. * @param subMesh Defines the submesh to check readyness for
  75427. * @param useInstances Defines wheter wee are trying to render instances or not
  75428. * @returns true if ready otherwise false
  75429. */
  75430. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75431. private _beforeRenderingMesh;
  75432. private _afterRenderingMesh;
  75433. }
  75434. }
  75435. declare module "babylonjs/Rendering/index" {
  75436. export * from "babylonjs/Rendering/boundingBoxRenderer";
  75437. export * from "babylonjs/Rendering/depthRenderer";
  75438. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  75439. export * from "babylonjs/Rendering/edgesRenderer";
  75440. export * from "babylonjs/Rendering/geometryBufferRenderer";
  75441. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75442. export * from "babylonjs/Rendering/prePassRenderer";
  75443. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  75444. export * from "babylonjs/Rendering/outlineRenderer";
  75445. export * from "babylonjs/Rendering/renderingGroup";
  75446. export * from "babylonjs/Rendering/renderingManager";
  75447. export * from "babylonjs/Rendering/utilityLayerRenderer";
  75448. }
  75449. declare module "babylonjs/Sprites/ISprites" {
  75450. /**
  75451. * Defines the basic options interface of a Sprite Frame Source Size.
  75452. */
  75453. export interface ISpriteJSONSpriteSourceSize {
  75454. /**
  75455. * number of the original width of the Frame
  75456. */
  75457. w: number;
  75458. /**
  75459. * number of the original height of the Frame
  75460. */
  75461. h: number;
  75462. }
  75463. /**
  75464. * Defines the basic options interface of a Sprite Frame Data.
  75465. */
  75466. export interface ISpriteJSONSpriteFrameData {
  75467. /**
  75468. * number of the x offset of the Frame
  75469. */
  75470. x: number;
  75471. /**
  75472. * number of the y offset of the Frame
  75473. */
  75474. y: number;
  75475. /**
  75476. * number of the width of the Frame
  75477. */
  75478. w: number;
  75479. /**
  75480. * number of the height of the Frame
  75481. */
  75482. h: number;
  75483. }
  75484. /**
  75485. * Defines the basic options interface of a JSON Sprite.
  75486. */
  75487. export interface ISpriteJSONSprite {
  75488. /**
  75489. * string name of the Frame
  75490. */
  75491. filename: string;
  75492. /**
  75493. * ISpriteJSONSpriteFrame basic object of the frame data
  75494. */
  75495. frame: ISpriteJSONSpriteFrameData;
  75496. /**
  75497. * boolean to flag is the frame was rotated.
  75498. */
  75499. rotated: boolean;
  75500. /**
  75501. * boolean to flag is the frame was trimmed.
  75502. */
  75503. trimmed: boolean;
  75504. /**
  75505. * ISpriteJSONSpriteFrame basic object of the source data
  75506. */
  75507. spriteSourceSize: ISpriteJSONSpriteFrameData;
  75508. /**
  75509. * ISpriteJSONSpriteFrame basic object of the source data
  75510. */
  75511. sourceSize: ISpriteJSONSpriteSourceSize;
  75512. }
  75513. /**
  75514. * Defines the basic options interface of a JSON atlas.
  75515. */
  75516. export interface ISpriteJSONAtlas {
  75517. /**
  75518. * Array of objects that contain the frame data.
  75519. */
  75520. frames: Array<ISpriteJSONSprite>;
  75521. /**
  75522. * object basic object containing the sprite meta data.
  75523. */
  75524. meta?: object;
  75525. }
  75526. }
  75527. declare module "babylonjs/Shaders/spriteMap.fragment" {
  75528. /** @hidden */
  75529. export var spriteMapPixelShader: {
  75530. name: string;
  75531. shader: string;
  75532. };
  75533. }
  75534. declare module "babylonjs/Shaders/spriteMap.vertex" {
  75535. /** @hidden */
  75536. export var spriteMapVertexShader: {
  75537. name: string;
  75538. shader: string;
  75539. };
  75540. }
  75541. declare module "babylonjs/Sprites/spriteMap" {
  75542. import { IDisposable, Scene } from "babylonjs/scene";
  75543. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  75544. import { Texture } from "babylonjs/Materials/Textures/texture";
  75545. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  75546. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  75547. import "babylonjs/Meshes/Builders/planeBuilder";
  75548. import "babylonjs/Shaders/spriteMap.fragment";
  75549. import "babylonjs/Shaders/spriteMap.vertex";
  75550. /**
  75551. * Defines the basic options interface of a SpriteMap
  75552. */
  75553. export interface ISpriteMapOptions {
  75554. /**
  75555. * Vector2 of the number of cells in the grid.
  75556. */
  75557. stageSize?: Vector2;
  75558. /**
  75559. * Vector2 of the size of the output plane in World Units.
  75560. */
  75561. outputSize?: Vector2;
  75562. /**
  75563. * Vector3 of the position of the output plane in World Units.
  75564. */
  75565. outputPosition?: Vector3;
  75566. /**
  75567. * Vector3 of the rotation of the output plane.
  75568. */
  75569. outputRotation?: Vector3;
  75570. /**
  75571. * number of layers that the system will reserve in resources.
  75572. */
  75573. layerCount?: number;
  75574. /**
  75575. * number of max animation frames a single cell will reserve in resources.
  75576. */
  75577. maxAnimationFrames?: number;
  75578. /**
  75579. * number cell index of the base tile when the system compiles.
  75580. */
  75581. baseTile?: number;
  75582. /**
  75583. * boolean flip the sprite after its been repositioned by the framing data.
  75584. */
  75585. flipU?: boolean;
  75586. /**
  75587. * Vector3 scalar of the global RGB values of the SpriteMap.
  75588. */
  75589. colorMultiply?: Vector3;
  75590. }
  75591. /**
  75592. * Defines the IDisposable interface in order to be cleanable from resources.
  75593. */
  75594. export interface ISpriteMap extends IDisposable {
  75595. /**
  75596. * String name of the SpriteMap.
  75597. */
  75598. name: string;
  75599. /**
  75600. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  75601. */
  75602. atlasJSON: ISpriteJSONAtlas;
  75603. /**
  75604. * Texture of the SpriteMap.
  75605. */
  75606. spriteSheet: Texture;
  75607. /**
  75608. * The parameters to initialize the SpriteMap with.
  75609. */
  75610. options: ISpriteMapOptions;
  75611. }
  75612. /**
  75613. * Class used to manage a grid restricted sprite deployment on an Output plane.
  75614. */
  75615. export class SpriteMap implements ISpriteMap {
  75616. /** The Name of the spriteMap */
  75617. name: string;
  75618. /** The JSON file with the frame and meta data */
  75619. atlasJSON: ISpriteJSONAtlas;
  75620. /** The systems Sprite Sheet Texture */
  75621. spriteSheet: Texture;
  75622. /** Arguments passed with the Constructor */
  75623. options: ISpriteMapOptions;
  75624. /** Public Sprite Storage array, parsed from atlasJSON */
  75625. sprites: Array<ISpriteJSONSprite>;
  75626. /** Returns the Number of Sprites in the System */
  75627. get spriteCount(): number;
  75628. /** Returns the Position of Output Plane*/
  75629. get position(): Vector3;
  75630. /** Returns the Position of Output Plane*/
  75631. set position(v: Vector3);
  75632. /** Returns the Rotation of Output Plane*/
  75633. get rotation(): Vector3;
  75634. /** Returns the Rotation of Output Plane*/
  75635. set rotation(v: Vector3);
  75636. /** Sets the AnimationMap*/
  75637. get animationMap(): RawTexture;
  75638. /** Sets the AnimationMap*/
  75639. set animationMap(v: RawTexture);
  75640. /** Scene that the SpriteMap was created in */
  75641. private _scene;
  75642. /** Texture Buffer of Float32 that holds tile frame data*/
  75643. private _frameMap;
  75644. /** Texture Buffers of Float32 that holds tileMap data*/
  75645. private _tileMaps;
  75646. /** Texture Buffer of Float32 that holds Animation Data*/
  75647. private _animationMap;
  75648. /** Custom ShaderMaterial Central to the System*/
  75649. private _material;
  75650. /** Custom ShaderMaterial Central to the System*/
  75651. private _output;
  75652. /** Systems Time Ticker*/
  75653. private _time;
  75654. /**
  75655. * Creates a new SpriteMap
  75656. * @param name defines the SpriteMaps Name
  75657. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  75658. * @param spriteSheet is the Texture that the Sprites are on.
  75659. * @param options a basic deployment configuration
  75660. * @param scene The Scene that the map is deployed on
  75661. */
  75662. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  75663. /**
  75664. * Returns tileID location
  75665. * @returns Vector2 the cell position ID
  75666. */
  75667. getTileID(): Vector2;
  75668. /**
  75669. * Gets the UV location of the mouse over the SpriteMap.
  75670. * @returns Vector2 the UV position of the mouse interaction
  75671. */
  75672. getMousePosition(): Vector2;
  75673. /**
  75674. * Creates the "frame" texture Buffer
  75675. * -------------------------------------
  75676. * Structure of frames
  75677. * "filename": "Falling-Water-2.png",
  75678. * "frame": {"x":69,"y":103,"w":24,"h":32},
  75679. * "rotated": true,
  75680. * "trimmed": true,
  75681. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  75682. * "sourceSize": {"w":32,"h":32}
  75683. * @returns RawTexture of the frameMap
  75684. */
  75685. private _createFrameBuffer;
  75686. /**
  75687. * Creates the tileMap texture Buffer
  75688. * @param buffer normally and array of numbers, or a false to generate from scratch
  75689. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  75690. * @returns RawTexture of the tileMap
  75691. */
  75692. private _createTileBuffer;
  75693. /**
  75694. * Modifies the data of the tileMaps
  75695. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  75696. * @param pos is the iVector2 Coordinates of the Tile
  75697. * @param tile The SpriteIndex of the new Tile
  75698. */
  75699. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  75700. /**
  75701. * Creates the animationMap texture Buffer
  75702. * @param buffer normally and array of numbers, or a false to generate from scratch
  75703. * @returns RawTexture of the animationMap
  75704. */
  75705. private _createTileAnimationBuffer;
  75706. /**
  75707. * Modifies the data of the animationMap
  75708. * @param cellID is the Index of the Sprite
  75709. * @param _frame is the target Animation frame
  75710. * @param toCell is the Target Index of the next frame of the animation
  75711. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  75712. * @param speed is a global scalar of the time variable on the map.
  75713. */
  75714. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  75715. /**
  75716. * Exports the .tilemaps file
  75717. */
  75718. saveTileMaps(): void;
  75719. /**
  75720. * Imports the .tilemaps file
  75721. * @param url of the .tilemaps file
  75722. */
  75723. loadTileMaps(url: string): void;
  75724. /**
  75725. * Release associated resources
  75726. */
  75727. dispose(): void;
  75728. }
  75729. }
  75730. declare module "babylonjs/Sprites/spritePackedManager" {
  75731. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  75732. import { Scene } from "babylonjs/scene";
  75733. /**
  75734. * Class used to manage multiple sprites of different sizes on the same spritesheet
  75735. * @see https://doc.babylonjs.com/babylon101/sprites
  75736. */
  75737. export class SpritePackedManager extends SpriteManager {
  75738. /** defines the packed manager's name */
  75739. name: string;
  75740. /**
  75741. * Creates a new sprite manager from a packed sprite sheet
  75742. * @param name defines the manager's name
  75743. * @param imgUrl defines the sprite sheet url
  75744. * @param capacity defines the maximum allowed number of sprites
  75745. * @param scene defines the hosting scene
  75746. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  75747. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  75748. * @param samplingMode defines the smapling mode to use with spritesheet
  75749. * @param fromPacked set to true; do not alter
  75750. */
  75751. constructor(
  75752. /** defines the packed manager's name */
  75753. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  75754. }
  75755. }
  75756. declare module "babylonjs/Sprites/index" {
  75757. export * from "babylonjs/Sprites/sprite";
  75758. export * from "babylonjs/Sprites/ISprites";
  75759. export * from "babylonjs/Sprites/spriteManager";
  75760. export * from "babylonjs/Sprites/spriteMap";
  75761. export * from "babylonjs/Sprites/spritePackedManager";
  75762. export * from "babylonjs/Sprites/spriteSceneComponent";
  75763. }
  75764. declare module "babylonjs/States/index" {
  75765. export * from "babylonjs/States/alphaCullingState";
  75766. export * from "babylonjs/States/depthCullingState";
  75767. export * from "babylonjs/States/stencilState";
  75768. }
  75769. declare module "babylonjs/Misc/assetsManager" {
  75770. import { Scene } from "babylonjs/scene";
  75771. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75772. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  75773. import { Skeleton } from "babylonjs/Bones/skeleton";
  75774. import { Observable } from "babylonjs/Misc/observable";
  75775. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  75776. import { Texture } from "babylonjs/Materials/Textures/texture";
  75777. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  75778. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  75779. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  75780. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  75781. /**
  75782. * Defines the list of states available for a task inside a AssetsManager
  75783. */
  75784. export enum AssetTaskState {
  75785. /**
  75786. * Initialization
  75787. */
  75788. INIT = 0,
  75789. /**
  75790. * Running
  75791. */
  75792. RUNNING = 1,
  75793. /**
  75794. * Done
  75795. */
  75796. DONE = 2,
  75797. /**
  75798. * Error
  75799. */
  75800. ERROR = 3
  75801. }
  75802. /**
  75803. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  75804. */
  75805. export abstract class AbstractAssetTask {
  75806. /**
  75807. * Task name
  75808. */ name: string;
  75809. /**
  75810. * Callback called when the task is successful
  75811. */
  75812. onSuccess: (task: any) => void;
  75813. /**
  75814. * Callback called when the task is not successful
  75815. */
  75816. onError: (task: any, message?: string, exception?: any) => void;
  75817. /**
  75818. * Creates a new AssetsManager
  75819. * @param name defines the name of the task
  75820. */
  75821. constructor(
  75822. /**
  75823. * Task name
  75824. */ name: string);
  75825. private _isCompleted;
  75826. private _taskState;
  75827. private _errorObject;
  75828. /**
  75829. * Get if the task is completed
  75830. */
  75831. get isCompleted(): boolean;
  75832. /**
  75833. * Gets the current state of the task
  75834. */
  75835. get taskState(): AssetTaskState;
  75836. /**
  75837. * Gets the current error object (if task is in error)
  75838. */
  75839. get errorObject(): {
  75840. message?: string;
  75841. exception?: any;
  75842. };
  75843. /**
  75844. * Internal only
  75845. * @hidden
  75846. */
  75847. _setErrorObject(message?: string, exception?: any): void;
  75848. /**
  75849. * Execute the current task
  75850. * @param scene defines the scene where you want your assets to be loaded
  75851. * @param onSuccess is a callback called when the task is successfully executed
  75852. * @param onError is a callback called if an error occurs
  75853. */
  75854. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75855. /**
  75856. * Execute the current task
  75857. * @param scene defines the scene where you want your assets to be loaded
  75858. * @param onSuccess is a callback called when the task is successfully executed
  75859. * @param onError is a callback called if an error occurs
  75860. */
  75861. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75862. /**
  75863. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  75864. * This can be used with failed tasks that have the reason for failure fixed.
  75865. */
  75866. reset(): void;
  75867. private onErrorCallback;
  75868. private onDoneCallback;
  75869. }
  75870. /**
  75871. * Define the interface used by progress events raised during assets loading
  75872. */
  75873. export interface IAssetsProgressEvent {
  75874. /**
  75875. * Defines the number of remaining tasks to process
  75876. */
  75877. remainingCount: number;
  75878. /**
  75879. * Defines the total number of tasks
  75880. */
  75881. totalCount: number;
  75882. /**
  75883. * Defines the task that was just processed
  75884. */
  75885. task: AbstractAssetTask;
  75886. }
  75887. /**
  75888. * Class used to share progress information about assets loading
  75889. */
  75890. export class AssetsProgressEvent implements IAssetsProgressEvent {
  75891. /**
  75892. * Defines the number of remaining tasks to process
  75893. */
  75894. remainingCount: number;
  75895. /**
  75896. * Defines the total number of tasks
  75897. */
  75898. totalCount: number;
  75899. /**
  75900. * Defines the task that was just processed
  75901. */
  75902. task: AbstractAssetTask;
  75903. /**
  75904. * Creates a AssetsProgressEvent
  75905. * @param remainingCount defines the number of remaining tasks to process
  75906. * @param totalCount defines the total number of tasks
  75907. * @param task defines the task that was just processed
  75908. */
  75909. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  75910. }
  75911. /**
  75912. * Define a task used by AssetsManager to load meshes
  75913. */
  75914. export class MeshAssetTask extends AbstractAssetTask {
  75915. /**
  75916. * Defines the name of the task
  75917. */
  75918. name: string;
  75919. /**
  75920. * Defines the list of mesh's names you want to load
  75921. */
  75922. meshesNames: any;
  75923. /**
  75924. * Defines the root url to use as a base to load your meshes and associated resources
  75925. */
  75926. rootUrl: string;
  75927. /**
  75928. * Defines the filename or File of the scene to load from
  75929. */
  75930. sceneFilename: string | File;
  75931. /**
  75932. * Gets the list of loaded meshes
  75933. */
  75934. loadedMeshes: Array<AbstractMesh>;
  75935. /**
  75936. * Gets the list of loaded particle systems
  75937. */
  75938. loadedParticleSystems: Array<IParticleSystem>;
  75939. /**
  75940. * Gets the list of loaded skeletons
  75941. */
  75942. loadedSkeletons: Array<Skeleton>;
  75943. /**
  75944. * Gets the list of loaded animation groups
  75945. */
  75946. loadedAnimationGroups: Array<AnimationGroup>;
  75947. /**
  75948. * Callback called when the task is successful
  75949. */
  75950. onSuccess: (task: MeshAssetTask) => void;
  75951. /**
  75952. * Callback called when the task is successful
  75953. */
  75954. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  75955. /**
  75956. * Creates a new MeshAssetTask
  75957. * @param name defines the name of the task
  75958. * @param meshesNames defines the list of mesh's names you want to load
  75959. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  75960. * @param sceneFilename defines the filename or File of the scene to load from
  75961. */
  75962. constructor(
  75963. /**
  75964. * Defines the name of the task
  75965. */
  75966. name: string,
  75967. /**
  75968. * Defines the list of mesh's names you want to load
  75969. */
  75970. meshesNames: any,
  75971. /**
  75972. * Defines the root url to use as a base to load your meshes and associated resources
  75973. */
  75974. rootUrl: string,
  75975. /**
  75976. * Defines the filename or File of the scene to load from
  75977. */
  75978. sceneFilename: string | File);
  75979. /**
  75980. * Execute the current task
  75981. * @param scene defines the scene where you want your assets to be loaded
  75982. * @param onSuccess is a callback called when the task is successfully executed
  75983. * @param onError is a callback called if an error occurs
  75984. */
  75985. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75986. }
  75987. /**
  75988. * Define a task used by AssetsManager to load text content
  75989. */
  75990. export class TextFileAssetTask extends AbstractAssetTask {
  75991. /**
  75992. * Defines the name of the task
  75993. */
  75994. name: string;
  75995. /**
  75996. * Defines the location of the file to load
  75997. */
  75998. url: string;
  75999. /**
  76000. * Gets the loaded text string
  76001. */
  76002. text: string;
  76003. /**
  76004. * Callback called when the task is successful
  76005. */
  76006. onSuccess: (task: TextFileAssetTask) => void;
  76007. /**
  76008. * Callback called when the task is successful
  76009. */
  76010. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76011. /**
  76012. * Creates a new TextFileAssetTask object
  76013. * @param name defines the name of the task
  76014. * @param url defines the location of the file to load
  76015. */
  76016. constructor(
  76017. /**
  76018. * Defines the name of the task
  76019. */
  76020. name: string,
  76021. /**
  76022. * Defines the location of the file to load
  76023. */
  76024. url: string);
  76025. /**
  76026. * Execute the current task
  76027. * @param scene defines the scene where you want your assets to be loaded
  76028. * @param onSuccess is a callback called when the task is successfully executed
  76029. * @param onError is a callback called if an error occurs
  76030. */
  76031. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76032. }
  76033. /**
  76034. * Define a task used by AssetsManager to load binary data
  76035. */
  76036. export class BinaryFileAssetTask extends AbstractAssetTask {
  76037. /**
  76038. * Defines the name of the task
  76039. */
  76040. name: string;
  76041. /**
  76042. * Defines the location of the file to load
  76043. */
  76044. url: string;
  76045. /**
  76046. * Gets the lodaded data (as an array buffer)
  76047. */
  76048. data: ArrayBuffer;
  76049. /**
  76050. * Callback called when the task is successful
  76051. */
  76052. onSuccess: (task: BinaryFileAssetTask) => void;
  76053. /**
  76054. * Callback called when the task is successful
  76055. */
  76056. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76057. /**
  76058. * Creates a new BinaryFileAssetTask object
  76059. * @param name defines the name of the new task
  76060. * @param url defines the location of the file to load
  76061. */
  76062. constructor(
  76063. /**
  76064. * Defines the name of the task
  76065. */
  76066. name: string,
  76067. /**
  76068. * Defines the location of the file to load
  76069. */
  76070. url: string);
  76071. /**
  76072. * Execute the current task
  76073. * @param scene defines the scene where you want your assets to be loaded
  76074. * @param onSuccess is a callback called when the task is successfully executed
  76075. * @param onError is a callback called if an error occurs
  76076. */
  76077. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76078. }
  76079. /**
  76080. * Define a task used by AssetsManager to load images
  76081. */
  76082. export class ImageAssetTask extends AbstractAssetTask {
  76083. /**
  76084. * Defines the name of the task
  76085. */
  76086. name: string;
  76087. /**
  76088. * Defines the location of the image to load
  76089. */
  76090. url: string;
  76091. /**
  76092. * Gets the loaded images
  76093. */
  76094. image: HTMLImageElement;
  76095. /**
  76096. * Callback called when the task is successful
  76097. */
  76098. onSuccess: (task: ImageAssetTask) => void;
  76099. /**
  76100. * Callback called when the task is successful
  76101. */
  76102. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76103. /**
  76104. * Creates a new ImageAssetTask
  76105. * @param name defines the name of the task
  76106. * @param url defines the location of the image to load
  76107. */
  76108. constructor(
  76109. /**
  76110. * Defines the name of the task
  76111. */
  76112. name: string,
  76113. /**
  76114. * Defines the location of the image to load
  76115. */
  76116. url: string);
  76117. /**
  76118. * Execute the current task
  76119. * @param scene defines the scene where you want your assets to be loaded
  76120. * @param onSuccess is a callback called when the task is successfully executed
  76121. * @param onError is a callback called if an error occurs
  76122. */
  76123. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76124. }
  76125. /**
  76126. * Defines the interface used by texture loading tasks
  76127. */
  76128. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76129. /**
  76130. * Gets the loaded texture
  76131. */
  76132. texture: TEX;
  76133. }
  76134. /**
  76135. * Define a task used by AssetsManager to load 2D textures
  76136. */
  76137. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76138. /**
  76139. * Defines the name of the task
  76140. */
  76141. name: string;
  76142. /**
  76143. * Defines the location of the file to load
  76144. */
  76145. url: string;
  76146. /**
  76147. * Defines if mipmap should not be generated (default is false)
  76148. */
  76149. noMipmap?: boolean | undefined;
  76150. /**
  76151. * Defines if texture must be inverted on Y axis (default is true)
  76152. */
  76153. invertY: boolean;
  76154. /**
  76155. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76156. */
  76157. samplingMode: number;
  76158. /**
  76159. * Gets the loaded texture
  76160. */
  76161. texture: Texture;
  76162. /**
  76163. * Callback called when the task is successful
  76164. */
  76165. onSuccess: (task: TextureAssetTask) => void;
  76166. /**
  76167. * Callback called when the task is successful
  76168. */
  76169. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76170. /**
  76171. * Creates a new TextureAssetTask object
  76172. * @param name defines the name of the task
  76173. * @param url defines the location of the file to load
  76174. * @param noMipmap defines if mipmap should not be generated (default is false)
  76175. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76176. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76177. */
  76178. constructor(
  76179. /**
  76180. * Defines the name of the task
  76181. */
  76182. name: string,
  76183. /**
  76184. * Defines the location of the file to load
  76185. */
  76186. url: string,
  76187. /**
  76188. * Defines if mipmap should not be generated (default is false)
  76189. */
  76190. noMipmap?: boolean | undefined,
  76191. /**
  76192. * Defines if texture must be inverted on Y axis (default is true)
  76193. */
  76194. invertY?: boolean,
  76195. /**
  76196. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76197. */
  76198. samplingMode?: number);
  76199. /**
  76200. * Execute the current task
  76201. * @param scene defines the scene where you want your assets to be loaded
  76202. * @param onSuccess is a callback called when the task is successfully executed
  76203. * @param onError is a callback called if an error occurs
  76204. */
  76205. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76206. }
  76207. /**
  76208. * Define a task used by AssetsManager to load cube textures
  76209. */
  76210. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76211. /**
  76212. * Defines the name of the task
  76213. */
  76214. name: string;
  76215. /**
  76216. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76217. */
  76218. url: string;
  76219. /**
  76220. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76221. */
  76222. extensions?: string[] | undefined;
  76223. /**
  76224. * Defines if mipmaps should not be generated (default is false)
  76225. */
  76226. noMipmap?: boolean | undefined;
  76227. /**
  76228. * Defines the explicit list of files (undefined by default)
  76229. */
  76230. files?: string[] | undefined;
  76231. /**
  76232. * Gets the loaded texture
  76233. */
  76234. texture: CubeTexture;
  76235. /**
  76236. * Callback called when the task is successful
  76237. */
  76238. onSuccess: (task: CubeTextureAssetTask) => void;
  76239. /**
  76240. * Callback called when the task is successful
  76241. */
  76242. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76243. /**
  76244. * Creates a new CubeTextureAssetTask
  76245. * @param name defines the name of the task
  76246. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76247. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76248. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76249. * @param files defines the explicit list of files (undefined by default)
  76250. */
  76251. constructor(
  76252. /**
  76253. * Defines the name of the task
  76254. */
  76255. name: string,
  76256. /**
  76257. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76258. */
  76259. url: string,
  76260. /**
  76261. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76262. */
  76263. extensions?: string[] | undefined,
  76264. /**
  76265. * Defines if mipmaps should not be generated (default is false)
  76266. */
  76267. noMipmap?: boolean | undefined,
  76268. /**
  76269. * Defines the explicit list of files (undefined by default)
  76270. */
  76271. files?: string[] | undefined);
  76272. /**
  76273. * Execute the current task
  76274. * @param scene defines the scene where you want your assets to be loaded
  76275. * @param onSuccess is a callback called when the task is successfully executed
  76276. * @param onError is a callback called if an error occurs
  76277. */
  76278. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76279. }
  76280. /**
  76281. * Define a task used by AssetsManager to load HDR cube textures
  76282. */
  76283. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76284. /**
  76285. * Defines the name of the task
  76286. */
  76287. name: string;
  76288. /**
  76289. * Defines the location of the file to load
  76290. */
  76291. url: string;
  76292. /**
  76293. * Defines the desired size (the more it increases the longer the generation will be)
  76294. */
  76295. size: number;
  76296. /**
  76297. * Defines if mipmaps should not be generated (default is false)
  76298. */
  76299. noMipmap: boolean;
  76300. /**
  76301. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76302. */
  76303. generateHarmonics: boolean;
  76304. /**
  76305. * 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)
  76306. */
  76307. gammaSpace: boolean;
  76308. /**
  76309. * Internal Use Only
  76310. */
  76311. reserved: boolean;
  76312. /**
  76313. * Gets the loaded texture
  76314. */
  76315. texture: HDRCubeTexture;
  76316. /**
  76317. * Callback called when the task is successful
  76318. */
  76319. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76320. /**
  76321. * Callback called when the task is successful
  76322. */
  76323. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76324. /**
  76325. * Creates a new HDRCubeTextureAssetTask object
  76326. * @param name defines the name of the task
  76327. * @param url defines the location of the file to load
  76328. * @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.
  76329. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76330. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76331. * @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)
  76332. * @param reserved Internal use only
  76333. */
  76334. constructor(
  76335. /**
  76336. * Defines the name of the task
  76337. */
  76338. name: string,
  76339. /**
  76340. * Defines the location of the file to load
  76341. */
  76342. url: string,
  76343. /**
  76344. * Defines the desired size (the more it increases the longer the generation will be)
  76345. */
  76346. size: number,
  76347. /**
  76348. * Defines if mipmaps should not be generated (default is false)
  76349. */
  76350. noMipmap?: boolean,
  76351. /**
  76352. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76353. */
  76354. generateHarmonics?: boolean,
  76355. /**
  76356. * 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)
  76357. */
  76358. gammaSpace?: boolean,
  76359. /**
  76360. * Internal Use Only
  76361. */
  76362. reserved?: boolean);
  76363. /**
  76364. * Execute the current task
  76365. * @param scene defines the scene where you want your assets to be loaded
  76366. * @param onSuccess is a callback called when the task is successfully executed
  76367. * @param onError is a callback called if an error occurs
  76368. */
  76369. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76370. }
  76371. /**
  76372. * Define a task used by AssetsManager to load Equirectangular cube textures
  76373. */
  76374. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  76375. /**
  76376. * Defines the name of the task
  76377. */
  76378. name: string;
  76379. /**
  76380. * Defines the location of the file to load
  76381. */
  76382. url: string;
  76383. /**
  76384. * Defines the desired size (the more it increases the longer the generation will be)
  76385. */
  76386. size: number;
  76387. /**
  76388. * Defines if mipmaps should not be generated (default is false)
  76389. */
  76390. noMipmap: boolean;
  76391. /**
  76392. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  76393. * but the standard material would require them in Gamma space) (default is true)
  76394. */
  76395. gammaSpace: boolean;
  76396. /**
  76397. * Gets the loaded texture
  76398. */
  76399. texture: EquiRectangularCubeTexture;
  76400. /**
  76401. * Callback called when the task is successful
  76402. */
  76403. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  76404. /**
  76405. * Callback called when the task is successful
  76406. */
  76407. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  76408. /**
  76409. * Creates a new EquiRectangularCubeTextureAssetTask object
  76410. * @param name defines the name of the task
  76411. * @param url defines the location of the file to load
  76412. * @param size defines the desired size (the more it increases the longer the generation will be)
  76413. * If the size is omitted this implies you are using a preprocessed cubemap.
  76414. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76415. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  76416. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  76417. * (default is true)
  76418. */
  76419. constructor(
  76420. /**
  76421. * Defines the name of the task
  76422. */
  76423. name: string,
  76424. /**
  76425. * Defines the location of the file to load
  76426. */
  76427. url: string,
  76428. /**
  76429. * Defines the desired size (the more it increases the longer the generation will be)
  76430. */
  76431. size: number,
  76432. /**
  76433. * Defines if mipmaps should not be generated (default is false)
  76434. */
  76435. noMipmap?: boolean,
  76436. /**
  76437. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  76438. * but the standard material would require them in Gamma space) (default is true)
  76439. */
  76440. gammaSpace?: boolean);
  76441. /**
  76442. * Execute the current task
  76443. * @param scene defines the scene where you want your assets to be loaded
  76444. * @param onSuccess is a callback called when the task is successfully executed
  76445. * @param onError is a callback called if an error occurs
  76446. */
  76447. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76448. }
  76449. /**
  76450. * This class can be used to easily import assets into a scene
  76451. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  76452. */
  76453. export class AssetsManager {
  76454. private _scene;
  76455. private _isLoading;
  76456. protected _tasks: AbstractAssetTask[];
  76457. protected _waitingTasksCount: number;
  76458. protected _totalTasksCount: number;
  76459. /**
  76460. * Callback called when all tasks are processed
  76461. */
  76462. onFinish: (tasks: AbstractAssetTask[]) => void;
  76463. /**
  76464. * Callback called when a task is successful
  76465. */
  76466. onTaskSuccess: (task: AbstractAssetTask) => void;
  76467. /**
  76468. * Callback called when a task had an error
  76469. */
  76470. onTaskError: (task: AbstractAssetTask) => void;
  76471. /**
  76472. * Callback called when a task is done (whatever the result is)
  76473. */
  76474. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  76475. /**
  76476. * Observable called when all tasks are processed
  76477. */
  76478. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  76479. /**
  76480. * Observable called when a task had an error
  76481. */
  76482. onTaskErrorObservable: Observable<AbstractAssetTask>;
  76483. /**
  76484. * Observable called when all tasks were executed
  76485. */
  76486. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  76487. /**
  76488. * Observable called when a task is done (whatever the result is)
  76489. */
  76490. onProgressObservable: Observable<IAssetsProgressEvent>;
  76491. /**
  76492. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  76493. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  76494. */
  76495. useDefaultLoadingScreen: boolean;
  76496. /**
  76497. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  76498. * when all assets have been downloaded.
  76499. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  76500. */
  76501. autoHideLoadingUI: boolean;
  76502. /**
  76503. * Creates a new AssetsManager
  76504. * @param scene defines the scene to work on
  76505. */
  76506. constructor(scene: Scene);
  76507. /**
  76508. * Add a MeshAssetTask to the list of active tasks
  76509. * @param taskName defines the name of the new task
  76510. * @param meshesNames defines the name of meshes to load
  76511. * @param rootUrl defines the root url to use to locate files
  76512. * @param sceneFilename defines the filename of the scene file
  76513. * @returns a new MeshAssetTask object
  76514. */
  76515. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  76516. /**
  76517. * Add a TextFileAssetTask to the list of active tasks
  76518. * @param taskName defines the name of the new task
  76519. * @param url defines the url of the file to load
  76520. * @returns a new TextFileAssetTask object
  76521. */
  76522. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  76523. /**
  76524. * Add a BinaryFileAssetTask to the list of active tasks
  76525. * @param taskName defines the name of the new task
  76526. * @param url defines the url of the file to load
  76527. * @returns a new BinaryFileAssetTask object
  76528. */
  76529. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  76530. /**
  76531. * Add a ImageAssetTask to the list of active tasks
  76532. * @param taskName defines the name of the new task
  76533. * @param url defines the url of the file to load
  76534. * @returns a new ImageAssetTask object
  76535. */
  76536. addImageTask(taskName: string, url: string): ImageAssetTask;
  76537. /**
  76538. * Add a TextureAssetTask to the list of active tasks
  76539. * @param taskName defines the name of the new task
  76540. * @param url defines the url of the file to load
  76541. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76542. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  76543. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  76544. * @returns a new TextureAssetTask object
  76545. */
  76546. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  76547. /**
  76548. * Add a CubeTextureAssetTask to the list of active tasks
  76549. * @param taskName defines the name of the new task
  76550. * @param url defines the url of the file to load
  76551. * @param extensions defines the extension to use to load the cube map (can be null)
  76552. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76553. * @param files defines the list of files to load (can be null)
  76554. * @returns a new CubeTextureAssetTask object
  76555. */
  76556. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  76557. /**
  76558. *
  76559. * Add a HDRCubeTextureAssetTask to the list of active tasks
  76560. * @param taskName defines the name of the new task
  76561. * @param url defines the url of the file to load
  76562. * @param size defines the size you want for the cubemap (can be null)
  76563. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76564. * @param generateHarmonics defines if you want to automatically generate (true by default)
  76565. * @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)
  76566. * @param reserved Internal use only
  76567. * @returns a new HDRCubeTextureAssetTask object
  76568. */
  76569. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  76570. /**
  76571. *
  76572. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  76573. * @param taskName defines the name of the new task
  76574. * @param url defines the url of the file to load
  76575. * @param size defines the size you want for the cubemap (can be null)
  76576. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76577. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  76578. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  76579. * @returns a new EquiRectangularCubeTextureAssetTask object
  76580. */
  76581. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  76582. /**
  76583. * Remove a task from the assets manager.
  76584. * @param task the task to remove
  76585. */
  76586. removeTask(task: AbstractAssetTask): void;
  76587. private _decreaseWaitingTasksCount;
  76588. private _runTask;
  76589. /**
  76590. * Reset the AssetsManager and remove all tasks
  76591. * @return the current instance of the AssetsManager
  76592. */
  76593. reset(): AssetsManager;
  76594. /**
  76595. * Start the loading process
  76596. * @return the current instance of the AssetsManager
  76597. */
  76598. load(): AssetsManager;
  76599. /**
  76600. * Start the loading process as an async operation
  76601. * @return a promise returning the list of failed tasks
  76602. */
  76603. loadAsync(): Promise<void>;
  76604. }
  76605. }
  76606. declare module "babylonjs/Misc/deferred" {
  76607. /**
  76608. * Wrapper class for promise with external resolve and reject.
  76609. */
  76610. export class Deferred<T> {
  76611. /**
  76612. * The promise associated with this deferred object.
  76613. */
  76614. readonly promise: Promise<T>;
  76615. private _resolve;
  76616. private _reject;
  76617. /**
  76618. * The resolve method of the promise associated with this deferred object.
  76619. */
  76620. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  76621. /**
  76622. * The reject method of the promise associated with this deferred object.
  76623. */
  76624. get reject(): (reason?: any) => void;
  76625. /**
  76626. * Constructor for this deferred object.
  76627. */
  76628. constructor();
  76629. }
  76630. }
  76631. declare module "babylonjs/Misc/meshExploder" {
  76632. import { Mesh } from "babylonjs/Meshes/mesh";
  76633. /**
  76634. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  76635. */
  76636. export class MeshExploder {
  76637. private _centerMesh;
  76638. private _meshes;
  76639. private _meshesOrigins;
  76640. private _toCenterVectors;
  76641. private _scaledDirection;
  76642. private _newPosition;
  76643. private _centerPosition;
  76644. /**
  76645. * Explodes meshes from a center mesh.
  76646. * @param meshes The meshes to explode.
  76647. * @param centerMesh The mesh to be center of explosion.
  76648. */
  76649. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  76650. private _setCenterMesh;
  76651. /**
  76652. * Get class name
  76653. * @returns "MeshExploder"
  76654. */
  76655. getClassName(): string;
  76656. /**
  76657. * "Exploded meshes"
  76658. * @returns Array of meshes with the centerMesh at index 0.
  76659. */
  76660. getMeshes(): Array<Mesh>;
  76661. /**
  76662. * Explodes meshes giving a specific direction
  76663. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  76664. */
  76665. explode(direction?: number): void;
  76666. }
  76667. }
  76668. declare module "babylonjs/Misc/filesInput" {
  76669. import { Engine } from "babylonjs/Engines/engine";
  76670. import { Scene } from "babylonjs/scene";
  76671. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  76672. import { Nullable } from "babylonjs/types";
  76673. /**
  76674. * Class used to help managing file picking and drag'n'drop
  76675. */
  76676. export class FilesInput {
  76677. /**
  76678. * List of files ready to be loaded
  76679. */
  76680. static get FilesToLoad(): {
  76681. [key: string]: File;
  76682. };
  76683. /**
  76684. * Callback called when a file is processed
  76685. */
  76686. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  76687. private _engine;
  76688. private _currentScene;
  76689. private _sceneLoadedCallback;
  76690. private _progressCallback;
  76691. private _additionalRenderLoopLogicCallback;
  76692. private _textureLoadingCallback;
  76693. private _startingProcessingFilesCallback;
  76694. private _onReloadCallback;
  76695. private _errorCallback;
  76696. private _elementToMonitor;
  76697. private _sceneFileToLoad;
  76698. private _filesToLoad;
  76699. /**
  76700. * Creates a new FilesInput
  76701. * @param engine defines the rendering engine
  76702. * @param scene defines the hosting scene
  76703. * @param sceneLoadedCallback callback called when scene is loaded
  76704. * @param progressCallback callback called to track progress
  76705. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  76706. * @param textureLoadingCallback callback called when a texture is loading
  76707. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  76708. * @param onReloadCallback callback called when a reload is requested
  76709. * @param errorCallback callback call if an error occurs
  76710. */
  76711. 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>);
  76712. private _dragEnterHandler;
  76713. private _dragOverHandler;
  76714. private _dropHandler;
  76715. /**
  76716. * Calls this function to listen to drag'n'drop events on a specific DOM element
  76717. * @param elementToMonitor defines the DOM element to track
  76718. */
  76719. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  76720. /** Gets the current list of files to load */
  76721. get filesToLoad(): File[];
  76722. /**
  76723. * Release all associated resources
  76724. */
  76725. dispose(): void;
  76726. private renderFunction;
  76727. private drag;
  76728. private drop;
  76729. private _traverseFolder;
  76730. private _processFiles;
  76731. /**
  76732. * Load files from a drop event
  76733. * @param event defines the drop event to use as source
  76734. */
  76735. loadFiles(event: any): void;
  76736. private _processReload;
  76737. /**
  76738. * Reload the current scene from the loaded files
  76739. */
  76740. reload(): void;
  76741. }
  76742. }
  76743. declare module "babylonjs/Misc/HighDynamicRange/index" {
  76744. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  76745. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  76746. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  76747. }
  76748. declare module "babylonjs/Misc/sceneOptimizer" {
  76749. import { Scene, IDisposable } from "babylonjs/scene";
  76750. import { Observable } from "babylonjs/Misc/observable";
  76751. /**
  76752. * Defines the root class used to create scene optimization to use with SceneOptimizer
  76753. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76754. */
  76755. export class SceneOptimization {
  76756. /**
  76757. * Defines the priority of this optimization (0 by default which means first in the list)
  76758. */
  76759. priority: number;
  76760. /**
  76761. * Gets a string describing the action executed by the current optimization
  76762. * @returns description string
  76763. */
  76764. getDescription(): string;
  76765. /**
  76766. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76767. * @param scene defines the current scene where to apply this optimization
  76768. * @param optimizer defines the current optimizer
  76769. * @returns true if everything that can be done was applied
  76770. */
  76771. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76772. /**
  76773. * Creates the SceneOptimization object
  76774. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76775. * @param desc defines the description associated with the optimization
  76776. */
  76777. constructor(
  76778. /**
  76779. * Defines the priority of this optimization (0 by default which means first in the list)
  76780. */
  76781. priority?: number);
  76782. }
  76783. /**
  76784. * Defines an optimization used to reduce the size of render target textures
  76785. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76786. */
  76787. export class TextureOptimization extends SceneOptimization {
  76788. /**
  76789. * Defines the priority of this optimization (0 by default which means first in the list)
  76790. */
  76791. priority: number;
  76792. /**
  76793. * 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
  76794. */
  76795. maximumSize: number;
  76796. /**
  76797. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76798. */
  76799. step: number;
  76800. /**
  76801. * Gets a string describing the action executed by the current optimization
  76802. * @returns description string
  76803. */
  76804. getDescription(): string;
  76805. /**
  76806. * Creates the TextureOptimization object
  76807. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76808. * @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
  76809. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76810. */
  76811. constructor(
  76812. /**
  76813. * Defines the priority of this optimization (0 by default which means first in the list)
  76814. */
  76815. priority?: number,
  76816. /**
  76817. * 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
  76818. */
  76819. maximumSize?: number,
  76820. /**
  76821. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76822. */
  76823. step?: number);
  76824. /**
  76825. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76826. * @param scene defines the current scene where to apply this optimization
  76827. * @param optimizer defines the current optimizer
  76828. * @returns true if everything that can be done was applied
  76829. */
  76830. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76831. }
  76832. /**
  76833. * Defines an optimization used to increase or decrease the rendering resolution
  76834. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76835. */
  76836. export class HardwareScalingOptimization extends SceneOptimization {
  76837. /**
  76838. * Defines the priority of this optimization (0 by default which means first in the list)
  76839. */
  76840. priority: number;
  76841. /**
  76842. * Defines the maximum scale to use (2 by default)
  76843. */
  76844. maximumScale: number;
  76845. /**
  76846. * Defines the step to use between two passes (0.5 by default)
  76847. */
  76848. step: number;
  76849. private _currentScale;
  76850. private _directionOffset;
  76851. /**
  76852. * Gets a string describing the action executed by the current optimization
  76853. * @return description string
  76854. */
  76855. getDescription(): string;
  76856. /**
  76857. * Creates the HardwareScalingOptimization object
  76858. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76859. * @param maximumScale defines the maximum scale to use (2 by default)
  76860. * @param step defines the step to use between two passes (0.5 by default)
  76861. */
  76862. constructor(
  76863. /**
  76864. * Defines the priority of this optimization (0 by default which means first in the list)
  76865. */
  76866. priority?: number,
  76867. /**
  76868. * Defines the maximum scale to use (2 by default)
  76869. */
  76870. maximumScale?: number,
  76871. /**
  76872. * Defines the step to use between two passes (0.5 by default)
  76873. */
  76874. step?: number);
  76875. /**
  76876. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76877. * @param scene defines the current scene where to apply this optimization
  76878. * @param optimizer defines the current optimizer
  76879. * @returns true if everything that can be done was applied
  76880. */
  76881. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76882. }
  76883. /**
  76884. * Defines an optimization used to remove shadows
  76885. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76886. */
  76887. export class ShadowsOptimization extends SceneOptimization {
  76888. /**
  76889. * Gets a string describing the action executed by the current optimization
  76890. * @return description string
  76891. */
  76892. getDescription(): string;
  76893. /**
  76894. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76895. * @param scene defines the current scene where to apply this optimization
  76896. * @param optimizer defines the current optimizer
  76897. * @returns true if everything that can be done was applied
  76898. */
  76899. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76900. }
  76901. /**
  76902. * Defines an optimization used to turn post-processes off
  76903. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76904. */
  76905. export class PostProcessesOptimization extends SceneOptimization {
  76906. /**
  76907. * Gets a string describing the action executed by the current optimization
  76908. * @return description string
  76909. */
  76910. getDescription(): string;
  76911. /**
  76912. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76913. * @param scene defines the current scene where to apply this optimization
  76914. * @param optimizer defines the current optimizer
  76915. * @returns true if everything that can be done was applied
  76916. */
  76917. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76918. }
  76919. /**
  76920. * Defines an optimization used to turn lens flares off
  76921. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76922. */
  76923. export class LensFlaresOptimization extends SceneOptimization {
  76924. /**
  76925. * Gets a string describing the action executed by the current optimization
  76926. * @return description string
  76927. */
  76928. getDescription(): string;
  76929. /**
  76930. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76931. * @param scene defines the current scene where to apply this optimization
  76932. * @param optimizer defines the current optimizer
  76933. * @returns true if everything that can be done was applied
  76934. */
  76935. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76936. }
  76937. /**
  76938. * Defines an optimization based on user defined callback.
  76939. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76940. */
  76941. export class CustomOptimization extends SceneOptimization {
  76942. /**
  76943. * Callback called to apply the custom optimization.
  76944. */
  76945. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  76946. /**
  76947. * Callback called to get custom description
  76948. */
  76949. onGetDescription: () => string;
  76950. /**
  76951. * Gets a string describing the action executed by the current optimization
  76952. * @returns description string
  76953. */
  76954. getDescription(): string;
  76955. /**
  76956. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76957. * @param scene defines the current scene where to apply this optimization
  76958. * @param optimizer defines the current optimizer
  76959. * @returns true if everything that can be done was applied
  76960. */
  76961. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76962. }
  76963. /**
  76964. * Defines an optimization used to turn particles off
  76965. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76966. */
  76967. export class ParticlesOptimization extends SceneOptimization {
  76968. /**
  76969. * Gets a string describing the action executed by the current optimization
  76970. * @return description string
  76971. */
  76972. getDescription(): string;
  76973. /**
  76974. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76975. * @param scene defines the current scene where to apply this optimization
  76976. * @param optimizer defines the current optimizer
  76977. * @returns true if everything that can be done was applied
  76978. */
  76979. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76980. }
  76981. /**
  76982. * Defines an optimization used to turn render targets off
  76983. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76984. */
  76985. export class RenderTargetsOptimization extends SceneOptimization {
  76986. /**
  76987. * Gets a string describing the action executed by the current optimization
  76988. * @return description string
  76989. */
  76990. getDescription(): string;
  76991. /**
  76992. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76993. * @param scene defines the current scene where to apply this optimization
  76994. * @param optimizer defines the current optimizer
  76995. * @returns true if everything that can be done was applied
  76996. */
  76997. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76998. }
  76999. /**
  77000. * Defines an optimization used to merge meshes with compatible materials
  77001. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77002. */
  77003. export class MergeMeshesOptimization extends SceneOptimization {
  77004. private static _UpdateSelectionTree;
  77005. /**
  77006. * Gets or sets a boolean which defines if optimization octree has to be updated
  77007. */
  77008. static get UpdateSelectionTree(): boolean;
  77009. /**
  77010. * Gets or sets a boolean which defines if optimization octree has to be updated
  77011. */
  77012. static set UpdateSelectionTree(value: boolean);
  77013. /**
  77014. * Gets a string describing the action executed by the current optimization
  77015. * @return description string
  77016. */
  77017. getDescription(): string;
  77018. private _canBeMerged;
  77019. /**
  77020. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77021. * @param scene defines the current scene where to apply this optimization
  77022. * @param optimizer defines the current optimizer
  77023. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77024. * @returns true if everything that can be done was applied
  77025. */
  77026. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77027. }
  77028. /**
  77029. * Defines a list of options used by SceneOptimizer
  77030. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77031. */
  77032. export class SceneOptimizerOptions {
  77033. /**
  77034. * Defines the target frame rate to reach (60 by default)
  77035. */
  77036. targetFrameRate: number;
  77037. /**
  77038. * Defines the interval between two checkes (2000ms by default)
  77039. */
  77040. trackerDuration: number;
  77041. /**
  77042. * Gets the list of optimizations to apply
  77043. */
  77044. optimizations: SceneOptimization[];
  77045. /**
  77046. * Creates a new list of options used by SceneOptimizer
  77047. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77048. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77049. */
  77050. constructor(
  77051. /**
  77052. * Defines the target frame rate to reach (60 by default)
  77053. */
  77054. targetFrameRate?: number,
  77055. /**
  77056. * Defines the interval between two checkes (2000ms by default)
  77057. */
  77058. trackerDuration?: number);
  77059. /**
  77060. * Add a new optimization
  77061. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77062. * @returns the current SceneOptimizerOptions
  77063. */
  77064. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77065. /**
  77066. * Add a new custom optimization
  77067. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77068. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77069. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77070. * @returns the current SceneOptimizerOptions
  77071. */
  77072. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77073. /**
  77074. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77075. * @param targetFrameRate defines the target frame rate (60 by default)
  77076. * @returns a SceneOptimizerOptions object
  77077. */
  77078. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77079. /**
  77080. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77081. * @param targetFrameRate defines the target frame rate (60 by default)
  77082. * @returns a SceneOptimizerOptions object
  77083. */
  77084. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77085. /**
  77086. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77087. * @param targetFrameRate defines the target frame rate (60 by default)
  77088. * @returns a SceneOptimizerOptions object
  77089. */
  77090. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77091. }
  77092. /**
  77093. * Class used to run optimizations in order to reach a target frame rate
  77094. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77095. */
  77096. export class SceneOptimizer implements IDisposable {
  77097. private _isRunning;
  77098. private _options;
  77099. private _scene;
  77100. private _currentPriorityLevel;
  77101. private _targetFrameRate;
  77102. private _trackerDuration;
  77103. private _currentFrameRate;
  77104. private _sceneDisposeObserver;
  77105. private _improvementMode;
  77106. /**
  77107. * Defines an observable called when the optimizer reaches the target frame rate
  77108. */
  77109. onSuccessObservable: Observable<SceneOptimizer>;
  77110. /**
  77111. * Defines an observable called when the optimizer enables an optimization
  77112. */
  77113. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77114. /**
  77115. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77116. */
  77117. onFailureObservable: Observable<SceneOptimizer>;
  77118. /**
  77119. * Gets a boolean indicating if the optimizer is in improvement mode
  77120. */
  77121. get isInImprovementMode(): boolean;
  77122. /**
  77123. * Gets the current priority level (0 at start)
  77124. */
  77125. get currentPriorityLevel(): number;
  77126. /**
  77127. * Gets the current frame rate checked by the SceneOptimizer
  77128. */
  77129. get currentFrameRate(): number;
  77130. /**
  77131. * Gets or sets the current target frame rate (60 by default)
  77132. */
  77133. get targetFrameRate(): number;
  77134. /**
  77135. * Gets or sets the current target frame rate (60 by default)
  77136. */
  77137. set targetFrameRate(value: number);
  77138. /**
  77139. * Gets or sets the current interval between two checks (every 2000ms by default)
  77140. */
  77141. get trackerDuration(): number;
  77142. /**
  77143. * Gets or sets the current interval between two checks (every 2000ms by default)
  77144. */
  77145. set trackerDuration(value: number);
  77146. /**
  77147. * Gets the list of active optimizations
  77148. */
  77149. get optimizations(): SceneOptimization[];
  77150. /**
  77151. * Creates a new SceneOptimizer
  77152. * @param scene defines the scene to work on
  77153. * @param options defines the options to use with the SceneOptimizer
  77154. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77155. * @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)
  77156. */
  77157. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77158. /**
  77159. * Stops the current optimizer
  77160. */
  77161. stop(): void;
  77162. /**
  77163. * Reset the optimizer to initial step (current priority level = 0)
  77164. */
  77165. reset(): void;
  77166. /**
  77167. * Start the optimizer. By default it will try to reach a specific framerate
  77168. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77169. */
  77170. start(): void;
  77171. private _checkCurrentState;
  77172. /**
  77173. * Release all resources
  77174. */
  77175. dispose(): void;
  77176. /**
  77177. * Helper function to create a SceneOptimizer with one single line of code
  77178. * @param scene defines the scene to work on
  77179. * @param options defines the options to use with the SceneOptimizer
  77180. * @param onSuccess defines a callback to call on success
  77181. * @param onFailure defines a callback to call on failure
  77182. * @returns the new SceneOptimizer object
  77183. */
  77184. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77185. }
  77186. }
  77187. declare module "babylonjs/Misc/sceneSerializer" {
  77188. import { Scene } from "babylonjs/scene";
  77189. /**
  77190. * Class used to serialize a scene into a string
  77191. */
  77192. export class SceneSerializer {
  77193. /**
  77194. * Clear cache used by a previous serialization
  77195. */
  77196. static ClearCache(): void;
  77197. /**
  77198. * Serialize a scene into a JSON compatible object
  77199. * @param scene defines the scene to serialize
  77200. * @returns a JSON compatible object
  77201. */
  77202. static Serialize(scene: Scene): any;
  77203. /**
  77204. * Serialize a mesh into a JSON compatible object
  77205. * @param toSerialize defines the mesh to serialize
  77206. * @param withParents defines if parents must be serialized as well
  77207. * @param withChildren defines if children must be serialized as well
  77208. * @returns a JSON compatible object
  77209. */
  77210. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77211. }
  77212. }
  77213. declare module "babylonjs/Misc/textureTools" {
  77214. import { Texture } from "babylonjs/Materials/Textures/texture";
  77215. /**
  77216. * Class used to host texture specific utilities
  77217. */
  77218. export class TextureTools {
  77219. /**
  77220. * Uses the GPU to create a copy texture rescaled at a given size
  77221. * @param texture Texture to copy from
  77222. * @param width defines the desired width
  77223. * @param height defines the desired height
  77224. * @param useBilinearMode defines if bilinear mode has to be used
  77225. * @return the generated texture
  77226. */
  77227. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77228. }
  77229. }
  77230. declare module "babylonjs/Misc/videoRecorder" {
  77231. import { Nullable } from "babylonjs/types";
  77232. import { Engine } from "babylonjs/Engines/engine";
  77233. /**
  77234. * This represents the different options available for the video capture.
  77235. */
  77236. export interface VideoRecorderOptions {
  77237. /** Defines the mime type of the video. */
  77238. mimeType: string;
  77239. /** Defines the FPS the video should be recorded at. */
  77240. fps: number;
  77241. /** Defines the chunk size for the recording data. */
  77242. recordChunckSize: number;
  77243. /** The audio tracks to attach to the recording. */
  77244. audioTracks?: MediaStreamTrack[];
  77245. }
  77246. /**
  77247. * This can help with recording videos from BabylonJS.
  77248. * This is based on the available WebRTC functionalities of the browser.
  77249. *
  77250. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77251. */
  77252. export class VideoRecorder {
  77253. private static readonly _defaultOptions;
  77254. /**
  77255. * Returns whether or not the VideoRecorder is available in your browser.
  77256. * @param engine Defines the Babylon Engine.
  77257. * @returns true if supported otherwise false.
  77258. */
  77259. static IsSupported(engine: Engine): boolean;
  77260. private readonly _options;
  77261. private _canvas;
  77262. private _mediaRecorder;
  77263. private _recordedChunks;
  77264. private _fileName;
  77265. private _resolve;
  77266. private _reject;
  77267. /**
  77268. * True when a recording is already in progress.
  77269. */
  77270. get isRecording(): boolean;
  77271. /**
  77272. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77273. * @param engine Defines the BabylonJS Engine you wish to record.
  77274. * @param options Defines options that can be used to customize the capture.
  77275. */
  77276. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77277. /**
  77278. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77279. */
  77280. stopRecording(): void;
  77281. /**
  77282. * Starts recording the canvas for a max duration specified in parameters.
  77283. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77284. * If null no automatic download will start and you can rely on the promise to get the data back.
  77285. * @param maxDuration Defines the maximum recording time in seconds.
  77286. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77287. * @return A promise callback at the end of the recording with the video data in Blob.
  77288. */
  77289. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77290. /**
  77291. * Releases internal resources used during the recording.
  77292. */
  77293. dispose(): void;
  77294. private _handleDataAvailable;
  77295. private _handleError;
  77296. private _handleStop;
  77297. }
  77298. }
  77299. declare module "babylonjs/Misc/screenshotTools" {
  77300. import { Camera } from "babylonjs/Cameras/camera";
  77301. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77302. import { Engine } from "babylonjs/Engines/engine";
  77303. /**
  77304. * Class containing a set of static utilities functions for screenshots
  77305. */
  77306. export class ScreenshotTools {
  77307. /**
  77308. * Captures a screenshot of the current rendering
  77309. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77310. * @param engine defines the rendering engine
  77311. * @param camera defines the source camera
  77312. * @param size This parameter can be set to a single number or to an object with the
  77313. * following (optional) properties: precision, width, height. If a single number is passed,
  77314. * it will be used for both width and height. If an object is passed, the screenshot size
  77315. * will be derived from the parameters. The precision property is a multiplier allowing
  77316. * rendering at a higher or lower resolution
  77317. * @param successCallback defines the callback receives a single parameter which contains the
  77318. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77319. * src parameter of an <img> to display it
  77320. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77321. * Check your browser for supported MIME types
  77322. */
  77323. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77324. /**
  77325. * Captures a screenshot of the current rendering
  77326. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77327. * @param engine defines the rendering engine
  77328. * @param camera defines the source camera
  77329. * @param size This parameter can be set to a single number or to an object with the
  77330. * following (optional) properties: precision, width, height. If a single number is passed,
  77331. * it will be used for both width and height. If an object is passed, the screenshot size
  77332. * will be derived from the parameters. The precision property is a multiplier allowing
  77333. * rendering at a higher or lower resolution
  77334. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77335. * Check your browser for supported MIME types
  77336. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77337. * to the src parameter of an <img> to display it
  77338. */
  77339. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  77340. /**
  77341. * Generates an image screenshot from the specified camera.
  77342. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77343. * @param engine The engine to use for rendering
  77344. * @param camera The camera to use for rendering
  77345. * @param size This parameter can be set to a single number or to an object with the
  77346. * following (optional) properties: precision, width, height. If a single number is passed,
  77347. * it will be used for both width and height. If an object is passed, the screenshot size
  77348. * will be derived from the parameters. The precision property is a multiplier allowing
  77349. * rendering at a higher or lower resolution
  77350. * @param successCallback The callback receives a single parameter which contains the
  77351. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77352. * src parameter of an <img> to display it
  77353. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77354. * Check your browser for supported MIME types
  77355. * @param samples Texture samples (default: 1)
  77356. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77357. * @param fileName A name for for the downloaded file.
  77358. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77359. */
  77360. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  77361. /**
  77362. * Generates an image screenshot from the specified camera.
  77363. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77364. * @param engine The engine to use for rendering
  77365. * @param camera The camera to use for rendering
  77366. * @param size This parameter can be set to a single number or to an object with the
  77367. * following (optional) properties: precision, width, height. If a single number is passed,
  77368. * it will be used for both width and height. If an object is passed, the screenshot size
  77369. * will be derived from the parameters. The precision property is a multiplier allowing
  77370. * rendering at a higher or lower resolution
  77371. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77372. * Check your browser for supported MIME types
  77373. * @param samples Texture samples (default: 1)
  77374. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77375. * @param fileName A name for for the downloaded file.
  77376. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77377. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77378. * to the src parameter of an <img> to display it
  77379. */
  77380. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  77381. /**
  77382. * Gets height and width for screenshot size
  77383. * @private
  77384. */
  77385. private static _getScreenshotSize;
  77386. }
  77387. }
  77388. declare module "babylonjs/Misc/dataReader" {
  77389. /**
  77390. * Interface for a data buffer
  77391. */
  77392. export interface IDataBuffer {
  77393. /**
  77394. * Reads bytes from the data buffer.
  77395. * @param byteOffset The byte offset to read
  77396. * @param byteLength The byte length to read
  77397. * @returns A promise that resolves when the bytes are read
  77398. */
  77399. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  77400. /**
  77401. * The byte length of the buffer.
  77402. */
  77403. readonly byteLength: number;
  77404. }
  77405. /**
  77406. * Utility class for reading from a data buffer
  77407. */
  77408. export class DataReader {
  77409. /**
  77410. * The data buffer associated with this data reader.
  77411. */
  77412. readonly buffer: IDataBuffer;
  77413. /**
  77414. * The current byte offset from the beginning of the data buffer.
  77415. */
  77416. byteOffset: number;
  77417. private _dataView;
  77418. private _dataByteOffset;
  77419. /**
  77420. * Constructor
  77421. * @param buffer The buffer to read
  77422. */
  77423. constructor(buffer: IDataBuffer);
  77424. /**
  77425. * Loads the given byte length.
  77426. * @param byteLength The byte length to load
  77427. * @returns A promise that resolves when the load is complete
  77428. */
  77429. loadAsync(byteLength: number): Promise<void>;
  77430. /**
  77431. * Read a unsigned 32-bit integer from the currently loaded data range.
  77432. * @returns The 32-bit integer read
  77433. */
  77434. readUint32(): number;
  77435. /**
  77436. * Read a byte array from the currently loaded data range.
  77437. * @param byteLength The byte length to read
  77438. * @returns The byte array read
  77439. */
  77440. readUint8Array(byteLength: number): Uint8Array;
  77441. /**
  77442. * Read a string from the currently loaded data range.
  77443. * @param byteLength The byte length to read
  77444. * @returns The string read
  77445. */
  77446. readString(byteLength: number): string;
  77447. /**
  77448. * Skips the given byte length the currently loaded data range.
  77449. * @param byteLength The byte length to skip
  77450. */
  77451. skipBytes(byteLength: number): void;
  77452. }
  77453. }
  77454. declare module "babylonjs/Misc/dataStorage" {
  77455. /**
  77456. * Class for storing data to local storage if available or in-memory storage otherwise
  77457. */
  77458. export class DataStorage {
  77459. private static _Storage;
  77460. private static _GetStorage;
  77461. /**
  77462. * Reads a string from the data storage
  77463. * @param key The key to read
  77464. * @param defaultValue The value if the key doesn't exist
  77465. * @returns The string value
  77466. */
  77467. static ReadString(key: string, defaultValue: string): string;
  77468. /**
  77469. * Writes a string to the data storage
  77470. * @param key The key to write
  77471. * @param value The value to write
  77472. */
  77473. static WriteString(key: string, value: string): void;
  77474. /**
  77475. * Reads a boolean from the data storage
  77476. * @param key The key to read
  77477. * @param defaultValue The value if the key doesn't exist
  77478. * @returns The boolean value
  77479. */
  77480. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  77481. /**
  77482. * Writes a boolean to the data storage
  77483. * @param key The key to write
  77484. * @param value The value to write
  77485. */
  77486. static WriteBoolean(key: string, value: boolean): void;
  77487. /**
  77488. * Reads a number from the data storage
  77489. * @param key The key to read
  77490. * @param defaultValue The value if the key doesn't exist
  77491. * @returns The number value
  77492. */
  77493. static ReadNumber(key: string, defaultValue: number): number;
  77494. /**
  77495. * Writes a number to the data storage
  77496. * @param key The key to write
  77497. * @param value The value to write
  77498. */
  77499. static WriteNumber(key: string, value: number): void;
  77500. }
  77501. }
  77502. declare module "babylonjs/Misc/sceneRecorder" {
  77503. import { Scene } from "babylonjs/scene";
  77504. /**
  77505. * Class used to record delta files between 2 scene states
  77506. */
  77507. export class SceneRecorder {
  77508. private _trackedScene;
  77509. private _savedJSON;
  77510. /**
  77511. * Track a given scene. This means the current scene state will be considered the original state
  77512. * @param scene defines the scene to track
  77513. */
  77514. track(scene: Scene): void;
  77515. /**
  77516. * Get the delta between current state and original state
  77517. * @returns a string containing the delta
  77518. */
  77519. getDelta(): any;
  77520. private _compareArray;
  77521. private _compareObjects;
  77522. private _compareCollections;
  77523. /**
  77524. * Apply a given delta to a given scene
  77525. * @param deltaJSON defines the JSON containing the delta
  77526. * @param scene defines the scene to apply the delta to
  77527. */
  77528. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  77529. private static _ApplyPropertiesToEntity;
  77530. private static _ApplyDeltaForEntity;
  77531. }
  77532. }
  77533. declare module "babylonjs/Misc/index" {
  77534. export * from "babylonjs/Misc/andOrNotEvaluator";
  77535. export * from "babylonjs/Misc/assetsManager";
  77536. export * from "babylonjs/Misc/basis";
  77537. export * from "babylonjs/Misc/dds";
  77538. export * from "babylonjs/Misc/decorators";
  77539. export * from "babylonjs/Misc/deferred";
  77540. export * from "babylonjs/Misc/environmentTextureTools";
  77541. export * from "babylonjs/Misc/meshExploder";
  77542. export * from "babylonjs/Misc/filesInput";
  77543. export * from "babylonjs/Misc/HighDynamicRange/index";
  77544. export * from "babylonjs/Misc/khronosTextureContainer";
  77545. export * from "babylonjs/Misc/observable";
  77546. export * from "babylonjs/Misc/performanceMonitor";
  77547. export * from "babylonjs/Misc/promise";
  77548. export * from "babylonjs/Misc/sceneOptimizer";
  77549. export * from "babylonjs/Misc/sceneSerializer";
  77550. export * from "babylonjs/Misc/smartArray";
  77551. export * from "babylonjs/Misc/stringDictionary";
  77552. export * from "babylonjs/Misc/tags";
  77553. export * from "babylonjs/Misc/textureTools";
  77554. export * from "babylonjs/Misc/tga";
  77555. export * from "babylonjs/Misc/tools";
  77556. export * from "babylonjs/Misc/videoRecorder";
  77557. export * from "babylonjs/Misc/virtualJoystick";
  77558. export * from "babylonjs/Misc/workerPool";
  77559. export * from "babylonjs/Misc/logger";
  77560. export * from "babylonjs/Misc/typeStore";
  77561. export * from "babylonjs/Misc/filesInputStore";
  77562. export * from "babylonjs/Misc/deepCopier";
  77563. export * from "babylonjs/Misc/pivotTools";
  77564. export * from "babylonjs/Misc/precisionDate";
  77565. export * from "babylonjs/Misc/screenshotTools";
  77566. export * from "babylonjs/Misc/typeStore";
  77567. export * from "babylonjs/Misc/webRequest";
  77568. export * from "babylonjs/Misc/iInspectable";
  77569. export * from "babylonjs/Misc/brdfTextureTools";
  77570. export * from "babylonjs/Misc/rgbdTextureTools";
  77571. export * from "babylonjs/Misc/gradients";
  77572. export * from "babylonjs/Misc/perfCounter";
  77573. export * from "babylonjs/Misc/fileRequest";
  77574. export * from "babylonjs/Misc/customAnimationFrameRequester";
  77575. export * from "babylonjs/Misc/retryStrategy";
  77576. export * from "babylonjs/Misc/interfaces/screenshotSize";
  77577. export * from "babylonjs/Misc/canvasGenerator";
  77578. export * from "babylonjs/Misc/fileTools";
  77579. export * from "babylonjs/Misc/stringTools";
  77580. export * from "babylonjs/Misc/dataReader";
  77581. export * from "babylonjs/Misc/minMaxReducer";
  77582. export * from "babylonjs/Misc/depthReducer";
  77583. export * from "babylonjs/Misc/dataStorage";
  77584. export * from "babylonjs/Misc/sceneRecorder";
  77585. }
  77586. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  77587. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  77588. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77589. import { Observable } from "babylonjs/Misc/observable";
  77590. import { Matrix } from "babylonjs/Maths/math.vector";
  77591. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77592. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77593. /**
  77594. * An interface for all Hit test features
  77595. */
  77596. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  77597. /**
  77598. * Triggered when new babylon (transformed) hit test results are available
  77599. */
  77600. onHitTestResultObservable: Observable<T[]>;
  77601. }
  77602. /**
  77603. * Options used for hit testing
  77604. */
  77605. export interface IWebXRLegacyHitTestOptions {
  77606. /**
  77607. * Only test when user interacted with the scene. Default - hit test every frame
  77608. */
  77609. testOnPointerDownOnly?: boolean;
  77610. /**
  77611. * The node to use to transform the local results to world coordinates
  77612. */
  77613. worldParentNode?: TransformNode;
  77614. }
  77615. /**
  77616. * Interface defining the babylon result of raycasting/hit-test
  77617. */
  77618. export interface IWebXRLegacyHitResult {
  77619. /**
  77620. * Transformation matrix that can be applied to a node that will put it in the hit point location
  77621. */
  77622. transformationMatrix: Matrix;
  77623. /**
  77624. * The native hit test result
  77625. */
  77626. xrHitResult: XRHitResult | XRHitTestResult;
  77627. }
  77628. /**
  77629. * The currently-working hit-test module.
  77630. * Hit test (or Ray-casting) is used to interact with the real world.
  77631. * For further information read here - https://github.com/immersive-web/hit-test
  77632. */
  77633. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  77634. /**
  77635. * options to use when constructing this feature
  77636. */
  77637. readonly options: IWebXRLegacyHitTestOptions;
  77638. private _direction;
  77639. private _mat;
  77640. private _onSelectEnabled;
  77641. private _origin;
  77642. /**
  77643. * The module's name
  77644. */
  77645. static readonly Name: string;
  77646. /**
  77647. * The (Babylon) version of this module.
  77648. * This is an integer representing the implementation version.
  77649. * This number does not correspond to the WebXR specs version
  77650. */
  77651. static readonly Version: number;
  77652. /**
  77653. * Populated with the last native XR Hit Results
  77654. */
  77655. lastNativeXRHitResults: XRHitResult[];
  77656. /**
  77657. * Triggered when new babylon (transformed) hit test results are available
  77658. */
  77659. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  77660. /**
  77661. * Creates a new instance of the (legacy version) hit test feature
  77662. * @param _xrSessionManager an instance of WebXRSessionManager
  77663. * @param options options to use when constructing this feature
  77664. */
  77665. constructor(_xrSessionManager: WebXRSessionManager,
  77666. /**
  77667. * options to use when constructing this feature
  77668. */
  77669. options?: IWebXRLegacyHitTestOptions);
  77670. /**
  77671. * execute a hit test with an XR Ray
  77672. *
  77673. * @param xrSession a native xrSession that will execute this hit test
  77674. * @param xrRay the ray (position and direction) to use for ray-casting
  77675. * @param referenceSpace native XR reference space to use for the hit-test
  77676. * @param filter filter function that will filter the results
  77677. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  77678. */
  77679. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  77680. /**
  77681. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  77682. * @param event the (select) event to use to select with
  77683. * @param referenceSpace the reference space to use for this hit test
  77684. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  77685. */
  77686. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  77687. /**
  77688. * attach this feature
  77689. * Will usually be called by the features manager
  77690. *
  77691. * @returns true if successful.
  77692. */
  77693. attach(): boolean;
  77694. /**
  77695. * detach this feature.
  77696. * Will usually be called by the features manager
  77697. *
  77698. * @returns true if successful.
  77699. */
  77700. detach(): boolean;
  77701. /**
  77702. * Dispose this feature and all of the resources attached
  77703. */
  77704. dispose(): void;
  77705. protected _onXRFrame(frame: XRFrame): void;
  77706. private _onHitTestResults;
  77707. private _onSelect;
  77708. }
  77709. }
  77710. declare module "babylonjs/XR/features/WebXRHitTest" {
  77711. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77712. import { Observable } from "babylonjs/Misc/observable";
  77713. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  77714. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77715. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  77716. /**
  77717. * Options used for hit testing (version 2)
  77718. */
  77719. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  77720. /**
  77721. * Do not create a permanent hit test. Will usually be used when only
  77722. * transient inputs are needed.
  77723. */
  77724. disablePermanentHitTest?: boolean;
  77725. /**
  77726. * Enable transient (for example touch-based) hit test inspections
  77727. */
  77728. enableTransientHitTest?: boolean;
  77729. /**
  77730. * Offset ray for the permanent hit test
  77731. */
  77732. offsetRay?: Vector3;
  77733. /**
  77734. * Offset ray for the transient hit test
  77735. */
  77736. transientOffsetRay?: Vector3;
  77737. /**
  77738. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  77739. */
  77740. useReferenceSpace?: boolean;
  77741. }
  77742. /**
  77743. * Interface defining the babylon result of hit-test
  77744. */
  77745. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  77746. /**
  77747. * The input source that generated this hit test (if transient)
  77748. */
  77749. inputSource?: XRInputSource;
  77750. /**
  77751. * Is this a transient hit test
  77752. */
  77753. isTransient?: boolean;
  77754. /**
  77755. * Position of the hit test result
  77756. */
  77757. position: Vector3;
  77758. /**
  77759. * Rotation of the hit test result
  77760. */
  77761. rotationQuaternion: Quaternion;
  77762. /**
  77763. * The native hit test result
  77764. */
  77765. xrHitResult: XRHitTestResult;
  77766. }
  77767. /**
  77768. * The currently-working hit-test module.
  77769. * Hit test (or Ray-casting) is used to interact with the real world.
  77770. * For further information read here - https://github.com/immersive-web/hit-test
  77771. *
  77772. * Tested on chrome (mobile) 80.
  77773. */
  77774. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  77775. /**
  77776. * options to use when constructing this feature
  77777. */
  77778. readonly options: IWebXRHitTestOptions;
  77779. private _tmpMat;
  77780. private _tmpPos;
  77781. private _tmpQuat;
  77782. private _transientXrHitTestSource;
  77783. private _xrHitTestSource;
  77784. private initHitTestSource;
  77785. /**
  77786. * The module's name
  77787. */
  77788. static readonly Name: string;
  77789. /**
  77790. * The (Babylon) version of this module.
  77791. * This is an integer representing the implementation version.
  77792. * This number does not correspond to the WebXR specs version
  77793. */
  77794. static readonly Version: number;
  77795. /**
  77796. * When set to true, each hit test will have its own position/rotation objects
  77797. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  77798. * the developers will clone them or copy them as they see fit.
  77799. */
  77800. autoCloneTransformation: boolean;
  77801. /**
  77802. * Triggered when new babylon (transformed) hit test results are available
  77803. */
  77804. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  77805. /**
  77806. * Use this to temporarily pause hit test checks.
  77807. */
  77808. paused: boolean;
  77809. /**
  77810. * Creates a new instance of the hit test feature
  77811. * @param _xrSessionManager an instance of WebXRSessionManager
  77812. * @param options options to use when constructing this feature
  77813. */
  77814. constructor(_xrSessionManager: WebXRSessionManager,
  77815. /**
  77816. * options to use when constructing this feature
  77817. */
  77818. options?: IWebXRHitTestOptions);
  77819. /**
  77820. * attach this feature
  77821. * Will usually be called by the features manager
  77822. *
  77823. * @returns true if successful.
  77824. */
  77825. attach(): boolean;
  77826. /**
  77827. * detach this feature.
  77828. * Will usually be called by the features manager
  77829. *
  77830. * @returns true if successful.
  77831. */
  77832. detach(): boolean;
  77833. /**
  77834. * Dispose this feature and all of the resources attached
  77835. */
  77836. dispose(): void;
  77837. protected _onXRFrame(frame: XRFrame): void;
  77838. private _processWebXRHitTestResult;
  77839. }
  77840. }
  77841. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  77842. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77843. import { Observable } from "babylonjs/Misc/observable";
  77844. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  77845. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77846. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77847. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  77848. /**
  77849. * Configuration options of the anchor system
  77850. */
  77851. export interface IWebXRAnchorSystemOptions {
  77852. /**
  77853. * a node that will be used to convert local to world coordinates
  77854. */
  77855. worldParentNode?: TransformNode;
  77856. /**
  77857. * If set to true a reference of the created anchors will be kept until the next session starts
  77858. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  77859. */
  77860. doNotRemoveAnchorsOnSessionEnded?: boolean;
  77861. }
  77862. /**
  77863. * A babylon container for an XR Anchor
  77864. */
  77865. export interface IWebXRAnchor {
  77866. /**
  77867. * A babylon-assigned ID for this anchor
  77868. */
  77869. id: number;
  77870. /**
  77871. * Transformation matrix to apply to an object attached to this anchor
  77872. */
  77873. transformationMatrix: Matrix;
  77874. /**
  77875. * The native anchor object
  77876. */
  77877. xrAnchor: XRAnchor;
  77878. /**
  77879. * if defined, this object will be constantly updated by the anchor's position and rotation
  77880. */
  77881. attachedNode?: TransformNode;
  77882. }
  77883. /**
  77884. * An implementation of the anchor system for WebXR.
  77885. * For further information see https://github.com/immersive-web/anchors/
  77886. */
  77887. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  77888. private _options;
  77889. private _lastFrameDetected;
  77890. private _trackedAnchors;
  77891. private _referenceSpaceForFrameAnchors;
  77892. private _futureAnchors;
  77893. /**
  77894. * The module's name
  77895. */
  77896. static readonly Name: string;
  77897. /**
  77898. * The (Babylon) version of this module.
  77899. * This is an integer representing the implementation version.
  77900. * This number does not correspond to the WebXR specs version
  77901. */
  77902. static readonly Version: number;
  77903. /**
  77904. * Observers registered here will be executed when a new anchor was added to the session
  77905. */
  77906. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  77907. /**
  77908. * Observers registered here will be executed when an anchor was removed from the session
  77909. */
  77910. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  77911. /**
  77912. * Observers registered here will be executed when an existing anchor updates
  77913. * This can execute N times every frame
  77914. */
  77915. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  77916. /**
  77917. * Set the reference space to use for anchor creation, when not using a hit test.
  77918. * Will default to the session's reference space if not defined
  77919. */
  77920. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  77921. /**
  77922. * constructs a new anchor system
  77923. * @param _xrSessionManager an instance of WebXRSessionManager
  77924. * @param _options configuration object for this feature
  77925. */
  77926. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  77927. private _tmpVector;
  77928. private _tmpQuaternion;
  77929. private _populateTmpTransformation;
  77930. /**
  77931. * Create a new anchor point using a hit test result at a specific point in the scene
  77932. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77933. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77934. *
  77935. * @param hitTestResult The hit test result to use for this anchor creation
  77936. * @param position an optional position offset for this anchor
  77937. * @param rotationQuaternion an optional rotation offset for this anchor
  77938. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77939. */
  77940. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  77941. /**
  77942. * Add a new anchor at a specific position and rotation
  77943. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  77944. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  77945. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77946. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77947. *
  77948. * @param position the position in which to add an anchor
  77949. * @param rotationQuaternion an optional rotation for the anchor transformation
  77950. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  77951. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77952. */
  77953. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  77954. /**
  77955. * detach this feature.
  77956. * Will usually be called by the features manager
  77957. *
  77958. * @returns true if successful.
  77959. */
  77960. detach(): boolean;
  77961. /**
  77962. * Dispose this feature and all of the resources attached
  77963. */
  77964. dispose(): void;
  77965. protected _onXRFrame(frame: XRFrame): void;
  77966. /**
  77967. * avoiding using Array.find for global support.
  77968. * @param xrAnchor the plane to find in the array
  77969. */
  77970. private _findIndexInAnchorArray;
  77971. private _updateAnchorWithXRFrame;
  77972. private _createAnchorAtTransformation;
  77973. }
  77974. }
  77975. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  77976. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77977. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77978. import { Observable } from "babylonjs/Misc/observable";
  77979. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  77980. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77981. /**
  77982. * Options used in the plane detector module
  77983. */
  77984. export interface IWebXRPlaneDetectorOptions {
  77985. /**
  77986. * The node to use to transform the local results to world coordinates
  77987. */
  77988. worldParentNode?: TransformNode;
  77989. /**
  77990. * If set to true a reference of the created planes will be kept until the next session starts
  77991. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  77992. */
  77993. doNotRemovePlanesOnSessionEnded?: boolean;
  77994. }
  77995. /**
  77996. * A babylon interface for a WebXR plane.
  77997. * A Plane is actually a polygon, built from N points in space
  77998. *
  77999. * Supported in chrome 79, not supported in canary 81 ATM
  78000. */
  78001. export interface IWebXRPlane {
  78002. /**
  78003. * a babylon-assigned ID for this polygon
  78004. */
  78005. id: number;
  78006. /**
  78007. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78008. */
  78009. polygonDefinition: Array<Vector3>;
  78010. /**
  78011. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78012. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78013. */
  78014. transformationMatrix: Matrix;
  78015. /**
  78016. * the native xr-plane object
  78017. */
  78018. xrPlane: XRPlane;
  78019. }
  78020. /**
  78021. * The plane detector is used to detect planes in the real world when in AR
  78022. * For more information see https://github.com/immersive-web/real-world-geometry/
  78023. */
  78024. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78025. private _options;
  78026. private _detectedPlanes;
  78027. private _enabled;
  78028. private _lastFrameDetected;
  78029. /**
  78030. * The module's name
  78031. */
  78032. static readonly Name: string;
  78033. /**
  78034. * The (Babylon) version of this module.
  78035. * This is an integer representing the implementation version.
  78036. * This number does not correspond to the WebXR specs version
  78037. */
  78038. static readonly Version: number;
  78039. /**
  78040. * Observers registered here will be executed when a new plane was added to the session
  78041. */
  78042. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78043. /**
  78044. * Observers registered here will be executed when a plane is no longer detected in the session
  78045. */
  78046. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78047. /**
  78048. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78049. * This can execute N times every frame
  78050. */
  78051. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78052. /**
  78053. * construct a new Plane Detector
  78054. * @param _xrSessionManager an instance of xr Session manager
  78055. * @param _options configuration to use when constructing this feature
  78056. */
  78057. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78058. /**
  78059. * detach this feature.
  78060. * Will usually be called by the features manager
  78061. *
  78062. * @returns true if successful.
  78063. */
  78064. detach(): boolean;
  78065. /**
  78066. * Dispose this feature and all of the resources attached
  78067. */
  78068. dispose(): void;
  78069. protected _onXRFrame(frame: XRFrame): void;
  78070. private _init;
  78071. private _updatePlaneWithXRPlane;
  78072. /**
  78073. * avoiding using Array.find for global support.
  78074. * @param xrPlane the plane to find in the array
  78075. */
  78076. private findIndexInPlaneArray;
  78077. }
  78078. }
  78079. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78080. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78081. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78082. import { Observable } from "babylonjs/Misc/observable";
  78083. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78084. /**
  78085. * Options interface for the background remover plugin
  78086. */
  78087. export interface IWebXRBackgroundRemoverOptions {
  78088. /**
  78089. * Further background meshes to disable when entering AR
  78090. */
  78091. backgroundMeshes?: AbstractMesh[];
  78092. /**
  78093. * flags to configure the removal of the environment helper.
  78094. * If not set, the entire background will be removed. If set, flags should be set as well.
  78095. */
  78096. environmentHelperRemovalFlags?: {
  78097. /**
  78098. * Should the skybox be removed (default false)
  78099. */
  78100. skyBox?: boolean;
  78101. /**
  78102. * Should the ground be removed (default false)
  78103. */
  78104. ground?: boolean;
  78105. };
  78106. /**
  78107. * don't disable the environment helper
  78108. */
  78109. ignoreEnvironmentHelper?: boolean;
  78110. }
  78111. /**
  78112. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78113. */
  78114. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78115. /**
  78116. * read-only options to be used in this module
  78117. */
  78118. readonly options: IWebXRBackgroundRemoverOptions;
  78119. /**
  78120. * The module's name
  78121. */
  78122. static readonly Name: string;
  78123. /**
  78124. * The (Babylon) version of this module.
  78125. * This is an integer representing the implementation version.
  78126. * This number does not correspond to the WebXR specs version
  78127. */
  78128. static readonly Version: number;
  78129. /**
  78130. * registered observers will be triggered when the background state changes
  78131. */
  78132. onBackgroundStateChangedObservable: Observable<boolean>;
  78133. /**
  78134. * constructs a new background remover module
  78135. * @param _xrSessionManager the session manager for this module
  78136. * @param options read-only options to be used in this module
  78137. */
  78138. constructor(_xrSessionManager: WebXRSessionManager,
  78139. /**
  78140. * read-only options to be used in this module
  78141. */
  78142. options?: IWebXRBackgroundRemoverOptions);
  78143. /**
  78144. * attach this feature
  78145. * Will usually be called by the features manager
  78146. *
  78147. * @returns true if successful.
  78148. */
  78149. attach(): boolean;
  78150. /**
  78151. * detach this feature.
  78152. * Will usually be called by the features manager
  78153. *
  78154. * @returns true if successful.
  78155. */
  78156. detach(): boolean;
  78157. /**
  78158. * Dispose this feature and all of the resources attached
  78159. */
  78160. dispose(): void;
  78161. protected _onXRFrame(_xrFrame: XRFrame): void;
  78162. private _setBackgroundState;
  78163. }
  78164. }
  78165. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78166. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78167. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78168. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78169. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78170. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78171. import { Nullable } from "babylonjs/types";
  78172. /**
  78173. * Options for the controller physics feature
  78174. */
  78175. export class IWebXRControllerPhysicsOptions {
  78176. /**
  78177. * Should the headset get its own impostor
  78178. */
  78179. enableHeadsetImpostor?: boolean;
  78180. /**
  78181. * Optional parameters for the headset impostor
  78182. */
  78183. headsetImpostorParams?: {
  78184. /**
  78185. * The type of impostor to create. Default is sphere
  78186. */
  78187. impostorType: number;
  78188. /**
  78189. * the size of the impostor. Defaults to 10cm
  78190. */
  78191. impostorSize?: number | {
  78192. width: number;
  78193. height: number;
  78194. depth: number;
  78195. };
  78196. /**
  78197. * Friction definitions
  78198. */
  78199. friction?: number;
  78200. /**
  78201. * Restitution
  78202. */
  78203. restitution?: number;
  78204. };
  78205. /**
  78206. * The physics properties of the future impostors
  78207. */
  78208. physicsProperties?: {
  78209. /**
  78210. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78211. * Note that this requires a physics engine that supports mesh impostors!
  78212. */
  78213. useControllerMesh?: boolean;
  78214. /**
  78215. * The type of impostor to create. Default is sphere
  78216. */
  78217. impostorType?: number;
  78218. /**
  78219. * the size of the impostor. Defaults to 10cm
  78220. */
  78221. impostorSize?: number | {
  78222. width: number;
  78223. height: number;
  78224. depth: number;
  78225. };
  78226. /**
  78227. * Friction definitions
  78228. */
  78229. friction?: number;
  78230. /**
  78231. * Restitution
  78232. */
  78233. restitution?: number;
  78234. };
  78235. /**
  78236. * the xr input to use with this pointer selection
  78237. */
  78238. xrInput: WebXRInput;
  78239. }
  78240. /**
  78241. * Add physics impostor to your webxr controllers,
  78242. * including naive calculation of their linear and angular velocity
  78243. */
  78244. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78245. private readonly _options;
  78246. private _attachController;
  78247. private _controllers;
  78248. private _debugMode;
  78249. private _delta;
  78250. private _headsetImpostor?;
  78251. private _headsetMesh?;
  78252. private _lastTimestamp;
  78253. private _tmpQuaternion;
  78254. private _tmpVector;
  78255. /**
  78256. * The module's name
  78257. */
  78258. static readonly Name: string;
  78259. /**
  78260. * The (Babylon) version of this module.
  78261. * This is an integer representing the implementation version.
  78262. * This number does not correspond to the webxr specs version
  78263. */
  78264. static readonly Version: number;
  78265. /**
  78266. * Construct a new Controller Physics Feature
  78267. * @param _xrSessionManager the corresponding xr session manager
  78268. * @param _options options to create this feature with
  78269. */
  78270. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78271. /**
  78272. * @hidden
  78273. * enable debugging - will show console outputs and the impostor mesh
  78274. */
  78275. _enablePhysicsDebug(): void;
  78276. /**
  78277. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78278. * @param xrController the controller to add
  78279. */
  78280. addController(xrController: WebXRInputSource): void;
  78281. /**
  78282. * attach this feature
  78283. * Will usually be called by the features manager
  78284. *
  78285. * @returns true if successful.
  78286. */
  78287. attach(): boolean;
  78288. /**
  78289. * detach this feature.
  78290. * Will usually be called by the features manager
  78291. *
  78292. * @returns true if successful.
  78293. */
  78294. detach(): boolean;
  78295. /**
  78296. * Get the headset impostor, if enabled
  78297. * @returns the impostor
  78298. */
  78299. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78300. /**
  78301. * Get the physics impostor of a specific controller.
  78302. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78303. * @param controller the controller or the controller id of which to get the impostor
  78304. * @returns the impostor or null
  78305. */
  78306. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78307. /**
  78308. * Update the physics properties provided in the constructor
  78309. * @param newProperties the new properties object
  78310. */
  78311. setPhysicsProperties(newProperties: {
  78312. impostorType?: number;
  78313. impostorSize?: number | {
  78314. width: number;
  78315. height: number;
  78316. depth: number;
  78317. };
  78318. friction?: number;
  78319. restitution?: number;
  78320. }): void;
  78321. protected _onXRFrame(_xrFrame: any): void;
  78322. private _detachController;
  78323. }
  78324. }
  78325. declare module "babylonjs/XR/features/index" {
  78326. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  78327. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  78328. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  78329. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  78330. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  78331. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  78332. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  78333. export * from "babylonjs/XR/features/WebXRHitTest";
  78334. }
  78335. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  78336. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78337. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78338. import { Scene } from "babylonjs/scene";
  78339. /**
  78340. * The motion controller class for all microsoft mixed reality controllers
  78341. */
  78342. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  78343. protected readonly _mapping: {
  78344. defaultButton: {
  78345. valueNodeName: string;
  78346. unpressedNodeName: string;
  78347. pressedNodeName: string;
  78348. };
  78349. defaultAxis: {
  78350. valueNodeName: string;
  78351. minNodeName: string;
  78352. maxNodeName: string;
  78353. };
  78354. buttons: {
  78355. "xr-standard-trigger": {
  78356. rootNodeName: string;
  78357. componentProperty: string;
  78358. states: string[];
  78359. };
  78360. "xr-standard-squeeze": {
  78361. rootNodeName: string;
  78362. componentProperty: string;
  78363. states: string[];
  78364. };
  78365. "xr-standard-touchpad": {
  78366. rootNodeName: string;
  78367. labelAnchorNodeName: string;
  78368. touchPointNodeName: string;
  78369. };
  78370. "xr-standard-thumbstick": {
  78371. rootNodeName: string;
  78372. componentProperty: string;
  78373. states: string[];
  78374. };
  78375. };
  78376. axes: {
  78377. "xr-standard-touchpad": {
  78378. "x-axis": {
  78379. rootNodeName: string;
  78380. };
  78381. "y-axis": {
  78382. rootNodeName: string;
  78383. };
  78384. };
  78385. "xr-standard-thumbstick": {
  78386. "x-axis": {
  78387. rootNodeName: string;
  78388. };
  78389. "y-axis": {
  78390. rootNodeName: string;
  78391. };
  78392. };
  78393. };
  78394. };
  78395. /**
  78396. * The base url used to load the left and right controller models
  78397. */
  78398. static MODEL_BASE_URL: string;
  78399. /**
  78400. * The name of the left controller model file
  78401. */
  78402. static MODEL_LEFT_FILENAME: string;
  78403. /**
  78404. * The name of the right controller model file
  78405. */
  78406. static MODEL_RIGHT_FILENAME: string;
  78407. profileId: string;
  78408. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  78409. protected _getFilenameAndPath(): {
  78410. filename: string;
  78411. path: string;
  78412. };
  78413. protected _getModelLoadingConstraints(): boolean;
  78414. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78415. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78416. protected _updateModel(): void;
  78417. }
  78418. }
  78419. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  78420. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78422. import { Scene } from "babylonjs/scene";
  78423. /**
  78424. * The motion controller class for oculus touch (quest, rift).
  78425. * This class supports legacy mapping as well the standard xr mapping
  78426. */
  78427. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  78428. private _forceLegacyControllers;
  78429. private _modelRootNode;
  78430. /**
  78431. * The base url used to load the left and right controller models
  78432. */
  78433. static MODEL_BASE_URL: string;
  78434. /**
  78435. * The name of the left controller model file
  78436. */
  78437. static MODEL_LEFT_FILENAME: string;
  78438. /**
  78439. * The name of the right controller model file
  78440. */
  78441. static MODEL_RIGHT_FILENAME: string;
  78442. /**
  78443. * Base Url for the Quest controller model.
  78444. */
  78445. static QUEST_MODEL_BASE_URL: string;
  78446. profileId: string;
  78447. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  78448. protected _getFilenameAndPath(): {
  78449. filename: string;
  78450. path: string;
  78451. };
  78452. protected _getModelLoadingConstraints(): boolean;
  78453. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78454. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78455. protected _updateModel(): void;
  78456. /**
  78457. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  78458. * between the touch and touch 2.
  78459. */
  78460. private _isQuest;
  78461. }
  78462. }
  78463. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  78464. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78465. import { Scene } from "babylonjs/scene";
  78466. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78467. /**
  78468. * The motion controller class for the standard HTC-Vive controllers
  78469. */
  78470. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  78471. private _modelRootNode;
  78472. /**
  78473. * The base url used to load the left and right controller models
  78474. */
  78475. static MODEL_BASE_URL: string;
  78476. /**
  78477. * File name for the controller model.
  78478. */
  78479. static MODEL_FILENAME: string;
  78480. profileId: string;
  78481. /**
  78482. * Create a new Vive motion controller object
  78483. * @param scene the scene to use to create this controller
  78484. * @param gamepadObject the corresponding gamepad object
  78485. * @param handedness the handedness of the controller
  78486. */
  78487. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  78488. protected _getFilenameAndPath(): {
  78489. filename: string;
  78490. path: string;
  78491. };
  78492. protected _getModelLoadingConstraints(): boolean;
  78493. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78494. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78495. protected _updateModel(): void;
  78496. }
  78497. }
  78498. declare module "babylonjs/XR/motionController/index" {
  78499. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78500. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  78501. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  78502. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  78503. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  78504. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  78505. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  78506. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  78507. }
  78508. declare module "babylonjs/XR/index" {
  78509. export * from "babylonjs/XR/webXRCamera";
  78510. export * from "babylonjs/XR/webXREnterExitUI";
  78511. export * from "babylonjs/XR/webXRExperienceHelper";
  78512. export * from "babylonjs/XR/webXRInput";
  78513. export * from "babylonjs/XR/webXRInputSource";
  78514. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  78515. export * from "babylonjs/XR/webXRTypes";
  78516. export * from "babylonjs/XR/webXRSessionManager";
  78517. export * from "babylonjs/XR/webXRDefaultExperience";
  78518. export * from "babylonjs/XR/webXRFeaturesManager";
  78519. export * from "babylonjs/XR/features/index";
  78520. export * from "babylonjs/XR/motionController/index";
  78521. }
  78522. declare module "babylonjs/index" {
  78523. export * from "babylonjs/abstractScene";
  78524. export * from "babylonjs/Actions/index";
  78525. export * from "babylonjs/Animations/index";
  78526. export * from "babylonjs/assetContainer";
  78527. export * from "babylonjs/Audio/index";
  78528. export * from "babylonjs/Behaviors/index";
  78529. export * from "babylonjs/Bones/index";
  78530. export * from "babylonjs/Cameras/index";
  78531. export * from "babylonjs/Collisions/index";
  78532. export * from "babylonjs/Culling/index";
  78533. export * from "babylonjs/Debug/index";
  78534. export * from "babylonjs/DeviceInput/index";
  78535. export * from "babylonjs/Engines/index";
  78536. export * from "babylonjs/Events/index";
  78537. export * from "babylonjs/Gamepads/index";
  78538. export * from "babylonjs/Gizmos/index";
  78539. export * from "babylonjs/Helpers/index";
  78540. export * from "babylonjs/Instrumentation/index";
  78541. export * from "babylonjs/Layers/index";
  78542. export * from "babylonjs/LensFlares/index";
  78543. export * from "babylonjs/Lights/index";
  78544. export * from "babylonjs/Loading/index";
  78545. export * from "babylonjs/Materials/index";
  78546. export * from "babylonjs/Maths/index";
  78547. export * from "babylonjs/Meshes/index";
  78548. export * from "babylonjs/Morph/index";
  78549. export * from "babylonjs/Navigation/index";
  78550. export * from "babylonjs/node";
  78551. export * from "babylonjs/Offline/index";
  78552. export * from "babylonjs/Particles/index";
  78553. export * from "babylonjs/Physics/index";
  78554. export * from "babylonjs/PostProcesses/index";
  78555. export * from "babylonjs/Probes/index";
  78556. export * from "babylonjs/Rendering/index";
  78557. export * from "babylonjs/scene";
  78558. export * from "babylonjs/sceneComponent";
  78559. export * from "babylonjs/Sprites/index";
  78560. export * from "babylonjs/States/index";
  78561. export * from "babylonjs/Misc/index";
  78562. export * from "babylonjs/XR/index";
  78563. export * from "babylonjs/types";
  78564. }
  78565. declare module "babylonjs/Animations/pathCursor" {
  78566. import { Vector3 } from "babylonjs/Maths/math.vector";
  78567. import { Path2 } from "babylonjs/Maths/math.path";
  78568. /**
  78569. * A cursor which tracks a point on a path
  78570. */
  78571. export class PathCursor {
  78572. private path;
  78573. /**
  78574. * Stores path cursor callbacks for when an onchange event is triggered
  78575. */
  78576. private _onchange;
  78577. /**
  78578. * The value of the path cursor
  78579. */
  78580. value: number;
  78581. /**
  78582. * The animation array of the path cursor
  78583. */
  78584. animations: Animation[];
  78585. /**
  78586. * Initializes the path cursor
  78587. * @param path The path to track
  78588. */
  78589. constructor(path: Path2);
  78590. /**
  78591. * Gets the cursor point on the path
  78592. * @returns A point on the path cursor at the cursor location
  78593. */
  78594. getPoint(): Vector3;
  78595. /**
  78596. * Moves the cursor ahead by the step amount
  78597. * @param step The amount to move the cursor forward
  78598. * @returns This path cursor
  78599. */
  78600. moveAhead(step?: number): PathCursor;
  78601. /**
  78602. * Moves the cursor behind by the step amount
  78603. * @param step The amount to move the cursor back
  78604. * @returns This path cursor
  78605. */
  78606. moveBack(step?: number): PathCursor;
  78607. /**
  78608. * Moves the cursor by the step amount
  78609. * If the step amount is greater than one, an exception is thrown
  78610. * @param step The amount to move the cursor
  78611. * @returns This path cursor
  78612. */
  78613. move(step: number): PathCursor;
  78614. /**
  78615. * Ensures that the value is limited between zero and one
  78616. * @returns This path cursor
  78617. */
  78618. private ensureLimits;
  78619. /**
  78620. * Runs onchange callbacks on change (used by the animation engine)
  78621. * @returns This path cursor
  78622. */
  78623. private raiseOnChange;
  78624. /**
  78625. * Executes a function on change
  78626. * @param f A path cursor onchange callback
  78627. * @returns This path cursor
  78628. */
  78629. onchange(f: (cursor: PathCursor) => void): PathCursor;
  78630. }
  78631. }
  78632. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  78633. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  78634. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  78635. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  78636. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  78637. }
  78638. declare module "babylonjs/Engines/Processors/Expressions/index" {
  78639. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  78640. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  78641. }
  78642. declare module "babylonjs/Engines/Processors/index" {
  78643. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  78644. export * from "babylonjs/Engines/Processors/Expressions/index";
  78645. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  78646. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  78647. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  78648. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  78649. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  78650. export * from "babylonjs/Engines/Processors/shaderProcessor";
  78651. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  78652. }
  78653. declare module "babylonjs/Legacy/legacy" {
  78654. import * as Babylon from "babylonjs/index";
  78655. export * from "babylonjs/index";
  78656. }
  78657. declare module "babylonjs/Shaders/blur.fragment" {
  78658. /** @hidden */
  78659. export var blurPixelShader: {
  78660. name: string;
  78661. shader: string;
  78662. };
  78663. }
  78664. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  78665. /** @hidden */
  78666. export var pointCloudVertexDeclaration: {
  78667. name: string;
  78668. shader: string;
  78669. };
  78670. }
  78671. declare module "babylonjs" {
  78672. export * from "babylonjs/Legacy/legacy";
  78673. }
  78674. declare module BABYLON {
  78675. /** Alias type for value that can be null */
  78676. export type Nullable<T> = T | null;
  78677. /**
  78678. * Alias type for number that are floats
  78679. * @ignorenaming
  78680. */
  78681. export type float = number;
  78682. /**
  78683. * Alias type for number that are doubles.
  78684. * @ignorenaming
  78685. */
  78686. export type double = number;
  78687. /**
  78688. * Alias type for number that are integer
  78689. * @ignorenaming
  78690. */
  78691. export type int = number;
  78692. /** Alias type for number array or Float32Array */
  78693. export type FloatArray = number[] | Float32Array;
  78694. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  78695. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  78696. /**
  78697. * Alias for types that can be used by a Buffer or VertexBuffer.
  78698. */
  78699. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  78700. /**
  78701. * Alias type for primitive types
  78702. * @ignorenaming
  78703. */
  78704. type Primitive = undefined | null | boolean | string | number | Function;
  78705. /**
  78706. * Type modifier to make all the properties of an object Readonly
  78707. */
  78708. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  78709. /**
  78710. * Type modifier to make all the properties of an object Readonly recursively
  78711. */
  78712. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  78713. /**
  78714. * Type modifier to make object properties readonly.
  78715. */
  78716. export type DeepImmutableObject<T> = {
  78717. readonly [K in keyof T]: DeepImmutable<T[K]>;
  78718. };
  78719. /** @hidden */
  78720. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  78721. }
  78722. }
  78723. declare module BABYLON {
  78724. /**
  78725. * A class serves as a medium between the observable and its observers
  78726. */
  78727. export class EventState {
  78728. /**
  78729. * Create a new EventState
  78730. * @param mask defines the mask associated with this state
  78731. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  78732. * @param target defines the original target of the state
  78733. * @param currentTarget defines the current target of the state
  78734. */
  78735. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  78736. /**
  78737. * Initialize the current event state
  78738. * @param mask defines the mask associated with this state
  78739. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  78740. * @param target defines the original target of the state
  78741. * @param currentTarget defines the current target of the state
  78742. * @returns the current event state
  78743. */
  78744. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  78745. /**
  78746. * An Observer can set this property to true to prevent subsequent observers of being notified
  78747. */
  78748. skipNextObservers: boolean;
  78749. /**
  78750. * Get the mask value that were used to trigger the event corresponding to this EventState object
  78751. */
  78752. mask: number;
  78753. /**
  78754. * The object that originally notified the event
  78755. */
  78756. target?: any;
  78757. /**
  78758. * The current object in the bubbling phase
  78759. */
  78760. currentTarget?: any;
  78761. /**
  78762. * This will be populated with the return value of the last function that was executed.
  78763. * If it is the first function in the callback chain it will be the event data.
  78764. */
  78765. lastReturnValue?: any;
  78766. }
  78767. /**
  78768. * Represent an Observer registered to a given Observable object.
  78769. */
  78770. export class Observer<T> {
  78771. /**
  78772. * Defines the callback to call when the observer is notified
  78773. */
  78774. callback: (eventData: T, eventState: EventState) => void;
  78775. /**
  78776. * Defines the mask of the observer (used to filter notifications)
  78777. */
  78778. mask: number;
  78779. /**
  78780. * Defines the current scope used to restore the JS context
  78781. */
  78782. scope: any;
  78783. /** @hidden */
  78784. _willBeUnregistered: boolean;
  78785. /**
  78786. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  78787. */
  78788. unregisterOnNextCall: boolean;
  78789. /**
  78790. * Creates a new observer
  78791. * @param callback defines the callback to call when the observer is notified
  78792. * @param mask defines the mask of the observer (used to filter notifications)
  78793. * @param scope defines the current scope used to restore the JS context
  78794. */
  78795. constructor(
  78796. /**
  78797. * Defines the callback to call when the observer is notified
  78798. */
  78799. callback: (eventData: T, eventState: EventState) => void,
  78800. /**
  78801. * Defines the mask of the observer (used to filter notifications)
  78802. */
  78803. mask: number,
  78804. /**
  78805. * Defines the current scope used to restore the JS context
  78806. */
  78807. scope?: any);
  78808. }
  78809. /**
  78810. * Represent a list of observers registered to multiple Observables object.
  78811. */
  78812. export class MultiObserver<T> {
  78813. private _observers;
  78814. private _observables;
  78815. /**
  78816. * Release associated resources
  78817. */
  78818. dispose(): void;
  78819. /**
  78820. * Raise a callback when one of the observable will notify
  78821. * @param observables defines a list of observables to watch
  78822. * @param callback defines the callback to call on notification
  78823. * @param mask defines the mask used to filter notifications
  78824. * @param scope defines the current scope used to restore the JS context
  78825. * @returns the new MultiObserver
  78826. */
  78827. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  78828. }
  78829. /**
  78830. * The Observable class is a simple implementation of the Observable pattern.
  78831. *
  78832. * 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.
  78833. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  78834. * 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).
  78835. * 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.
  78836. */
  78837. export class Observable<T> {
  78838. private _observers;
  78839. private _eventState;
  78840. private _onObserverAdded;
  78841. /**
  78842. * Gets the list of observers
  78843. */
  78844. get observers(): Array<Observer<T>>;
  78845. /**
  78846. * Creates a new observable
  78847. * @param onObserverAdded defines a callback to call when a new observer is added
  78848. */
  78849. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  78850. /**
  78851. * Create a new Observer with the specified callback
  78852. * @param callback the callback that will be executed for that Observer
  78853. * @param mask the mask used to filter observers
  78854. * @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.
  78855. * @param scope optional scope for the callback to be called from
  78856. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  78857. * @returns the new observer created for the callback
  78858. */
  78859. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  78860. /**
  78861. * Create a new Observer with the specified callback and unregisters after the next notification
  78862. * @param callback the callback that will be executed for that Observer
  78863. * @returns the new observer created for the callback
  78864. */
  78865. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  78866. /**
  78867. * Remove an Observer from the Observable object
  78868. * @param observer the instance of the Observer to remove
  78869. * @returns false if it doesn't belong to this Observable
  78870. */
  78871. remove(observer: Nullable<Observer<T>>): boolean;
  78872. /**
  78873. * Remove a callback from the Observable object
  78874. * @param callback the callback to remove
  78875. * @param scope optional scope. If used only the callbacks with this scope will be removed
  78876. * @returns false if it doesn't belong to this Observable
  78877. */
  78878. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  78879. private _deferUnregister;
  78880. private _remove;
  78881. /**
  78882. * Moves the observable to the top of the observer list making it get called first when notified
  78883. * @param observer the observer to move
  78884. */
  78885. makeObserverTopPriority(observer: Observer<T>): void;
  78886. /**
  78887. * Moves the observable to the bottom of the observer list making it get called last when notified
  78888. * @param observer the observer to move
  78889. */
  78890. makeObserverBottomPriority(observer: Observer<T>): void;
  78891. /**
  78892. * Notify all Observers by calling their respective callback with the given data
  78893. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  78894. * @param eventData defines the data to send to all observers
  78895. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  78896. * @param target defines the original target of the state
  78897. * @param currentTarget defines the current target of the state
  78898. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  78899. */
  78900. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  78901. /**
  78902. * Calling this will execute each callback, expecting it to be a promise or return a value.
  78903. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  78904. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  78905. * and it is crucial that all callbacks will be executed.
  78906. * The order of the callbacks is kept, callbacks are not executed parallel.
  78907. *
  78908. * @param eventData The data to be sent to each callback
  78909. * @param mask is used to filter observers defaults to -1
  78910. * @param target defines the callback target (see EventState)
  78911. * @param currentTarget defines he current object in the bubbling phase
  78912. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  78913. */
  78914. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  78915. /**
  78916. * Notify a specific observer
  78917. * @param observer defines the observer to notify
  78918. * @param eventData defines the data to be sent to each callback
  78919. * @param mask is used to filter observers defaults to -1
  78920. */
  78921. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  78922. /**
  78923. * Gets a boolean indicating if the observable has at least one observer
  78924. * @returns true is the Observable has at least one Observer registered
  78925. */
  78926. hasObservers(): boolean;
  78927. /**
  78928. * Clear the list of observers
  78929. */
  78930. clear(): void;
  78931. /**
  78932. * Clone the current observable
  78933. * @returns a new observable
  78934. */
  78935. clone(): Observable<T>;
  78936. /**
  78937. * Does this observable handles observer registered with a given mask
  78938. * @param mask defines the mask to be tested
  78939. * @return whether or not one observer registered with the given mask is handeled
  78940. **/
  78941. hasSpecificMask(mask?: number): boolean;
  78942. }
  78943. }
  78944. declare module BABYLON {
  78945. /**
  78946. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  78947. * Babylon.js
  78948. */
  78949. export class DomManagement {
  78950. /**
  78951. * Checks if the window object exists
  78952. * @returns true if the window object exists
  78953. */
  78954. static IsWindowObjectExist(): boolean;
  78955. /**
  78956. * Checks if the navigator object exists
  78957. * @returns true if the navigator object exists
  78958. */
  78959. static IsNavigatorAvailable(): boolean;
  78960. /**
  78961. * Check if the document object exists
  78962. * @returns true if the document object exists
  78963. */
  78964. static IsDocumentAvailable(): boolean;
  78965. /**
  78966. * Extracts text content from a DOM element hierarchy
  78967. * @param element defines the root element
  78968. * @returns a string
  78969. */
  78970. static GetDOMTextContent(element: HTMLElement): string;
  78971. }
  78972. }
  78973. declare module BABYLON {
  78974. /**
  78975. * Logger used througouht the application to allow configuration of
  78976. * the log level required for the messages.
  78977. */
  78978. export class Logger {
  78979. /**
  78980. * No log
  78981. */
  78982. static readonly NoneLogLevel: number;
  78983. /**
  78984. * Only message logs
  78985. */
  78986. static readonly MessageLogLevel: number;
  78987. /**
  78988. * Only warning logs
  78989. */
  78990. static readonly WarningLogLevel: number;
  78991. /**
  78992. * Only error logs
  78993. */
  78994. static readonly ErrorLogLevel: number;
  78995. /**
  78996. * All logs
  78997. */
  78998. static readonly AllLogLevel: number;
  78999. private static _LogCache;
  79000. /**
  79001. * Gets a value indicating the number of loading errors
  79002. * @ignorenaming
  79003. */
  79004. static errorsCount: number;
  79005. /**
  79006. * Callback called when a new log is added
  79007. */
  79008. static OnNewCacheEntry: (entry: string) => void;
  79009. private static _AddLogEntry;
  79010. private static _FormatMessage;
  79011. private static _LogDisabled;
  79012. private static _LogEnabled;
  79013. private static _WarnDisabled;
  79014. private static _WarnEnabled;
  79015. private static _ErrorDisabled;
  79016. private static _ErrorEnabled;
  79017. /**
  79018. * Log a message to the console
  79019. */
  79020. static Log: (message: string) => void;
  79021. /**
  79022. * Write a warning message to the console
  79023. */
  79024. static Warn: (message: string) => void;
  79025. /**
  79026. * Write an error message to the console
  79027. */
  79028. static Error: (message: string) => void;
  79029. /**
  79030. * Gets current log cache (list of logs)
  79031. */
  79032. static get LogCache(): string;
  79033. /**
  79034. * Clears the log cache
  79035. */
  79036. static ClearLogCache(): void;
  79037. /**
  79038. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  79039. */
  79040. static set LogLevels(level: number);
  79041. }
  79042. }
  79043. declare module BABYLON {
  79044. /** @hidden */
  79045. export class _TypeStore {
  79046. /** @hidden */
  79047. static RegisteredTypes: {
  79048. [key: string]: Object;
  79049. };
  79050. /** @hidden */
  79051. static GetClass(fqdn: string): any;
  79052. }
  79053. }
  79054. declare module BABYLON {
  79055. /**
  79056. * Helper to manipulate strings
  79057. */
  79058. export class StringTools {
  79059. /**
  79060. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  79061. * @param str Source string
  79062. * @param suffix Suffix to search for in the source string
  79063. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79064. */
  79065. static EndsWith(str: string, suffix: string): boolean;
  79066. /**
  79067. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  79068. * @param str Source string
  79069. * @param suffix Suffix to search for in the source string
  79070. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79071. */
  79072. static StartsWith(str: string, suffix: string): boolean;
  79073. /**
  79074. * Decodes a buffer into a string
  79075. * @param buffer The buffer to decode
  79076. * @returns The decoded string
  79077. */
  79078. static Decode(buffer: Uint8Array | Uint16Array): string;
  79079. /**
  79080. * Encode a buffer to a base64 string
  79081. * @param buffer defines the buffer to encode
  79082. * @returns the encoded string
  79083. */
  79084. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  79085. /**
  79086. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  79087. * @param num the number to convert and pad
  79088. * @param length the expected length of the string
  79089. * @returns the padded string
  79090. */
  79091. static PadNumber(num: number, length: number): string;
  79092. }
  79093. }
  79094. declare module BABYLON {
  79095. /**
  79096. * Class containing a set of static utilities functions for deep copy.
  79097. */
  79098. export class DeepCopier {
  79099. /**
  79100. * Tries to copy an object by duplicating every property
  79101. * @param source defines the source object
  79102. * @param destination defines the target object
  79103. * @param doNotCopyList defines a list of properties to avoid
  79104. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  79105. */
  79106. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  79107. }
  79108. }
  79109. declare module BABYLON {
  79110. /**
  79111. * Class containing a set of static utilities functions for precision date
  79112. */
  79113. export class PrecisionDate {
  79114. /**
  79115. * Gets either window.performance.now() if supported or Date.now() else
  79116. */
  79117. static get Now(): number;
  79118. }
  79119. }
  79120. declare module BABYLON {
  79121. /** @hidden */
  79122. export class _DevTools {
  79123. static WarnImport(name: string): string;
  79124. }
  79125. }
  79126. declare module BABYLON {
  79127. /**
  79128. * Interface used to define the mechanism to get data from the network
  79129. */
  79130. export interface IWebRequest {
  79131. /**
  79132. * Returns client's response url
  79133. */
  79134. responseURL: string;
  79135. /**
  79136. * Returns client's status
  79137. */
  79138. status: number;
  79139. /**
  79140. * Returns client's status as a text
  79141. */
  79142. statusText: string;
  79143. }
  79144. }
  79145. declare module BABYLON {
  79146. /**
  79147. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  79148. */
  79149. export class WebRequest implements IWebRequest {
  79150. private _xhr;
  79151. /**
  79152. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  79153. * i.e. when loading files, where the server/service expects an Authorization header
  79154. */
  79155. static CustomRequestHeaders: {
  79156. [key: string]: string;
  79157. };
  79158. /**
  79159. * Add callback functions in this array to update all the requests before they get sent to the network
  79160. */
  79161. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  79162. private _injectCustomRequestHeaders;
  79163. /**
  79164. * Gets or sets a function to be called when loading progress changes
  79165. */
  79166. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  79167. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  79168. /**
  79169. * Returns client's state
  79170. */
  79171. get readyState(): number;
  79172. /**
  79173. * Returns client's status
  79174. */
  79175. get status(): number;
  79176. /**
  79177. * Returns client's status as a text
  79178. */
  79179. get statusText(): string;
  79180. /**
  79181. * Returns client's response
  79182. */
  79183. get response(): any;
  79184. /**
  79185. * Returns client's response url
  79186. */
  79187. get responseURL(): string;
  79188. /**
  79189. * Returns client's response as text
  79190. */
  79191. get responseText(): string;
  79192. /**
  79193. * Gets or sets the expected response type
  79194. */
  79195. get responseType(): XMLHttpRequestResponseType;
  79196. set responseType(value: XMLHttpRequestResponseType);
  79197. /** @hidden */
  79198. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  79199. /** @hidden */
  79200. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  79201. /**
  79202. * Cancels any network activity
  79203. */
  79204. abort(): void;
  79205. /**
  79206. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  79207. * @param body defines an optional request body
  79208. */
  79209. send(body?: Document | BodyInit | null): void;
  79210. /**
  79211. * Sets the request method, request URL
  79212. * @param method defines the method to use (GET, POST, etc..)
  79213. * @param url defines the url to connect with
  79214. */
  79215. open(method: string, url: string): void;
  79216. /**
  79217. * Sets the value of a request header.
  79218. * @param name The name of the header whose value is to be set
  79219. * @param value The value to set as the body of the header
  79220. */
  79221. setRequestHeader(name: string, value: string): void;
  79222. /**
  79223. * Get the string containing the text of a particular header's value.
  79224. * @param name The name of the header
  79225. * @returns The string containing the text of the given header name
  79226. */
  79227. getResponseHeader(name: string): Nullable<string>;
  79228. }
  79229. }
  79230. declare module BABYLON {
  79231. /**
  79232. * File request interface
  79233. */
  79234. export interface IFileRequest {
  79235. /**
  79236. * Raised when the request is complete (success or error).
  79237. */
  79238. onCompleteObservable: Observable<IFileRequest>;
  79239. /**
  79240. * Aborts the request for a file.
  79241. */
  79242. abort: () => void;
  79243. }
  79244. }
  79245. declare module BABYLON {
  79246. /**
  79247. * Define options used to create a render target texture
  79248. */
  79249. export class RenderTargetCreationOptions {
  79250. /**
  79251. * Specifies is mipmaps must be generated
  79252. */
  79253. generateMipMaps?: boolean;
  79254. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  79255. generateDepthBuffer?: boolean;
  79256. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  79257. generateStencilBuffer?: boolean;
  79258. /** Defines texture type (int by default) */
  79259. type?: number;
  79260. /** Defines sampling mode (trilinear by default) */
  79261. samplingMode?: number;
  79262. /** Defines format (RGBA by default) */
  79263. format?: number;
  79264. }
  79265. }
  79266. declare module BABYLON {
  79267. /** Defines the cross module used constants to avoid circular dependncies */
  79268. export class Constants {
  79269. /** Defines that alpha blending is disabled */
  79270. static readonly ALPHA_DISABLE: number;
  79271. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  79272. static readonly ALPHA_ADD: number;
  79273. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  79274. static readonly ALPHA_COMBINE: number;
  79275. /** Defines that alpha blending is DEST - SRC * DEST */
  79276. static readonly ALPHA_SUBTRACT: number;
  79277. /** Defines that alpha blending is SRC * DEST */
  79278. static readonly ALPHA_MULTIPLY: number;
  79279. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  79280. static readonly ALPHA_MAXIMIZED: number;
  79281. /** Defines that alpha blending is SRC + DEST */
  79282. static readonly ALPHA_ONEONE: number;
  79283. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  79284. static readonly ALPHA_PREMULTIPLIED: number;
  79285. /**
  79286. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  79287. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  79288. */
  79289. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  79290. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  79291. static readonly ALPHA_INTERPOLATE: number;
  79292. /**
  79293. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  79294. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  79295. */
  79296. static readonly ALPHA_SCREENMODE: number;
  79297. /**
  79298. * Defines that alpha blending is SRC + DST
  79299. * Alpha will be set to SRC ALPHA + DST ALPHA
  79300. */
  79301. static readonly ALPHA_ONEONE_ONEONE: number;
  79302. /**
  79303. * Defines that alpha blending is SRC * DST ALPHA + DST
  79304. * Alpha will be set to 0
  79305. */
  79306. static readonly ALPHA_ALPHATOCOLOR: number;
  79307. /**
  79308. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79309. */
  79310. static readonly ALPHA_REVERSEONEMINUS: number;
  79311. /**
  79312. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  79313. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  79314. */
  79315. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  79316. /**
  79317. * Defines that alpha blending is SRC + DST
  79318. * Alpha will be set to SRC ALPHA
  79319. */
  79320. static readonly ALPHA_ONEONE_ONEZERO: number;
  79321. /**
  79322. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79323. * Alpha will be set to DST ALPHA
  79324. */
  79325. static readonly ALPHA_EXCLUSION: number;
  79326. /** Defines that alpha blending equation a SUM */
  79327. static readonly ALPHA_EQUATION_ADD: number;
  79328. /** Defines that alpha blending equation a SUBSTRACTION */
  79329. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  79330. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  79331. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  79332. /** Defines that alpha blending equation a MAX operation */
  79333. static readonly ALPHA_EQUATION_MAX: number;
  79334. /** Defines that alpha blending equation a MIN operation */
  79335. static readonly ALPHA_EQUATION_MIN: number;
  79336. /**
  79337. * Defines that alpha blending equation a DARKEN operation:
  79338. * It takes the min of the src and sums the alpha channels.
  79339. */
  79340. static readonly ALPHA_EQUATION_DARKEN: number;
  79341. /** Defines that the ressource is not delayed*/
  79342. static readonly DELAYLOADSTATE_NONE: number;
  79343. /** Defines that the ressource was successfully delay loaded */
  79344. static readonly DELAYLOADSTATE_LOADED: number;
  79345. /** Defines that the ressource is currently delay loading */
  79346. static readonly DELAYLOADSTATE_LOADING: number;
  79347. /** Defines that the ressource is delayed and has not started loading */
  79348. static readonly DELAYLOADSTATE_NOTLOADED: number;
  79349. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  79350. static readonly NEVER: number;
  79351. /** 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 */
  79352. static readonly ALWAYS: number;
  79353. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  79354. static readonly LESS: number;
  79355. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  79356. static readonly EQUAL: number;
  79357. /** 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 */
  79358. static readonly LEQUAL: number;
  79359. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  79360. static readonly GREATER: number;
  79361. /** 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 */
  79362. static readonly GEQUAL: number;
  79363. /** 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 */
  79364. static readonly NOTEQUAL: number;
  79365. /** Passed to stencilOperation to specify that stencil value must be kept */
  79366. static readonly KEEP: number;
  79367. /** Passed to stencilOperation to specify that stencil value must be replaced */
  79368. static readonly REPLACE: number;
  79369. /** Passed to stencilOperation to specify that stencil value must be incremented */
  79370. static readonly INCR: number;
  79371. /** Passed to stencilOperation to specify that stencil value must be decremented */
  79372. static readonly DECR: number;
  79373. /** Passed to stencilOperation to specify that stencil value must be inverted */
  79374. static readonly INVERT: number;
  79375. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  79376. static readonly INCR_WRAP: number;
  79377. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  79378. static readonly DECR_WRAP: number;
  79379. /** Texture is not repeating outside of 0..1 UVs */
  79380. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  79381. /** Texture is repeating outside of 0..1 UVs */
  79382. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  79383. /** Texture is repeating and mirrored */
  79384. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  79385. /** ALPHA */
  79386. static readonly TEXTUREFORMAT_ALPHA: number;
  79387. /** LUMINANCE */
  79388. static readonly TEXTUREFORMAT_LUMINANCE: number;
  79389. /** LUMINANCE_ALPHA */
  79390. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  79391. /** RGB */
  79392. static readonly TEXTUREFORMAT_RGB: number;
  79393. /** RGBA */
  79394. static readonly TEXTUREFORMAT_RGBA: number;
  79395. /** RED */
  79396. static readonly TEXTUREFORMAT_RED: number;
  79397. /** RED (2nd reference) */
  79398. static readonly TEXTUREFORMAT_R: number;
  79399. /** RG */
  79400. static readonly TEXTUREFORMAT_RG: number;
  79401. /** RED_INTEGER */
  79402. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  79403. /** RED_INTEGER (2nd reference) */
  79404. static readonly TEXTUREFORMAT_R_INTEGER: number;
  79405. /** RG_INTEGER */
  79406. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  79407. /** RGB_INTEGER */
  79408. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  79409. /** RGBA_INTEGER */
  79410. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  79411. /** UNSIGNED_BYTE */
  79412. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  79413. /** UNSIGNED_BYTE (2nd reference) */
  79414. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  79415. /** FLOAT */
  79416. static readonly TEXTURETYPE_FLOAT: number;
  79417. /** HALF_FLOAT */
  79418. static readonly TEXTURETYPE_HALF_FLOAT: number;
  79419. /** BYTE */
  79420. static readonly TEXTURETYPE_BYTE: number;
  79421. /** SHORT */
  79422. static readonly TEXTURETYPE_SHORT: number;
  79423. /** UNSIGNED_SHORT */
  79424. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  79425. /** INT */
  79426. static readonly TEXTURETYPE_INT: number;
  79427. /** UNSIGNED_INT */
  79428. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  79429. /** UNSIGNED_SHORT_4_4_4_4 */
  79430. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  79431. /** UNSIGNED_SHORT_5_5_5_1 */
  79432. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  79433. /** UNSIGNED_SHORT_5_6_5 */
  79434. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  79435. /** UNSIGNED_INT_2_10_10_10_REV */
  79436. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  79437. /** UNSIGNED_INT_24_8 */
  79438. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  79439. /** UNSIGNED_INT_10F_11F_11F_REV */
  79440. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  79441. /** UNSIGNED_INT_5_9_9_9_REV */
  79442. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  79443. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  79444. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  79445. /** nearest is mag = nearest and min = nearest and no mip */
  79446. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  79447. /** mag = nearest and min = nearest and mip = none */
  79448. static readonly TEXTURE_NEAREST_NEAREST: number;
  79449. /** Bilinear is mag = linear and min = linear and no mip */
  79450. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  79451. /** mag = linear and min = linear and mip = none */
  79452. static readonly TEXTURE_LINEAR_LINEAR: number;
  79453. /** Trilinear is mag = linear and min = linear and mip = linear */
  79454. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  79455. /** Trilinear is mag = linear and min = linear and mip = linear */
  79456. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  79457. /** mag = nearest and min = nearest and mip = nearest */
  79458. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  79459. /** mag = nearest and min = linear and mip = nearest */
  79460. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  79461. /** mag = nearest and min = linear and mip = linear */
  79462. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  79463. /** mag = nearest and min = linear and mip = none */
  79464. static readonly TEXTURE_NEAREST_LINEAR: number;
  79465. /** nearest is mag = nearest and min = nearest and mip = linear */
  79466. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  79467. /** mag = linear and min = nearest and mip = nearest */
  79468. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  79469. /** mag = linear and min = nearest and mip = linear */
  79470. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  79471. /** Bilinear is mag = linear and min = linear and mip = nearest */
  79472. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  79473. /** mag = linear and min = nearest and mip = none */
  79474. static readonly TEXTURE_LINEAR_NEAREST: number;
  79475. /** Explicit coordinates mode */
  79476. static readonly TEXTURE_EXPLICIT_MODE: number;
  79477. /** Spherical coordinates mode */
  79478. static readonly TEXTURE_SPHERICAL_MODE: number;
  79479. /** Planar coordinates mode */
  79480. static readonly TEXTURE_PLANAR_MODE: number;
  79481. /** Cubic coordinates mode */
  79482. static readonly TEXTURE_CUBIC_MODE: number;
  79483. /** Projection coordinates mode */
  79484. static readonly TEXTURE_PROJECTION_MODE: number;
  79485. /** Skybox coordinates mode */
  79486. static readonly TEXTURE_SKYBOX_MODE: number;
  79487. /** Inverse Cubic coordinates mode */
  79488. static readonly TEXTURE_INVCUBIC_MODE: number;
  79489. /** Equirectangular coordinates mode */
  79490. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  79491. /** Equirectangular Fixed coordinates mode */
  79492. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  79493. /** Equirectangular Fixed Mirrored coordinates mode */
  79494. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  79495. /** Offline (baking) quality for texture filtering */
  79496. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  79497. /** High quality for texture filtering */
  79498. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  79499. /** Medium quality for texture filtering */
  79500. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  79501. /** Low quality for texture filtering */
  79502. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  79503. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  79504. static readonly SCALEMODE_FLOOR: number;
  79505. /** Defines that texture rescaling will look for the nearest power of 2 size */
  79506. static readonly SCALEMODE_NEAREST: number;
  79507. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  79508. static readonly SCALEMODE_CEILING: number;
  79509. /**
  79510. * The dirty texture flag value
  79511. */
  79512. static readonly MATERIAL_TextureDirtyFlag: number;
  79513. /**
  79514. * The dirty light flag value
  79515. */
  79516. static readonly MATERIAL_LightDirtyFlag: number;
  79517. /**
  79518. * The dirty fresnel flag value
  79519. */
  79520. static readonly MATERIAL_FresnelDirtyFlag: number;
  79521. /**
  79522. * The dirty attribute flag value
  79523. */
  79524. static readonly MATERIAL_AttributesDirtyFlag: number;
  79525. /**
  79526. * The dirty misc flag value
  79527. */
  79528. static readonly MATERIAL_MiscDirtyFlag: number;
  79529. /**
  79530. * The all dirty flag value
  79531. */
  79532. static readonly MATERIAL_AllDirtyFlag: number;
  79533. /**
  79534. * Returns the triangle fill mode
  79535. */
  79536. static readonly MATERIAL_TriangleFillMode: number;
  79537. /**
  79538. * Returns the wireframe mode
  79539. */
  79540. static readonly MATERIAL_WireFrameFillMode: number;
  79541. /**
  79542. * Returns the point fill mode
  79543. */
  79544. static readonly MATERIAL_PointFillMode: number;
  79545. /**
  79546. * Returns the point list draw mode
  79547. */
  79548. static readonly MATERIAL_PointListDrawMode: number;
  79549. /**
  79550. * Returns the line list draw mode
  79551. */
  79552. static readonly MATERIAL_LineListDrawMode: number;
  79553. /**
  79554. * Returns the line loop draw mode
  79555. */
  79556. static readonly MATERIAL_LineLoopDrawMode: number;
  79557. /**
  79558. * Returns the line strip draw mode
  79559. */
  79560. static readonly MATERIAL_LineStripDrawMode: number;
  79561. /**
  79562. * Returns the triangle strip draw mode
  79563. */
  79564. static readonly MATERIAL_TriangleStripDrawMode: number;
  79565. /**
  79566. * Returns the triangle fan draw mode
  79567. */
  79568. static readonly MATERIAL_TriangleFanDrawMode: number;
  79569. /**
  79570. * Stores the clock-wise side orientation
  79571. */
  79572. static readonly MATERIAL_ClockWiseSideOrientation: number;
  79573. /**
  79574. * Stores the counter clock-wise side orientation
  79575. */
  79576. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  79577. /**
  79578. * Nothing
  79579. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79580. */
  79581. static readonly ACTION_NothingTrigger: number;
  79582. /**
  79583. * On pick
  79584. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79585. */
  79586. static readonly ACTION_OnPickTrigger: number;
  79587. /**
  79588. * On left pick
  79589. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79590. */
  79591. static readonly ACTION_OnLeftPickTrigger: number;
  79592. /**
  79593. * On right pick
  79594. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79595. */
  79596. static readonly ACTION_OnRightPickTrigger: number;
  79597. /**
  79598. * On center pick
  79599. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79600. */
  79601. static readonly ACTION_OnCenterPickTrigger: number;
  79602. /**
  79603. * On pick down
  79604. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79605. */
  79606. static readonly ACTION_OnPickDownTrigger: number;
  79607. /**
  79608. * On double pick
  79609. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79610. */
  79611. static readonly ACTION_OnDoublePickTrigger: number;
  79612. /**
  79613. * On pick up
  79614. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79615. */
  79616. static readonly ACTION_OnPickUpTrigger: number;
  79617. /**
  79618. * On pick out.
  79619. * This trigger will only be raised if you also declared a OnPickDown
  79620. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79621. */
  79622. static readonly ACTION_OnPickOutTrigger: number;
  79623. /**
  79624. * On long press
  79625. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79626. */
  79627. static readonly ACTION_OnLongPressTrigger: number;
  79628. /**
  79629. * On pointer over
  79630. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79631. */
  79632. static readonly ACTION_OnPointerOverTrigger: number;
  79633. /**
  79634. * On pointer out
  79635. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79636. */
  79637. static readonly ACTION_OnPointerOutTrigger: number;
  79638. /**
  79639. * On every frame
  79640. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79641. */
  79642. static readonly ACTION_OnEveryFrameTrigger: number;
  79643. /**
  79644. * On intersection enter
  79645. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79646. */
  79647. static readonly ACTION_OnIntersectionEnterTrigger: number;
  79648. /**
  79649. * On intersection exit
  79650. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79651. */
  79652. static readonly ACTION_OnIntersectionExitTrigger: number;
  79653. /**
  79654. * On key down
  79655. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79656. */
  79657. static readonly ACTION_OnKeyDownTrigger: number;
  79658. /**
  79659. * On key up
  79660. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79661. */
  79662. static readonly ACTION_OnKeyUpTrigger: number;
  79663. /**
  79664. * Billboard mode will only apply to Y axis
  79665. */
  79666. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  79667. /**
  79668. * Billboard mode will apply to all axes
  79669. */
  79670. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  79671. /**
  79672. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  79673. */
  79674. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  79675. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  79676. * Test order :
  79677. * Is the bounding sphere outside the frustum ?
  79678. * If not, are the bounding box vertices outside the frustum ?
  79679. * It not, then the cullable object is in the frustum.
  79680. */
  79681. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  79682. /** Culling strategy : Bounding Sphere Only.
  79683. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  79684. * It's also less accurate than the standard because some not visible objects can still be selected.
  79685. * Test : is the bounding sphere outside the frustum ?
  79686. * If not, then the cullable object is in the frustum.
  79687. */
  79688. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  79689. /** Culling strategy : Optimistic Inclusion.
  79690. * This in an inclusion test first, then the standard exclusion test.
  79691. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  79692. * 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.
  79693. * Anyway, it's as accurate as the standard strategy.
  79694. * Test :
  79695. * Is the cullable object bounding sphere center in the frustum ?
  79696. * If not, apply the default culling strategy.
  79697. */
  79698. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  79699. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  79700. * This in an inclusion test first, then the bounding sphere only exclusion test.
  79701. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  79702. * 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.
  79703. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  79704. * Test :
  79705. * Is the cullable object bounding sphere center in the frustum ?
  79706. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  79707. */
  79708. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  79709. /**
  79710. * No logging while loading
  79711. */
  79712. static readonly SCENELOADER_NO_LOGGING: number;
  79713. /**
  79714. * Minimal logging while loading
  79715. */
  79716. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  79717. /**
  79718. * Summary logging while loading
  79719. */
  79720. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  79721. /**
  79722. * Detailled logging while loading
  79723. */
  79724. static readonly SCENELOADER_DETAILED_LOGGING: number;
  79725. /**
  79726. * Prepass texture index for color
  79727. */
  79728. static readonly PREPASS_COLOR_INDEX: number;
  79729. /**
  79730. * Prepass texture index for irradiance
  79731. */
  79732. static readonly PREPASS_IRRADIANCE_INDEX: number;
  79733. /**
  79734. * Prepass texture index for depth + normal
  79735. */
  79736. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  79737. /**
  79738. * Prepass texture index for albedo
  79739. */
  79740. static readonly PREPASS_ALBEDO_INDEX: number;
  79741. }
  79742. }
  79743. declare module BABYLON {
  79744. /**
  79745. * This represents the required contract to create a new type of texture loader.
  79746. */
  79747. export interface IInternalTextureLoader {
  79748. /**
  79749. * Defines wether the loader supports cascade loading the different faces.
  79750. */
  79751. supportCascades: boolean;
  79752. /**
  79753. * This returns if the loader support the current file information.
  79754. * @param extension defines the file extension of the file being loaded
  79755. * @param mimeType defines the optional mime type of the file being loaded
  79756. * @returns true if the loader can load the specified file
  79757. */
  79758. canLoad(extension: string, mimeType?: string): boolean;
  79759. /**
  79760. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  79761. * @param data contains the texture data
  79762. * @param texture defines the BabylonJS internal texture
  79763. * @param createPolynomials will be true if polynomials have been requested
  79764. * @param onLoad defines the callback to trigger once the texture is ready
  79765. * @param onError defines the callback to trigger in case of error
  79766. */
  79767. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  79768. /**
  79769. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  79770. * @param data contains the texture data
  79771. * @param texture defines the BabylonJS internal texture
  79772. * @param callback defines the method to call once ready to upload
  79773. */
  79774. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  79775. }
  79776. }
  79777. declare module BABYLON {
  79778. /**
  79779. * Class used to store and describe the pipeline context associated with an effect
  79780. */
  79781. export interface IPipelineContext {
  79782. /**
  79783. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  79784. */
  79785. isAsync: boolean;
  79786. /**
  79787. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  79788. */
  79789. isReady: boolean;
  79790. /** @hidden */
  79791. _getVertexShaderCode(): string | null;
  79792. /** @hidden */
  79793. _getFragmentShaderCode(): string | null;
  79794. /** @hidden */
  79795. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  79796. }
  79797. }
  79798. declare module BABYLON {
  79799. /**
  79800. * Class used to store gfx data (like WebGLBuffer)
  79801. */
  79802. export class DataBuffer {
  79803. /**
  79804. * Gets or sets the number of objects referencing this buffer
  79805. */
  79806. references: number;
  79807. /** Gets or sets the size of the underlying buffer */
  79808. capacity: number;
  79809. /**
  79810. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  79811. */
  79812. is32Bits: boolean;
  79813. /**
  79814. * Gets the underlying buffer
  79815. */
  79816. get underlyingResource(): any;
  79817. }
  79818. }
  79819. declare module BABYLON {
  79820. /** @hidden */
  79821. export interface IShaderProcessor {
  79822. attributeProcessor?: (attribute: string) => string;
  79823. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  79824. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  79825. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  79826. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  79827. lineProcessor?: (line: string, isFragment: boolean) => string;
  79828. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  79829. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  79830. }
  79831. }
  79832. declare module BABYLON {
  79833. /** @hidden */
  79834. export interface ProcessingOptions {
  79835. defines: string[];
  79836. indexParameters: any;
  79837. isFragment: boolean;
  79838. shouldUseHighPrecisionShader: boolean;
  79839. supportsUniformBuffers: boolean;
  79840. shadersRepository: string;
  79841. includesShadersStore: {
  79842. [key: string]: string;
  79843. };
  79844. processor?: IShaderProcessor;
  79845. version: string;
  79846. platformName: string;
  79847. lookForClosingBracketForUniformBuffer?: boolean;
  79848. }
  79849. }
  79850. declare module BABYLON {
  79851. /** @hidden */
  79852. export class ShaderCodeNode {
  79853. line: string;
  79854. children: ShaderCodeNode[];
  79855. additionalDefineKey?: string;
  79856. additionalDefineValue?: string;
  79857. isValid(preprocessors: {
  79858. [key: string]: string;
  79859. }): boolean;
  79860. process(preprocessors: {
  79861. [key: string]: string;
  79862. }, options: ProcessingOptions): string;
  79863. }
  79864. }
  79865. declare module BABYLON {
  79866. /** @hidden */
  79867. export class ShaderCodeCursor {
  79868. private _lines;
  79869. lineIndex: number;
  79870. get currentLine(): string;
  79871. get canRead(): boolean;
  79872. set lines(value: string[]);
  79873. }
  79874. }
  79875. declare module BABYLON {
  79876. /** @hidden */
  79877. export class ShaderCodeConditionNode extends ShaderCodeNode {
  79878. process(preprocessors: {
  79879. [key: string]: string;
  79880. }, options: ProcessingOptions): string;
  79881. }
  79882. }
  79883. declare module BABYLON {
  79884. /** @hidden */
  79885. export class ShaderDefineExpression {
  79886. isTrue(preprocessors: {
  79887. [key: string]: string;
  79888. }): boolean;
  79889. private static _OperatorPriority;
  79890. private static _Stack;
  79891. static postfixToInfix(postfix: string[]): string;
  79892. static infixToPostfix(infix: string): string[];
  79893. }
  79894. }
  79895. declare module BABYLON {
  79896. /** @hidden */
  79897. export class ShaderCodeTestNode extends ShaderCodeNode {
  79898. testExpression: ShaderDefineExpression;
  79899. isValid(preprocessors: {
  79900. [key: string]: string;
  79901. }): boolean;
  79902. }
  79903. }
  79904. declare module BABYLON {
  79905. /** @hidden */
  79906. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  79907. define: string;
  79908. not: boolean;
  79909. constructor(define: string, not?: boolean);
  79910. isTrue(preprocessors: {
  79911. [key: string]: string;
  79912. }): boolean;
  79913. }
  79914. }
  79915. declare module BABYLON {
  79916. /** @hidden */
  79917. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  79918. leftOperand: ShaderDefineExpression;
  79919. rightOperand: ShaderDefineExpression;
  79920. isTrue(preprocessors: {
  79921. [key: string]: string;
  79922. }): boolean;
  79923. }
  79924. }
  79925. declare module BABYLON {
  79926. /** @hidden */
  79927. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  79928. leftOperand: ShaderDefineExpression;
  79929. rightOperand: ShaderDefineExpression;
  79930. isTrue(preprocessors: {
  79931. [key: string]: string;
  79932. }): boolean;
  79933. }
  79934. }
  79935. declare module BABYLON {
  79936. /** @hidden */
  79937. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  79938. define: string;
  79939. operand: string;
  79940. testValue: string;
  79941. constructor(define: string, operand: string, testValue: string);
  79942. isTrue(preprocessors: {
  79943. [key: string]: string;
  79944. }): boolean;
  79945. }
  79946. }
  79947. declare module BABYLON {
  79948. /**
  79949. * Class used to enable access to offline support
  79950. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  79951. */
  79952. export interface IOfflineProvider {
  79953. /**
  79954. * Gets a boolean indicating if scene must be saved in the database
  79955. */
  79956. enableSceneOffline: boolean;
  79957. /**
  79958. * Gets a boolean indicating if textures must be saved in the database
  79959. */
  79960. enableTexturesOffline: boolean;
  79961. /**
  79962. * Open the offline support and make it available
  79963. * @param successCallback defines the callback to call on success
  79964. * @param errorCallback defines the callback to call on error
  79965. */
  79966. open(successCallback: () => void, errorCallback: () => void): void;
  79967. /**
  79968. * Loads an image from the offline support
  79969. * @param url defines the url to load from
  79970. * @param image defines the target DOM image
  79971. */
  79972. loadImage(url: string, image: HTMLImageElement): void;
  79973. /**
  79974. * Loads a file from offline support
  79975. * @param url defines the URL to load from
  79976. * @param sceneLoaded defines a callback to call on success
  79977. * @param progressCallBack defines a callback to call when progress changed
  79978. * @param errorCallback defines a callback to call on error
  79979. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  79980. */
  79981. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  79982. }
  79983. }
  79984. declare module BABYLON {
  79985. /**
  79986. * Class used to help managing file picking and drag'n'drop
  79987. * File Storage
  79988. */
  79989. export class FilesInputStore {
  79990. /**
  79991. * List of files ready to be loaded
  79992. */
  79993. static FilesToLoad: {
  79994. [key: string]: File;
  79995. };
  79996. }
  79997. }
  79998. declare module BABYLON {
  79999. /**
  80000. * Class used to define a retry strategy when error happens while loading assets
  80001. */
  80002. export class RetryStrategy {
  80003. /**
  80004. * Function used to defines an exponential back off strategy
  80005. * @param maxRetries defines the maximum number of retries (3 by default)
  80006. * @param baseInterval defines the interval between retries
  80007. * @returns the strategy function to use
  80008. */
  80009. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80010. }
  80011. }
  80012. declare module BABYLON {
  80013. /**
  80014. * @ignore
  80015. * Application error to support additional information when loading a file
  80016. */
  80017. export abstract class BaseError extends Error {
  80018. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80019. }
  80020. }
  80021. declare module BABYLON {
  80022. /** @ignore */
  80023. export class LoadFileError extends BaseError {
  80024. request?: WebRequest;
  80025. file?: File;
  80026. /**
  80027. * Creates a new LoadFileError
  80028. * @param message defines the message of the error
  80029. * @param request defines the optional web request
  80030. * @param file defines the optional file
  80031. */
  80032. constructor(message: string, object?: WebRequest | File);
  80033. }
  80034. /** @ignore */
  80035. export class RequestFileError extends BaseError {
  80036. request: WebRequest;
  80037. /**
  80038. * Creates a new LoadFileError
  80039. * @param message defines the message of the error
  80040. * @param request defines the optional web request
  80041. */
  80042. constructor(message: string, request: WebRequest);
  80043. }
  80044. /** @ignore */
  80045. export class ReadFileError extends BaseError {
  80046. file: File;
  80047. /**
  80048. * Creates a new ReadFileError
  80049. * @param message defines the message of the error
  80050. * @param file defines the optional file
  80051. */
  80052. constructor(message: string, file: File);
  80053. }
  80054. /**
  80055. * @hidden
  80056. */
  80057. export class FileTools {
  80058. /**
  80059. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  80060. */
  80061. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  80062. /**
  80063. * Gets or sets the base URL to use to load assets
  80064. */
  80065. static BaseUrl: string;
  80066. /**
  80067. * Default behaviour for cors in the application.
  80068. * It can be a string if the expected behavior is identical in the entire app.
  80069. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  80070. */
  80071. static CorsBehavior: string | ((url: string | string[]) => string);
  80072. /**
  80073. * Gets or sets a function used to pre-process url before using them to load assets
  80074. */
  80075. static PreprocessUrl: (url: string) => string;
  80076. /**
  80077. * Removes unwanted characters from an url
  80078. * @param url defines the url to clean
  80079. * @returns the cleaned url
  80080. */
  80081. private static _CleanUrl;
  80082. /**
  80083. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  80084. * @param url define the url we are trying
  80085. * @param element define the dom element where to configure the cors policy
  80086. */
  80087. static SetCorsBehavior(url: string | string[], element: {
  80088. crossOrigin: string | null;
  80089. }): void;
  80090. /**
  80091. * Loads an image as an HTMLImageElement.
  80092. * @param input url string, ArrayBuffer, or Blob to load
  80093. * @param onLoad callback called when the image successfully loads
  80094. * @param onError callback called when the image fails to load
  80095. * @param offlineProvider offline provider for caching
  80096. * @param mimeType optional mime type
  80097. * @returns the HTMLImageElement of the loaded image
  80098. */
  80099. 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>;
  80100. /**
  80101. * Reads a file from a File object
  80102. * @param file defines the file to load
  80103. * @param onSuccess defines the callback to call when data is loaded
  80104. * @param onProgress defines the callback to call during loading process
  80105. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  80106. * @param onError defines the callback to call when an error occurs
  80107. * @returns a file request object
  80108. */
  80109. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  80110. /**
  80111. * Loads a file from a url
  80112. * @param url url to load
  80113. * @param onSuccess callback called when the file successfully loads
  80114. * @param onProgress callback called while file is loading (if the server supports this mode)
  80115. * @param offlineProvider defines the offline provider for caching
  80116. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80117. * @param onError callback called when the file fails to load
  80118. * @returns a file request object
  80119. */
  80120. 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;
  80121. /**
  80122. * Loads a file
  80123. * @param url url to load
  80124. * @param onSuccess callback called when the file successfully loads
  80125. * @param onProgress callback called while file is loading (if the server supports this mode)
  80126. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80127. * @param onError callback called when the file fails to load
  80128. * @param onOpened callback called when the web request is opened
  80129. * @returns a file request object
  80130. */
  80131. 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;
  80132. /**
  80133. * Checks if the loaded document was accessed via `file:`-Protocol.
  80134. * @returns boolean
  80135. */
  80136. static IsFileURL(): boolean;
  80137. }
  80138. }
  80139. declare module BABYLON {
  80140. /** @hidden */
  80141. export class ShaderProcessor {
  80142. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  80143. private static _ProcessPrecision;
  80144. private static _ExtractOperation;
  80145. private static _BuildSubExpression;
  80146. private static _BuildExpression;
  80147. private static _MoveCursorWithinIf;
  80148. private static _MoveCursor;
  80149. private static _EvaluatePreProcessors;
  80150. private static _PreparePreProcessors;
  80151. private static _ProcessShaderConversion;
  80152. private static _ProcessIncludes;
  80153. /**
  80154. * Loads a file from a url
  80155. * @param url url to load
  80156. * @param onSuccess callback called when the file successfully loads
  80157. * @param onProgress callback called while file is loading (if the server supports this mode)
  80158. * @param offlineProvider defines the offline provider for caching
  80159. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80160. * @param onError callback called when the file fails to load
  80161. * @returns a file request object
  80162. * @hidden
  80163. */
  80164. 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;
  80165. }
  80166. }
  80167. declare module BABYLON {
  80168. /**
  80169. * @hidden
  80170. */
  80171. export interface IColor4Like {
  80172. r: float;
  80173. g: float;
  80174. b: float;
  80175. a: float;
  80176. }
  80177. /**
  80178. * @hidden
  80179. */
  80180. export interface IColor3Like {
  80181. r: float;
  80182. g: float;
  80183. b: float;
  80184. }
  80185. /**
  80186. * @hidden
  80187. */
  80188. export interface IVector4Like {
  80189. x: float;
  80190. y: float;
  80191. z: float;
  80192. w: float;
  80193. }
  80194. /**
  80195. * @hidden
  80196. */
  80197. export interface IVector3Like {
  80198. x: float;
  80199. y: float;
  80200. z: float;
  80201. }
  80202. /**
  80203. * @hidden
  80204. */
  80205. export interface IVector2Like {
  80206. x: float;
  80207. y: float;
  80208. }
  80209. /**
  80210. * @hidden
  80211. */
  80212. export interface IMatrixLike {
  80213. toArray(): DeepImmutable<Float32Array | Array<number>>;
  80214. updateFlag: int;
  80215. }
  80216. /**
  80217. * @hidden
  80218. */
  80219. export interface IViewportLike {
  80220. x: float;
  80221. y: float;
  80222. width: float;
  80223. height: float;
  80224. }
  80225. /**
  80226. * @hidden
  80227. */
  80228. export interface IPlaneLike {
  80229. normal: IVector3Like;
  80230. d: float;
  80231. normalize(): void;
  80232. }
  80233. }
  80234. declare module BABYLON {
  80235. /**
  80236. * Interface used to define common properties for effect fallbacks
  80237. */
  80238. export interface IEffectFallbacks {
  80239. /**
  80240. * Removes the defines that should be removed when falling back.
  80241. * @param currentDefines defines the current define statements for the shader.
  80242. * @param effect defines the current effect we try to compile
  80243. * @returns The resulting defines with defines of the current rank removed.
  80244. */
  80245. reduce(currentDefines: string, effect: Effect): string;
  80246. /**
  80247. * Removes the fallback from the bound mesh.
  80248. */
  80249. unBindMesh(): void;
  80250. /**
  80251. * Checks to see if more fallbacks are still availible.
  80252. */
  80253. hasMoreFallbacks: boolean;
  80254. }
  80255. }
  80256. declare module BABYLON {
  80257. /**
  80258. * Class used to evalaute queries containing `and` and `or` operators
  80259. */
  80260. export class AndOrNotEvaluator {
  80261. /**
  80262. * Evaluate a query
  80263. * @param query defines the query to evaluate
  80264. * @param evaluateCallback defines the callback used to filter result
  80265. * @returns true if the query matches
  80266. */
  80267. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  80268. private static _HandleParenthesisContent;
  80269. private static _SimplifyNegation;
  80270. }
  80271. }
  80272. declare module BABYLON {
  80273. /**
  80274. * Class used to store custom tags
  80275. */
  80276. export class Tags {
  80277. /**
  80278. * Adds support for tags on the given object
  80279. * @param obj defines the object to use
  80280. */
  80281. static EnableFor(obj: any): void;
  80282. /**
  80283. * Removes tags support
  80284. * @param obj defines the object to use
  80285. */
  80286. static DisableFor(obj: any): void;
  80287. /**
  80288. * Gets a boolean indicating if the given object has tags
  80289. * @param obj defines the object to use
  80290. * @returns a boolean
  80291. */
  80292. static HasTags(obj: any): boolean;
  80293. /**
  80294. * Gets the tags available on a given object
  80295. * @param obj defines the object to use
  80296. * @param asString defines if the tags must be returned as a string instead of an array of strings
  80297. * @returns the tags
  80298. */
  80299. static GetTags(obj: any, asString?: boolean): any;
  80300. /**
  80301. * Adds tags to an object
  80302. * @param obj defines the object to use
  80303. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  80304. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  80305. */
  80306. static AddTagsTo(obj: any, tagsString: string): void;
  80307. /**
  80308. * @hidden
  80309. */
  80310. static _AddTagTo(obj: any, tag: string): void;
  80311. /**
  80312. * Removes specific tags from a specific object
  80313. * @param obj defines the object to use
  80314. * @param tagsString defines the tags to remove
  80315. */
  80316. static RemoveTagsFrom(obj: any, tagsString: string): void;
  80317. /**
  80318. * @hidden
  80319. */
  80320. static _RemoveTagFrom(obj: any, tag: string): void;
  80321. /**
  80322. * Defines if tags hosted on an object match a given query
  80323. * @param obj defines the object to use
  80324. * @param tagsQuery defines the tag query
  80325. * @returns a boolean
  80326. */
  80327. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  80328. }
  80329. }
  80330. declare module BABYLON {
  80331. /**
  80332. * Scalar computation library
  80333. */
  80334. export class Scalar {
  80335. /**
  80336. * Two pi constants convenient for computation.
  80337. */
  80338. static TwoPi: number;
  80339. /**
  80340. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80341. * @param a number
  80342. * @param b number
  80343. * @param epsilon (default = 1.401298E-45)
  80344. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80345. */
  80346. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  80347. /**
  80348. * Returns a string : the upper case translation of the number i to hexadecimal.
  80349. * @param i number
  80350. * @returns the upper case translation of the number i to hexadecimal.
  80351. */
  80352. static ToHex(i: number): string;
  80353. /**
  80354. * Returns -1 if value is negative and +1 is value is positive.
  80355. * @param value the value
  80356. * @returns the value itself if it's equal to zero.
  80357. */
  80358. static Sign(value: number): number;
  80359. /**
  80360. * Returns the value itself if it's between min and max.
  80361. * Returns min if the value is lower than min.
  80362. * Returns max if the value is greater than max.
  80363. * @param value the value to clmap
  80364. * @param min the min value to clamp to (default: 0)
  80365. * @param max the max value to clamp to (default: 1)
  80366. * @returns the clamped value
  80367. */
  80368. static Clamp(value: number, min?: number, max?: number): number;
  80369. /**
  80370. * the log2 of value.
  80371. * @param value the value to compute log2 of
  80372. * @returns the log2 of value.
  80373. */
  80374. static Log2(value: number): number;
  80375. /**
  80376. * Loops the value, so that it is never larger than length and never smaller than 0.
  80377. *
  80378. * This is similar to the modulo operator but it works with floating point numbers.
  80379. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  80380. * With t = 5 and length = 2.5, the result would be 0.0.
  80381. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  80382. * @param value the value
  80383. * @param length the length
  80384. * @returns the looped value
  80385. */
  80386. static Repeat(value: number, length: number): number;
  80387. /**
  80388. * Normalize the value between 0.0 and 1.0 using min and max values
  80389. * @param value value to normalize
  80390. * @param min max to normalize between
  80391. * @param max min to normalize between
  80392. * @returns the normalized value
  80393. */
  80394. static Normalize(value: number, min: number, max: number): number;
  80395. /**
  80396. * Denormalize the value from 0.0 and 1.0 using min and max values
  80397. * @param normalized value to denormalize
  80398. * @param min max to denormalize between
  80399. * @param max min to denormalize between
  80400. * @returns the denormalized value
  80401. */
  80402. static Denormalize(normalized: number, min: number, max: number): number;
  80403. /**
  80404. * Calculates the shortest difference between two given angles given in degrees.
  80405. * @param current current angle in degrees
  80406. * @param target target angle in degrees
  80407. * @returns the delta
  80408. */
  80409. static DeltaAngle(current: number, target: number): number;
  80410. /**
  80411. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  80412. * @param tx value
  80413. * @param length length
  80414. * @returns The returned value will move back and forth between 0 and length
  80415. */
  80416. static PingPong(tx: number, length: number): number;
  80417. /**
  80418. * Interpolates between min and max with smoothing at the limits.
  80419. *
  80420. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  80421. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  80422. * @param from from
  80423. * @param to to
  80424. * @param tx value
  80425. * @returns the smooth stepped value
  80426. */
  80427. static SmoothStep(from: number, to: number, tx: number): number;
  80428. /**
  80429. * Moves a value current towards target.
  80430. *
  80431. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  80432. * Negative values of maxDelta pushes the value away from target.
  80433. * @param current current value
  80434. * @param target target value
  80435. * @param maxDelta max distance to move
  80436. * @returns resulting value
  80437. */
  80438. static MoveTowards(current: number, target: number, maxDelta: number): number;
  80439. /**
  80440. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  80441. *
  80442. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  80443. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  80444. * @param current current value
  80445. * @param target target value
  80446. * @param maxDelta max distance to move
  80447. * @returns resulting angle
  80448. */
  80449. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  80450. /**
  80451. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  80452. * @param start start value
  80453. * @param end target value
  80454. * @param amount amount to lerp between
  80455. * @returns the lerped value
  80456. */
  80457. static Lerp(start: number, end: number, amount: number): number;
  80458. /**
  80459. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  80460. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  80461. * @param start start value
  80462. * @param end target value
  80463. * @param amount amount to lerp between
  80464. * @returns the lerped value
  80465. */
  80466. static LerpAngle(start: number, end: number, amount: number): number;
  80467. /**
  80468. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  80469. * @param a start value
  80470. * @param b target value
  80471. * @param value value between a and b
  80472. * @returns the inverseLerp value
  80473. */
  80474. static InverseLerp(a: number, b: number, value: number): number;
  80475. /**
  80476. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  80477. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  80478. * @param value1 spline value
  80479. * @param tangent1 spline value
  80480. * @param value2 spline value
  80481. * @param tangent2 spline value
  80482. * @param amount input value
  80483. * @returns hermite result
  80484. */
  80485. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  80486. /**
  80487. * Returns a random float number between and min and max values
  80488. * @param min min value of random
  80489. * @param max max value of random
  80490. * @returns random value
  80491. */
  80492. static RandomRange(min: number, max: number): number;
  80493. /**
  80494. * This function returns percentage of a number in a given range.
  80495. *
  80496. * RangeToPercent(40,20,60) will return 0.5 (50%)
  80497. * RangeToPercent(34,0,100) will return 0.34 (34%)
  80498. * @param number to convert to percentage
  80499. * @param min min range
  80500. * @param max max range
  80501. * @returns the percentage
  80502. */
  80503. static RangeToPercent(number: number, min: number, max: number): number;
  80504. /**
  80505. * This function returns number that corresponds to the percentage in a given range.
  80506. *
  80507. * PercentToRange(0.34,0,100) will return 34.
  80508. * @param percent to convert to number
  80509. * @param min min range
  80510. * @param max max range
  80511. * @returns the number
  80512. */
  80513. static PercentToRange(percent: number, min: number, max: number): number;
  80514. /**
  80515. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  80516. * @param angle The angle to normalize in radian.
  80517. * @return The converted angle.
  80518. */
  80519. static NormalizeRadians(angle: number): number;
  80520. }
  80521. }
  80522. declare module BABYLON {
  80523. /**
  80524. * Constant used to convert a value to gamma space
  80525. * @ignorenaming
  80526. */
  80527. export const ToGammaSpace: number;
  80528. /**
  80529. * Constant used to convert a value to linear space
  80530. * @ignorenaming
  80531. */
  80532. export const ToLinearSpace = 2.2;
  80533. /**
  80534. * Constant used to define the minimal number value in Babylon.js
  80535. * @ignorenaming
  80536. */
  80537. let Epsilon: number;
  80538. }
  80539. declare module BABYLON {
  80540. /**
  80541. * Class used to represent a viewport on screen
  80542. */
  80543. export class Viewport {
  80544. /** viewport left coordinate */
  80545. x: number;
  80546. /** viewport top coordinate */
  80547. y: number;
  80548. /**viewport width */
  80549. width: number;
  80550. /** viewport height */
  80551. height: number;
  80552. /**
  80553. * Creates a Viewport object located at (x, y) and sized (width, height)
  80554. * @param x defines viewport left coordinate
  80555. * @param y defines viewport top coordinate
  80556. * @param width defines the viewport width
  80557. * @param height defines the viewport height
  80558. */
  80559. constructor(
  80560. /** viewport left coordinate */
  80561. x: number,
  80562. /** viewport top coordinate */
  80563. y: number,
  80564. /**viewport width */
  80565. width: number,
  80566. /** viewport height */
  80567. height: number);
  80568. /**
  80569. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  80570. * @param renderWidth defines the rendering width
  80571. * @param renderHeight defines the rendering height
  80572. * @returns a new Viewport
  80573. */
  80574. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  80575. /**
  80576. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  80577. * @param renderWidth defines the rendering width
  80578. * @param renderHeight defines the rendering height
  80579. * @param ref defines the target viewport
  80580. * @returns the current viewport
  80581. */
  80582. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  80583. /**
  80584. * Returns a new Viewport copied from the current one
  80585. * @returns a new Viewport
  80586. */
  80587. clone(): Viewport;
  80588. }
  80589. }
  80590. declare module BABYLON {
  80591. /**
  80592. * Class containing a set of static utilities functions for arrays.
  80593. */
  80594. export class ArrayTools {
  80595. /**
  80596. * Returns an array of the given size filled with element built from the given constructor and the paramters
  80597. * @param size the number of element to construct and put in the array
  80598. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  80599. * @returns a new array filled with new objects
  80600. */
  80601. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  80602. }
  80603. }
  80604. declare module BABYLON {
  80605. /**
  80606. * Represents a plane by the equation ax + by + cz + d = 0
  80607. */
  80608. export class Plane {
  80609. private static _TmpMatrix;
  80610. /**
  80611. * Normal of the plane (a,b,c)
  80612. */
  80613. normal: Vector3;
  80614. /**
  80615. * d component of the plane
  80616. */
  80617. d: number;
  80618. /**
  80619. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  80620. * @param a a component of the plane
  80621. * @param b b component of the plane
  80622. * @param c c component of the plane
  80623. * @param d d component of the plane
  80624. */
  80625. constructor(a: number, b: number, c: number, d: number);
  80626. /**
  80627. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  80628. */
  80629. asArray(): number[];
  80630. /**
  80631. * @returns a new plane copied from the current Plane.
  80632. */
  80633. clone(): Plane;
  80634. /**
  80635. * @returns the string "Plane".
  80636. */
  80637. getClassName(): string;
  80638. /**
  80639. * @returns the Plane hash code.
  80640. */
  80641. getHashCode(): number;
  80642. /**
  80643. * Normalize the current Plane in place.
  80644. * @returns the updated Plane.
  80645. */
  80646. normalize(): Plane;
  80647. /**
  80648. * Applies a transformation the plane and returns the result
  80649. * @param transformation the transformation matrix to be applied to the plane
  80650. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  80651. */
  80652. transform(transformation: DeepImmutable<Matrix>): Plane;
  80653. /**
  80654. * Compute the dot product between the point and the plane normal
  80655. * @param point point to calculate the dot product with
  80656. * @returns the dot product (float) of the point coordinates and the plane normal.
  80657. */
  80658. dotCoordinate(point: DeepImmutable<Vector3>): number;
  80659. /**
  80660. * Updates the current Plane from the plane defined by the three given points.
  80661. * @param point1 one of the points used to contruct the plane
  80662. * @param point2 one of the points used to contruct the plane
  80663. * @param point3 one of the points used to contruct the plane
  80664. * @returns the updated Plane.
  80665. */
  80666. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  80667. /**
  80668. * Checks if the plane is facing a given direction
  80669. * @param direction the direction to check if the plane is facing
  80670. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  80671. * @returns True is the vector "direction" is the same side than the plane normal.
  80672. */
  80673. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  80674. /**
  80675. * Calculates the distance to a point
  80676. * @param point point to calculate distance to
  80677. * @returns the signed distance (float) from the given point to the Plane.
  80678. */
  80679. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  80680. /**
  80681. * Creates a plane from an array
  80682. * @param array the array to create a plane from
  80683. * @returns a new Plane from the given array.
  80684. */
  80685. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  80686. /**
  80687. * Creates a plane from three points
  80688. * @param point1 point used to create the plane
  80689. * @param point2 point used to create the plane
  80690. * @param point3 point used to create the plane
  80691. * @returns a new Plane defined by the three given points.
  80692. */
  80693. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  80694. /**
  80695. * Creates a plane from an origin point and a normal
  80696. * @param origin origin of the plane to be constructed
  80697. * @param normal normal of the plane to be constructed
  80698. * @returns a new Plane the normal vector to this plane at the given origin point.
  80699. * Note : the vector "normal" is updated because normalized.
  80700. */
  80701. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  80702. /**
  80703. * Calculates the distance from a plane and a point
  80704. * @param origin origin of the plane to be constructed
  80705. * @param normal normal of the plane to be constructed
  80706. * @param point point to calculate distance to
  80707. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  80708. */
  80709. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  80710. }
  80711. }
  80712. declare module BABYLON {
  80713. /** @hidden */
  80714. export class PerformanceConfigurator {
  80715. /** @hidden */
  80716. static MatrixUse64Bits: boolean;
  80717. /** @hidden */
  80718. static MatrixTrackPrecisionChange: boolean;
  80719. /** @hidden */
  80720. static MatrixCurrentType: any;
  80721. /** @hidden */
  80722. static MatrixTrackedMatrices: Array<any> | null;
  80723. /** @hidden */
  80724. static SetMatrixPrecision(use64bits: boolean): void;
  80725. }
  80726. }
  80727. declare module BABYLON {
  80728. /**
  80729. * Class representing a vector containing 2 coordinates
  80730. */
  80731. export class Vector2 {
  80732. /** defines the first coordinate */
  80733. x: number;
  80734. /** defines the second coordinate */
  80735. y: number;
  80736. /**
  80737. * Creates a new Vector2 from the given x and y coordinates
  80738. * @param x defines the first coordinate
  80739. * @param y defines the second coordinate
  80740. */
  80741. constructor(
  80742. /** defines the first coordinate */
  80743. x?: number,
  80744. /** defines the second coordinate */
  80745. y?: number);
  80746. /**
  80747. * Gets a string with the Vector2 coordinates
  80748. * @returns a string with the Vector2 coordinates
  80749. */
  80750. toString(): string;
  80751. /**
  80752. * Gets class name
  80753. * @returns the string "Vector2"
  80754. */
  80755. getClassName(): string;
  80756. /**
  80757. * Gets current vector hash code
  80758. * @returns the Vector2 hash code as a number
  80759. */
  80760. getHashCode(): number;
  80761. /**
  80762. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  80763. * @param array defines the source array
  80764. * @param index defines the offset in source array
  80765. * @returns the current Vector2
  80766. */
  80767. toArray(array: FloatArray, index?: number): Vector2;
  80768. /**
  80769. * Update the current vector from an array
  80770. * @param array defines the destination array
  80771. * @param index defines the offset in the destination array
  80772. * @returns the current Vector3
  80773. */
  80774. fromArray(array: FloatArray, index?: number): Vector2;
  80775. /**
  80776. * Copy the current vector to an array
  80777. * @returns a new array with 2 elements: the Vector2 coordinates.
  80778. */
  80779. asArray(): number[];
  80780. /**
  80781. * Sets the Vector2 coordinates with the given Vector2 coordinates
  80782. * @param source defines the source Vector2
  80783. * @returns the current updated Vector2
  80784. */
  80785. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  80786. /**
  80787. * Sets the Vector2 coordinates with the given floats
  80788. * @param x defines the first coordinate
  80789. * @param y defines the second coordinate
  80790. * @returns the current updated Vector2
  80791. */
  80792. copyFromFloats(x: number, y: number): Vector2;
  80793. /**
  80794. * Sets the Vector2 coordinates with the given floats
  80795. * @param x defines the first coordinate
  80796. * @param y defines the second coordinate
  80797. * @returns the current updated Vector2
  80798. */
  80799. set(x: number, y: number): Vector2;
  80800. /**
  80801. * Add another vector with the current one
  80802. * @param otherVector defines the other vector
  80803. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  80804. */
  80805. add(otherVector: DeepImmutable<Vector2>): Vector2;
  80806. /**
  80807. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  80808. * @param otherVector defines the other vector
  80809. * @param result defines the target vector
  80810. * @returns the unmodified current Vector2
  80811. */
  80812. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80813. /**
  80814. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  80815. * @param otherVector defines the other vector
  80816. * @returns the current updated Vector2
  80817. */
  80818. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80819. /**
  80820. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  80821. * @param otherVector defines the other vector
  80822. * @returns a new Vector2
  80823. */
  80824. addVector3(otherVector: Vector3): Vector2;
  80825. /**
  80826. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  80827. * @param otherVector defines the other vector
  80828. * @returns a new Vector2
  80829. */
  80830. subtract(otherVector: Vector2): Vector2;
  80831. /**
  80832. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  80833. * @param otherVector defines the other vector
  80834. * @param result defines the target vector
  80835. * @returns the unmodified current Vector2
  80836. */
  80837. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80838. /**
  80839. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  80840. * @param otherVector defines the other vector
  80841. * @returns the current updated Vector2
  80842. */
  80843. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80844. /**
  80845. * Multiplies in place the current Vector2 coordinates by the given ones
  80846. * @param otherVector defines the other vector
  80847. * @returns the current updated Vector2
  80848. */
  80849. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80850. /**
  80851. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  80852. * @param otherVector defines the other vector
  80853. * @returns a new Vector2
  80854. */
  80855. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  80856. /**
  80857. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  80858. * @param otherVector defines the other vector
  80859. * @param result defines the target vector
  80860. * @returns the unmodified current Vector2
  80861. */
  80862. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80863. /**
  80864. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  80865. * @param x defines the first coordinate
  80866. * @param y defines the second coordinate
  80867. * @returns a new Vector2
  80868. */
  80869. multiplyByFloats(x: number, y: number): Vector2;
  80870. /**
  80871. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  80872. * @param otherVector defines the other vector
  80873. * @returns a new Vector2
  80874. */
  80875. divide(otherVector: Vector2): Vector2;
  80876. /**
  80877. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  80878. * @param otherVector defines the other vector
  80879. * @param result defines the target vector
  80880. * @returns the unmodified current Vector2
  80881. */
  80882. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80883. /**
  80884. * Divides the current Vector2 coordinates by the given ones
  80885. * @param otherVector defines the other vector
  80886. * @returns the current updated Vector2
  80887. */
  80888. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80889. /**
  80890. * Gets a new Vector2 with current Vector2 negated coordinates
  80891. * @returns a new Vector2
  80892. */
  80893. negate(): Vector2;
  80894. /**
  80895. * Negate this vector in place
  80896. * @returns this
  80897. */
  80898. negateInPlace(): Vector2;
  80899. /**
  80900. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  80901. * @param result defines the Vector3 object where to store the result
  80902. * @returns the current Vector2
  80903. */
  80904. negateToRef(result: Vector2): Vector2;
  80905. /**
  80906. * Multiply the Vector2 coordinates by scale
  80907. * @param scale defines the scaling factor
  80908. * @returns the current updated Vector2
  80909. */
  80910. scaleInPlace(scale: number): Vector2;
  80911. /**
  80912. * Returns a new Vector2 scaled by "scale" from the current Vector2
  80913. * @param scale defines the scaling factor
  80914. * @returns a new Vector2
  80915. */
  80916. scale(scale: number): Vector2;
  80917. /**
  80918. * Scale the current Vector2 values by a factor to a given Vector2
  80919. * @param scale defines the scale factor
  80920. * @param result defines the Vector2 object where to store the result
  80921. * @returns the unmodified current Vector2
  80922. */
  80923. scaleToRef(scale: number, result: Vector2): Vector2;
  80924. /**
  80925. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  80926. * @param scale defines the scale factor
  80927. * @param result defines the Vector2 object where to store the result
  80928. * @returns the unmodified current Vector2
  80929. */
  80930. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  80931. /**
  80932. * Gets a boolean if two vectors are equals
  80933. * @param otherVector defines the other vector
  80934. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  80935. */
  80936. equals(otherVector: DeepImmutable<Vector2>): boolean;
  80937. /**
  80938. * Gets a boolean if two vectors are equals (using an epsilon value)
  80939. * @param otherVector defines the other vector
  80940. * @param epsilon defines the minimal distance to consider equality
  80941. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  80942. */
  80943. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  80944. /**
  80945. * Gets a new Vector2 from current Vector2 floored values
  80946. * @returns a new Vector2
  80947. */
  80948. floor(): Vector2;
  80949. /**
  80950. * Gets a new Vector2 from current Vector2 floored values
  80951. * @returns a new Vector2
  80952. */
  80953. fract(): Vector2;
  80954. /**
  80955. * Gets the length of the vector
  80956. * @returns the vector length (float)
  80957. */
  80958. length(): number;
  80959. /**
  80960. * Gets the vector squared length
  80961. * @returns the vector squared length (float)
  80962. */
  80963. lengthSquared(): number;
  80964. /**
  80965. * Normalize the vector
  80966. * @returns the current updated Vector2
  80967. */
  80968. normalize(): Vector2;
  80969. /**
  80970. * Gets a new Vector2 copied from the Vector2
  80971. * @returns a new Vector2
  80972. */
  80973. clone(): Vector2;
  80974. /**
  80975. * Gets a new Vector2(0, 0)
  80976. * @returns a new Vector2
  80977. */
  80978. static Zero(): Vector2;
  80979. /**
  80980. * Gets a new Vector2(1, 1)
  80981. * @returns a new Vector2
  80982. */
  80983. static One(): Vector2;
  80984. /**
  80985. * Gets a new Vector2 set from the given index element of the given array
  80986. * @param array defines the data source
  80987. * @param offset defines the offset in the data source
  80988. * @returns a new Vector2
  80989. */
  80990. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  80991. /**
  80992. * Sets "result" from the given index element of the given array
  80993. * @param array defines the data source
  80994. * @param offset defines the offset in the data source
  80995. * @param result defines the target vector
  80996. */
  80997. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  80998. /**
  80999. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81000. * @param value1 defines 1st point of control
  81001. * @param value2 defines 2nd point of control
  81002. * @param value3 defines 3rd point of control
  81003. * @param value4 defines 4th point of control
  81004. * @param amount defines the interpolation factor
  81005. * @returns a new Vector2
  81006. */
  81007. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81008. /**
  81009. * 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".
  81010. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81011. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81012. * @param value defines the value to clamp
  81013. * @param min defines the lower limit
  81014. * @param max defines the upper limit
  81015. * @returns a new Vector2
  81016. */
  81017. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81018. /**
  81019. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81020. * @param value1 defines the 1st control point
  81021. * @param tangent1 defines the outgoing tangent
  81022. * @param value2 defines the 2nd control point
  81023. * @param tangent2 defines the incoming tangent
  81024. * @param amount defines the interpolation factor
  81025. * @returns a new Vector2
  81026. */
  81027. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81028. /**
  81029. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81030. * @param start defines the start vector
  81031. * @param end defines the end vector
  81032. * @param amount defines the interpolation factor
  81033. * @returns a new Vector2
  81034. */
  81035. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  81036. /**
  81037. * Gets the dot product of the vector "left" and the vector "right"
  81038. * @param left defines first vector
  81039. * @param right defines second vector
  81040. * @returns the dot product (float)
  81041. */
  81042. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  81043. /**
  81044. * Returns a new Vector2 equal to the normalized given vector
  81045. * @param vector defines the vector to normalize
  81046. * @returns a new Vector2
  81047. */
  81048. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  81049. /**
  81050. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  81051. * @param left defines 1st vector
  81052. * @param right defines 2nd vector
  81053. * @returns a new Vector2
  81054. */
  81055. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81056. /**
  81057. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  81058. * @param left defines 1st vector
  81059. * @param right defines 2nd vector
  81060. * @returns a new Vector2
  81061. */
  81062. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81063. /**
  81064. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  81065. * @param vector defines the vector to transform
  81066. * @param transformation defines the matrix to apply
  81067. * @returns a new Vector2
  81068. */
  81069. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  81070. /**
  81071. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  81072. * @param vector defines the vector to transform
  81073. * @param transformation defines the matrix to apply
  81074. * @param result defines the target vector
  81075. */
  81076. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  81077. /**
  81078. * Determines if a given vector is included in a triangle
  81079. * @param p defines the vector to test
  81080. * @param p0 defines 1st triangle point
  81081. * @param p1 defines 2nd triangle point
  81082. * @param p2 defines 3rd triangle point
  81083. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  81084. */
  81085. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  81086. /**
  81087. * Gets the distance between the vectors "value1" and "value2"
  81088. * @param value1 defines first vector
  81089. * @param value2 defines second vector
  81090. * @returns the distance between vectors
  81091. */
  81092. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81093. /**
  81094. * Returns the squared distance between the vectors "value1" and "value2"
  81095. * @param value1 defines first vector
  81096. * @param value2 defines second vector
  81097. * @returns the squared distance between vectors
  81098. */
  81099. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81100. /**
  81101. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  81102. * @param value1 defines first vector
  81103. * @param value2 defines second vector
  81104. * @returns a new Vector2
  81105. */
  81106. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  81107. /**
  81108. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  81109. * @param p defines the middle point
  81110. * @param segA defines one point of the segment
  81111. * @param segB defines the other point of the segment
  81112. * @returns the shortest distance
  81113. */
  81114. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  81115. }
  81116. /**
  81117. * Class used to store (x,y,z) vector representation
  81118. * A Vector3 is the main object used in 3D geometry
  81119. * It can represent etiher the coordinates of a point the space, either a direction
  81120. * Reminder: js uses a left handed forward facing system
  81121. */
  81122. export class Vector3 {
  81123. private static _UpReadOnly;
  81124. private static _ZeroReadOnly;
  81125. /** @hidden */
  81126. _x: number;
  81127. /** @hidden */
  81128. _y: number;
  81129. /** @hidden */
  81130. _z: number;
  81131. /** @hidden */
  81132. _isDirty: boolean;
  81133. /** Gets or sets the x coordinate */
  81134. get x(): number;
  81135. set x(value: number);
  81136. /** Gets or sets the y coordinate */
  81137. get y(): number;
  81138. set y(value: number);
  81139. /** Gets or sets the z coordinate */
  81140. get z(): number;
  81141. set z(value: number);
  81142. /**
  81143. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  81144. * @param x defines the first coordinates (on X axis)
  81145. * @param y defines the second coordinates (on Y axis)
  81146. * @param z defines the third coordinates (on Z axis)
  81147. */
  81148. constructor(x?: number, y?: number, z?: number);
  81149. /**
  81150. * Creates a string representation of the Vector3
  81151. * @returns a string with the Vector3 coordinates.
  81152. */
  81153. toString(): string;
  81154. /**
  81155. * Gets the class name
  81156. * @returns the string "Vector3"
  81157. */
  81158. getClassName(): string;
  81159. /**
  81160. * Creates the Vector3 hash code
  81161. * @returns a number which tends to be unique between Vector3 instances
  81162. */
  81163. getHashCode(): number;
  81164. /**
  81165. * Creates an array containing three elements : the coordinates of the Vector3
  81166. * @returns a new array of numbers
  81167. */
  81168. asArray(): number[];
  81169. /**
  81170. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  81171. * @param array defines the destination array
  81172. * @param index defines the offset in the destination array
  81173. * @returns the current Vector3
  81174. */
  81175. toArray(array: FloatArray, index?: number): Vector3;
  81176. /**
  81177. * Update the current vector from an array
  81178. * @param array defines the destination array
  81179. * @param index defines the offset in the destination array
  81180. * @returns the current Vector3
  81181. */
  81182. fromArray(array: FloatArray, index?: number): Vector3;
  81183. /**
  81184. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  81185. * @returns a new Quaternion object, computed from the Vector3 coordinates
  81186. */
  81187. toQuaternion(): Quaternion;
  81188. /**
  81189. * Adds the given vector to the current Vector3
  81190. * @param otherVector defines the second operand
  81191. * @returns the current updated Vector3
  81192. */
  81193. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81194. /**
  81195. * Adds the given coordinates to the current Vector3
  81196. * @param x defines the x coordinate of the operand
  81197. * @param y defines the y coordinate of the operand
  81198. * @param z defines the z coordinate of the operand
  81199. * @returns the current updated Vector3
  81200. */
  81201. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81202. /**
  81203. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  81204. * @param otherVector defines the second operand
  81205. * @returns the resulting Vector3
  81206. */
  81207. add(otherVector: DeepImmutable<Vector3>): Vector3;
  81208. /**
  81209. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  81210. * @param otherVector defines the second operand
  81211. * @param result defines the Vector3 object where to store the result
  81212. * @returns the current Vector3
  81213. */
  81214. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81215. /**
  81216. * Subtract the given vector from the current Vector3
  81217. * @param otherVector defines the second operand
  81218. * @returns the current updated Vector3
  81219. */
  81220. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81221. /**
  81222. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  81223. * @param otherVector defines the second operand
  81224. * @returns the resulting Vector3
  81225. */
  81226. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  81227. /**
  81228. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  81229. * @param otherVector defines the second operand
  81230. * @param result defines the Vector3 object where to store the result
  81231. * @returns the current Vector3
  81232. */
  81233. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81234. /**
  81235. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  81236. * @param x defines the x coordinate of the operand
  81237. * @param y defines the y coordinate of the operand
  81238. * @param z defines the z coordinate of the operand
  81239. * @returns the resulting Vector3
  81240. */
  81241. subtractFromFloats(x: number, y: number, z: number): Vector3;
  81242. /**
  81243. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  81244. * @param x defines the x coordinate of the operand
  81245. * @param y defines the y coordinate of the operand
  81246. * @param z defines the z coordinate of the operand
  81247. * @param result defines the Vector3 object where to store the result
  81248. * @returns the current Vector3
  81249. */
  81250. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  81251. /**
  81252. * Gets a new Vector3 set with the current Vector3 negated coordinates
  81253. * @returns a new Vector3
  81254. */
  81255. negate(): Vector3;
  81256. /**
  81257. * Negate this vector in place
  81258. * @returns this
  81259. */
  81260. negateInPlace(): Vector3;
  81261. /**
  81262. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  81263. * @param result defines the Vector3 object where to store the result
  81264. * @returns the current Vector3
  81265. */
  81266. negateToRef(result: Vector3): Vector3;
  81267. /**
  81268. * Multiplies the Vector3 coordinates by the float "scale"
  81269. * @param scale defines the multiplier factor
  81270. * @returns the current updated Vector3
  81271. */
  81272. scaleInPlace(scale: number): Vector3;
  81273. /**
  81274. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  81275. * @param scale defines the multiplier factor
  81276. * @returns a new Vector3
  81277. */
  81278. scale(scale: number): Vector3;
  81279. /**
  81280. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  81281. * @param scale defines the multiplier factor
  81282. * @param result defines the Vector3 object where to store the result
  81283. * @returns the current Vector3
  81284. */
  81285. scaleToRef(scale: number, result: Vector3): Vector3;
  81286. /**
  81287. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  81288. * @param scale defines the scale factor
  81289. * @param result defines the Vector3 object where to store the result
  81290. * @returns the unmodified current Vector3
  81291. */
  81292. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  81293. /**
  81294. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81295. * @param origin defines the origin of the projection ray
  81296. * @param plane defines the plane to project to
  81297. * @returns the projected vector3
  81298. */
  81299. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  81300. /**
  81301. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81302. * @param origin defines the origin of the projection ray
  81303. * @param plane defines the plane to project to
  81304. * @param result defines the Vector3 where to store the result
  81305. */
  81306. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  81307. /**
  81308. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  81309. * @param otherVector defines the second operand
  81310. * @returns true if both vectors are equals
  81311. */
  81312. equals(otherVector: DeepImmutable<Vector3>): boolean;
  81313. /**
  81314. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  81315. * @param otherVector defines the second operand
  81316. * @param epsilon defines the minimal distance to define values as equals
  81317. * @returns true if both vectors are distant less than epsilon
  81318. */
  81319. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  81320. /**
  81321. * Returns true if the current Vector3 coordinates equals the given floats
  81322. * @param x defines the x coordinate of the operand
  81323. * @param y defines the y coordinate of the operand
  81324. * @param z defines the z coordinate of the operand
  81325. * @returns true if both vectors are equals
  81326. */
  81327. equalsToFloats(x: number, y: number, z: number): boolean;
  81328. /**
  81329. * Multiplies the current Vector3 coordinates by the given ones
  81330. * @param otherVector defines the second operand
  81331. * @returns the current updated Vector3
  81332. */
  81333. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81334. /**
  81335. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  81336. * @param otherVector defines the second operand
  81337. * @returns the new Vector3
  81338. */
  81339. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  81340. /**
  81341. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  81342. * @param otherVector defines the second operand
  81343. * @param result defines the Vector3 object where to store the result
  81344. * @returns the current Vector3
  81345. */
  81346. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81347. /**
  81348. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  81349. * @param x defines the x coordinate of the operand
  81350. * @param y defines the y coordinate of the operand
  81351. * @param z defines the z coordinate of the operand
  81352. * @returns the new Vector3
  81353. */
  81354. multiplyByFloats(x: number, y: number, z: number): Vector3;
  81355. /**
  81356. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  81357. * @param otherVector defines the second operand
  81358. * @returns the new Vector3
  81359. */
  81360. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  81361. /**
  81362. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  81363. * @param otherVector defines the second operand
  81364. * @param result defines the Vector3 object where to store the result
  81365. * @returns the current Vector3
  81366. */
  81367. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81368. /**
  81369. * Divides the current Vector3 coordinates by the given ones.
  81370. * @param otherVector defines the second operand
  81371. * @returns the current updated Vector3
  81372. */
  81373. divideInPlace(otherVector: Vector3): Vector3;
  81374. /**
  81375. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  81376. * @param other defines the second operand
  81377. * @returns the current updated Vector3
  81378. */
  81379. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  81380. /**
  81381. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  81382. * @param other defines the second operand
  81383. * @returns the current updated Vector3
  81384. */
  81385. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  81386. /**
  81387. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  81388. * @param x defines the x coordinate of the operand
  81389. * @param y defines the y coordinate of the operand
  81390. * @param z defines the z coordinate of the operand
  81391. * @returns the current updated Vector3
  81392. */
  81393. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81394. /**
  81395. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  81396. * @param x defines the x coordinate of the operand
  81397. * @param y defines the y coordinate of the operand
  81398. * @param z defines the z coordinate of the operand
  81399. * @returns the current updated Vector3
  81400. */
  81401. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81402. /**
  81403. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  81404. * Check if is non uniform within a certain amount of decimal places to account for this
  81405. * @param epsilon the amount the values can differ
  81406. * @returns if the the vector is non uniform to a certain number of decimal places
  81407. */
  81408. isNonUniformWithinEpsilon(epsilon: number): boolean;
  81409. /**
  81410. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  81411. */
  81412. get isNonUniform(): boolean;
  81413. /**
  81414. * Gets a new Vector3 from current Vector3 floored values
  81415. * @returns a new Vector3
  81416. */
  81417. floor(): Vector3;
  81418. /**
  81419. * Gets a new Vector3 from current Vector3 floored values
  81420. * @returns a new Vector3
  81421. */
  81422. fract(): Vector3;
  81423. /**
  81424. * Gets the length of the Vector3
  81425. * @returns the length of the Vector3
  81426. */
  81427. length(): number;
  81428. /**
  81429. * Gets the squared length of the Vector3
  81430. * @returns squared length of the Vector3
  81431. */
  81432. lengthSquared(): number;
  81433. /**
  81434. * Normalize the current Vector3.
  81435. * Please note that this is an in place operation.
  81436. * @returns the current updated Vector3
  81437. */
  81438. normalize(): Vector3;
  81439. /**
  81440. * Reorders the x y z properties of the vector in place
  81441. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  81442. * @returns the current updated vector
  81443. */
  81444. reorderInPlace(order: string): this;
  81445. /**
  81446. * Rotates the vector around 0,0,0 by a quaternion
  81447. * @param quaternion the rotation quaternion
  81448. * @param result vector to store the result
  81449. * @returns the resulting vector
  81450. */
  81451. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  81452. /**
  81453. * Rotates a vector around a given point
  81454. * @param quaternion the rotation quaternion
  81455. * @param point the point to rotate around
  81456. * @param result vector to store the result
  81457. * @returns the resulting vector
  81458. */
  81459. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  81460. /**
  81461. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  81462. * The cross product is then orthogonal to both current and "other"
  81463. * @param other defines the right operand
  81464. * @returns the cross product
  81465. */
  81466. cross(other: Vector3): Vector3;
  81467. /**
  81468. * Normalize the current Vector3 with the given input length.
  81469. * Please note that this is an in place operation.
  81470. * @param len the length of the vector
  81471. * @returns the current updated Vector3
  81472. */
  81473. normalizeFromLength(len: number): Vector3;
  81474. /**
  81475. * Normalize the current Vector3 to a new vector
  81476. * @returns the new Vector3
  81477. */
  81478. normalizeToNew(): Vector3;
  81479. /**
  81480. * Normalize the current Vector3 to the reference
  81481. * @param reference define the Vector3 to update
  81482. * @returns the updated Vector3
  81483. */
  81484. normalizeToRef(reference: Vector3): Vector3;
  81485. /**
  81486. * Creates a new Vector3 copied from the current Vector3
  81487. * @returns the new Vector3
  81488. */
  81489. clone(): Vector3;
  81490. /**
  81491. * Copies the given vector coordinates to the current Vector3 ones
  81492. * @param source defines the source Vector3
  81493. * @returns the current updated Vector3
  81494. */
  81495. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  81496. /**
  81497. * Copies the given floats to the current Vector3 coordinates
  81498. * @param x defines the x coordinate of the operand
  81499. * @param y defines the y coordinate of the operand
  81500. * @param z defines the z coordinate of the operand
  81501. * @returns the current updated Vector3
  81502. */
  81503. copyFromFloats(x: number, y: number, z: number): Vector3;
  81504. /**
  81505. * Copies the given floats to the current Vector3 coordinates
  81506. * @param x defines the x coordinate of the operand
  81507. * @param y defines the y coordinate of the operand
  81508. * @param z defines the z coordinate of the operand
  81509. * @returns the current updated Vector3
  81510. */
  81511. set(x: number, y: number, z: number): Vector3;
  81512. /**
  81513. * Copies the given float to the current Vector3 coordinates
  81514. * @param v defines the x, y and z coordinates of the operand
  81515. * @returns the current updated Vector3
  81516. */
  81517. setAll(v: number): Vector3;
  81518. /**
  81519. * Get the clip factor between two vectors
  81520. * @param vector0 defines the first operand
  81521. * @param vector1 defines the second operand
  81522. * @param axis defines the axis to use
  81523. * @param size defines the size along the axis
  81524. * @returns the clip factor
  81525. */
  81526. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  81527. /**
  81528. * Get angle between two vectors
  81529. * @param vector0 angle between vector0 and vector1
  81530. * @param vector1 angle between vector0 and vector1
  81531. * @param normal direction of the normal
  81532. * @return the angle between vector0 and vector1
  81533. */
  81534. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  81535. /**
  81536. * Returns a new Vector3 set from the index "offset" of the given array
  81537. * @param array defines the source array
  81538. * @param offset defines the offset in the source array
  81539. * @returns the new Vector3
  81540. */
  81541. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  81542. /**
  81543. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  81544. * @param array defines the source array
  81545. * @param offset defines the offset in the source array
  81546. * @returns the new Vector3
  81547. * @deprecated Please use FromArray instead.
  81548. */
  81549. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  81550. /**
  81551. * Sets the given vector "result" with the element values from the index "offset" of the given array
  81552. * @param array defines the source array
  81553. * @param offset defines the offset in the source array
  81554. * @param result defines the Vector3 where to store the result
  81555. */
  81556. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  81557. /**
  81558. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  81559. * @param array defines the source array
  81560. * @param offset defines the offset in the source array
  81561. * @param result defines the Vector3 where to store the result
  81562. * @deprecated Please use FromArrayToRef instead.
  81563. */
  81564. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  81565. /**
  81566. * Sets the given vector "result" with the given floats.
  81567. * @param x defines the x coordinate of the source
  81568. * @param y defines the y coordinate of the source
  81569. * @param z defines the z coordinate of the source
  81570. * @param result defines the Vector3 where to store the result
  81571. */
  81572. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  81573. /**
  81574. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  81575. * @returns a new empty Vector3
  81576. */
  81577. static Zero(): Vector3;
  81578. /**
  81579. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  81580. * @returns a new unit Vector3
  81581. */
  81582. static One(): Vector3;
  81583. /**
  81584. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  81585. * @returns a new up Vector3
  81586. */
  81587. static Up(): Vector3;
  81588. /**
  81589. * Gets a up Vector3 that must not be updated
  81590. */
  81591. static get UpReadOnly(): DeepImmutable<Vector3>;
  81592. /**
  81593. * Gets a zero Vector3 that must not be updated
  81594. */
  81595. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  81596. /**
  81597. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  81598. * @returns a new down Vector3
  81599. */
  81600. static Down(): Vector3;
  81601. /**
  81602. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  81603. * @param rightHandedSystem is the scene right-handed (negative z)
  81604. * @returns a new forward Vector3
  81605. */
  81606. static Forward(rightHandedSystem?: boolean): Vector3;
  81607. /**
  81608. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  81609. * @param rightHandedSystem is the scene right-handed (negative-z)
  81610. * @returns a new forward Vector3
  81611. */
  81612. static Backward(rightHandedSystem?: boolean): Vector3;
  81613. /**
  81614. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  81615. * @returns a new right Vector3
  81616. */
  81617. static Right(): Vector3;
  81618. /**
  81619. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  81620. * @returns a new left Vector3
  81621. */
  81622. static Left(): Vector3;
  81623. /**
  81624. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  81625. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  81626. * @param vector defines the Vector3 to transform
  81627. * @param transformation defines the transformation matrix
  81628. * @returns the transformed Vector3
  81629. */
  81630. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  81631. /**
  81632. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  81633. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  81634. * @param vector defines the Vector3 to transform
  81635. * @param transformation defines the transformation matrix
  81636. * @param result defines the Vector3 where to store the result
  81637. */
  81638. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81639. /**
  81640. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  81641. * This method computes tranformed coordinates only, not transformed direction vectors
  81642. * @param x define the x coordinate of the source vector
  81643. * @param y define the y coordinate of the source vector
  81644. * @param z define the z coordinate of the source vector
  81645. * @param transformation defines the transformation matrix
  81646. * @param result defines the Vector3 where to store the result
  81647. */
  81648. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81649. /**
  81650. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  81651. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81652. * @param vector defines the Vector3 to transform
  81653. * @param transformation defines the transformation matrix
  81654. * @returns the new Vector3
  81655. */
  81656. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  81657. /**
  81658. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  81659. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81660. * @param vector defines the Vector3 to transform
  81661. * @param transformation defines the transformation matrix
  81662. * @param result defines the Vector3 where to store the result
  81663. */
  81664. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81665. /**
  81666. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  81667. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81668. * @param x define the x coordinate of the source vector
  81669. * @param y define the y coordinate of the source vector
  81670. * @param z define the z coordinate of the source vector
  81671. * @param transformation defines the transformation matrix
  81672. * @param result defines the Vector3 where to store the result
  81673. */
  81674. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81675. /**
  81676. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  81677. * @param value1 defines the first control point
  81678. * @param value2 defines the second control point
  81679. * @param value3 defines the third control point
  81680. * @param value4 defines the fourth control point
  81681. * @param amount defines the amount on the spline to use
  81682. * @returns the new Vector3
  81683. */
  81684. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  81685. /**
  81686. * 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"
  81687. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  81688. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  81689. * @param value defines the current value
  81690. * @param min defines the lower range value
  81691. * @param max defines the upper range value
  81692. * @returns the new Vector3
  81693. */
  81694. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  81695. /**
  81696. * 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"
  81697. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  81698. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  81699. * @param value defines the current value
  81700. * @param min defines the lower range value
  81701. * @param max defines the upper range value
  81702. * @param result defines the Vector3 where to store the result
  81703. */
  81704. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  81705. /**
  81706. * Checks if a given vector is inside a specific range
  81707. * @param v defines the vector to test
  81708. * @param min defines the minimum range
  81709. * @param max defines the maximum range
  81710. */
  81711. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  81712. /**
  81713. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  81714. * @param value1 defines the first control point
  81715. * @param tangent1 defines the first tangent vector
  81716. * @param value2 defines the second control point
  81717. * @param tangent2 defines the second tangent vector
  81718. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  81719. * @returns the new Vector3
  81720. */
  81721. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  81722. /**
  81723. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  81724. * @param start defines the start value
  81725. * @param end defines the end value
  81726. * @param amount max defines amount between both (between 0 and 1)
  81727. * @returns the new Vector3
  81728. */
  81729. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  81730. /**
  81731. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  81732. * @param start defines the start value
  81733. * @param end defines the end value
  81734. * @param amount max defines amount between both (between 0 and 1)
  81735. * @param result defines the Vector3 where to store the result
  81736. */
  81737. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  81738. /**
  81739. * Returns the dot product (float) between the vectors "left" and "right"
  81740. * @param left defines the left operand
  81741. * @param right defines the right operand
  81742. * @returns the dot product
  81743. */
  81744. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  81745. /**
  81746. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  81747. * The cross product is then orthogonal to both "left" and "right"
  81748. * @param left defines the left operand
  81749. * @param right defines the right operand
  81750. * @returns the cross product
  81751. */
  81752. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81753. /**
  81754. * Sets the given vector "result" with the cross product of "left" and "right"
  81755. * The cross product is then orthogonal to both "left" and "right"
  81756. * @param left defines the left operand
  81757. * @param right defines the right operand
  81758. * @param result defines the Vector3 where to store the result
  81759. */
  81760. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  81761. /**
  81762. * Returns a new Vector3 as the normalization of the given vector
  81763. * @param vector defines the Vector3 to normalize
  81764. * @returns the new Vector3
  81765. */
  81766. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  81767. /**
  81768. * Sets the given vector "result" with the normalization of the given first vector
  81769. * @param vector defines the Vector3 to normalize
  81770. * @param result defines the Vector3 where to store the result
  81771. */
  81772. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  81773. /**
  81774. * Project a Vector3 onto screen space
  81775. * @param vector defines the Vector3 to project
  81776. * @param world defines the world matrix to use
  81777. * @param transform defines the transform (view x projection) matrix to use
  81778. * @param viewport defines the screen viewport to use
  81779. * @returns the new Vector3
  81780. */
  81781. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  81782. /** @hidden */
  81783. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  81784. /**
  81785. * Unproject from screen space to object space
  81786. * @param source defines the screen space Vector3 to use
  81787. * @param viewportWidth defines the current width of the viewport
  81788. * @param viewportHeight defines the current height of the viewport
  81789. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81790. * @param transform defines the transform (view x projection) matrix to use
  81791. * @returns the new Vector3
  81792. */
  81793. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  81794. /**
  81795. * Unproject from screen space to object space
  81796. * @param source defines the screen space Vector3 to use
  81797. * @param viewportWidth defines the current width of the viewport
  81798. * @param viewportHeight defines the current height of the viewport
  81799. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81800. * @param view defines the view matrix to use
  81801. * @param projection defines the projection matrix to use
  81802. * @returns the new Vector3
  81803. */
  81804. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  81805. /**
  81806. * Unproject from screen space to object space
  81807. * @param source defines the screen space Vector3 to use
  81808. * @param viewportWidth defines the current width of the viewport
  81809. * @param viewportHeight defines the current height of the viewport
  81810. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81811. * @param view defines the view matrix to use
  81812. * @param projection defines the projection matrix to use
  81813. * @param result defines the Vector3 where to store the result
  81814. */
  81815. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  81816. /**
  81817. * Unproject from screen space to object space
  81818. * @param sourceX defines the screen space x coordinate to use
  81819. * @param sourceY defines the screen space y coordinate to use
  81820. * @param sourceZ defines the screen space z coordinate to use
  81821. * @param viewportWidth defines the current width of the viewport
  81822. * @param viewportHeight defines the current height of the viewport
  81823. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81824. * @param view defines the view matrix to use
  81825. * @param projection defines the projection matrix to use
  81826. * @param result defines the Vector3 where to store the result
  81827. */
  81828. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  81829. /**
  81830. * Gets the minimal coordinate values between two Vector3
  81831. * @param left defines the first operand
  81832. * @param right defines the second operand
  81833. * @returns the new Vector3
  81834. */
  81835. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81836. /**
  81837. * Gets the maximal coordinate values between two Vector3
  81838. * @param left defines the first operand
  81839. * @param right defines the second operand
  81840. * @returns the new Vector3
  81841. */
  81842. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81843. /**
  81844. * Returns the distance between the vectors "value1" and "value2"
  81845. * @param value1 defines the first operand
  81846. * @param value2 defines the second operand
  81847. * @returns the distance
  81848. */
  81849. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  81850. /**
  81851. * Returns the squared distance between the vectors "value1" and "value2"
  81852. * @param value1 defines the first operand
  81853. * @param value2 defines the second operand
  81854. * @returns the squared distance
  81855. */
  81856. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  81857. /**
  81858. * Returns a new Vector3 located at the center between "value1" and "value2"
  81859. * @param value1 defines the first operand
  81860. * @param value2 defines the second operand
  81861. * @returns the new Vector3
  81862. */
  81863. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  81864. /**
  81865. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  81866. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  81867. * to something in order to rotate it from its local system to the given target system
  81868. * Note: axis1, axis2 and axis3 are normalized during this operation
  81869. * @param axis1 defines the first axis
  81870. * @param axis2 defines the second axis
  81871. * @param axis3 defines the third axis
  81872. * @returns a new Vector3
  81873. */
  81874. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  81875. /**
  81876. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  81877. * @param axis1 defines the first axis
  81878. * @param axis2 defines the second axis
  81879. * @param axis3 defines the third axis
  81880. * @param ref defines the Vector3 where to store the result
  81881. */
  81882. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  81883. }
  81884. /**
  81885. * Vector4 class created for EulerAngle class conversion to Quaternion
  81886. */
  81887. export class Vector4 {
  81888. /** x value of the vector */
  81889. x: number;
  81890. /** y value of the vector */
  81891. y: number;
  81892. /** z value of the vector */
  81893. z: number;
  81894. /** w value of the vector */
  81895. w: number;
  81896. /**
  81897. * Creates a Vector4 object from the given floats.
  81898. * @param x x value of the vector
  81899. * @param y y value of the vector
  81900. * @param z z value of the vector
  81901. * @param w w value of the vector
  81902. */
  81903. constructor(
  81904. /** x value of the vector */
  81905. x: number,
  81906. /** y value of the vector */
  81907. y: number,
  81908. /** z value of the vector */
  81909. z: number,
  81910. /** w value of the vector */
  81911. w: number);
  81912. /**
  81913. * Returns the string with the Vector4 coordinates.
  81914. * @returns a string containing all the vector values
  81915. */
  81916. toString(): string;
  81917. /**
  81918. * Returns the string "Vector4".
  81919. * @returns "Vector4"
  81920. */
  81921. getClassName(): string;
  81922. /**
  81923. * Returns the Vector4 hash code.
  81924. * @returns a unique hash code
  81925. */
  81926. getHashCode(): number;
  81927. /**
  81928. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  81929. * @returns the resulting array
  81930. */
  81931. asArray(): number[];
  81932. /**
  81933. * Populates the given array from the given index with the Vector4 coordinates.
  81934. * @param array array to populate
  81935. * @param index index of the array to start at (default: 0)
  81936. * @returns the Vector4.
  81937. */
  81938. toArray(array: FloatArray, index?: number): Vector4;
  81939. /**
  81940. * Update the current vector from an array
  81941. * @param array defines the destination array
  81942. * @param index defines the offset in the destination array
  81943. * @returns the current Vector3
  81944. */
  81945. fromArray(array: FloatArray, index?: number): Vector4;
  81946. /**
  81947. * Adds the given vector to the current Vector4.
  81948. * @param otherVector the vector to add
  81949. * @returns the updated Vector4.
  81950. */
  81951. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81952. /**
  81953. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  81954. * @param otherVector the vector to add
  81955. * @returns the resulting vector
  81956. */
  81957. add(otherVector: DeepImmutable<Vector4>): Vector4;
  81958. /**
  81959. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  81960. * @param otherVector the vector to add
  81961. * @param result the vector to store the result
  81962. * @returns the current Vector4.
  81963. */
  81964. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81965. /**
  81966. * Subtract in place the given vector from the current Vector4.
  81967. * @param otherVector the vector to subtract
  81968. * @returns the updated Vector4.
  81969. */
  81970. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81971. /**
  81972. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  81973. * @param otherVector the vector to add
  81974. * @returns the new vector with the result
  81975. */
  81976. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  81977. /**
  81978. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  81979. * @param otherVector the vector to subtract
  81980. * @param result the vector to store the result
  81981. * @returns the current Vector4.
  81982. */
  81983. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81984. /**
  81985. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81986. */
  81987. /**
  81988. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81989. * @param x value to subtract
  81990. * @param y value to subtract
  81991. * @param z value to subtract
  81992. * @param w value to subtract
  81993. * @returns new vector containing the result
  81994. */
  81995. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  81996. /**
  81997. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81998. * @param x value to subtract
  81999. * @param y value to subtract
  82000. * @param z value to subtract
  82001. * @param w value to subtract
  82002. * @param result the vector to store the result in
  82003. * @returns the current Vector4.
  82004. */
  82005. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82006. /**
  82007. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82008. * @returns a new vector with the negated values
  82009. */
  82010. negate(): Vector4;
  82011. /**
  82012. * Negate this vector in place
  82013. * @returns this
  82014. */
  82015. negateInPlace(): Vector4;
  82016. /**
  82017. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82018. * @param result defines the Vector3 object where to store the result
  82019. * @returns the current Vector4
  82020. */
  82021. negateToRef(result: Vector4): Vector4;
  82022. /**
  82023. * Multiplies the current Vector4 coordinates by scale (float).
  82024. * @param scale the number to scale with
  82025. * @returns the updated Vector4.
  82026. */
  82027. scaleInPlace(scale: number): Vector4;
  82028. /**
  82029. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82030. * @param scale the number to scale with
  82031. * @returns a new vector with the result
  82032. */
  82033. scale(scale: number): Vector4;
  82034. /**
  82035. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  82036. * @param scale the number to scale with
  82037. * @param result a vector to store the result in
  82038. * @returns the current Vector4.
  82039. */
  82040. scaleToRef(scale: number, result: Vector4): Vector4;
  82041. /**
  82042. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  82043. * @param scale defines the scale factor
  82044. * @param result defines the Vector4 object where to store the result
  82045. * @returns the unmodified current Vector4
  82046. */
  82047. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  82048. /**
  82049. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  82050. * @param otherVector the vector to compare against
  82051. * @returns true if they are equal
  82052. */
  82053. equals(otherVector: DeepImmutable<Vector4>): boolean;
  82054. /**
  82055. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  82056. * @param otherVector vector to compare against
  82057. * @param epsilon (Default: very small number)
  82058. * @returns true if they are equal
  82059. */
  82060. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  82061. /**
  82062. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  82063. * @param x x value to compare against
  82064. * @param y y value to compare against
  82065. * @param z z value to compare against
  82066. * @param w w value to compare against
  82067. * @returns true if equal
  82068. */
  82069. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  82070. /**
  82071. * Multiplies in place the current Vector4 by the given one.
  82072. * @param otherVector vector to multiple with
  82073. * @returns the updated Vector4.
  82074. */
  82075. multiplyInPlace(otherVector: Vector4): Vector4;
  82076. /**
  82077. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  82078. * @param otherVector vector to multiple with
  82079. * @returns resulting new vector
  82080. */
  82081. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  82082. /**
  82083. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  82084. * @param otherVector vector to multiple with
  82085. * @param result vector to store the result
  82086. * @returns the current Vector4.
  82087. */
  82088. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82089. /**
  82090. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  82091. * @param x x value multiply with
  82092. * @param y y value multiply with
  82093. * @param z z value multiply with
  82094. * @param w w value multiply with
  82095. * @returns resulting new vector
  82096. */
  82097. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  82098. /**
  82099. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  82100. * @param otherVector vector to devide with
  82101. * @returns resulting new vector
  82102. */
  82103. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  82104. /**
  82105. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  82106. * @param otherVector vector to devide with
  82107. * @param result vector to store the result
  82108. * @returns the current Vector4.
  82109. */
  82110. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82111. /**
  82112. * Divides the current Vector3 coordinates by the given ones.
  82113. * @param otherVector vector to devide with
  82114. * @returns the updated Vector3.
  82115. */
  82116. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82117. /**
  82118. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  82119. * @param other defines the second operand
  82120. * @returns the current updated Vector4
  82121. */
  82122. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82123. /**
  82124. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  82125. * @param other defines the second operand
  82126. * @returns the current updated Vector4
  82127. */
  82128. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82129. /**
  82130. * Gets a new Vector4 from current Vector4 floored values
  82131. * @returns a new Vector4
  82132. */
  82133. floor(): Vector4;
  82134. /**
  82135. * Gets a new Vector4 from current Vector3 floored values
  82136. * @returns a new Vector4
  82137. */
  82138. fract(): Vector4;
  82139. /**
  82140. * Returns the Vector4 length (float).
  82141. * @returns the length
  82142. */
  82143. length(): number;
  82144. /**
  82145. * Returns the Vector4 squared length (float).
  82146. * @returns the length squared
  82147. */
  82148. lengthSquared(): number;
  82149. /**
  82150. * Normalizes in place the Vector4.
  82151. * @returns the updated Vector4.
  82152. */
  82153. normalize(): Vector4;
  82154. /**
  82155. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  82156. * @returns this converted to a new vector3
  82157. */
  82158. toVector3(): Vector3;
  82159. /**
  82160. * Returns a new Vector4 copied from the current one.
  82161. * @returns the new cloned vector
  82162. */
  82163. clone(): Vector4;
  82164. /**
  82165. * Updates the current Vector4 with the given one coordinates.
  82166. * @param source the source vector to copy from
  82167. * @returns the updated Vector4.
  82168. */
  82169. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  82170. /**
  82171. * Updates the current Vector4 coordinates with the given floats.
  82172. * @param x float to copy from
  82173. * @param y float to copy from
  82174. * @param z float to copy from
  82175. * @param w float to copy from
  82176. * @returns the updated Vector4.
  82177. */
  82178. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82179. /**
  82180. * Updates the current Vector4 coordinates with the given floats.
  82181. * @param x float to set from
  82182. * @param y float to set from
  82183. * @param z float to set from
  82184. * @param w float to set from
  82185. * @returns the updated Vector4.
  82186. */
  82187. set(x: number, y: number, z: number, w: number): Vector4;
  82188. /**
  82189. * Copies the given float to the current Vector3 coordinates
  82190. * @param v defines the x, y, z and w coordinates of the operand
  82191. * @returns the current updated Vector3
  82192. */
  82193. setAll(v: number): Vector4;
  82194. /**
  82195. * Returns a new Vector4 set from the starting index of the given array.
  82196. * @param array the array to pull values from
  82197. * @param offset the offset into the array to start at
  82198. * @returns the new vector
  82199. */
  82200. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  82201. /**
  82202. * Updates the given vector "result" from the starting index of the given array.
  82203. * @param array the array to pull values from
  82204. * @param offset the offset into the array to start at
  82205. * @param result the vector to store the result in
  82206. */
  82207. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  82208. /**
  82209. * Updates the given vector "result" from the starting index of the given Float32Array.
  82210. * @param array the array to pull values from
  82211. * @param offset the offset into the array to start at
  82212. * @param result the vector to store the result in
  82213. */
  82214. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  82215. /**
  82216. * Updates the given vector "result" coordinates from the given floats.
  82217. * @param x float to set from
  82218. * @param y float to set from
  82219. * @param z float to set from
  82220. * @param w float to set from
  82221. * @param result the vector to the floats in
  82222. */
  82223. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  82224. /**
  82225. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  82226. * @returns the new vector
  82227. */
  82228. static Zero(): Vector4;
  82229. /**
  82230. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  82231. * @returns the new vector
  82232. */
  82233. static One(): Vector4;
  82234. /**
  82235. * Returns a new normalized Vector4 from the given one.
  82236. * @param vector the vector to normalize
  82237. * @returns the vector
  82238. */
  82239. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  82240. /**
  82241. * Updates the given vector "result" from the normalization of the given one.
  82242. * @param vector the vector to normalize
  82243. * @param result the vector to store the result in
  82244. */
  82245. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  82246. /**
  82247. * Returns a vector with the minimum values from the left and right vectors
  82248. * @param left left vector to minimize
  82249. * @param right right vector to minimize
  82250. * @returns a new vector with the minimum of the left and right vector values
  82251. */
  82252. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82253. /**
  82254. * Returns a vector with the maximum values from the left and right vectors
  82255. * @param left left vector to maximize
  82256. * @param right right vector to maximize
  82257. * @returns a new vector with the maximum of the left and right vector values
  82258. */
  82259. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82260. /**
  82261. * Returns the distance (float) between the vectors "value1" and "value2".
  82262. * @param value1 value to calulate the distance between
  82263. * @param value2 value to calulate the distance between
  82264. * @return the distance between the two vectors
  82265. */
  82266. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82267. /**
  82268. * Returns the squared distance (float) between the vectors "value1" and "value2".
  82269. * @param value1 value to calulate the distance between
  82270. * @param value2 value to calulate the distance between
  82271. * @return the distance between the two vectors squared
  82272. */
  82273. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82274. /**
  82275. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  82276. * @param value1 value to calulate the center between
  82277. * @param value2 value to calulate the center between
  82278. * @return the center between the two vectors
  82279. */
  82280. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  82281. /**
  82282. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  82283. * This methods computes transformed normalized direction vectors only.
  82284. * @param vector the vector to transform
  82285. * @param transformation the transformation matrix to apply
  82286. * @returns the new vector
  82287. */
  82288. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  82289. /**
  82290. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  82291. * This methods computes transformed normalized direction vectors only.
  82292. * @param vector the vector to transform
  82293. * @param transformation the transformation matrix to apply
  82294. * @param result the vector to store the result in
  82295. */
  82296. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82297. /**
  82298. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  82299. * This methods computes transformed normalized direction vectors only.
  82300. * @param x value to transform
  82301. * @param y value to transform
  82302. * @param z value to transform
  82303. * @param w value to transform
  82304. * @param transformation the transformation matrix to apply
  82305. * @param result the vector to store the results in
  82306. */
  82307. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82308. /**
  82309. * Creates a new Vector4 from a Vector3
  82310. * @param source defines the source data
  82311. * @param w defines the 4th component (default is 0)
  82312. * @returns a new Vector4
  82313. */
  82314. static FromVector3(source: Vector3, w?: number): Vector4;
  82315. }
  82316. /**
  82317. * Class used to store quaternion data
  82318. * @see https://en.wikipedia.org/wiki/Quaternion
  82319. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  82320. */
  82321. export class Quaternion {
  82322. /** @hidden */
  82323. _x: number;
  82324. /** @hidden */
  82325. _y: number;
  82326. /** @hidden */
  82327. _z: number;
  82328. /** @hidden */
  82329. _w: number;
  82330. /** @hidden */
  82331. _isDirty: boolean;
  82332. /** Gets or sets the x coordinate */
  82333. get x(): number;
  82334. set x(value: number);
  82335. /** Gets or sets the y coordinate */
  82336. get y(): number;
  82337. set y(value: number);
  82338. /** Gets or sets the z coordinate */
  82339. get z(): number;
  82340. set z(value: number);
  82341. /** Gets or sets the w coordinate */
  82342. get w(): number;
  82343. set w(value: number);
  82344. /**
  82345. * Creates a new Quaternion from the given floats
  82346. * @param x defines the first component (0 by default)
  82347. * @param y defines the second component (0 by default)
  82348. * @param z defines the third component (0 by default)
  82349. * @param w defines the fourth component (1.0 by default)
  82350. */
  82351. constructor(x?: number, y?: number, z?: number, w?: number);
  82352. /**
  82353. * Gets a string representation for the current quaternion
  82354. * @returns a string with the Quaternion coordinates
  82355. */
  82356. toString(): string;
  82357. /**
  82358. * Gets the class name of the quaternion
  82359. * @returns the string "Quaternion"
  82360. */
  82361. getClassName(): string;
  82362. /**
  82363. * Gets a hash code for this quaternion
  82364. * @returns the quaternion hash code
  82365. */
  82366. getHashCode(): number;
  82367. /**
  82368. * Copy the quaternion to an array
  82369. * @returns a new array populated with 4 elements from the quaternion coordinates
  82370. */
  82371. asArray(): number[];
  82372. /**
  82373. * Check if two quaternions are equals
  82374. * @param otherQuaternion defines the second operand
  82375. * @return true if the current quaternion and the given one coordinates are strictly equals
  82376. */
  82377. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  82378. /**
  82379. * Gets a boolean if two quaternions are equals (using an epsilon value)
  82380. * @param otherQuaternion defines the other quaternion
  82381. * @param epsilon defines the minimal distance to consider equality
  82382. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  82383. */
  82384. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  82385. /**
  82386. * Clone the current quaternion
  82387. * @returns a new quaternion copied from the current one
  82388. */
  82389. clone(): Quaternion;
  82390. /**
  82391. * Copy a quaternion to the current one
  82392. * @param other defines the other quaternion
  82393. * @returns the updated current quaternion
  82394. */
  82395. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  82396. /**
  82397. * Updates the current quaternion with the given float coordinates
  82398. * @param x defines the x coordinate
  82399. * @param y defines the y coordinate
  82400. * @param z defines the z coordinate
  82401. * @param w defines the w coordinate
  82402. * @returns the updated current quaternion
  82403. */
  82404. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  82405. /**
  82406. * Updates the current quaternion from the given float coordinates
  82407. * @param x defines the x coordinate
  82408. * @param y defines the y coordinate
  82409. * @param z defines the z coordinate
  82410. * @param w defines the w coordinate
  82411. * @returns the updated current quaternion
  82412. */
  82413. set(x: number, y: number, z: number, w: number): Quaternion;
  82414. /**
  82415. * Adds two quaternions
  82416. * @param other defines the second operand
  82417. * @returns a new quaternion as the addition result of the given one and the current quaternion
  82418. */
  82419. add(other: DeepImmutable<Quaternion>): Quaternion;
  82420. /**
  82421. * Add a quaternion to the current one
  82422. * @param other defines the quaternion to add
  82423. * @returns the current quaternion
  82424. */
  82425. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  82426. /**
  82427. * Subtract two quaternions
  82428. * @param other defines the second operand
  82429. * @returns a new quaternion as the subtraction result of the given one from the current one
  82430. */
  82431. subtract(other: Quaternion): Quaternion;
  82432. /**
  82433. * Multiplies the current quaternion by a scale factor
  82434. * @param value defines the scale factor
  82435. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  82436. */
  82437. scale(value: number): Quaternion;
  82438. /**
  82439. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  82440. * @param scale defines the scale factor
  82441. * @param result defines the Quaternion object where to store the result
  82442. * @returns the unmodified current quaternion
  82443. */
  82444. scaleToRef(scale: number, result: Quaternion): Quaternion;
  82445. /**
  82446. * Multiplies in place the current quaternion by a scale factor
  82447. * @param value defines the scale factor
  82448. * @returns the current modified quaternion
  82449. */
  82450. scaleInPlace(value: number): Quaternion;
  82451. /**
  82452. * Scale the current quaternion values by a factor and add the result to a given quaternion
  82453. * @param scale defines the scale factor
  82454. * @param result defines the Quaternion object where to store the result
  82455. * @returns the unmodified current quaternion
  82456. */
  82457. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  82458. /**
  82459. * Multiplies two quaternions
  82460. * @param q1 defines the second operand
  82461. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  82462. */
  82463. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  82464. /**
  82465. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  82466. * @param q1 defines the second operand
  82467. * @param result defines the target quaternion
  82468. * @returns the current quaternion
  82469. */
  82470. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  82471. /**
  82472. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  82473. * @param q1 defines the second operand
  82474. * @returns the currentupdated quaternion
  82475. */
  82476. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  82477. /**
  82478. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  82479. * @param ref defines the target quaternion
  82480. * @returns the current quaternion
  82481. */
  82482. conjugateToRef(ref: Quaternion): Quaternion;
  82483. /**
  82484. * Conjugates in place (1-q) the current quaternion
  82485. * @returns the current updated quaternion
  82486. */
  82487. conjugateInPlace(): Quaternion;
  82488. /**
  82489. * Conjugates in place (1-q) the current quaternion
  82490. * @returns a new quaternion
  82491. */
  82492. conjugate(): Quaternion;
  82493. /**
  82494. * Gets length of current quaternion
  82495. * @returns the quaternion length (float)
  82496. */
  82497. length(): number;
  82498. /**
  82499. * Normalize in place the current quaternion
  82500. * @returns the current updated quaternion
  82501. */
  82502. normalize(): Quaternion;
  82503. /**
  82504. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  82505. * @param order is a reserved parameter and is ignore for now
  82506. * @returns a new Vector3 containing the Euler angles
  82507. */
  82508. toEulerAngles(order?: string): Vector3;
  82509. /**
  82510. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  82511. * @param result defines the vector which will be filled with the Euler angles
  82512. * @param order is a reserved parameter and is ignore for now
  82513. * @returns the current unchanged quaternion
  82514. */
  82515. toEulerAnglesToRef(result: Vector3): Quaternion;
  82516. /**
  82517. * Updates the given rotation matrix with the current quaternion values
  82518. * @param result defines the target matrix
  82519. * @returns the current unchanged quaternion
  82520. */
  82521. toRotationMatrix(result: Matrix): Quaternion;
  82522. /**
  82523. * Updates the current quaternion from the given rotation matrix values
  82524. * @param matrix defines the source matrix
  82525. * @returns the current updated quaternion
  82526. */
  82527. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  82528. /**
  82529. * Creates a new quaternion from a rotation matrix
  82530. * @param matrix defines the source matrix
  82531. * @returns a new quaternion created from the given rotation matrix values
  82532. */
  82533. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  82534. /**
  82535. * Updates the given quaternion with the given rotation matrix values
  82536. * @param matrix defines the source matrix
  82537. * @param result defines the target quaternion
  82538. */
  82539. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  82540. /**
  82541. * Returns the dot product (float) between the quaternions "left" and "right"
  82542. * @param left defines the left operand
  82543. * @param right defines the right operand
  82544. * @returns the dot product
  82545. */
  82546. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  82547. /**
  82548. * Checks if the two quaternions are close to each other
  82549. * @param quat0 defines the first quaternion to check
  82550. * @param quat1 defines the second quaternion to check
  82551. * @returns true if the two quaternions are close to each other
  82552. */
  82553. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  82554. /**
  82555. * Creates an empty quaternion
  82556. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  82557. */
  82558. static Zero(): Quaternion;
  82559. /**
  82560. * Inverse a given quaternion
  82561. * @param q defines the source quaternion
  82562. * @returns a new quaternion as the inverted current quaternion
  82563. */
  82564. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  82565. /**
  82566. * Inverse a given quaternion
  82567. * @param q defines the source quaternion
  82568. * @param result the quaternion the result will be stored in
  82569. * @returns the result quaternion
  82570. */
  82571. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  82572. /**
  82573. * Creates an identity quaternion
  82574. * @returns the identity quaternion
  82575. */
  82576. static Identity(): Quaternion;
  82577. /**
  82578. * Gets a boolean indicating if the given quaternion is identity
  82579. * @param quaternion defines the quaternion to check
  82580. * @returns true if the quaternion is identity
  82581. */
  82582. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  82583. /**
  82584. * Creates a quaternion from a rotation around an axis
  82585. * @param axis defines the axis to use
  82586. * @param angle defines the angle to use
  82587. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  82588. */
  82589. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  82590. /**
  82591. * Creates a rotation around an axis and stores it into the given quaternion
  82592. * @param axis defines the axis to use
  82593. * @param angle defines the angle to use
  82594. * @param result defines the target quaternion
  82595. * @returns the target quaternion
  82596. */
  82597. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  82598. /**
  82599. * Creates a new quaternion from data stored into an array
  82600. * @param array defines the data source
  82601. * @param offset defines the offset in the source array where the data starts
  82602. * @returns a new quaternion
  82603. */
  82604. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  82605. /**
  82606. * Updates the given quaternion "result" from the starting index of the given array.
  82607. * @param array the array to pull values from
  82608. * @param offset the offset into the array to start at
  82609. * @param result the quaternion to store the result in
  82610. */
  82611. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  82612. /**
  82613. * Create a quaternion from Euler rotation angles
  82614. * @param x Pitch
  82615. * @param y Yaw
  82616. * @param z Roll
  82617. * @returns the new Quaternion
  82618. */
  82619. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  82620. /**
  82621. * Updates a quaternion from Euler rotation angles
  82622. * @param x Pitch
  82623. * @param y Yaw
  82624. * @param z Roll
  82625. * @param result the quaternion to store the result
  82626. * @returns the updated quaternion
  82627. */
  82628. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  82629. /**
  82630. * Create a quaternion from Euler rotation vector
  82631. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  82632. * @returns the new Quaternion
  82633. */
  82634. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  82635. /**
  82636. * Updates a quaternion from Euler rotation vector
  82637. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  82638. * @param result the quaternion to store the result
  82639. * @returns the updated quaternion
  82640. */
  82641. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  82642. /**
  82643. * Creates a new quaternion from the given Euler float angles (y, x, z)
  82644. * @param yaw defines the rotation around Y axis
  82645. * @param pitch defines the rotation around X axis
  82646. * @param roll defines the rotation around Z axis
  82647. * @returns the new quaternion
  82648. */
  82649. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  82650. /**
  82651. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  82652. * @param yaw defines the rotation around Y axis
  82653. * @param pitch defines the rotation around X axis
  82654. * @param roll defines the rotation around Z axis
  82655. * @param result defines the target quaternion
  82656. */
  82657. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  82658. /**
  82659. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  82660. * @param alpha defines the rotation around first axis
  82661. * @param beta defines the rotation around second axis
  82662. * @param gamma defines the rotation around third axis
  82663. * @returns the new quaternion
  82664. */
  82665. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  82666. /**
  82667. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  82668. * @param alpha defines the rotation around first axis
  82669. * @param beta defines the rotation around second axis
  82670. * @param gamma defines the rotation around third axis
  82671. * @param result defines the target quaternion
  82672. */
  82673. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  82674. /**
  82675. * 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)
  82676. * @param axis1 defines the first axis
  82677. * @param axis2 defines the second axis
  82678. * @param axis3 defines the third axis
  82679. * @returns the new quaternion
  82680. */
  82681. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  82682. /**
  82683. * 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
  82684. * @param axis1 defines the first axis
  82685. * @param axis2 defines the second axis
  82686. * @param axis3 defines the third axis
  82687. * @param ref defines the target quaternion
  82688. */
  82689. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  82690. /**
  82691. * Interpolates between two quaternions
  82692. * @param left defines first quaternion
  82693. * @param right defines second quaternion
  82694. * @param amount defines the gradient to use
  82695. * @returns the new interpolated quaternion
  82696. */
  82697. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  82698. /**
  82699. * Interpolates between two quaternions and stores it into a target quaternion
  82700. * @param left defines first quaternion
  82701. * @param right defines second quaternion
  82702. * @param amount defines the gradient to use
  82703. * @param result defines the target quaternion
  82704. */
  82705. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  82706. /**
  82707. * Interpolate between two quaternions using Hermite interpolation
  82708. * @param value1 defines first quaternion
  82709. * @param tangent1 defines the incoming tangent
  82710. * @param value2 defines second quaternion
  82711. * @param tangent2 defines the outgoing tangent
  82712. * @param amount defines the target quaternion
  82713. * @returns the new interpolated quaternion
  82714. */
  82715. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  82716. }
  82717. /**
  82718. * Class used to store matrix data (4x4)
  82719. */
  82720. export class Matrix {
  82721. /**
  82722. * Gets the precision of matrix computations
  82723. */
  82724. static get Use64Bits(): boolean;
  82725. private static _updateFlagSeed;
  82726. private static _identityReadOnly;
  82727. private _isIdentity;
  82728. private _isIdentityDirty;
  82729. private _isIdentity3x2;
  82730. private _isIdentity3x2Dirty;
  82731. /**
  82732. * Gets the update flag of the matrix which is an unique number for the matrix.
  82733. * It will be incremented every time the matrix data change.
  82734. * You can use it to speed the comparison between two versions of the same matrix.
  82735. */
  82736. updateFlag: number;
  82737. private readonly _m;
  82738. /**
  82739. * Gets the internal data of the matrix
  82740. */
  82741. get m(): DeepImmutable<Float32Array | Array<number>>;
  82742. /** @hidden */
  82743. _markAsUpdated(): void;
  82744. /** @hidden */
  82745. private _updateIdentityStatus;
  82746. /**
  82747. * Creates an empty matrix (filled with zeros)
  82748. */
  82749. constructor();
  82750. /**
  82751. * Check if the current matrix is identity
  82752. * @returns true is the matrix is the identity matrix
  82753. */
  82754. isIdentity(): boolean;
  82755. /**
  82756. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  82757. * @returns true is the matrix is the identity matrix
  82758. */
  82759. isIdentityAs3x2(): boolean;
  82760. /**
  82761. * Gets the determinant of the matrix
  82762. * @returns the matrix determinant
  82763. */
  82764. determinant(): number;
  82765. /**
  82766. * Returns the matrix as a Float32Array or Array<number>
  82767. * @returns the matrix underlying array
  82768. */
  82769. toArray(): DeepImmutable<Float32Array | Array<number>>;
  82770. /**
  82771. * Returns the matrix as a Float32Array or Array<number>
  82772. * @returns the matrix underlying array.
  82773. */
  82774. asArray(): DeepImmutable<Float32Array | Array<number>>;
  82775. /**
  82776. * Inverts the current matrix in place
  82777. * @returns the current inverted matrix
  82778. */
  82779. invert(): Matrix;
  82780. /**
  82781. * Sets all the matrix elements to zero
  82782. * @returns the current matrix
  82783. */
  82784. reset(): Matrix;
  82785. /**
  82786. * Adds the current matrix with a second one
  82787. * @param other defines the matrix to add
  82788. * @returns a new matrix as the addition of the current matrix and the given one
  82789. */
  82790. add(other: DeepImmutable<Matrix>): Matrix;
  82791. /**
  82792. * Sets the given matrix "result" to the addition of the current matrix and the given one
  82793. * @param other defines the matrix to add
  82794. * @param result defines the target matrix
  82795. * @returns the current matrix
  82796. */
  82797. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  82798. /**
  82799. * Adds in place the given matrix to the current matrix
  82800. * @param other defines the second operand
  82801. * @returns the current updated matrix
  82802. */
  82803. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  82804. /**
  82805. * Sets the given matrix to the current inverted Matrix
  82806. * @param other defines the target matrix
  82807. * @returns the unmodified current matrix
  82808. */
  82809. invertToRef(other: Matrix): Matrix;
  82810. /**
  82811. * add a value at the specified position in the current Matrix
  82812. * @param index the index of the value within the matrix. between 0 and 15.
  82813. * @param value the value to be added
  82814. * @returns the current updated matrix
  82815. */
  82816. addAtIndex(index: number, value: number): Matrix;
  82817. /**
  82818. * mutiply the specified position in the current Matrix by a value
  82819. * @param index the index of the value within the matrix. between 0 and 15.
  82820. * @param value the value to be added
  82821. * @returns the current updated matrix
  82822. */
  82823. multiplyAtIndex(index: number, value: number): Matrix;
  82824. /**
  82825. * Inserts the translation vector (using 3 floats) in the current matrix
  82826. * @param x defines the 1st component of the translation
  82827. * @param y defines the 2nd component of the translation
  82828. * @param z defines the 3rd component of the translation
  82829. * @returns the current updated matrix
  82830. */
  82831. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  82832. /**
  82833. * Adds the translation vector (using 3 floats) in the current matrix
  82834. * @param x defines the 1st component of the translation
  82835. * @param y defines the 2nd component of the translation
  82836. * @param z defines the 3rd component of the translation
  82837. * @returns the current updated matrix
  82838. */
  82839. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  82840. /**
  82841. * Inserts the translation vector in the current matrix
  82842. * @param vector3 defines the translation to insert
  82843. * @returns the current updated matrix
  82844. */
  82845. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  82846. /**
  82847. * Gets the translation value of the current matrix
  82848. * @returns a new Vector3 as the extracted translation from the matrix
  82849. */
  82850. getTranslation(): Vector3;
  82851. /**
  82852. * Fill a Vector3 with the extracted translation from the matrix
  82853. * @param result defines the Vector3 where to store the translation
  82854. * @returns the current matrix
  82855. */
  82856. getTranslationToRef(result: Vector3): Matrix;
  82857. /**
  82858. * Remove rotation and scaling part from the matrix
  82859. * @returns the updated matrix
  82860. */
  82861. removeRotationAndScaling(): Matrix;
  82862. /**
  82863. * Multiply two matrices
  82864. * @param other defines the second operand
  82865. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  82866. */
  82867. multiply(other: DeepImmutable<Matrix>): Matrix;
  82868. /**
  82869. * Copy the current matrix from the given one
  82870. * @param other defines the source matrix
  82871. * @returns the current updated matrix
  82872. */
  82873. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  82874. /**
  82875. * Populates the given array from the starting index with the current matrix values
  82876. * @param array defines the target array
  82877. * @param offset defines the offset in the target array where to start storing values
  82878. * @returns the current matrix
  82879. */
  82880. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  82881. /**
  82882. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  82883. * @param other defines the second operand
  82884. * @param result defines the matrix where to store the multiplication
  82885. * @returns the current matrix
  82886. */
  82887. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  82888. /**
  82889. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  82890. * @param other defines the second operand
  82891. * @param result defines the array where to store the multiplication
  82892. * @param offset defines the offset in the target array where to start storing values
  82893. * @returns the current matrix
  82894. */
  82895. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  82896. /**
  82897. * Check equality between this matrix and a second one
  82898. * @param value defines the second matrix to compare
  82899. * @returns true is the current matrix and the given one values are strictly equal
  82900. */
  82901. equals(value: DeepImmutable<Matrix>): boolean;
  82902. /**
  82903. * Clone the current matrix
  82904. * @returns a new matrix from the current matrix
  82905. */
  82906. clone(): Matrix;
  82907. /**
  82908. * Returns the name of the current matrix class
  82909. * @returns the string "Matrix"
  82910. */
  82911. getClassName(): string;
  82912. /**
  82913. * Gets the hash code of the current matrix
  82914. * @returns the hash code
  82915. */
  82916. getHashCode(): number;
  82917. /**
  82918. * Decomposes the current Matrix into a translation, rotation and scaling components
  82919. * @param scale defines the scale vector3 given as a reference to update
  82920. * @param rotation defines the rotation quaternion given as a reference to update
  82921. * @param translation defines the translation vector3 given as a reference to update
  82922. * @returns true if operation was successful
  82923. */
  82924. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  82925. /**
  82926. * Gets specific row of the matrix
  82927. * @param index defines the number of the row to get
  82928. * @returns the index-th row of the current matrix as a new Vector4
  82929. */
  82930. getRow(index: number): Nullable<Vector4>;
  82931. /**
  82932. * Sets the index-th row of the current matrix to the vector4 values
  82933. * @param index defines the number of the row to set
  82934. * @param row defines the target vector4
  82935. * @returns the updated current matrix
  82936. */
  82937. setRow(index: number, row: Vector4): Matrix;
  82938. /**
  82939. * Compute the transpose of the matrix
  82940. * @returns the new transposed matrix
  82941. */
  82942. transpose(): Matrix;
  82943. /**
  82944. * Compute the transpose of the matrix and store it in a given matrix
  82945. * @param result defines the target matrix
  82946. * @returns the current matrix
  82947. */
  82948. transposeToRef(result: Matrix): Matrix;
  82949. /**
  82950. * Sets the index-th row of the current matrix with the given 4 x float values
  82951. * @param index defines the row index
  82952. * @param x defines the x component to set
  82953. * @param y defines the y component to set
  82954. * @param z defines the z component to set
  82955. * @param w defines the w component to set
  82956. * @returns the updated current matrix
  82957. */
  82958. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  82959. /**
  82960. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  82961. * @param scale defines the scale factor
  82962. * @returns a new matrix
  82963. */
  82964. scale(scale: number): Matrix;
  82965. /**
  82966. * Scale the current matrix values by a factor to a given result matrix
  82967. * @param scale defines the scale factor
  82968. * @param result defines the matrix to store the result
  82969. * @returns the current matrix
  82970. */
  82971. scaleToRef(scale: number, result: Matrix): Matrix;
  82972. /**
  82973. * Scale the current matrix values by a factor and add the result to a given matrix
  82974. * @param scale defines the scale factor
  82975. * @param result defines the Matrix to store the result
  82976. * @returns the current matrix
  82977. */
  82978. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  82979. /**
  82980. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  82981. * @param ref matrix to store the result
  82982. */
  82983. toNormalMatrix(ref: Matrix): void;
  82984. /**
  82985. * Gets only rotation part of the current matrix
  82986. * @returns a new matrix sets to the extracted rotation matrix from the current one
  82987. */
  82988. getRotationMatrix(): Matrix;
  82989. /**
  82990. * Extracts the rotation matrix from the current one and sets it as the given "result"
  82991. * @param result defines the target matrix to store data to
  82992. * @returns the current matrix
  82993. */
  82994. getRotationMatrixToRef(result: Matrix): Matrix;
  82995. /**
  82996. * Toggles model matrix from being right handed to left handed in place and vice versa
  82997. */
  82998. toggleModelMatrixHandInPlace(): void;
  82999. /**
  83000. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83001. */
  83002. toggleProjectionMatrixHandInPlace(): void;
  83003. /**
  83004. * Creates a matrix from an array
  83005. * @param array defines the source array
  83006. * @param offset defines an offset in the source array
  83007. * @returns a new Matrix set from the starting index of the given array
  83008. */
  83009. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83010. /**
  83011. * Copy the content of an array into a given matrix
  83012. * @param array defines the source array
  83013. * @param offset defines an offset in the source array
  83014. * @param result defines the target matrix
  83015. */
  83016. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83017. /**
  83018. * Stores an array into a matrix after having multiplied each component by a given factor
  83019. * @param array defines the source array
  83020. * @param offset defines the offset in the source array
  83021. * @param scale defines the scaling factor
  83022. * @param result defines the target matrix
  83023. */
  83024. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83025. /**
  83026. * Gets an identity matrix that must not be updated
  83027. */
  83028. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83029. /**
  83030. * Stores a list of values (16) inside a given matrix
  83031. * @param initialM11 defines 1st value of 1st row
  83032. * @param initialM12 defines 2nd value of 1st row
  83033. * @param initialM13 defines 3rd value of 1st row
  83034. * @param initialM14 defines 4th value of 1st row
  83035. * @param initialM21 defines 1st value of 2nd row
  83036. * @param initialM22 defines 2nd value of 2nd row
  83037. * @param initialM23 defines 3rd value of 2nd row
  83038. * @param initialM24 defines 4th value of 2nd row
  83039. * @param initialM31 defines 1st value of 3rd row
  83040. * @param initialM32 defines 2nd value of 3rd row
  83041. * @param initialM33 defines 3rd value of 3rd row
  83042. * @param initialM34 defines 4th value of 3rd row
  83043. * @param initialM41 defines 1st value of 4th row
  83044. * @param initialM42 defines 2nd value of 4th row
  83045. * @param initialM43 defines 3rd value of 4th row
  83046. * @param initialM44 defines 4th value of 4th row
  83047. * @param result defines the target matrix
  83048. */
  83049. 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;
  83050. /**
  83051. * Creates new matrix from a list of values (16)
  83052. * @param initialM11 defines 1st value of 1st row
  83053. * @param initialM12 defines 2nd value of 1st row
  83054. * @param initialM13 defines 3rd value of 1st row
  83055. * @param initialM14 defines 4th value of 1st row
  83056. * @param initialM21 defines 1st value of 2nd row
  83057. * @param initialM22 defines 2nd value of 2nd row
  83058. * @param initialM23 defines 3rd value of 2nd row
  83059. * @param initialM24 defines 4th value of 2nd row
  83060. * @param initialM31 defines 1st value of 3rd row
  83061. * @param initialM32 defines 2nd value of 3rd row
  83062. * @param initialM33 defines 3rd value of 3rd row
  83063. * @param initialM34 defines 4th value of 3rd row
  83064. * @param initialM41 defines 1st value of 4th row
  83065. * @param initialM42 defines 2nd value of 4th row
  83066. * @param initialM43 defines 3rd value of 4th row
  83067. * @param initialM44 defines 4th value of 4th row
  83068. * @returns the new matrix
  83069. */
  83070. 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;
  83071. /**
  83072. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83073. * @param scale defines the scale vector3
  83074. * @param rotation defines the rotation quaternion
  83075. * @param translation defines the translation vector3
  83076. * @returns a new matrix
  83077. */
  83078. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  83079. /**
  83080. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83081. * @param scale defines the scale vector3
  83082. * @param rotation defines the rotation quaternion
  83083. * @param translation defines the translation vector3
  83084. * @param result defines the target matrix
  83085. */
  83086. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  83087. /**
  83088. * Creates a new identity matrix
  83089. * @returns a new identity matrix
  83090. */
  83091. static Identity(): Matrix;
  83092. /**
  83093. * Creates a new identity matrix and stores the result in a given matrix
  83094. * @param result defines the target matrix
  83095. */
  83096. static IdentityToRef(result: Matrix): void;
  83097. /**
  83098. * Creates a new zero matrix
  83099. * @returns a new zero matrix
  83100. */
  83101. static Zero(): Matrix;
  83102. /**
  83103. * Creates a new rotation matrix for "angle" radians around the X axis
  83104. * @param angle defines the angle (in radians) to use
  83105. * @return the new matrix
  83106. */
  83107. static RotationX(angle: number): Matrix;
  83108. /**
  83109. * Creates a new matrix as the invert of a given matrix
  83110. * @param source defines the source matrix
  83111. * @returns the new matrix
  83112. */
  83113. static Invert(source: DeepImmutable<Matrix>): Matrix;
  83114. /**
  83115. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  83116. * @param angle defines the angle (in radians) to use
  83117. * @param result defines the target matrix
  83118. */
  83119. static RotationXToRef(angle: number, result: Matrix): void;
  83120. /**
  83121. * Creates a new rotation matrix for "angle" radians around the Y axis
  83122. * @param angle defines the angle (in radians) to use
  83123. * @return the new matrix
  83124. */
  83125. static RotationY(angle: number): Matrix;
  83126. /**
  83127. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  83128. * @param angle defines the angle (in radians) to use
  83129. * @param result defines the target matrix
  83130. */
  83131. static RotationYToRef(angle: number, result: Matrix): void;
  83132. /**
  83133. * Creates a new rotation matrix for "angle" radians around the Z axis
  83134. * @param angle defines the angle (in radians) to use
  83135. * @return the new matrix
  83136. */
  83137. static RotationZ(angle: number): Matrix;
  83138. /**
  83139. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  83140. * @param angle defines the angle (in radians) to use
  83141. * @param result defines the target matrix
  83142. */
  83143. static RotationZToRef(angle: number, result: Matrix): void;
  83144. /**
  83145. * Creates a new rotation matrix for "angle" radians around the given axis
  83146. * @param axis defines the axis to use
  83147. * @param angle defines the angle (in radians) to use
  83148. * @return the new matrix
  83149. */
  83150. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  83151. /**
  83152. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  83153. * @param axis defines the axis to use
  83154. * @param angle defines the angle (in radians) to use
  83155. * @param result defines the target matrix
  83156. */
  83157. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  83158. /**
  83159. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  83160. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  83161. * @param from defines the vector to align
  83162. * @param to defines the vector to align to
  83163. * @param result defines the target matrix
  83164. */
  83165. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  83166. /**
  83167. * Creates a rotation matrix
  83168. * @param yaw defines the yaw angle in radians (Y axis)
  83169. * @param pitch defines the pitch angle in radians (X axis)
  83170. * @param roll defines the roll angle in radians (Z axis)
  83171. * @returns the new rotation matrix
  83172. */
  83173. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  83174. /**
  83175. * Creates a rotation matrix and stores it in a given matrix
  83176. * @param yaw defines the yaw angle in radians (Y axis)
  83177. * @param pitch defines the pitch angle in radians (X axis)
  83178. * @param roll defines the roll angle in radians (Z axis)
  83179. * @param result defines the target matrix
  83180. */
  83181. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  83182. /**
  83183. * Creates a scaling matrix
  83184. * @param x defines the scale factor on X axis
  83185. * @param y defines the scale factor on Y axis
  83186. * @param z defines the scale factor on Z axis
  83187. * @returns the new matrix
  83188. */
  83189. static Scaling(x: number, y: number, z: number): Matrix;
  83190. /**
  83191. * Creates a scaling matrix and stores it in a given matrix
  83192. * @param x defines the scale factor on X axis
  83193. * @param y defines the scale factor on Y axis
  83194. * @param z defines the scale factor on Z axis
  83195. * @param result defines the target matrix
  83196. */
  83197. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  83198. /**
  83199. * Creates a translation matrix
  83200. * @param x defines the translation on X axis
  83201. * @param y defines the translation on Y axis
  83202. * @param z defines the translationon Z axis
  83203. * @returns the new matrix
  83204. */
  83205. static Translation(x: number, y: number, z: number): Matrix;
  83206. /**
  83207. * Creates a translation matrix and stores it in a given matrix
  83208. * @param x defines the translation on X axis
  83209. * @param y defines the translation on Y axis
  83210. * @param z defines the translationon Z axis
  83211. * @param result defines the target matrix
  83212. */
  83213. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  83214. /**
  83215. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83216. * @param startValue defines the start value
  83217. * @param endValue defines the end value
  83218. * @param gradient defines the gradient factor
  83219. * @returns the new matrix
  83220. */
  83221. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83222. /**
  83223. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83224. * @param startValue defines the start value
  83225. * @param endValue defines the end value
  83226. * @param gradient defines the gradient factor
  83227. * @param result defines the Matrix object where to store data
  83228. */
  83229. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83230. /**
  83231. * Builds a new matrix whose values are computed by:
  83232. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83233. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83234. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83235. * @param startValue defines the first matrix
  83236. * @param endValue defines the second matrix
  83237. * @param gradient defines the gradient between the two matrices
  83238. * @returns the new matrix
  83239. */
  83240. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83241. /**
  83242. * Update a matrix to values which are computed by:
  83243. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83244. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83245. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83246. * @param startValue defines the first matrix
  83247. * @param endValue defines the second matrix
  83248. * @param gradient defines the gradient between the two matrices
  83249. * @param result defines the target matrix
  83250. */
  83251. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83252. /**
  83253. * 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"
  83254. * This function works in left handed mode
  83255. * @param eye defines the final position of the entity
  83256. * @param target defines where the entity should look at
  83257. * @param up defines the up vector for the entity
  83258. * @returns the new matrix
  83259. */
  83260. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83261. /**
  83262. * 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".
  83263. * This function works in left handed mode
  83264. * @param eye defines the final position of the entity
  83265. * @param target defines where the entity should look at
  83266. * @param up defines the up vector for the entity
  83267. * @param result defines the target matrix
  83268. */
  83269. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83270. /**
  83271. * 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"
  83272. * This function works in right handed mode
  83273. * @param eye defines the final position of the entity
  83274. * @param target defines where the entity should look at
  83275. * @param up defines the up vector for the entity
  83276. * @returns the new matrix
  83277. */
  83278. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83279. /**
  83280. * 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".
  83281. * This function works in right handed mode
  83282. * @param eye defines the final position of the entity
  83283. * @param target defines where the entity should look at
  83284. * @param up defines the up vector for the entity
  83285. * @param result defines the target matrix
  83286. */
  83287. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83288. /**
  83289. * Create a left-handed orthographic projection matrix
  83290. * @param width defines the viewport width
  83291. * @param height defines the viewport height
  83292. * @param znear defines the near clip plane
  83293. * @param zfar defines the far clip plane
  83294. * @returns a new matrix as a left-handed orthographic projection matrix
  83295. */
  83296. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83297. /**
  83298. * Store a left-handed orthographic projection to a given matrix
  83299. * @param width defines the viewport width
  83300. * @param height defines the viewport height
  83301. * @param znear defines the near clip plane
  83302. * @param zfar defines the far clip plane
  83303. * @param result defines the target matrix
  83304. */
  83305. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  83306. /**
  83307. * Create a left-handed orthographic projection matrix
  83308. * @param left defines the viewport left coordinate
  83309. * @param right defines the viewport right coordinate
  83310. * @param bottom defines the viewport bottom coordinate
  83311. * @param top defines the viewport top coordinate
  83312. * @param znear defines the near clip plane
  83313. * @param zfar defines the far clip plane
  83314. * @returns a new matrix as a left-handed orthographic projection matrix
  83315. */
  83316. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83317. /**
  83318. * Stores a left-handed orthographic projection into a given matrix
  83319. * @param left defines the viewport left coordinate
  83320. * @param right defines the viewport right coordinate
  83321. * @param bottom defines the viewport bottom coordinate
  83322. * @param top defines the viewport top coordinate
  83323. * @param znear defines the near clip plane
  83324. * @param zfar defines the far clip plane
  83325. * @param result defines the target matrix
  83326. */
  83327. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83328. /**
  83329. * Creates a right-handed orthographic projection matrix
  83330. * @param left defines the viewport left coordinate
  83331. * @param right defines the viewport right coordinate
  83332. * @param bottom defines the viewport bottom coordinate
  83333. * @param top defines the viewport top coordinate
  83334. * @param znear defines the near clip plane
  83335. * @param zfar defines the far clip plane
  83336. * @returns a new matrix as a right-handed orthographic projection matrix
  83337. */
  83338. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83339. /**
  83340. * Stores a right-handed orthographic projection into a given matrix
  83341. * @param left defines the viewport left coordinate
  83342. * @param right defines the viewport right coordinate
  83343. * @param bottom defines the viewport bottom coordinate
  83344. * @param top defines the viewport top coordinate
  83345. * @param znear defines the near clip plane
  83346. * @param zfar defines the far clip plane
  83347. * @param result defines the target matrix
  83348. */
  83349. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83350. /**
  83351. * Creates a left-handed perspective projection matrix
  83352. * @param width defines the viewport width
  83353. * @param height defines the viewport height
  83354. * @param znear defines the near clip plane
  83355. * @param zfar defines the far clip plane
  83356. * @returns a new matrix as a left-handed perspective projection matrix
  83357. */
  83358. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83359. /**
  83360. * Creates a left-handed perspective projection matrix
  83361. * @param fov defines the horizontal field of view
  83362. * @param aspect defines the aspect ratio
  83363. * @param znear defines the near clip plane
  83364. * @param zfar defines the far clip plane
  83365. * @returns a new matrix as a left-handed perspective projection matrix
  83366. */
  83367. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  83368. /**
  83369. * Stores a left-handed perspective projection into a given matrix
  83370. * @param fov defines the horizontal field of view
  83371. * @param aspect defines the aspect ratio
  83372. * @param znear defines the near clip plane
  83373. * @param zfar defines the far clip plane
  83374. * @param result defines the target matrix
  83375. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83376. */
  83377. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83378. /**
  83379. * Stores a left-handed perspective projection into a given matrix with depth reversed
  83380. * @param fov defines the horizontal field of view
  83381. * @param aspect defines the aspect ratio
  83382. * @param znear defines the near clip plane
  83383. * @param zfar not used as infinity is used as far clip
  83384. * @param result defines the target matrix
  83385. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83386. */
  83387. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83388. /**
  83389. * Creates a right-handed perspective projection matrix
  83390. * @param fov defines the horizontal field of view
  83391. * @param aspect defines the aspect ratio
  83392. * @param znear defines the near clip plane
  83393. * @param zfar defines the far clip plane
  83394. * @returns a new matrix as a right-handed perspective projection matrix
  83395. */
  83396. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  83397. /**
  83398. * Stores a right-handed perspective projection into a given matrix
  83399. * @param fov defines the horizontal field of view
  83400. * @param aspect defines the aspect ratio
  83401. * @param znear defines the near clip plane
  83402. * @param zfar defines the far clip plane
  83403. * @param result defines the target matrix
  83404. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83405. */
  83406. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83407. /**
  83408. * Stores a right-handed perspective projection into a given matrix
  83409. * @param fov defines the horizontal field of view
  83410. * @param aspect defines the aspect ratio
  83411. * @param znear defines the near clip plane
  83412. * @param zfar not used as infinity is used as far clip
  83413. * @param result defines the target matrix
  83414. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83415. */
  83416. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83417. /**
  83418. * Stores a perspective projection for WebVR info a given matrix
  83419. * @param fov defines the field of view
  83420. * @param znear defines the near clip plane
  83421. * @param zfar defines the far clip plane
  83422. * @param result defines the target matrix
  83423. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  83424. */
  83425. static PerspectiveFovWebVRToRef(fov: {
  83426. upDegrees: number;
  83427. downDegrees: number;
  83428. leftDegrees: number;
  83429. rightDegrees: number;
  83430. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  83431. /**
  83432. * Computes a complete transformation matrix
  83433. * @param viewport defines the viewport to use
  83434. * @param world defines the world matrix
  83435. * @param view defines the view matrix
  83436. * @param projection defines the projection matrix
  83437. * @param zmin defines the near clip plane
  83438. * @param zmax defines the far clip plane
  83439. * @returns the transformation matrix
  83440. */
  83441. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  83442. /**
  83443. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  83444. * @param matrix defines the matrix to use
  83445. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  83446. */
  83447. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  83448. /**
  83449. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  83450. * @param matrix defines the matrix to use
  83451. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  83452. */
  83453. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  83454. /**
  83455. * Compute the transpose of a given matrix
  83456. * @param matrix defines the matrix to transpose
  83457. * @returns the new matrix
  83458. */
  83459. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  83460. /**
  83461. * Compute the transpose of a matrix and store it in a target matrix
  83462. * @param matrix defines the matrix to transpose
  83463. * @param result defines the target matrix
  83464. */
  83465. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  83466. /**
  83467. * Computes a reflection matrix from a plane
  83468. * @param plane defines the reflection plane
  83469. * @returns a new matrix
  83470. */
  83471. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  83472. /**
  83473. * Computes a reflection matrix from a plane
  83474. * @param plane defines the reflection plane
  83475. * @param result defines the target matrix
  83476. */
  83477. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  83478. /**
  83479. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  83480. * @param xaxis defines the value of the 1st axis
  83481. * @param yaxis defines the value of the 2nd axis
  83482. * @param zaxis defines the value of the 3rd axis
  83483. * @param result defines the target matrix
  83484. */
  83485. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  83486. /**
  83487. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  83488. * @param quat defines the quaternion to use
  83489. * @param result defines the target matrix
  83490. */
  83491. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  83492. }
  83493. /**
  83494. * @hidden
  83495. */
  83496. export class TmpVectors {
  83497. static Vector2: Vector2[];
  83498. static Vector3: Vector3[];
  83499. static Vector4: Vector4[];
  83500. static Quaternion: Quaternion[];
  83501. static Matrix: Matrix[];
  83502. }
  83503. }
  83504. declare module BABYLON {
  83505. /**
  83506. * Defines potential orientation for back face culling
  83507. */
  83508. export enum Orientation {
  83509. /**
  83510. * Clockwise
  83511. */
  83512. CW = 0,
  83513. /** Counter clockwise */
  83514. CCW = 1
  83515. }
  83516. /** Class used to represent a Bezier curve */
  83517. export class BezierCurve {
  83518. /**
  83519. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  83520. * @param t defines the time
  83521. * @param x1 defines the left coordinate on X axis
  83522. * @param y1 defines the left coordinate on Y axis
  83523. * @param x2 defines the right coordinate on X axis
  83524. * @param y2 defines the right coordinate on Y axis
  83525. * @returns the interpolated value
  83526. */
  83527. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  83528. }
  83529. /**
  83530. * Defines angle representation
  83531. */
  83532. export class Angle {
  83533. private _radians;
  83534. /**
  83535. * Creates an Angle object of "radians" radians (float).
  83536. * @param radians the angle in radians
  83537. */
  83538. constructor(radians: number);
  83539. /**
  83540. * Get value in degrees
  83541. * @returns the Angle value in degrees (float)
  83542. */
  83543. degrees(): number;
  83544. /**
  83545. * Get value in radians
  83546. * @returns the Angle value in radians (float)
  83547. */
  83548. radians(): number;
  83549. /**
  83550. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  83551. * @param a defines first point as the origin
  83552. * @param b defines point
  83553. * @returns a new Angle
  83554. */
  83555. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  83556. /**
  83557. * Gets a new Angle object from the given float in radians
  83558. * @param radians defines the angle value in radians
  83559. * @returns a new Angle
  83560. */
  83561. static FromRadians(radians: number): Angle;
  83562. /**
  83563. * Gets a new Angle object from the given float in degrees
  83564. * @param degrees defines the angle value in degrees
  83565. * @returns a new Angle
  83566. */
  83567. static FromDegrees(degrees: number): Angle;
  83568. }
  83569. /**
  83570. * This represents an arc in a 2d space.
  83571. */
  83572. export class Arc2 {
  83573. /** Defines the start point of the arc */
  83574. startPoint: Vector2;
  83575. /** Defines the mid point of the arc */
  83576. midPoint: Vector2;
  83577. /** Defines the end point of the arc */
  83578. endPoint: Vector2;
  83579. /**
  83580. * Defines the center point of the arc.
  83581. */
  83582. centerPoint: Vector2;
  83583. /**
  83584. * Defines the radius of the arc.
  83585. */
  83586. radius: number;
  83587. /**
  83588. * Defines the angle of the arc (from mid point to end point).
  83589. */
  83590. angle: Angle;
  83591. /**
  83592. * Defines the start angle of the arc (from start point to middle point).
  83593. */
  83594. startAngle: Angle;
  83595. /**
  83596. * Defines the orientation of the arc (clock wise/counter clock wise).
  83597. */
  83598. orientation: Orientation;
  83599. /**
  83600. * Creates an Arc object from the three given points : start, middle and end.
  83601. * @param startPoint Defines the start point of the arc
  83602. * @param midPoint Defines the midlle point of the arc
  83603. * @param endPoint Defines the end point of the arc
  83604. */
  83605. constructor(
  83606. /** Defines the start point of the arc */
  83607. startPoint: Vector2,
  83608. /** Defines the mid point of the arc */
  83609. midPoint: Vector2,
  83610. /** Defines the end point of the arc */
  83611. endPoint: Vector2);
  83612. }
  83613. /**
  83614. * Represents a 2D path made up of multiple 2D points
  83615. */
  83616. export class Path2 {
  83617. private _points;
  83618. private _length;
  83619. /**
  83620. * If the path start and end point are the same
  83621. */
  83622. closed: boolean;
  83623. /**
  83624. * Creates a Path2 object from the starting 2D coordinates x and y.
  83625. * @param x the starting points x value
  83626. * @param y the starting points y value
  83627. */
  83628. constructor(x: number, y: number);
  83629. /**
  83630. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  83631. * @param x the added points x value
  83632. * @param y the added points y value
  83633. * @returns the updated Path2.
  83634. */
  83635. addLineTo(x: number, y: number): Path2;
  83636. /**
  83637. * 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.
  83638. * @param midX middle point x value
  83639. * @param midY middle point y value
  83640. * @param endX end point x value
  83641. * @param endY end point y value
  83642. * @param numberOfSegments (default: 36)
  83643. * @returns the updated Path2.
  83644. */
  83645. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  83646. /**
  83647. * Closes the Path2.
  83648. * @returns the Path2.
  83649. */
  83650. close(): Path2;
  83651. /**
  83652. * Gets the sum of the distance between each sequential point in the path
  83653. * @returns the Path2 total length (float).
  83654. */
  83655. length(): number;
  83656. /**
  83657. * Gets the points which construct the path
  83658. * @returns the Path2 internal array of points.
  83659. */
  83660. getPoints(): Vector2[];
  83661. /**
  83662. * Retreives the point at the distance aways from the starting point
  83663. * @param normalizedLengthPosition the length along the path to retreive the point from
  83664. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  83665. */
  83666. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  83667. /**
  83668. * Creates a new path starting from an x and y position
  83669. * @param x starting x value
  83670. * @param y starting y value
  83671. * @returns a new Path2 starting at the coordinates (x, y).
  83672. */
  83673. static StartingAt(x: number, y: number): Path2;
  83674. }
  83675. /**
  83676. * Represents a 3D path made up of multiple 3D points
  83677. */
  83678. export class Path3D {
  83679. /**
  83680. * an array of Vector3, the curve axis of the Path3D
  83681. */
  83682. path: Vector3[];
  83683. private _curve;
  83684. private _distances;
  83685. private _tangents;
  83686. private _normals;
  83687. private _binormals;
  83688. private _raw;
  83689. private _alignTangentsWithPath;
  83690. private readonly _pointAtData;
  83691. /**
  83692. * new Path3D(path, normal, raw)
  83693. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  83694. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  83695. * @param path an array of Vector3, the curve axis of the Path3D
  83696. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  83697. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  83698. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  83699. */
  83700. constructor(
  83701. /**
  83702. * an array of Vector3, the curve axis of the Path3D
  83703. */
  83704. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  83705. /**
  83706. * Returns the Path3D array of successive Vector3 designing its curve.
  83707. * @returns the Path3D array of successive Vector3 designing its curve.
  83708. */
  83709. getCurve(): Vector3[];
  83710. /**
  83711. * Returns the Path3D array of successive Vector3 designing its curve.
  83712. * @returns the Path3D array of successive Vector3 designing its curve.
  83713. */
  83714. getPoints(): Vector3[];
  83715. /**
  83716. * @returns the computed length (float) of the path.
  83717. */
  83718. length(): number;
  83719. /**
  83720. * Returns an array populated with tangent vectors on each Path3D curve point.
  83721. * @returns an array populated with tangent vectors on each Path3D curve point.
  83722. */
  83723. getTangents(): Vector3[];
  83724. /**
  83725. * Returns an array populated with normal vectors on each Path3D curve point.
  83726. * @returns an array populated with normal vectors on each Path3D curve point.
  83727. */
  83728. getNormals(): Vector3[];
  83729. /**
  83730. * Returns an array populated with binormal vectors on each Path3D curve point.
  83731. * @returns an array populated with binormal vectors on each Path3D curve point.
  83732. */
  83733. getBinormals(): Vector3[];
  83734. /**
  83735. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  83736. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  83737. */
  83738. getDistances(): number[];
  83739. /**
  83740. * Returns an interpolated point along this path
  83741. * @param position the position of the point along this path, from 0.0 to 1.0
  83742. * @returns a new Vector3 as the point
  83743. */
  83744. getPointAt(position: number): Vector3;
  83745. /**
  83746. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  83747. * @param position the position of the point along this path, from 0.0 to 1.0
  83748. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  83749. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  83750. */
  83751. getTangentAt(position: number, interpolated?: boolean): Vector3;
  83752. /**
  83753. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  83754. * @param position the position of the point along this path, from 0.0 to 1.0
  83755. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  83756. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  83757. */
  83758. getNormalAt(position: number, interpolated?: boolean): Vector3;
  83759. /**
  83760. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  83761. * @param position the position of the point along this path, from 0.0 to 1.0
  83762. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  83763. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  83764. */
  83765. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  83766. /**
  83767. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  83768. * @param position the position of the point along this path, from 0.0 to 1.0
  83769. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  83770. */
  83771. getDistanceAt(position: number): number;
  83772. /**
  83773. * Returns the array index of the previous point of an interpolated point along this path
  83774. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  83775. * @returns the array index
  83776. */
  83777. getPreviousPointIndexAt(position: number): number;
  83778. /**
  83779. * 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)
  83780. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  83781. * @returns the sub position
  83782. */
  83783. getSubPositionAt(position: number): number;
  83784. /**
  83785. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  83786. * @param target the vector of which to get the closest position to
  83787. * @returns the position of the closest virtual point on this path to the target vector
  83788. */
  83789. getClosestPositionTo(target: Vector3): number;
  83790. /**
  83791. * Returns a sub path (slice) of this path
  83792. * @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
  83793. * @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
  83794. * @returns a sub path (slice) of this path
  83795. */
  83796. slice(start?: number, end?: number): Path3D;
  83797. /**
  83798. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  83799. * @param path path which all values are copied into the curves points
  83800. * @param firstNormal which should be projected onto the curve
  83801. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  83802. * @returns the same object updated.
  83803. */
  83804. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  83805. private _compute;
  83806. private _getFirstNonNullVector;
  83807. private _getLastNonNullVector;
  83808. private _normalVector;
  83809. /**
  83810. * Updates the point at data for an interpolated point along this curve
  83811. * @param position the position of the point along this curve, from 0.0 to 1.0
  83812. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  83813. * @returns the (updated) point at data
  83814. */
  83815. private _updatePointAtData;
  83816. /**
  83817. * Updates the point at data from the specified parameters
  83818. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  83819. * @param point the interpolated point
  83820. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  83821. */
  83822. private _setPointAtData;
  83823. /**
  83824. * Updates the point at interpolation matrix for the tangents, normals and binormals
  83825. */
  83826. private _updateInterpolationMatrix;
  83827. }
  83828. /**
  83829. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  83830. * A Curve3 is designed from a series of successive Vector3.
  83831. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  83832. */
  83833. export class Curve3 {
  83834. private _points;
  83835. private _length;
  83836. /**
  83837. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  83838. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  83839. * @param v1 (Vector3) the control point
  83840. * @param v2 (Vector3) the end point of the Quadratic Bezier
  83841. * @param nbPoints (integer) the wanted number of points in the curve
  83842. * @returns the created Curve3
  83843. */
  83844. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83845. /**
  83846. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  83847. * @param v0 (Vector3) the origin point of the Cubic Bezier
  83848. * @param v1 (Vector3) the first control point
  83849. * @param v2 (Vector3) the second control point
  83850. * @param v3 (Vector3) the end point of the Cubic Bezier
  83851. * @param nbPoints (integer) the wanted number of points in the curve
  83852. * @returns the created Curve3
  83853. */
  83854. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83855. /**
  83856. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  83857. * @param p1 (Vector3) the origin point of the Hermite Spline
  83858. * @param t1 (Vector3) the tangent vector at the origin point
  83859. * @param p2 (Vector3) the end point of the Hermite Spline
  83860. * @param t2 (Vector3) the tangent vector at the end point
  83861. * @param nbPoints (integer) the wanted number of points in the curve
  83862. * @returns the created Curve3
  83863. */
  83864. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83865. /**
  83866. * Returns a Curve3 object along a CatmullRom Spline curve :
  83867. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  83868. * @param nbPoints (integer) the wanted number of points between each curve control points
  83869. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  83870. * @returns the created Curve3
  83871. */
  83872. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  83873. /**
  83874. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  83875. * A Curve3 is designed from a series of successive Vector3.
  83876. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  83877. * @param points points which make up the curve
  83878. */
  83879. constructor(points: Vector3[]);
  83880. /**
  83881. * @returns the Curve3 stored array of successive Vector3
  83882. */
  83883. getPoints(): Vector3[];
  83884. /**
  83885. * @returns the computed length (float) of the curve.
  83886. */
  83887. length(): number;
  83888. /**
  83889. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  83890. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  83891. * curveA and curveB keep unchanged.
  83892. * @param curve the curve to continue from this curve
  83893. * @returns the newly constructed curve
  83894. */
  83895. continue(curve: DeepImmutable<Curve3>): Curve3;
  83896. private _computeLength;
  83897. }
  83898. }
  83899. declare module BABYLON {
  83900. /**
  83901. * This represents the main contract an easing function should follow.
  83902. * Easing functions are used throughout the animation system.
  83903. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83904. */
  83905. export interface IEasingFunction {
  83906. /**
  83907. * Given an input gradient between 0 and 1, this returns the corrseponding value
  83908. * of the easing function.
  83909. * The link below provides some of the most common examples of easing functions.
  83910. * @see https://easings.net/
  83911. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83912. * @returns the corresponding value on the curve defined by the easing function
  83913. */
  83914. ease(gradient: number): number;
  83915. }
  83916. /**
  83917. * Base class used for every default easing function.
  83918. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83919. */
  83920. export class EasingFunction implements IEasingFunction {
  83921. /**
  83922. * Interpolation follows the mathematical formula associated with the easing function.
  83923. */
  83924. static readonly EASINGMODE_EASEIN: number;
  83925. /**
  83926. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  83927. */
  83928. static readonly EASINGMODE_EASEOUT: number;
  83929. /**
  83930. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  83931. */
  83932. static readonly EASINGMODE_EASEINOUT: number;
  83933. private _easingMode;
  83934. /**
  83935. * Sets the easing mode of the current function.
  83936. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  83937. */
  83938. setEasingMode(easingMode: number): void;
  83939. /**
  83940. * Gets the current easing mode.
  83941. * @returns the easing mode
  83942. */
  83943. getEasingMode(): number;
  83944. /**
  83945. * @hidden
  83946. */
  83947. easeInCore(gradient: number): number;
  83948. /**
  83949. * Given an input gradient between 0 and 1, this returns the corresponding value
  83950. * of the easing function.
  83951. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83952. * @returns the corresponding value on the curve defined by the easing function
  83953. */
  83954. ease(gradient: number): number;
  83955. }
  83956. /**
  83957. * Easing function with a circle shape (see link below).
  83958. * @see https://easings.net/#easeInCirc
  83959. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83960. */
  83961. export class CircleEase extends EasingFunction implements IEasingFunction {
  83962. /** @hidden */
  83963. easeInCore(gradient: number): number;
  83964. }
  83965. /**
  83966. * Easing function with a ease back shape (see link below).
  83967. * @see https://easings.net/#easeInBack
  83968. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83969. */
  83970. export class BackEase extends EasingFunction implements IEasingFunction {
  83971. /** Defines the amplitude of the function */
  83972. amplitude: number;
  83973. /**
  83974. * Instantiates a back ease easing
  83975. * @see https://easings.net/#easeInBack
  83976. * @param amplitude Defines the amplitude of the function
  83977. */
  83978. constructor(
  83979. /** Defines the amplitude of the function */
  83980. amplitude?: number);
  83981. /** @hidden */
  83982. easeInCore(gradient: number): number;
  83983. }
  83984. /**
  83985. * Easing function with a bouncing shape (see link below).
  83986. * @see https://easings.net/#easeInBounce
  83987. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83988. */
  83989. export class BounceEase extends EasingFunction implements IEasingFunction {
  83990. /** Defines the number of bounces */
  83991. bounces: number;
  83992. /** Defines the amplitude of the bounce */
  83993. bounciness: number;
  83994. /**
  83995. * Instantiates a bounce easing
  83996. * @see https://easings.net/#easeInBounce
  83997. * @param bounces Defines the number of bounces
  83998. * @param bounciness Defines the amplitude of the bounce
  83999. */
  84000. constructor(
  84001. /** Defines the number of bounces */
  84002. bounces?: number,
  84003. /** Defines the amplitude of the bounce */
  84004. bounciness?: number);
  84005. /** @hidden */
  84006. easeInCore(gradient: number): number;
  84007. }
  84008. /**
  84009. * Easing function with a power of 3 shape (see link below).
  84010. * @see https://easings.net/#easeInCubic
  84011. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84012. */
  84013. export class CubicEase extends EasingFunction implements IEasingFunction {
  84014. /** @hidden */
  84015. easeInCore(gradient: number): number;
  84016. }
  84017. /**
  84018. * Easing function with an elastic shape (see link below).
  84019. * @see https://easings.net/#easeInElastic
  84020. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84021. */
  84022. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84023. /** Defines the number of oscillations*/
  84024. oscillations: number;
  84025. /** Defines the amplitude of the oscillations*/
  84026. springiness: number;
  84027. /**
  84028. * Instantiates an elastic easing function
  84029. * @see https://easings.net/#easeInElastic
  84030. * @param oscillations Defines the number of oscillations
  84031. * @param springiness Defines the amplitude of the oscillations
  84032. */
  84033. constructor(
  84034. /** Defines the number of oscillations*/
  84035. oscillations?: number,
  84036. /** Defines the amplitude of the oscillations*/
  84037. springiness?: number);
  84038. /** @hidden */
  84039. easeInCore(gradient: number): number;
  84040. }
  84041. /**
  84042. * Easing function with an exponential shape (see link below).
  84043. * @see https://easings.net/#easeInExpo
  84044. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84045. */
  84046. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  84047. /** Defines the exponent of the function */
  84048. exponent: number;
  84049. /**
  84050. * Instantiates an exponential easing function
  84051. * @see https://easings.net/#easeInExpo
  84052. * @param exponent Defines the exponent of the function
  84053. */
  84054. constructor(
  84055. /** Defines the exponent of the function */
  84056. exponent?: number);
  84057. /** @hidden */
  84058. easeInCore(gradient: number): number;
  84059. }
  84060. /**
  84061. * Easing function with a power shape (see link below).
  84062. * @see https://easings.net/#easeInQuad
  84063. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84064. */
  84065. export class PowerEase extends EasingFunction implements IEasingFunction {
  84066. /** Defines the power of the function */
  84067. power: number;
  84068. /**
  84069. * Instantiates an power base easing function
  84070. * @see https://easings.net/#easeInQuad
  84071. * @param power Defines the power of the function
  84072. */
  84073. constructor(
  84074. /** Defines the power of the function */
  84075. power?: number);
  84076. /** @hidden */
  84077. easeInCore(gradient: number): number;
  84078. }
  84079. /**
  84080. * Easing function with a power of 2 shape (see link below).
  84081. * @see https://easings.net/#easeInQuad
  84082. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84083. */
  84084. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  84085. /** @hidden */
  84086. easeInCore(gradient: number): number;
  84087. }
  84088. /**
  84089. * Easing function with a power of 4 shape (see link below).
  84090. * @see https://easings.net/#easeInQuart
  84091. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84092. */
  84093. export class QuarticEase extends EasingFunction implements IEasingFunction {
  84094. /** @hidden */
  84095. easeInCore(gradient: number): number;
  84096. }
  84097. /**
  84098. * Easing function with a power of 5 shape (see link below).
  84099. * @see https://easings.net/#easeInQuint
  84100. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84101. */
  84102. export class QuinticEase extends EasingFunction implements IEasingFunction {
  84103. /** @hidden */
  84104. easeInCore(gradient: number): number;
  84105. }
  84106. /**
  84107. * Easing function with a sin shape (see link below).
  84108. * @see https://easings.net/#easeInSine
  84109. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84110. */
  84111. export class SineEase extends EasingFunction implements IEasingFunction {
  84112. /** @hidden */
  84113. easeInCore(gradient: number): number;
  84114. }
  84115. /**
  84116. * Easing function with a bezier shape (see link below).
  84117. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84118. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84119. */
  84120. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  84121. /** Defines the x component of the start tangent in the bezier curve */
  84122. x1: number;
  84123. /** Defines the y component of the start tangent in the bezier curve */
  84124. y1: number;
  84125. /** Defines the x component of the end tangent in the bezier curve */
  84126. x2: number;
  84127. /** Defines the y component of the end tangent in the bezier curve */
  84128. y2: number;
  84129. /**
  84130. * Instantiates a bezier function
  84131. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84132. * @param x1 Defines the x component of the start tangent in the bezier curve
  84133. * @param y1 Defines the y component of the start tangent in the bezier curve
  84134. * @param x2 Defines the x component of the end tangent in the bezier curve
  84135. * @param y2 Defines the y component of the end tangent in the bezier curve
  84136. */
  84137. constructor(
  84138. /** Defines the x component of the start tangent in the bezier curve */
  84139. x1?: number,
  84140. /** Defines the y component of the start tangent in the bezier curve */
  84141. y1?: number,
  84142. /** Defines the x component of the end tangent in the bezier curve */
  84143. x2?: number,
  84144. /** Defines the y component of the end tangent in the bezier curve */
  84145. y2?: number);
  84146. /** @hidden */
  84147. easeInCore(gradient: number): number;
  84148. }
  84149. }
  84150. declare module BABYLON {
  84151. /**
  84152. * Class used to hold a RBG color
  84153. */
  84154. export class Color3 {
  84155. /**
  84156. * Defines the red component (between 0 and 1, default is 0)
  84157. */
  84158. r: number;
  84159. /**
  84160. * Defines the green component (between 0 and 1, default is 0)
  84161. */
  84162. g: number;
  84163. /**
  84164. * Defines the blue component (between 0 and 1, default is 0)
  84165. */
  84166. b: number;
  84167. /**
  84168. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  84169. * @param r defines the red component (between 0 and 1, default is 0)
  84170. * @param g defines the green component (between 0 and 1, default is 0)
  84171. * @param b defines the blue component (between 0 and 1, default is 0)
  84172. */
  84173. constructor(
  84174. /**
  84175. * Defines the red component (between 0 and 1, default is 0)
  84176. */
  84177. r?: number,
  84178. /**
  84179. * Defines the green component (between 0 and 1, default is 0)
  84180. */
  84181. g?: number,
  84182. /**
  84183. * Defines the blue component (between 0 and 1, default is 0)
  84184. */
  84185. b?: number);
  84186. /**
  84187. * Creates a string with the Color3 current values
  84188. * @returns the string representation of the Color3 object
  84189. */
  84190. toString(): string;
  84191. /**
  84192. * Returns the string "Color3"
  84193. * @returns "Color3"
  84194. */
  84195. getClassName(): string;
  84196. /**
  84197. * Compute the Color3 hash code
  84198. * @returns an unique number that can be used to hash Color3 objects
  84199. */
  84200. getHashCode(): number;
  84201. /**
  84202. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  84203. * @param array defines the array where to store the r,g,b components
  84204. * @param index defines an optional index in the target array to define where to start storing values
  84205. * @returns the current Color3 object
  84206. */
  84207. toArray(array: FloatArray, index?: number): Color3;
  84208. /**
  84209. * Update the current color with values stored in an array from the starting index of the given array
  84210. * @param array defines the source array
  84211. * @param offset defines an offset in the source array
  84212. * @returns the current Color3 object
  84213. */
  84214. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  84215. /**
  84216. * Returns a new Color4 object from the current Color3 and the given alpha
  84217. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  84218. * @returns a new Color4 object
  84219. */
  84220. toColor4(alpha?: number): Color4;
  84221. /**
  84222. * Returns a new array populated with 3 numeric elements : red, green and blue values
  84223. * @returns the new array
  84224. */
  84225. asArray(): number[];
  84226. /**
  84227. * Returns the luminance value
  84228. * @returns a float value
  84229. */
  84230. toLuminance(): number;
  84231. /**
  84232. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  84233. * @param otherColor defines the second operand
  84234. * @returns the new Color3 object
  84235. */
  84236. multiply(otherColor: DeepImmutable<Color3>): Color3;
  84237. /**
  84238. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  84239. * @param otherColor defines the second operand
  84240. * @param result defines the Color3 object where to store the result
  84241. * @returns the current Color3
  84242. */
  84243. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84244. /**
  84245. * Determines equality between Color3 objects
  84246. * @param otherColor defines the second operand
  84247. * @returns true if the rgb values are equal to the given ones
  84248. */
  84249. equals(otherColor: DeepImmutable<Color3>): boolean;
  84250. /**
  84251. * Determines equality between the current Color3 object and a set of r,b,g values
  84252. * @param r defines the red component to check
  84253. * @param g defines the green component to check
  84254. * @param b defines the blue component to check
  84255. * @returns true if the rgb values are equal to the given ones
  84256. */
  84257. equalsFloats(r: number, g: number, b: number): boolean;
  84258. /**
  84259. * Multiplies in place each rgb value by scale
  84260. * @param scale defines the scaling factor
  84261. * @returns the updated Color3
  84262. */
  84263. scale(scale: number): Color3;
  84264. /**
  84265. * Multiplies the rgb values by scale and stores the result into "result"
  84266. * @param scale defines the scaling factor
  84267. * @param result defines the Color3 object where to store the result
  84268. * @returns the unmodified current Color3
  84269. */
  84270. scaleToRef(scale: number, result: Color3): Color3;
  84271. /**
  84272. * Scale the current Color3 values by a factor and add the result to a given Color3
  84273. * @param scale defines the scale factor
  84274. * @param result defines color to store the result into
  84275. * @returns the unmodified current Color3
  84276. */
  84277. scaleAndAddToRef(scale: number, result: Color3): Color3;
  84278. /**
  84279. * Clamps the rgb values by the min and max values and stores the result into "result"
  84280. * @param min defines minimum clamping value (default is 0)
  84281. * @param max defines maximum clamping value (default is 1)
  84282. * @param result defines color to store the result into
  84283. * @returns the original Color3
  84284. */
  84285. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  84286. /**
  84287. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  84288. * @param otherColor defines the second operand
  84289. * @returns the new Color3
  84290. */
  84291. add(otherColor: DeepImmutable<Color3>): Color3;
  84292. /**
  84293. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  84294. * @param otherColor defines the second operand
  84295. * @param result defines Color3 object to store the result into
  84296. * @returns the unmodified current Color3
  84297. */
  84298. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84299. /**
  84300. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  84301. * @param otherColor defines the second operand
  84302. * @returns the new Color3
  84303. */
  84304. subtract(otherColor: DeepImmutable<Color3>): Color3;
  84305. /**
  84306. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  84307. * @param otherColor defines the second operand
  84308. * @param result defines Color3 object to store the result into
  84309. * @returns the unmodified current Color3
  84310. */
  84311. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84312. /**
  84313. * Copy the current object
  84314. * @returns a new Color3 copied the current one
  84315. */
  84316. clone(): Color3;
  84317. /**
  84318. * Copies the rgb values from the source in the current Color3
  84319. * @param source defines the source Color3 object
  84320. * @returns the updated Color3 object
  84321. */
  84322. copyFrom(source: DeepImmutable<Color3>): Color3;
  84323. /**
  84324. * Updates the Color3 rgb values from the given floats
  84325. * @param r defines the red component to read from
  84326. * @param g defines the green component to read from
  84327. * @param b defines the blue component to read from
  84328. * @returns the current Color3 object
  84329. */
  84330. copyFromFloats(r: number, g: number, b: number): Color3;
  84331. /**
  84332. * Updates the Color3 rgb values from the given floats
  84333. * @param r defines the red component to read from
  84334. * @param g defines the green component to read from
  84335. * @param b defines the blue component to read from
  84336. * @returns the current Color3 object
  84337. */
  84338. set(r: number, g: number, b: number): Color3;
  84339. /**
  84340. * Compute the Color3 hexadecimal code as a string
  84341. * @returns a string containing the hexadecimal representation of the Color3 object
  84342. */
  84343. toHexString(): string;
  84344. /**
  84345. * Computes a new Color3 converted from the current one to linear space
  84346. * @returns a new Color3 object
  84347. */
  84348. toLinearSpace(): Color3;
  84349. /**
  84350. * Converts current color in rgb space to HSV values
  84351. * @returns a new color3 representing the HSV values
  84352. */
  84353. toHSV(): Color3;
  84354. /**
  84355. * Converts current color in rgb space to HSV values
  84356. * @param result defines the Color3 where to store the HSV values
  84357. */
  84358. toHSVToRef(result: Color3): void;
  84359. /**
  84360. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  84361. * @param convertedColor defines the Color3 object where to store the linear space version
  84362. * @returns the unmodified Color3
  84363. */
  84364. toLinearSpaceToRef(convertedColor: Color3): Color3;
  84365. /**
  84366. * Computes a new Color3 converted from the current one to gamma space
  84367. * @returns a new Color3 object
  84368. */
  84369. toGammaSpace(): Color3;
  84370. /**
  84371. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  84372. * @param convertedColor defines the Color3 object where to store the gamma space version
  84373. * @returns the unmodified Color3
  84374. */
  84375. toGammaSpaceToRef(convertedColor: Color3): Color3;
  84376. private static _BlackReadOnly;
  84377. /**
  84378. * Convert Hue, saturation and value to a Color3 (RGB)
  84379. * @param hue defines the hue
  84380. * @param saturation defines the saturation
  84381. * @param value defines the value
  84382. * @param result defines the Color3 where to store the RGB values
  84383. */
  84384. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  84385. /**
  84386. * Creates a new Color3 from the string containing valid hexadecimal values
  84387. * @param hex defines a string containing valid hexadecimal values
  84388. * @returns a new Color3 object
  84389. */
  84390. static FromHexString(hex: string): Color3;
  84391. /**
  84392. * Creates a new Color3 from the starting index of the given array
  84393. * @param array defines the source array
  84394. * @param offset defines an offset in the source array
  84395. * @returns a new Color3 object
  84396. */
  84397. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  84398. /**
  84399. * Creates a new Color3 from the starting index element of the given array
  84400. * @param array defines the source array to read from
  84401. * @param offset defines the offset in the source array
  84402. * @param result defines the target Color3 object
  84403. */
  84404. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  84405. /**
  84406. * Creates a new Color3 from integer values (< 256)
  84407. * @param r defines the red component to read from (value between 0 and 255)
  84408. * @param g defines the green component to read from (value between 0 and 255)
  84409. * @param b defines the blue component to read from (value between 0 and 255)
  84410. * @returns a new Color3 object
  84411. */
  84412. static FromInts(r: number, g: number, b: number): Color3;
  84413. /**
  84414. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  84415. * @param start defines the start Color3 value
  84416. * @param end defines the end Color3 value
  84417. * @param amount defines the gradient value between start and end
  84418. * @returns a new Color3 object
  84419. */
  84420. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  84421. /**
  84422. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  84423. * @param left defines the start value
  84424. * @param right defines the end value
  84425. * @param amount defines the gradient factor
  84426. * @param result defines the Color3 object where to store the result
  84427. */
  84428. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  84429. /**
  84430. * Returns a Color3 value containing a red color
  84431. * @returns a new Color3 object
  84432. */
  84433. static Red(): Color3;
  84434. /**
  84435. * Returns a Color3 value containing a green color
  84436. * @returns a new Color3 object
  84437. */
  84438. static Green(): Color3;
  84439. /**
  84440. * Returns a Color3 value containing a blue color
  84441. * @returns a new Color3 object
  84442. */
  84443. static Blue(): Color3;
  84444. /**
  84445. * Returns a Color3 value containing a black color
  84446. * @returns a new Color3 object
  84447. */
  84448. static Black(): Color3;
  84449. /**
  84450. * Gets a Color3 value containing a black color that must not be updated
  84451. */
  84452. static get BlackReadOnly(): DeepImmutable<Color3>;
  84453. /**
  84454. * Returns a Color3 value containing a white color
  84455. * @returns a new Color3 object
  84456. */
  84457. static White(): Color3;
  84458. /**
  84459. * Returns a Color3 value containing a purple color
  84460. * @returns a new Color3 object
  84461. */
  84462. static Purple(): Color3;
  84463. /**
  84464. * Returns a Color3 value containing a magenta color
  84465. * @returns a new Color3 object
  84466. */
  84467. static Magenta(): Color3;
  84468. /**
  84469. * Returns a Color3 value containing a yellow color
  84470. * @returns a new Color3 object
  84471. */
  84472. static Yellow(): Color3;
  84473. /**
  84474. * Returns a Color3 value containing a gray color
  84475. * @returns a new Color3 object
  84476. */
  84477. static Gray(): Color3;
  84478. /**
  84479. * Returns a Color3 value containing a teal color
  84480. * @returns a new Color3 object
  84481. */
  84482. static Teal(): Color3;
  84483. /**
  84484. * Returns a Color3 value containing a random color
  84485. * @returns a new Color3 object
  84486. */
  84487. static Random(): Color3;
  84488. }
  84489. /**
  84490. * Class used to hold a RBGA color
  84491. */
  84492. export class Color4 {
  84493. /**
  84494. * Defines the red component (between 0 and 1, default is 0)
  84495. */
  84496. r: number;
  84497. /**
  84498. * Defines the green component (between 0 and 1, default is 0)
  84499. */
  84500. g: number;
  84501. /**
  84502. * Defines the blue component (between 0 and 1, default is 0)
  84503. */
  84504. b: number;
  84505. /**
  84506. * Defines the alpha component (between 0 and 1, default is 1)
  84507. */
  84508. a: number;
  84509. /**
  84510. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  84511. * @param r defines the red component (between 0 and 1, default is 0)
  84512. * @param g defines the green component (between 0 and 1, default is 0)
  84513. * @param b defines the blue component (between 0 and 1, default is 0)
  84514. * @param a defines the alpha component (between 0 and 1, default is 1)
  84515. */
  84516. constructor(
  84517. /**
  84518. * Defines the red component (between 0 and 1, default is 0)
  84519. */
  84520. r?: number,
  84521. /**
  84522. * Defines the green component (between 0 and 1, default is 0)
  84523. */
  84524. g?: number,
  84525. /**
  84526. * Defines the blue component (between 0 and 1, default is 0)
  84527. */
  84528. b?: number,
  84529. /**
  84530. * Defines the alpha component (between 0 and 1, default is 1)
  84531. */
  84532. a?: number);
  84533. /**
  84534. * Adds in place the given Color4 values to the current Color4 object
  84535. * @param right defines the second operand
  84536. * @returns the current updated Color4 object
  84537. */
  84538. addInPlace(right: DeepImmutable<Color4>): Color4;
  84539. /**
  84540. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  84541. * @returns the new array
  84542. */
  84543. asArray(): number[];
  84544. /**
  84545. * Stores from the starting index in the given array the Color4 successive values
  84546. * @param array defines the array where to store the r,g,b components
  84547. * @param index defines an optional index in the target array to define where to start storing values
  84548. * @returns the current Color4 object
  84549. */
  84550. toArray(array: number[], index?: number): Color4;
  84551. /**
  84552. * Update the current color with values stored in an array from the starting index of the given array
  84553. * @param array defines the source array
  84554. * @param offset defines an offset in the source array
  84555. * @returns the current Color4 object
  84556. */
  84557. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  84558. /**
  84559. * Determines equality between Color4 objects
  84560. * @param otherColor defines the second operand
  84561. * @returns true if the rgba values are equal to the given ones
  84562. */
  84563. equals(otherColor: DeepImmutable<Color4>): boolean;
  84564. /**
  84565. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  84566. * @param right defines the second operand
  84567. * @returns a new Color4 object
  84568. */
  84569. add(right: DeepImmutable<Color4>): Color4;
  84570. /**
  84571. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  84572. * @param right defines the second operand
  84573. * @returns a new Color4 object
  84574. */
  84575. subtract(right: DeepImmutable<Color4>): Color4;
  84576. /**
  84577. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  84578. * @param right defines the second operand
  84579. * @param result defines the Color4 object where to store the result
  84580. * @returns the current Color4 object
  84581. */
  84582. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  84583. /**
  84584. * Creates a new Color4 with the current Color4 values multiplied by scale
  84585. * @param scale defines the scaling factor to apply
  84586. * @returns a new Color4 object
  84587. */
  84588. scale(scale: number): Color4;
  84589. /**
  84590. * Multiplies the current Color4 values by scale and stores the result in "result"
  84591. * @param scale defines the scaling factor to apply
  84592. * @param result defines the Color4 object where to store the result
  84593. * @returns the current unmodified Color4
  84594. */
  84595. scaleToRef(scale: number, result: Color4): Color4;
  84596. /**
  84597. * Scale the current Color4 values by a factor and add the result to a given Color4
  84598. * @param scale defines the scale factor
  84599. * @param result defines the Color4 object where to store the result
  84600. * @returns the unmodified current Color4
  84601. */
  84602. scaleAndAddToRef(scale: number, result: Color4): Color4;
  84603. /**
  84604. * Clamps the rgb values by the min and max values and stores the result into "result"
  84605. * @param min defines minimum clamping value (default is 0)
  84606. * @param max defines maximum clamping value (default is 1)
  84607. * @param result defines color to store the result into.
  84608. * @returns the cuurent Color4
  84609. */
  84610. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  84611. /**
  84612. * Multipy an Color4 value by another and return a new Color4 object
  84613. * @param color defines the Color4 value to multiply by
  84614. * @returns a new Color4 object
  84615. */
  84616. multiply(color: Color4): Color4;
  84617. /**
  84618. * Multipy a Color4 value by another and push the result in a reference value
  84619. * @param color defines the Color4 value to multiply by
  84620. * @param result defines the Color4 to fill the result in
  84621. * @returns the result Color4
  84622. */
  84623. multiplyToRef(color: Color4, result: Color4): Color4;
  84624. /**
  84625. * Creates a string with the Color4 current values
  84626. * @returns the string representation of the Color4 object
  84627. */
  84628. toString(): string;
  84629. /**
  84630. * Returns the string "Color4"
  84631. * @returns "Color4"
  84632. */
  84633. getClassName(): string;
  84634. /**
  84635. * Compute the Color4 hash code
  84636. * @returns an unique number that can be used to hash Color4 objects
  84637. */
  84638. getHashCode(): number;
  84639. /**
  84640. * Creates a new Color4 copied from the current one
  84641. * @returns a new Color4 object
  84642. */
  84643. clone(): Color4;
  84644. /**
  84645. * Copies the given Color4 values into the current one
  84646. * @param source defines the source Color4 object
  84647. * @returns the current updated Color4 object
  84648. */
  84649. copyFrom(source: Color4): Color4;
  84650. /**
  84651. * Copies the given float values into the current one
  84652. * @param r defines the red component to read from
  84653. * @param g defines the green component to read from
  84654. * @param b defines the blue component to read from
  84655. * @param a defines the alpha component to read from
  84656. * @returns the current updated Color4 object
  84657. */
  84658. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  84659. /**
  84660. * Copies the given float values into the current one
  84661. * @param r defines the red component to read from
  84662. * @param g defines the green component to read from
  84663. * @param b defines the blue component to read from
  84664. * @param a defines the alpha component to read from
  84665. * @returns the current updated Color4 object
  84666. */
  84667. set(r: number, g: number, b: number, a: number): Color4;
  84668. /**
  84669. * Compute the Color4 hexadecimal code as a string
  84670. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  84671. * @returns a string containing the hexadecimal representation of the Color4 object
  84672. */
  84673. toHexString(returnAsColor3?: boolean): string;
  84674. /**
  84675. * Computes a new Color4 converted from the current one to linear space
  84676. * @returns a new Color4 object
  84677. */
  84678. toLinearSpace(): Color4;
  84679. /**
  84680. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  84681. * @param convertedColor defines the Color4 object where to store the linear space version
  84682. * @returns the unmodified Color4
  84683. */
  84684. toLinearSpaceToRef(convertedColor: Color4): Color4;
  84685. /**
  84686. * Computes a new Color4 converted from the current one to gamma space
  84687. * @returns a new Color4 object
  84688. */
  84689. toGammaSpace(): Color4;
  84690. /**
  84691. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  84692. * @param convertedColor defines the Color4 object where to store the gamma space version
  84693. * @returns the unmodified Color4
  84694. */
  84695. toGammaSpaceToRef(convertedColor: Color4): Color4;
  84696. /**
  84697. * Creates a new Color4 from the string containing valid hexadecimal values
  84698. * @param hex defines a string containing valid hexadecimal values
  84699. * @returns a new Color4 object
  84700. */
  84701. static FromHexString(hex: string): Color4;
  84702. /**
  84703. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  84704. * @param left defines the start value
  84705. * @param right defines the end value
  84706. * @param amount defines the gradient factor
  84707. * @returns a new Color4 object
  84708. */
  84709. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  84710. /**
  84711. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  84712. * @param left defines the start value
  84713. * @param right defines the end value
  84714. * @param amount defines the gradient factor
  84715. * @param result defines the Color4 object where to store data
  84716. */
  84717. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  84718. /**
  84719. * Creates a new Color4 from a Color3 and an alpha value
  84720. * @param color3 defines the source Color3 to read from
  84721. * @param alpha defines the alpha component (1.0 by default)
  84722. * @returns a new Color4 object
  84723. */
  84724. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  84725. /**
  84726. * Creates a new Color4 from the starting index element of the given array
  84727. * @param array defines the source array to read from
  84728. * @param offset defines the offset in the source array
  84729. * @returns a new Color4 object
  84730. */
  84731. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  84732. /**
  84733. * Creates a new Color4 from the starting index element of the given array
  84734. * @param array defines the source array to read from
  84735. * @param offset defines the offset in the source array
  84736. * @param result defines the target Color4 object
  84737. */
  84738. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  84739. /**
  84740. * Creates a new Color3 from integer values (< 256)
  84741. * @param r defines the red component to read from (value between 0 and 255)
  84742. * @param g defines the green component to read from (value between 0 and 255)
  84743. * @param b defines the blue component to read from (value between 0 and 255)
  84744. * @param a defines the alpha component to read from (value between 0 and 255)
  84745. * @returns a new Color3 object
  84746. */
  84747. static FromInts(r: number, g: number, b: number, a: number): Color4;
  84748. /**
  84749. * Check the content of a given array and convert it to an array containing RGBA data
  84750. * If the original array was already containing count * 4 values then it is returned directly
  84751. * @param colors defines the array to check
  84752. * @param count defines the number of RGBA data to expect
  84753. * @returns an array containing count * 4 values (RGBA)
  84754. */
  84755. static CheckColors4(colors: number[], count: number): number[];
  84756. }
  84757. /**
  84758. * @hidden
  84759. */
  84760. export class TmpColors {
  84761. static Color3: Color3[];
  84762. static Color4: Color4[];
  84763. }
  84764. }
  84765. declare module BABYLON {
  84766. /**
  84767. * Defines an interface which represents an animation key frame
  84768. */
  84769. export interface IAnimationKey {
  84770. /**
  84771. * Frame of the key frame
  84772. */
  84773. frame: number;
  84774. /**
  84775. * Value at the specifies key frame
  84776. */
  84777. value: any;
  84778. /**
  84779. * The input tangent for the cubic hermite spline
  84780. */
  84781. inTangent?: any;
  84782. /**
  84783. * The output tangent for the cubic hermite spline
  84784. */
  84785. outTangent?: any;
  84786. /**
  84787. * The animation interpolation type
  84788. */
  84789. interpolation?: AnimationKeyInterpolation;
  84790. }
  84791. /**
  84792. * Enum for the animation key frame interpolation type
  84793. */
  84794. export enum AnimationKeyInterpolation {
  84795. /**
  84796. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  84797. */
  84798. STEP = 1
  84799. }
  84800. }
  84801. declare module BABYLON {
  84802. /**
  84803. * Represents the range of an animation
  84804. */
  84805. export class AnimationRange {
  84806. /**The name of the animation range**/
  84807. name: string;
  84808. /**The starting frame of the animation */
  84809. from: number;
  84810. /**The ending frame of the animation*/
  84811. to: number;
  84812. /**
  84813. * Initializes the range of an animation
  84814. * @param name The name of the animation range
  84815. * @param from The starting frame of the animation
  84816. * @param to The ending frame of the animation
  84817. */
  84818. constructor(
  84819. /**The name of the animation range**/
  84820. name: string,
  84821. /**The starting frame of the animation */
  84822. from: number,
  84823. /**The ending frame of the animation*/
  84824. to: number);
  84825. /**
  84826. * Makes a copy of the animation range
  84827. * @returns A copy of the animation range
  84828. */
  84829. clone(): AnimationRange;
  84830. }
  84831. }
  84832. declare module BABYLON {
  84833. /**
  84834. * Composed of a frame, and an action function
  84835. */
  84836. export class AnimationEvent {
  84837. /** The frame for which the event is triggered **/
  84838. frame: number;
  84839. /** The event to perform when triggered **/
  84840. action: (currentFrame: number) => void;
  84841. /** Specifies if the event should be triggered only once**/
  84842. onlyOnce?: boolean | undefined;
  84843. /**
  84844. * Specifies if the animation event is done
  84845. */
  84846. isDone: boolean;
  84847. /**
  84848. * Initializes the animation event
  84849. * @param frame The frame for which the event is triggered
  84850. * @param action The event to perform when triggered
  84851. * @param onlyOnce Specifies if the event should be triggered only once
  84852. */
  84853. constructor(
  84854. /** The frame for which the event is triggered **/
  84855. frame: number,
  84856. /** The event to perform when triggered **/
  84857. action: (currentFrame: number) => void,
  84858. /** Specifies if the event should be triggered only once**/
  84859. onlyOnce?: boolean | undefined);
  84860. /** @hidden */
  84861. _clone(): AnimationEvent;
  84862. }
  84863. }
  84864. declare module BABYLON {
  84865. /**
  84866. * Interface used to define a behavior
  84867. */
  84868. export interface Behavior<T> {
  84869. /** gets or sets behavior's name */
  84870. name: string;
  84871. /**
  84872. * Function called when the behavior needs to be initialized (after attaching it to a target)
  84873. */
  84874. init(): void;
  84875. /**
  84876. * Called when the behavior is attached to a target
  84877. * @param target defines the target where the behavior is attached to
  84878. */
  84879. attach(target: T): void;
  84880. /**
  84881. * Called when the behavior is detached from its target
  84882. */
  84883. detach(): void;
  84884. }
  84885. /**
  84886. * Interface implemented by classes supporting behaviors
  84887. */
  84888. export interface IBehaviorAware<T> {
  84889. /**
  84890. * Attach a behavior
  84891. * @param behavior defines the behavior to attach
  84892. * @returns the current host
  84893. */
  84894. addBehavior(behavior: Behavior<T>): T;
  84895. /**
  84896. * Remove a behavior from the current object
  84897. * @param behavior defines the behavior to detach
  84898. * @returns the current host
  84899. */
  84900. removeBehavior(behavior: Behavior<T>): T;
  84901. /**
  84902. * Gets a behavior using its name to search
  84903. * @param name defines the name to search
  84904. * @returns the behavior or null if not found
  84905. */
  84906. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  84907. }
  84908. }
  84909. declare module BABYLON {
  84910. /**
  84911. * Defines an array and its length.
  84912. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  84913. */
  84914. export interface ISmartArrayLike<T> {
  84915. /**
  84916. * The data of the array.
  84917. */
  84918. data: Array<T>;
  84919. /**
  84920. * The active length of the array.
  84921. */
  84922. length: number;
  84923. }
  84924. /**
  84925. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  84926. */
  84927. export class SmartArray<T> implements ISmartArrayLike<T> {
  84928. /**
  84929. * The full set of data from the array.
  84930. */
  84931. data: Array<T>;
  84932. /**
  84933. * The active length of the array.
  84934. */
  84935. length: number;
  84936. protected _id: number;
  84937. /**
  84938. * Instantiates a Smart Array.
  84939. * @param capacity defines the default capacity of the array.
  84940. */
  84941. constructor(capacity: number);
  84942. /**
  84943. * Pushes a value at the end of the active data.
  84944. * @param value defines the object to push in the array.
  84945. */
  84946. push(value: T): void;
  84947. /**
  84948. * Iterates over the active data and apply the lambda to them.
  84949. * @param func defines the action to apply on each value.
  84950. */
  84951. forEach(func: (content: T) => void): void;
  84952. /**
  84953. * Sorts the full sets of data.
  84954. * @param compareFn defines the comparison function to apply.
  84955. */
  84956. sort(compareFn: (a: T, b: T) => number): void;
  84957. /**
  84958. * Resets the active data to an empty array.
  84959. */
  84960. reset(): void;
  84961. /**
  84962. * Releases all the data from the array as well as the array.
  84963. */
  84964. dispose(): void;
  84965. /**
  84966. * Concats the active data with a given array.
  84967. * @param array defines the data to concatenate with.
  84968. */
  84969. concat(array: any): void;
  84970. /**
  84971. * Returns the position of a value in the active data.
  84972. * @param value defines the value to find the index for
  84973. * @returns the index if found in the active data otherwise -1
  84974. */
  84975. indexOf(value: T): number;
  84976. /**
  84977. * Returns whether an element is part of the active data.
  84978. * @param value defines the value to look for
  84979. * @returns true if found in the active data otherwise false
  84980. */
  84981. contains(value: T): boolean;
  84982. private static _GlobalId;
  84983. }
  84984. /**
  84985. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  84986. * The data in this array can only be present once
  84987. */
  84988. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  84989. private _duplicateId;
  84990. /**
  84991. * Pushes a value at the end of the active data.
  84992. * THIS DOES NOT PREVENT DUPPLICATE DATA
  84993. * @param value defines the object to push in the array.
  84994. */
  84995. push(value: T): void;
  84996. /**
  84997. * Pushes a value at the end of the active data.
  84998. * If the data is already present, it won t be added again
  84999. * @param value defines the object to push in the array.
  85000. * @returns true if added false if it was already present
  85001. */
  85002. pushNoDuplicate(value: T): boolean;
  85003. /**
  85004. * Resets the active data to an empty array.
  85005. */
  85006. reset(): void;
  85007. /**
  85008. * Concats the active data with a given array.
  85009. * This ensures no dupplicate will be present in the result.
  85010. * @param array defines the data to concatenate with.
  85011. */
  85012. concatWithNoDuplicate(array: any): void;
  85013. }
  85014. }
  85015. declare module BABYLON {
  85016. /**
  85017. * @ignore
  85018. * This is a list of all the different input types that are available in the application.
  85019. * Fo instance: ArcRotateCameraGamepadInput...
  85020. */
  85021. export var CameraInputTypes: {};
  85022. /**
  85023. * This is the contract to implement in order to create a new input class.
  85024. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85025. */
  85026. export interface ICameraInput<TCamera extends Camera> {
  85027. /**
  85028. * Defines the camera the input is attached to.
  85029. */
  85030. camera: Nullable<TCamera>;
  85031. /**
  85032. * Gets the class name of the current intput.
  85033. * @returns the class name
  85034. */
  85035. getClassName(): string;
  85036. /**
  85037. * Get the friendly name associated with the input class.
  85038. * @returns the input friendly name
  85039. */
  85040. getSimpleName(): string;
  85041. /**
  85042. * Attach the input controls to a specific dom element to get the input from.
  85043. * @param element Defines the element the controls should be listened from
  85044. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85045. */
  85046. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  85047. /**
  85048. * Detach the current controls from the specified dom element.
  85049. * @param element Defines the element to stop listening the inputs from
  85050. */
  85051. detachControl(element: Nullable<HTMLElement>): void;
  85052. /**
  85053. * Update the current camera state depending on the inputs that have been used this frame.
  85054. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85055. */
  85056. checkInputs?: () => void;
  85057. }
  85058. /**
  85059. * Represents a map of input types to input instance or input index to input instance.
  85060. */
  85061. export interface CameraInputsMap<TCamera extends Camera> {
  85062. /**
  85063. * Accessor to the input by input type.
  85064. */
  85065. [name: string]: ICameraInput<TCamera>;
  85066. /**
  85067. * Accessor to the input by input index.
  85068. */
  85069. [idx: number]: ICameraInput<TCamera>;
  85070. }
  85071. /**
  85072. * This represents the input manager used within a camera.
  85073. * It helps dealing with all the different kind of input attached to a camera.
  85074. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85075. */
  85076. export class CameraInputsManager<TCamera extends Camera> {
  85077. /**
  85078. * Defines the list of inputs attahed to the camera.
  85079. */
  85080. attached: CameraInputsMap<TCamera>;
  85081. /**
  85082. * Defines the dom element the camera is collecting inputs from.
  85083. * This is null if the controls have not been attached.
  85084. */
  85085. attachedElement: Nullable<HTMLElement>;
  85086. /**
  85087. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85088. */
  85089. noPreventDefault: boolean;
  85090. /**
  85091. * Defined the camera the input manager belongs to.
  85092. */
  85093. camera: TCamera;
  85094. /**
  85095. * Update the current camera state depending on the inputs that have been used this frame.
  85096. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85097. */
  85098. checkInputs: () => void;
  85099. /**
  85100. * Instantiate a new Camera Input Manager.
  85101. * @param camera Defines the camera the input manager blongs to
  85102. */
  85103. constructor(camera: TCamera);
  85104. /**
  85105. * Add an input method to a camera
  85106. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85107. * @param input camera input method
  85108. */
  85109. add(input: ICameraInput<TCamera>): void;
  85110. /**
  85111. * Remove a specific input method from a camera
  85112. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  85113. * @param inputToRemove camera input method
  85114. */
  85115. remove(inputToRemove: ICameraInput<TCamera>): void;
  85116. /**
  85117. * Remove a specific input type from a camera
  85118. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  85119. * @param inputType the type of the input to remove
  85120. */
  85121. removeByType(inputType: string): void;
  85122. private _addCheckInputs;
  85123. /**
  85124. * Attach the input controls to the currently attached dom element to listen the events from.
  85125. * @param input Defines the input to attach
  85126. */
  85127. attachInput(input: ICameraInput<TCamera>): void;
  85128. /**
  85129. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  85130. * @param element Defines the dom element to collect the events from
  85131. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85132. */
  85133. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  85134. /**
  85135. * Detach the current manager inputs controls from a specific dom element.
  85136. * @param element Defines the dom element to collect the events from
  85137. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  85138. */
  85139. detachElement(element: HTMLElement, disconnect?: boolean): void;
  85140. /**
  85141. * Rebuild the dynamic inputCheck function from the current list of
  85142. * defined inputs in the manager.
  85143. */
  85144. rebuildInputCheck(): void;
  85145. /**
  85146. * Remove all attached input methods from a camera
  85147. */
  85148. clear(): void;
  85149. /**
  85150. * Serialize the current input manager attached to a camera.
  85151. * This ensures than once parsed,
  85152. * the input associated to the camera will be identical to the current ones
  85153. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  85154. */
  85155. serialize(serializedCamera: any): void;
  85156. /**
  85157. * Parses an input manager serialized JSON to restore the previous list of inputs
  85158. * and states associated to a camera.
  85159. * @param parsedCamera Defines the JSON to parse
  85160. */
  85161. parse(parsedCamera: any): void;
  85162. }
  85163. }
  85164. declare module BABYLON {
  85165. /**
  85166. * Class used to store data that will be store in GPU memory
  85167. */
  85168. export class Buffer {
  85169. private _engine;
  85170. private _buffer;
  85171. /** @hidden */
  85172. _data: Nullable<DataArray>;
  85173. private _updatable;
  85174. private _instanced;
  85175. private _divisor;
  85176. /**
  85177. * Gets the byte stride.
  85178. */
  85179. readonly byteStride: number;
  85180. /**
  85181. * Constructor
  85182. * @param engine the engine
  85183. * @param data the data to use for this buffer
  85184. * @param updatable whether the data is updatable
  85185. * @param stride the stride (optional)
  85186. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85187. * @param instanced whether the buffer is instanced (optional)
  85188. * @param useBytes set to true if the stride in in bytes (optional)
  85189. * @param divisor sets an optional divisor for instances (1 by default)
  85190. */
  85191. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  85192. /**
  85193. * Create a new VertexBuffer based on the current buffer
  85194. * @param kind defines the vertex buffer kind (position, normal, etc.)
  85195. * @param offset defines offset in the buffer (0 by default)
  85196. * @param size defines the size in floats of attributes (position is 3 for instance)
  85197. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  85198. * @param instanced defines if the vertex buffer contains indexed data
  85199. * @param useBytes defines if the offset and stride are in bytes *
  85200. * @param divisor sets an optional divisor for instances (1 by default)
  85201. * @returns the new vertex buffer
  85202. */
  85203. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  85204. /**
  85205. * Gets a boolean indicating if the Buffer is updatable?
  85206. * @returns true if the buffer is updatable
  85207. */
  85208. isUpdatable(): boolean;
  85209. /**
  85210. * Gets current buffer's data
  85211. * @returns a DataArray or null
  85212. */
  85213. getData(): Nullable<DataArray>;
  85214. /**
  85215. * Gets underlying native buffer
  85216. * @returns underlying native buffer
  85217. */
  85218. getBuffer(): Nullable<DataBuffer>;
  85219. /**
  85220. * Gets the stride in float32 units (i.e. byte stride / 4).
  85221. * May not be an integer if the byte stride is not divisible by 4.
  85222. * @returns the stride in float32 units
  85223. * @deprecated Please use byteStride instead.
  85224. */
  85225. getStrideSize(): number;
  85226. /**
  85227. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85228. * @param data defines the data to store
  85229. */
  85230. create(data?: Nullable<DataArray>): void;
  85231. /** @hidden */
  85232. _rebuild(): void;
  85233. /**
  85234. * Update current buffer data
  85235. * @param data defines the data to store
  85236. */
  85237. update(data: DataArray): void;
  85238. /**
  85239. * Updates the data directly.
  85240. * @param data the new data
  85241. * @param offset the new offset
  85242. * @param vertexCount the vertex count (optional)
  85243. * @param useBytes set to true if the offset is in bytes
  85244. */
  85245. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  85246. /**
  85247. * Release all resources
  85248. */
  85249. dispose(): void;
  85250. }
  85251. /**
  85252. * Specialized buffer used to store vertex data
  85253. */
  85254. export class VertexBuffer {
  85255. /** @hidden */
  85256. _buffer: Buffer;
  85257. private _kind;
  85258. private _size;
  85259. private _ownsBuffer;
  85260. private _instanced;
  85261. private _instanceDivisor;
  85262. /**
  85263. * The byte type.
  85264. */
  85265. static readonly BYTE: number;
  85266. /**
  85267. * The unsigned byte type.
  85268. */
  85269. static readonly UNSIGNED_BYTE: number;
  85270. /**
  85271. * The short type.
  85272. */
  85273. static readonly SHORT: number;
  85274. /**
  85275. * The unsigned short type.
  85276. */
  85277. static readonly UNSIGNED_SHORT: number;
  85278. /**
  85279. * The integer type.
  85280. */
  85281. static readonly INT: number;
  85282. /**
  85283. * The unsigned integer type.
  85284. */
  85285. static readonly UNSIGNED_INT: number;
  85286. /**
  85287. * The float type.
  85288. */
  85289. static readonly FLOAT: number;
  85290. /**
  85291. * Gets or sets the instance divisor when in instanced mode
  85292. */
  85293. get instanceDivisor(): number;
  85294. set instanceDivisor(value: number);
  85295. /**
  85296. * Gets the byte stride.
  85297. */
  85298. readonly byteStride: number;
  85299. /**
  85300. * Gets the byte offset.
  85301. */
  85302. readonly byteOffset: number;
  85303. /**
  85304. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  85305. */
  85306. readonly normalized: boolean;
  85307. /**
  85308. * Gets the data type of each component in the array.
  85309. */
  85310. readonly type: number;
  85311. /**
  85312. * Constructor
  85313. * @param engine the engine
  85314. * @param data the data to use for this vertex buffer
  85315. * @param kind the vertex buffer kind
  85316. * @param updatable whether the data is updatable
  85317. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85318. * @param stride the stride (optional)
  85319. * @param instanced whether the buffer is instanced (optional)
  85320. * @param offset the offset of the data (optional)
  85321. * @param size the number of components (optional)
  85322. * @param type the type of the component (optional)
  85323. * @param normalized whether the data contains normalized data (optional)
  85324. * @param useBytes set to true if stride and offset are in bytes (optional)
  85325. * @param divisor defines the instance divisor to use (1 by default)
  85326. */
  85327. 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);
  85328. /** @hidden */
  85329. _rebuild(): void;
  85330. /**
  85331. * Returns the kind of the VertexBuffer (string)
  85332. * @returns a string
  85333. */
  85334. getKind(): string;
  85335. /**
  85336. * Gets a boolean indicating if the VertexBuffer is updatable?
  85337. * @returns true if the buffer is updatable
  85338. */
  85339. isUpdatable(): boolean;
  85340. /**
  85341. * Gets current buffer's data
  85342. * @returns a DataArray or null
  85343. */
  85344. getData(): Nullable<DataArray>;
  85345. /**
  85346. * Gets underlying native buffer
  85347. * @returns underlying native buffer
  85348. */
  85349. getBuffer(): Nullable<DataBuffer>;
  85350. /**
  85351. * Gets the stride in float32 units (i.e. byte stride / 4).
  85352. * May not be an integer if the byte stride is not divisible by 4.
  85353. * @returns the stride in float32 units
  85354. * @deprecated Please use byteStride instead.
  85355. */
  85356. getStrideSize(): number;
  85357. /**
  85358. * Returns the offset as a multiple of the type byte length.
  85359. * @returns the offset in bytes
  85360. * @deprecated Please use byteOffset instead.
  85361. */
  85362. getOffset(): number;
  85363. /**
  85364. * Returns the number of components per vertex attribute (integer)
  85365. * @returns the size in float
  85366. */
  85367. getSize(): number;
  85368. /**
  85369. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  85370. * @returns true if this buffer is instanced
  85371. */
  85372. getIsInstanced(): boolean;
  85373. /**
  85374. * Returns the instancing divisor, zero for non-instanced (integer).
  85375. * @returns a number
  85376. */
  85377. getInstanceDivisor(): number;
  85378. /**
  85379. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85380. * @param data defines the data to store
  85381. */
  85382. create(data?: DataArray): void;
  85383. /**
  85384. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  85385. * This function will create a new buffer if the current one is not updatable
  85386. * @param data defines the data to store
  85387. */
  85388. update(data: DataArray): void;
  85389. /**
  85390. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  85391. * Returns the directly updated WebGLBuffer.
  85392. * @param data the new data
  85393. * @param offset the new offset
  85394. * @param useBytes set to true if the offset is in bytes
  85395. */
  85396. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  85397. /**
  85398. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  85399. */
  85400. dispose(): void;
  85401. /**
  85402. * Enumerates each value of this vertex buffer as numbers.
  85403. * @param count the number of values to enumerate
  85404. * @param callback the callback function called for each value
  85405. */
  85406. forEach(count: number, callback: (value: number, index: number) => void): void;
  85407. /**
  85408. * Positions
  85409. */
  85410. static readonly PositionKind: string;
  85411. /**
  85412. * Normals
  85413. */
  85414. static readonly NormalKind: string;
  85415. /**
  85416. * Tangents
  85417. */
  85418. static readonly TangentKind: string;
  85419. /**
  85420. * Texture coordinates
  85421. */
  85422. static readonly UVKind: string;
  85423. /**
  85424. * Texture coordinates 2
  85425. */
  85426. static readonly UV2Kind: string;
  85427. /**
  85428. * Texture coordinates 3
  85429. */
  85430. static readonly UV3Kind: string;
  85431. /**
  85432. * Texture coordinates 4
  85433. */
  85434. static readonly UV4Kind: string;
  85435. /**
  85436. * Texture coordinates 5
  85437. */
  85438. static readonly UV5Kind: string;
  85439. /**
  85440. * Texture coordinates 6
  85441. */
  85442. static readonly UV6Kind: string;
  85443. /**
  85444. * Colors
  85445. */
  85446. static readonly ColorKind: string;
  85447. /**
  85448. * Matrix indices (for bones)
  85449. */
  85450. static readonly MatricesIndicesKind: string;
  85451. /**
  85452. * Matrix weights (for bones)
  85453. */
  85454. static readonly MatricesWeightsKind: string;
  85455. /**
  85456. * Additional matrix indices (for bones)
  85457. */
  85458. static readonly MatricesIndicesExtraKind: string;
  85459. /**
  85460. * Additional matrix weights (for bones)
  85461. */
  85462. static readonly MatricesWeightsExtraKind: string;
  85463. /**
  85464. * Deduces the stride given a kind.
  85465. * @param kind The kind string to deduce
  85466. * @returns The deduced stride
  85467. */
  85468. static DeduceStride(kind: string): number;
  85469. /**
  85470. * Gets the byte length of the given type.
  85471. * @param type the type
  85472. * @returns the number of bytes
  85473. */
  85474. static GetTypeByteLength(type: number): number;
  85475. /**
  85476. * Enumerates each value of the given parameters as numbers.
  85477. * @param data the data to enumerate
  85478. * @param byteOffset the byte offset of the data
  85479. * @param byteStride the byte stride of the data
  85480. * @param componentCount the number of components per element
  85481. * @param componentType the type of the component
  85482. * @param count the number of values to enumerate
  85483. * @param normalized whether the data is normalized
  85484. * @param callback the callback function called for each value
  85485. */
  85486. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  85487. private static _GetFloatValue;
  85488. }
  85489. }
  85490. declare module BABYLON {
  85491. /**
  85492. * @hidden
  85493. */
  85494. export class IntersectionInfo {
  85495. bu: Nullable<number>;
  85496. bv: Nullable<number>;
  85497. distance: number;
  85498. faceId: number;
  85499. subMeshId: number;
  85500. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  85501. }
  85502. }
  85503. declare module BABYLON {
  85504. /**
  85505. * Class used to store bounding sphere information
  85506. */
  85507. export class BoundingSphere {
  85508. /**
  85509. * Gets the center of the bounding sphere in local space
  85510. */
  85511. readonly center: Vector3;
  85512. /**
  85513. * Radius of the bounding sphere in local space
  85514. */
  85515. radius: number;
  85516. /**
  85517. * Gets the center of the bounding sphere in world space
  85518. */
  85519. readonly centerWorld: Vector3;
  85520. /**
  85521. * Radius of the bounding sphere in world space
  85522. */
  85523. radiusWorld: number;
  85524. /**
  85525. * Gets the minimum vector in local space
  85526. */
  85527. readonly minimum: Vector3;
  85528. /**
  85529. * Gets the maximum vector in local space
  85530. */
  85531. readonly maximum: Vector3;
  85532. private _worldMatrix;
  85533. private static readonly TmpVector3;
  85534. /**
  85535. * Creates a new bounding sphere
  85536. * @param min defines the minimum vector (in local space)
  85537. * @param max defines the maximum vector (in local space)
  85538. * @param worldMatrix defines the new world matrix
  85539. */
  85540. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85541. /**
  85542. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  85543. * @param min defines the new minimum vector (in local space)
  85544. * @param max defines the new maximum vector (in local space)
  85545. * @param worldMatrix defines the new world matrix
  85546. */
  85547. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85548. /**
  85549. * Scale the current bounding sphere by applying a scale factor
  85550. * @param factor defines the scale factor to apply
  85551. * @returns the current bounding box
  85552. */
  85553. scale(factor: number): BoundingSphere;
  85554. /**
  85555. * Gets the world matrix of the bounding box
  85556. * @returns a matrix
  85557. */
  85558. getWorldMatrix(): DeepImmutable<Matrix>;
  85559. /** @hidden */
  85560. _update(worldMatrix: DeepImmutable<Matrix>): void;
  85561. /**
  85562. * Tests if the bounding sphere is intersecting the frustum planes
  85563. * @param frustumPlanes defines the frustum planes to test
  85564. * @returns true if there is an intersection
  85565. */
  85566. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85567. /**
  85568. * Tests if the bounding sphere center is in between the frustum planes.
  85569. * Used for optimistic fast inclusion.
  85570. * @param frustumPlanes defines the frustum planes to test
  85571. * @returns true if the sphere center is in between the frustum planes
  85572. */
  85573. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85574. /**
  85575. * Tests if a point is inside the bounding sphere
  85576. * @param point defines the point to test
  85577. * @returns true if the point is inside the bounding sphere
  85578. */
  85579. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85580. /**
  85581. * Checks if two sphere intersct
  85582. * @param sphere0 sphere 0
  85583. * @param sphere1 sphere 1
  85584. * @returns true if the speres intersect
  85585. */
  85586. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  85587. }
  85588. }
  85589. declare module BABYLON {
  85590. /**
  85591. * Class used to store bounding box information
  85592. */
  85593. export class BoundingBox implements ICullable {
  85594. /**
  85595. * Gets the 8 vectors representing the bounding box in local space
  85596. */
  85597. readonly vectors: Vector3[];
  85598. /**
  85599. * Gets the center of the bounding box in local space
  85600. */
  85601. readonly center: Vector3;
  85602. /**
  85603. * Gets the center of the bounding box in world space
  85604. */
  85605. readonly centerWorld: Vector3;
  85606. /**
  85607. * Gets the extend size in local space
  85608. */
  85609. readonly extendSize: Vector3;
  85610. /**
  85611. * Gets the extend size in world space
  85612. */
  85613. readonly extendSizeWorld: Vector3;
  85614. /**
  85615. * Gets the OBB (object bounding box) directions
  85616. */
  85617. readonly directions: Vector3[];
  85618. /**
  85619. * Gets the 8 vectors representing the bounding box in world space
  85620. */
  85621. readonly vectorsWorld: Vector3[];
  85622. /**
  85623. * Gets the minimum vector in world space
  85624. */
  85625. readonly minimumWorld: Vector3;
  85626. /**
  85627. * Gets the maximum vector in world space
  85628. */
  85629. readonly maximumWorld: Vector3;
  85630. /**
  85631. * Gets the minimum vector in local space
  85632. */
  85633. readonly minimum: Vector3;
  85634. /**
  85635. * Gets the maximum vector in local space
  85636. */
  85637. readonly maximum: Vector3;
  85638. private _worldMatrix;
  85639. private static readonly TmpVector3;
  85640. /**
  85641. * @hidden
  85642. */
  85643. _tag: number;
  85644. /**
  85645. * Creates a new bounding box
  85646. * @param min defines the minimum vector (in local space)
  85647. * @param max defines the maximum vector (in local space)
  85648. * @param worldMatrix defines the new world matrix
  85649. */
  85650. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85651. /**
  85652. * Recreates the entire bounding box from scratch as if we call the constructor in place
  85653. * @param min defines the new minimum vector (in local space)
  85654. * @param max defines the new maximum vector (in local space)
  85655. * @param worldMatrix defines the new world matrix
  85656. */
  85657. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85658. /**
  85659. * Scale the current bounding box by applying a scale factor
  85660. * @param factor defines the scale factor to apply
  85661. * @returns the current bounding box
  85662. */
  85663. scale(factor: number): BoundingBox;
  85664. /**
  85665. * Gets the world matrix of the bounding box
  85666. * @returns a matrix
  85667. */
  85668. getWorldMatrix(): DeepImmutable<Matrix>;
  85669. /** @hidden */
  85670. _update(world: DeepImmutable<Matrix>): void;
  85671. /**
  85672. * Tests if the bounding box is intersecting the frustum planes
  85673. * @param frustumPlanes defines the frustum planes to test
  85674. * @returns true if there is an intersection
  85675. */
  85676. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85677. /**
  85678. * Tests if the bounding box is entirely inside the frustum planes
  85679. * @param frustumPlanes defines the frustum planes to test
  85680. * @returns true if there is an inclusion
  85681. */
  85682. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85683. /**
  85684. * Tests if a point is inside the bounding box
  85685. * @param point defines the point to test
  85686. * @returns true if the point is inside the bounding box
  85687. */
  85688. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85689. /**
  85690. * Tests if the bounding box intersects with a bounding sphere
  85691. * @param sphere defines the sphere to test
  85692. * @returns true if there is an intersection
  85693. */
  85694. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  85695. /**
  85696. * Tests if the bounding box intersects with a box defined by a min and max vectors
  85697. * @param min defines the min vector to use
  85698. * @param max defines the max vector to use
  85699. * @returns true if there is an intersection
  85700. */
  85701. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  85702. /**
  85703. * Tests if two bounding boxes are intersections
  85704. * @param box0 defines the first box to test
  85705. * @param box1 defines the second box to test
  85706. * @returns true if there is an intersection
  85707. */
  85708. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  85709. /**
  85710. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  85711. * @param minPoint defines the minimum vector of the bounding box
  85712. * @param maxPoint defines the maximum vector of the bounding box
  85713. * @param sphereCenter defines the sphere center
  85714. * @param sphereRadius defines the sphere radius
  85715. * @returns true if there is an intersection
  85716. */
  85717. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  85718. /**
  85719. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  85720. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  85721. * @param frustumPlanes defines the frustum planes to test
  85722. * @return true if there is an inclusion
  85723. */
  85724. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85725. /**
  85726. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  85727. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  85728. * @param frustumPlanes defines the frustum planes to test
  85729. * @return true if there is an intersection
  85730. */
  85731. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85732. }
  85733. }
  85734. declare module BABYLON {
  85735. /** @hidden */
  85736. export class Collider {
  85737. /** Define if a collision was found */
  85738. collisionFound: boolean;
  85739. /**
  85740. * Define last intersection point in local space
  85741. */
  85742. intersectionPoint: Vector3;
  85743. /**
  85744. * Define last collided mesh
  85745. */
  85746. collidedMesh: Nullable<AbstractMesh>;
  85747. private _collisionPoint;
  85748. private _planeIntersectionPoint;
  85749. private _tempVector;
  85750. private _tempVector2;
  85751. private _tempVector3;
  85752. private _tempVector4;
  85753. private _edge;
  85754. private _baseToVertex;
  85755. private _destinationPoint;
  85756. private _slidePlaneNormal;
  85757. private _displacementVector;
  85758. /** @hidden */
  85759. _radius: Vector3;
  85760. /** @hidden */
  85761. _retry: number;
  85762. private _velocity;
  85763. private _basePoint;
  85764. private _epsilon;
  85765. /** @hidden */
  85766. _velocityWorldLength: number;
  85767. /** @hidden */
  85768. _basePointWorld: Vector3;
  85769. private _velocityWorld;
  85770. private _normalizedVelocity;
  85771. /** @hidden */
  85772. _initialVelocity: Vector3;
  85773. /** @hidden */
  85774. _initialPosition: Vector3;
  85775. private _nearestDistance;
  85776. private _collisionMask;
  85777. get collisionMask(): number;
  85778. set collisionMask(mask: number);
  85779. /**
  85780. * Gets the plane normal used to compute the sliding response (in local space)
  85781. */
  85782. get slidePlaneNormal(): Vector3;
  85783. /** @hidden */
  85784. _initialize(source: Vector3, dir: Vector3, e: number): void;
  85785. /** @hidden */
  85786. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  85787. /** @hidden */
  85788. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  85789. /** @hidden */
  85790. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  85791. /** @hidden */
  85792. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  85793. /** @hidden */
  85794. _getResponse(pos: Vector3, vel: Vector3): void;
  85795. }
  85796. }
  85797. declare module BABYLON {
  85798. /**
  85799. * Interface for cullable objects
  85800. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  85801. */
  85802. export interface ICullable {
  85803. /**
  85804. * Checks if the object or part of the object is in the frustum
  85805. * @param frustumPlanes Camera near/planes
  85806. * @returns true if the object is in frustum otherwise false
  85807. */
  85808. isInFrustum(frustumPlanes: Plane[]): boolean;
  85809. /**
  85810. * Checks if a cullable object (mesh...) is in the camera frustum
  85811. * Unlike isInFrustum this cheks the full bounding box
  85812. * @param frustumPlanes Camera near/planes
  85813. * @returns true if the object is in frustum otherwise false
  85814. */
  85815. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  85816. }
  85817. /**
  85818. * Info for a bounding data of a mesh
  85819. */
  85820. export class BoundingInfo implements ICullable {
  85821. /**
  85822. * Bounding box for the mesh
  85823. */
  85824. readonly boundingBox: BoundingBox;
  85825. /**
  85826. * Bounding sphere for the mesh
  85827. */
  85828. readonly boundingSphere: BoundingSphere;
  85829. private _isLocked;
  85830. private static readonly TmpVector3;
  85831. /**
  85832. * Constructs bounding info
  85833. * @param minimum min vector of the bounding box/sphere
  85834. * @param maximum max vector of the bounding box/sphere
  85835. * @param worldMatrix defines the new world matrix
  85836. */
  85837. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85838. /**
  85839. * Recreates the entire bounding info from scratch as if we call the constructor in place
  85840. * @param min defines the new minimum vector (in local space)
  85841. * @param max defines the new maximum vector (in local space)
  85842. * @param worldMatrix defines the new world matrix
  85843. */
  85844. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85845. /**
  85846. * min vector of the bounding box/sphere
  85847. */
  85848. get minimum(): Vector3;
  85849. /**
  85850. * max vector of the bounding box/sphere
  85851. */
  85852. get maximum(): Vector3;
  85853. /**
  85854. * If the info is locked and won't be updated to avoid perf overhead
  85855. */
  85856. get isLocked(): boolean;
  85857. set isLocked(value: boolean);
  85858. /**
  85859. * Updates the bounding sphere and box
  85860. * @param world world matrix to be used to update
  85861. */
  85862. update(world: DeepImmutable<Matrix>): void;
  85863. /**
  85864. * Recreate the bounding info to be centered around a specific point given a specific extend.
  85865. * @param center New center of the bounding info
  85866. * @param extend New extend of the bounding info
  85867. * @returns the current bounding info
  85868. */
  85869. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  85870. /**
  85871. * Scale the current bounding info by applying a scale factor
  85872. * @param factor defines the scale factor to apply
  85873. * @returns the current bounding info
  85874. */
  85875. scale(factor: number): BoundingInfo;
  85876. /**
  85877. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  85878. * @param frustumPlanes defines the frustum to test
  85879. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  85880. * @returns true if the bounding info is in the frustum planes
  85881. */
  85882. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  85883. /**
  85884. * Gets the world distance between the min and max points of the bounding box
  85885. */
  85886. get diagonalLength(): number;
  85887. /**
  85888. * Checks if a cullable object (mesh...) is in the camera frustum
  85889. * Unlike isInFrustum this cheks the full bounding box
  85890. * @param frustumPlanes Camera near/planes
  85891. * @returns true if the object is in frustum otherwise false
  85892. */
  85893. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85894. /** @hidden */
  85895. _checkCollision(collider: Collider): boolean;
  85896. /**
  85897. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  85898. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  85899. * @param point the point to check intersection with
  85900. * @returns if the point intersects
  85901. */
  85902. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85903. /**
  85904. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  85905. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  85906. * @param boundingInfo the bounding info to check intersection with
  85907. * @param precise if the intersection should be done using OBB
  85908. * @returns if the bounding info intersects
  85909. */
  85910. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  85911. }
  85912. }
  85913. declare module BABYLON {
  85914. /**
  85915. * Extracts minimum and maximum values from a list of indexed positions
  85916. * @param positions defines the positions to use
  85917. * @param indices defines the indices to the positions
  85918. * @param indexStart defines the start index
  85919. * @param indexCount defines the end index
  85920. * @param bias defines bias value to add to the result
  85921. * @return minimum and maximum values
  85922. */
  85923. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  85924. minimum: Vector3;
  85925. maximum: Vector3;
  85926. };
  85927. /**
  85928. * Extracts minimum and maximum values from a list of positions
  85929. * @param positions defines the positions to use
  85930. * @param start defines the start index in the positions array
  85931. * @param count defines the number of positions to handle
  85932. * @param bias defines bias value to add to the result
  85933. * @param stride defines the stride size to use (distance between two positions in the positions array)
  85934. * @return minimum and maximum values
  85935. */
  85936. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  85937. minimum: Vector3;
  85938. maximum: Vector3;
  85939. };
  85940. }
  85941. declare module BABYLON {
  85942. /** @hidden */
  85943. export class WebGLDataBuffer extends DataBuffer {
  85944. private _buffer;
  85945. constructor(resource: WebGLBuffer);
  85946. get underlyingResource(): any;
  85947. }
  85948. }
  85949. declare module BABYLON {
  85950. /** @hidden */
  85951. export class WebGLPipelineContext implements IPipelineContext {
  85952. engine: ThinEngine;
  85953. program: Nullable<WebGLProgram>;
  85954. context?: WebGLRenderingContext;
  85955. vertexShader?: WebGLShader;
  85956. fragmentShader?: WebGLShader;
  85957. isParallelCompiled: boolean;
  85958. onCompiled?: () => void;
  85959. transformFeedback?: WebGLTransformFeedback | null;
  85960. vertexCompilationError: Nullable<string>;
  85961. fragmentCompilationError: Nullable<string>;
  85962. programLinkError: Nullable<string>;
  85963. programValidationError: Nullable<string>;
  85964. get isAsync(): boolean;
  85965. get isReady(): boolean;
  85966. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  85967. _getVertexShaderCode(): string | null;
  85968. _getFragmentShaderCode(): string | null;
  85969. }
  85970. }
  85971. declare module BABYLON {
  85972. interface ThinEngine {
  85973. /**
  85974. * Create an uniform buffer
  85975. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85976. * @param elements defines the content of the uniform buffer
  85977. * @returns the webGL uniform buffer
  85978. */
  85979. createUniformBuffer(elements: FloatArray): DataBuffer;
  85980. /**
  85981. * Create a dynamic uniform buffer
  85982. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85983. * @param elements defines the content of the uniform buffer
  85984. * @returns the webGL uniform buffer
  85985. */
  85986. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  85987. /**
  85988. * Update an existing uniform buffer
  85989. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85990. * @param uniformBuffer defines the target uniform buffer
  85991. * @param elements defines the content to update
  85992. * @param offset defines the offset in the uniform buffer where update should start
  85993. * @param count defines the size of the data to update
  85994. */
  85995. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  85996. /**
  85997. * Bind an uniform buffer to the current webGL context
  85998. * @param buffer defines the buffer to bind
  85999. */
  86000. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86001. /**
  86002. * Bind a buffer to the current webGL context at a given location
  86003. * @param buffer defines the buffer to bind
  86004. * @param location defines the index where to bind the buffer
  86005. */
  86006. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86007. /**
  86008. * Bind a specific block at a given index in a specific shader program
  86009. * @param pipelineContext defines the pipeline context to use
  86010. * @param blockName defines the block name
  86011. * @param index defines the index where to bind the block
  86012. */
  86013. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86014. }
  86015. }
  86016. declare module BABYLON {
  86017. /**
  86018. * Uniform buffer objects.
  86019. *
  86020. * Handles blocks of uniform on the GPU.
  86021. *
  86022. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86023. *
  86024. * For more information, please refer to :
  86025. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86026. */
  86027. export class UniformBuffer {
  86028. private _engine;
  86029. private _buffer;
  86030. private _data;
  86031. private _bufferData;
  86032. private _dynamic?;
  86033. private _uniformLocations;
  86034. private _uniformSizes;
  86035. private _uniformLocationPointer;
  86036. private _needSync;
  86037. private _noUBO;
  86038. private _currentEffect;
  86039. /** @hidden */
  86040. _alreadyBound: boolean;
  86041. private static _MAX_UNIFORM_SIZE;
  86042. private static _tempBuffer;
  86043. /**
  86044. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  86045. * This is dynamic to allow compat with webgl 1 and 2.
  86046. * You will need to pass the name of the uniform as well as the value.
  86047. */
  86048. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  86049. /**
  86050. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  86051. * This is dynamic to allow compat with webgl 1 and 2.
  86052. * You will need to pass the name of the uniform as well as the value.
  86053. */
  86054. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  86055. /**
  86056. * Lambda to Update a single float in a uniform buffer.
  86057. * This is dynamic to allow compat with webgl 1 and 2.
  86058. * You will need to pass the name of the uniform as well as the value.
  86059. */
  86060. updateFloat: (name: string, x: number) => void;
  86061. /**
  86062. * Lambda to Update a vec2 of float in a uniform buffer.
  86063. * This is dynamic to allow compat with webgl 1 and 2.
  86064. * You will need to pass the name of the uniform as well as the value.
  86065. */
  86066. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  86067. /**
  86068. * Lambda to Update a vec3 of float in a uniform buffer.
  86069. * This is dynamic to allow compat with webgl 1 and 2.
  86070. * You will need to pass the name of the uniform as well as the value.
  86071. */
  86072. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  86073. /**
  86074. * Lambda to Update a vec4 of float in a uniform buffer.
  86075. * This is dynamic to allow compat with webgl 1 and 2.
  86076. * You will need to pass the name of the uniform as well as the value.
  86077. */
  86078. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  86079. /**
  86080. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  86081. * This is dynamic to allow compat with webgl 1 and 2.
  86082. * You will need to pass the name of the uniform as well as the value.
  86083. */
  86084. updateMatrix: (name: string, mat: Matrix) => void;
  86085. /**
  86086. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  86087. * This is dynamic to allow compat with webgl 1 and 2.
  86088. * You will need to pass the name of the uniform as well as the value.
  86089. */
  86090. updateVector3: (name: string, vector: Vector3) => void;
  86091. /**
  86092. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  86093. * This is dynamic to allow compat with webgl 1 and 2.
  86094. * You will need to pass the name of the uniform as well as the value.
  86095. */
  86096. updateVector4: (name: string, vector: Vector4) => void;
  86097. /**
  86098. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  86099. * This is dynamic to allow compat with webgl 1 and 2.
  86100. * You will need to pass the name of the uniform as well as the value.
  86101. */
  86102. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  86103. /**
  86104. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  86105. * This is dynamic to allow compat with webgl 1 and 2.
  86106. * You will need to pass the name of the uniform as well as the value.
  86107. */
  86108. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  86109. /**
  86110. * Instantiates a new Uniform buffer objects.
  86111. *
  86112. * Handles blocks of uniform on the GPU.
  86113. *
  86114. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86115. *
  86116. * For more information, please refer to :
  86117. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86118. * @param engine Define the engine the buffer is associated with
  86119. * @param data Define the data contained in the buffer
  86120. * @param dynamic Define if the buffer is updatable
  86121. */
  86122. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  86123. /**
  86124. * Indicates if the buffer is using the WebGL2 UBO implementation,
  86125. * or just falling back on setUniformXXX calls.
  86126. */
  86127. get useUbo(): boolean;
  86128. /**
  86129. * Indicates if the WebGL underlying uniform buffer is in sync
  86130. * with the javascript cache data.
  86131. */
  86132. get isSync(): boolean;
  86133. /**
  86134. * Indicates if the WebGL underlying uniform buffer is dynamic.
  86135. * Also, a dynamic UniformBuffer will disable cache verification and always
  86136. * update the underlying WebGL uniform buffer to the GPU.
  86137. * @returns if Dynamic, otherwise false
  86138. */
  86139. isDynamic(): boolean;
  86140. /**
  86141. * The data cache on JS side.
  86142. * @returns the underlying data as a float array
  86143. */
  86144. getData(): Float32Array;
  86145. /**
  86146. * The underlying WebGL Uniform buffer.
  86147. * @returns the webgl buffer
  86148. */
  86149. getBuffer(): Nullable<DataBuffer>;
  86150. /**
  86151. * std140 layout specifies how to align data within an UBO structure.
  86152. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  86153. * for specs.
  86154. */
  86155. private _fillAlignment;
  86156. /**
  86157. * Adds an uniform in the buffer.
  86158. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  86159. * for the layout to be correct !
  86160. * @param name Name of the uniform, as used in the uniform block in the shader.
  86161. * @param size Data size, or data directly.
  86162. */
  86163. addUniform(name: string, size: number | number[]): void;
  86164. /**
  86165. * Adds a Matrix 4x4 to the uniform buffer.
  86166. * @param name Name of the uniform, as used in the uniform block in the shader.
  86167. * @param mat A 4x4 matrix.
  86168. */
  86169. addMatrix(name: string, mat: Matrix): void;
  86170. /**
  86171. * Adds a vec2 to the uniform buffer.
  86172. * @param name Name of the uniform, as used in the uniform block in the shader.
  86173. * @param x Define the x component value of the vec2
  86174. * @param y Define the y component value of the vec2
  86175. */
  86176. addFloat2(name: string, x: number, y: number): void;
  86177. /**
  86178. * Adds a vec3 to the uniform buffer.
  86179. * @param name Name of the uniform, as used in the uniform block in the shader.
  86180. * @param x Define the x component value of the vec3
  86181. * @param y Define the y component value of the vec3
  86182. * @param z Define the z component value of the vec3
  86183. */
  86184. addFloat3(name: string, x: number, y: number, z: number): void;
  86185. /**
  86186. * Adds a vec3 to the uniform buffer.
  86187. * @param name Name of the uniform, as used in the uniform block in the shader.
  86188. * @param color Define the vec3 from a Color
  86189. */
  86190. addColor3(name: string, color: Color3): void;
  86191. /**
  86192. * Adds a vec4 to the uniform buffer.
  86193. * @param name Name of the uniform, as used in the uniform block in the shader.
  86194. * @param color Define the rgb components from a Color
  86195. * @param alpha Define the a component of the vec4
  86196. */
  86197. addColor4(name: string, color: Color3, alpha: number): void;
  86198. /**
  86199. * Adds a vec3 to the uniform buffer.
  86200. * @param name Name of the uniform, as used in the uniform block in the shader.
  86201. * @param vector Define the vec3 components from a Vector
  86202. */
  86203. addVector3(name: string, vector: Vector3): void;
  86204. /**
  86205. * Adds a Matrix 3x3 to the uniform buffer.
  86206. * @param name Name of the uniform, as used in the uniform block in the shader.
  86207. */
  86208. addMatrix3x3(name: string): void;
  86209. /**
  86210. * Adds a Matrix 2x2 to the uniform buffer.
  86211. * @param name Name of the uniform, as used in the uniform block in the shader.
  86212. */
  86213. addMatrix2x2(name: string): void;
  86214. /**
  86215. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  86216. */
  86217. create(): void;
  86218. /** @hidden */
  86219. _rebuild(): void;
  86220. /**
  86221. * Updates the WebGL Uniform Buffer on the GPU.
  86222. * If the `dynamic` flag is set to true, no cache comparison is done.
  86223. * Otherwise, the buffer will be updated only if the cache differs.
  86224. */
  86225. update(): void;
  86226. /**
  86227. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  86228. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86229. * @param data Define the flattened data
  86230. * @param size Define the size of the data.
  86231. */
  86232. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  86233. private _valueCache;
  86234. private _cacheMatrix;
  86235. private _updateMatrix3x3ForUniform;
  86236. private _updateMatrix3x3ForEffect;
  86237. private _updateMatrix2x2ForEffect;
  86238. private _updateMatrix2x2ForUniform;
  86239. private _updateFloatForEffect;
  86240. private _updateFloatForUniform;
  86241. private _updateFloat2ForEffect;
  86242. private _updateFloat2ForUniform;
  86243. private _updateFloat3ForEffect;
  86244. private _updateFloat3ForUniform;
  86245. private _updateFloat4ForEffect;
  86246. private _updateFloat4ForUniform;
  86247. private _updateMatrixForEffect;
  86248. private _updateMatrixForUniform;
  86249. private _updateVector3ForEffect;
  86250. private _updateVector3ForUniform;
  86251. private _updateVector4ForEffect;
  86252. private _updateVector4ForUniform;
  86253. private _updateColor3ForEffect;
  86254. private _updateColor3ForUniform;
  86255. private _updateColor4ForEffect;
  86256. private _updateColor4ForUniform;
  86257. /**
  86258. * Sets a sampler uniform on the effect.
  86259. * @param name Define the name of the sampler.
  86260. * @param texture Define the texture to set in the sampler
  86261. */
  86262. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  86263. /**
  86264. * Directly updates the value of the uniform in the cache AND on the GPU.
  86265. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86266. * @param data Define the flattened data
  86267. */
  86268. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  86269. /**
  86270. * Binds this uniform buffer to an effect.
  86271. * @param effect Define the effect to bind the buffer to
  86272. * @param name Name of the uniform block in the shader.
  86273. */
  86274. bindToEffect(effect: Effect, name: string): void;
  86275. /**
  86276. * Disposes the uniform buffer.
  86277. */
  86278. dispose(): void;
  86279. }
  86280. }
  86281. declare module BABYLON {
  86282. /**
  86283. * Enum that determines the text-wrapping mode to use.
  86284. */
  86285. export enum InspectableType {
  86286. /**
  86287. * Checkbox for booleans
  86288. */
  86289. Checkbox = 0,
  86290. /**
  86291. * Sliders for numbers
  86292. */
  86293. Slider = 1,
  86294. /**
  86295. * Vector3
  86296. */
  86297. Vector3 = 2,
  86298. /**
  86299. * Quaternions
  86300. */
  86301. Quaternion = 3,
  86302. /**
  86303. * Color3
  86304. */
  86305. Color3 = 4,
  86306. /**
  86307. * String
  86308. */
  86309. String = 5
  86310. }
  86311. /**
  86312. * Interface used to define custom inspectable properties.
  86313. * This interface is used by the inspector to display custom property grids
  86314. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  86315. */
  86316. export interface IInspectable {
  86317. /**
  86318. * Gets the label to display
  86319. */
  86320. label: string;
  86321. /**
  86322. * Gets the name of the property to edit
  86323. */
  86324. propertyName: string;
  86325. /**
  86326. * Gets the type of the editor to use
  86327. */
  86328. type: InspectableType;
  86329. /**
  86330. * Gets the minimum value of the property when using in "slider" mode
  86331. */
  86332. min?: number;
  86333. /**
  86334. * Gets the maximum value of the property when using in "slider" mode
  86335. */
  86336. max?: number;
  86337. /**
  86338. * Gets the setp to use when using in "slider" mode
  86339. */
  86340. step?: number;
  86341. }
  86342. }
  86343. declare module BABYLON {
  86344. /**
  86345. * Class used to provide helper for timing
  86346. */
  86347. export class TimingTools {
  86348. /**
  86349. * Polyfill for setImmediate
  86350. * @param action defines the action to execute after the current execution block
  86351. */
  86352. static SetImmediate(action: () => void): void;
  86353. }
  86354. }
  86355. declare module BABYLON {
  86356. /**
  86357. * Class used to enable instatition of objects by class name
  86358. */
  86359. export class InstantiationTools {
  86360. /**
  86361. * Use this object to register external classes like custom textures or material
  86362. * to allow the laoders to instantiate them
  86363. */
  86364. static RegisteredExternalClasses: {
  86365. [key: string]: Object;
  86366. };
  86367. /**
  86368. * Tries to instantiate a new object from a given class name
  86369. * @param className defines the class name to instantiate
  86370. * @returns the new object or null if the system was not able to do the instantiation
  86371. */
  86372. static Instantiate(className: string): any;
  86373. }
  86374. }
  86375. declare module BABYLON {
  86376. /**
  86377. * Define options used to create a depth texture
  86378. */
  86379. export class DepthTextureCreationOptions {
  86380. /** Specifies whether or not a stencil should be allocated in the texture */
  86381. generateStencil?: boolean;
  86382. /** Specifies whether or not bilinear filtering is enable on the texture */
  86383. bilinearFiltering?: boolean;
  86384. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  86385. comparisonFunction?: number;
  86386. /** Specifies if the created texture is a cube texture */
  86387. isCube?: boolean;
  86388. }
  86389. }
  86390. declare module BABYLON {
  86391. interface ThinEngine {
  86392. /**
  86393. * Creates a depth stencil cube texture.
  86394. * This is only available in WebGL 2.
  86395. * @param size The size of face edge in the cube texture.
  86396. * @param options The options defining the cube texture.
  86397. * @returns The cube texture
  86398. */
  86399. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  86400. /**
  86401. * Creates a cube texture
  86402. * @param rootUrl defines the url where the files to load is located
  86403. * @param scene defines the current scene
  86404. * @param files defines the list of files to load (1 per face)
  86405. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86406. * @param onLoad defines an optional callback raised when the texture is loaded
  86407. * @param onError defines an optional callback raised if there is an issue to load the texture
  86408. * @param format defines the format of the data
  86409. * @param forcedExtension defines the extension to use to pick the right loader
  86410. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  86411. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86412. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86413. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  86414. * @returns the cube texture as an InternalTexture
  86415. */
  86416. 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;
  86417. /**
  86418. * Creates a cube texture
  86419. * @param rootUrl defines the url where the files to load is located
  86420. * @param scene defines the current scene
  86421. * @param files defines the list of files to load (1 per face)
  86422. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86423. * @param onLoad defines an optional callback raised when the texture is loaded
  86424. * @param onError defines an optional callback raised if there is an issue to load the texture
  86425. * @param format defines the format of the data
  86426. * @param forcedExtension defines the extension to use to pick the right loader
  86427. * @returns the cube texture as an InternalTexture
  86428. */
  86429. 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;
  86430. /**
  86431. * Creates a cube texture
  86432. * @param rootUrl defines the url where the files to load is located
  86433. * @param scene defines the current scene
  86434. * @param files defines the list of files to load (1 per face)
  86435. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86436. * @param onLoad defines an optional callback raised when the texture is loaded
  86437. * @param onError defines an optional callback raised if there is an issue to load the texture
  86438. * @param format defines the format of the data
  86439. * @param forcedExtension defines the extension to use to pick the right loader
  86440. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  86441. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86442. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86443. * @returns the cube texture as an InternalTexture
  86444. */
  86445. 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;
  86446. /** @hidden */
  86447. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  86448. /** @hidden */
  86449. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  86450. /** @hidden */
  86451. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  86452. /** @hidden */
  86453. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  86454. /**
  86455. * @hidden
  86456. */
  86457. _setCubeMapTextureParams(loadMipmap: boolean): void;
  86458. }
  86459. }
  86460. declare module BABYLON {
  86461. /**
  86462. * Class for creating a cube texture
  86463. */
  86464. export class CubeTexture extends BaseTexture {
  86465. private _delayedOnLoad;
  86466. /**
  86467. * Observable triggered once the texture has been loaded.
  86468. */
  86469. onLoadObservable: Observable<CubeTexture>;
  86470. /**
  86471. * The url of the texture
  86472. */
  86473. url: string;
  86474. /**
  86475. * Gets or sets the center of the bounding box associated with the cube texture.
  86476. * It must define where the camera used to render the texture was set
  86477. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  86478. */
  86479. boundingBoxPosition: Vector3;
  86480. private _boundingBoxSize;
  86481. /**
  86482. * Gets or sets the size of the bounding box associated with the cube texture
  86483. * When defined, the cubemap will switch to local mode
  86484. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  86485. * @example https://www.babylonjs-playground.com/#RNASML
  86486. */
  86487. set boundingBoxSize(value: Vector3);
  86488. /**
  86489. * Returns the bounding box size
  86490. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  86491. */
  86492. get boundingBoxSize(): Vector3;
  86493. protected _rotationY: number;
  86494. /**
  86495. * Sets texture matrix rotation angle around Y axis in radians.
  86496. */
  86497. set rotationY(value: number);
  86498. /**
  86499. * Gets texture matrix rotation angle around Y axis radians.
  86500. */
  86501. get rotationY(): number;
  86502. /**
  86503. * Are mip maps generated for this texture or not.
  86504. */
  86505. get noMipmap(): boolean;
  86506. private _noMipmap;
  86507. private _files;
  86508. protected _forcedExtension: Nullable<string>;
  86509. private _extensions;
  86510. private _textureMatrix;
  86511. private _format;
  86512. private _createPolynomials;
  86513. /**
  86514. * Creates a cube texture from an array of image urls
  86515. * @param files defines an array of image urls
  86516. * @param scene defines the hosting scene
  86517. * @param noMipmap specifies if mip maps are not used
  86518. * @returns a cube texture
  86519. */
  86520. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  86521. /**
  86522. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  86523. * @param url defines the url of the prefiltered texture
  86524. * @param scene defines the scene the texture is attached to
  86525. * @param forcedExtension defines the extension of the file if different from the url
  86526. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  86527. * @return the prefiltered texture
  86528. */
  86529. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  86530. /**
  86531. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  86532. * as prefiltered data.
  86533. * @param rootUrl defines the url of the texture or the root name of the six images
  86534. * @param null defines the scene or engine the texture is attached to
  86535. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  86536. * @param noMipmap defines if mipmaps should be created or not
  86537. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  86538. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  86539. * @param onError defines a callback triggered in case of error during load
  86540. * @param format defines the internal format to use for the texture once loaded
  86541. * @param prefiltered defines whether or not the texture is created from prefiltered data
  86542. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  86543. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  86544. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86545. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86546. * @return the cube texture
  86547. */
  86548. 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);
  86549. /**
  86550. * Get the current class name of the texture useful for serialization or dynamic coding.
  86551. * @returns "CubeTexture"
  86552. */
  86553. getClassName(): string;
  86554. /**
  86555. * Update the url (and optional buffer) of this texture if url was null during construction.
  86556. * @param url the url of the texture
  86557. * @param forcedExtension defines the extension to use
  86558. * @param onLoad callback called when the texture is loaded (defaults to null)
  86559. * @param prefiltered Defines whether the updated texture is prefiltered or not
  86560. */
  86561. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  86562. /**
  86563. * Delays loading of the cube texture
  86564. * @param forcedExtension defines the extension to use
  86565. */
  86566. delayLoad(forcedExtension?: string): void;
  86567. /**
  86568. * Returns the reflection texture matrix
  86569. * @returns the reflection texture matrix
  86570. */
  86571. getReflectionTextureMatrix(): Matrix;
  86572. /**
  86573. * Sets the reflection texture matrix
  86574. * @param value Reflection texture matrix
  86575. */
  86576. setReflectionTextureMatrix(value: Matrix): void;
  86577. /**
  86578. * Parses text to create a cube texture
  86579. * @param parsedTexture define the serialized text to read from
  86580. * @param scene defines the hosting scene
  86581. * @param rootUrl defines the root url of the cube texture
  86582. * @returns a cube texture
  86583. */
  86584. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  86585. /**
  86586. * Makes a clone, or deep copy, of the cube texture
  86587. * @returns a new cube texture
  86588. */
  86589. clone(): CubeTexture;
  86590. }
  86591. }
  86592. declare module BABYLON {
  86593. /**
  86594. * Manages the defines for the Material
  86595. */
  86596. export class MaterialDefines {
  86597. /** @hidden */
  86598. protected _keys: string[];
  86599. private _isDirty;
  86600. /** @hidden */
  86601. _renderId: number;
  86602. /** @hidden */
  86603. _areLightsDirty: boolean;
  86604. /** @hidden */
  86605. _areLightsDisposed: boolean;
  86606. /** @hidden */
  86607. _areAttributesDirty: boolean;
  86608. /** @hidden */
  86609. _areTexturesDirty: boolean;
  86610. /** @hidden */
  86611. _areFresnelDirty: boolean;
  86612. /** @hidden */
  86613. _areMiscDirty: boolean;
  86614. /** @hidden */
  86615. _areImageProcessingDirty: boolean;
  86616. /** @hidden */
  86617. _normals: boolean;
  86618. /** @hidden */
  86619. _uvs: boolean;
  86620. /** @hidden */
  86621. _needNormals: boolean;
  86622. /** @hidden */
  86623. _needUVs: boolean;
  86624. [id: string]: any;
  86625. /**
  86626. * Specifies if the material needs to be re-calculated
  86627. */
  86628. get isDirty(): boolean;
  86629. /**
  86630. * Marks the material to indicate that it has been re-calculated
  86631. */
  86632. markAsProcessed(): void;
  86633. /**
  86634. * Marks the material to indicate that it needs to be re-calculated
  86635. */
  86636. markAsUnprocessed(): void;
  86637. /**
  86638. * Marks the material to indicate all of its defines need to be re-calculated
  86639. */
  86640. markAllAsDirty(): void;
  86641. /**
  86642. * Marks the material to indicate that image processing needs to be re-calculated
  86643. */
  86644. markAsImageProcessingDirty(): void;
  86645. /**
  86646. * Marks the material to indicate the lights need to be re-calculated
  86647. * @param disposed Defines whether the light is dirty due to dispose or not
  86648. */
  86649. markAsLightDirty(disposed?: boolean): void;
  86650. /**
  86651. * Marks the attribute state as changed
  86652. */
  86653. markAsAttributesDirty(): void;
  86654. /**
  86655. * Marks the texture state as changed
  86656. */
  86657. markAsTexturesDirty(): void;
  86658. /**
  86659. * Marks the fresnel state as changed
  86660. */
  86661. markAsFresnelDirty(): void;
  86662. /**
  86663. * Marks the misc state as changed
  86664. */
  86665. markAsMiscDirty(): void;
  86666. /**
  86667. * Rebuilds the material defines
  86668. */
  86669. rebuild(): void;
  86670. /**
  86671. * Specifies if two material defines are equal
  86672. * @param other - A material define instance to compare to
  86673. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  86674. */
  86675. isEqual(other: MaterialDefines): boolean;
  86676. /**
  86677. * Clones this instance's defines to another instance
  86678. * @param other - material defines to clone values to
  86679. */
  86680. cloneTo(other: MaterialDefines): void;
  86681. /**
  86682. * Resets the material define values
  86683. */
  86684. reset(): void;
  86685. /**
  86686. * Converts the material define values to a string
  86687. * @returns - String of material define information
  86688. */
  86689. toString(): string;
  86690. }
  86691. }
  86692. declare module BABYLON {
  86693. /**
  86694. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  86695. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  86696. * 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;
  86697. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  86698. */
  86699. export class ColorCurves {
  86700. private _dirty;
  86701. private _tempColor;
  86702. private _globalCurve;
  86703. private _highlightsCurve;
  86704. private _midtonesCurve;
  86705. private _shadowsCurve;
  86706. private _positiveCurve;
  86707. private _negativeCurve;
  86708. private _globalHue;
  86709. private _globalDensity;
  86710. private _globalSaturation;
  86711. private _globalExposure;
  86712. /**
  86713. * Gets the global Hue value.
  86714. * 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).
  86715. */
  86716. get globalHue(): number;
  86717. /**
  86718. * Sets the global Hue value.
  86719. * 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).
  86720. */
  86721. set globalHue(value: number);
  86722. /**
  86723. * Gets the global Density value.
  86724. * 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.
  86725. * Values less than zero provide a filter of opposite hue.
  86726. */
  86727. get globalDensity(): number;
  86728. /**
  86729. * Sets the global Density value.
  86730. * 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.
  86731. * Values less than zero provide a filter of opposite hue.
  86732. */
  86733. set globalDensity(value: number);
  86734. /**
  86735. * Gets the global Saturation value.
  86736. * 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.
  86737. */
  86738. get globalSaturation(): number;
  86739. /**
  86740. * Sets the global Saturation value.
  86741. * 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.
  86742. */
  86743. set globalSaturation(value: number);
  86744. /**
  86745. * Gets the global Exposure value.
  86746. * 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.
  86747. */
  86748. get globalExposure(): number;
  86749. /**
  86750. * Sets the global Exposure value.
  86751. * 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.
  86752. */
  86753. set globalExposure(value: number);
  86754. private _highlightsHue;
  86755. private _highlightsDensity;
  86756. private _highlightsSaturation;
  86757. private _highlightsExposure;
  86758. /**
  86759. * Gets the highlights Hue value.
  86760. * 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).
  86761. */
  86762. get highlightsHue(): number;
  86763. /**
  86764. * Sets the highlights Hue value.
  86765. * 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).
  86766. */
  86767. set highlightsHue(value: number);
  86768. /**
  86769. * Gets the highlights Density value.
  86770. * 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.
  86771. * Values less than zero provide a filter of opposite hue.
  86772. */
  86773. get highlightsDensity(): number;
  86774. /**
  86775. * Sets the highlights Density value.
  86776. * 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.
  86777. * Values less than zero provide a filter of opposite hue.
  86778. */
  86779. set highlightsDensity(value: number);
  86780. /**
  86781. * Gets the highlights Saturation value.
  86782. * 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.
  86783. */
  86784. get highlightsSaturation(): number;
  86785. /**
  86786. * Sets the highlights Saturation value.
  86787. * 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.
  86788. */
  86789. set highlightsSaturation(value: number);
  86790. /**
  86791. * Gets the highlights Exposure value.
  86792. * 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.
  86793. */
  86794. get highlightsExposure(): number;
  86795. /**
  86796. * Sets the highlights Exposure value.
  86797. * 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.
  86798. */
  86799. set highlightsExposure(value: number);
  86800. private _midtonesHue;
  86801. private _midtonesDensity;
  86802. private _midtonesSaturation;
  86803. private _midtonesExposure;
  86804. /**
  86805. * Gets the midtones Hue value.
  86806. * 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).
  86807. */
  86808. get midtonesHue(): number;
  86809. /**
  86810. * Sets the midtones Hue value.
  86811. * 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).
  86812. */
  86813. set midtonesHue(value: number);
  86814. /**
  86815. * Gets the midtones Density value.
  86816. * 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.
  86817. * Values less than zero provide a filter of opposite hue.
  86818. */
  86819. get midtonesDensity(): number;
  86820. /**
  86821. * Sets the midtones Density value.
  86822. * 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.
  86823. * Values less than zero provide a filter of opposite hue.
  86824. */
  86825. set midtonesDensity(value: number);
  86826. /**
  86827. * Gets the midtones Saturation value.
  86828. * 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.
  86829. */
  86830. get midtonesSaturation(): number;
  86831. /**
  86832. * Sets the midtones Saturation value.
  86833. * 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.
  86834. */
  86835. set midtonesSaturation(value: number);
  86836. /**
  86837. * Gets the midtones Exposure value.
  86838. * 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.
  86839. */
  86840. get midtonesExposure(): number;
  86841. /**
  86842. * Sets the midtones Exposure value.
  86843. * 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.
  86844. */
  86845. set midtonesExposure(value: number);
  86846. private _shadowsHue;
  86847. private _shadowsDensity;
  86848. private _shadowsSaturation;
  86849. private _shadowsExposure;
  86850. /**
  86851. * Gets the shadows Hue value.
  86852. * 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).
  86853. */
  86854. get shadowsHue(): number;
  86855. /**
  86856. * Sets the shadows Hue value.
  86857. * 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).
  86858. */
  86859. set shadowsHue(value: number);
  86860. /**
  86861. * Gets the shadows Density value.
  86862. * 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.
  86863. * Values less than zero provide a filter of opposite hue.
  86864. */
  86865. get shadowsDensity(): number;
  86866. /**
  86867. * Sets the shadows Density value.
  86868. * 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.
  86869. * Values less than zero provide a filter of opposite hue.
  86870. */
  86871. set shadowsDensity(value: number);
  86872. /**
  86873. * Gets the shadows Saturation value.
  86874. * 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.
  86875. */
  86876. get shadowsSaturation(): number;
  86877. /**
  86878. * Sets the shadows Saturation value.
  86879. * 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.
  86880. */
  86881. set shadowsSaturation(value: number);
  86882. /**
  86883. * Gets the shadows Exposure value.
  86884. * 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.
  86885. */
  86886. get shadowsExposure(): number;
  86887. /**
  86888. * Sets the shadows Exposure value.
  86889. * 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.
  86890. */
  86891. set shadowsExposure(value: number);
  86892. /**
  86893. * Returns the class name
  86894. * @returns The class name
  86895. */
  86896. getClassName(): string;
  86897. /**
  86898. * Binds the color curves to the shader.
  86899. * @param colorCurves The color curve to bind
  86900. * @param effect The effect to bind to
  86901. * @param positiveUniform The positive uniform shader parameter
  86902. * @param neutralUniform The neutral uniform shader parameter
  86903. * @param negativeUniform The negative uniform shader parameter
  86904. */
  86905. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  86906. /**
  86907. * Prepare the list of uniforms associated with the ColorCurves effects.
  86908. * @param uniformsList The list of uniforms used in the effect
  86909. */
  86910. static PrepareUniforms(uniformsList: string[]): void;
  86911. /**
  86912. * Returns color grading data based on a hue, density, saturation and exposure value.
  86913. * @param filterHue The hue of the color filter.
  86914. * @param filterDensity The density of the color filter.
  86915. * @param saturation The saturation.
  86916. * @param exposure The exposure.
  86917. * @param result The result data container.
  86918. */
  86919. private getColorGradingDataToRef;
  86920. /**
  86921. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  86922. * @param value The input slider value in range [-100,100].
  86923. * @returns Adjusted value.
  86924. */
  86925. private static applyColorGradingSliderNonlinear;
  86926. /**
  86927. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  86928. * @param hue The hue (H) input.
  86929. * @param saturation The saturation (S) input.
  86930. * @param brightness The brightness (B) input.
  86931. * @result An RGBA color represented as Vector4.
  86932. */
  86933. private static fromHSBToRef;
  86934. /**
  86935. * Returns a value clamped between min and max
  86936. * @param value The value to clamp
  86937. * @param min The minimum of value
  86938. * @param max The maximum of value
  86939. * @returns The clamped value.
  86940. */
  86941. private static clamp;
  86942. /**
  86943. * Clones the current color curve instance.
  86944. * @return The cloned curves
  86945. */
  86946. clone(): ColorCurves;
  86947. /**
  86948. * Serializes the current color curve instance to a json representation.
  86949. * @return a JSON representation
  86950. */
  86951. serialize(): any;
  86952. /**
  86953. * Parses the color curve from a json representation.
  86954. * @param source the JSON source to parse
  86955. * @return The parsed curves
  86956. */
  86957. static Parse(source: any): ColorCurves;
  86958. }
  86959. }
  86960. declare module BABYLON {
  86961. /**
  86962. * Interface to follow in your material defines to integrate easily the
  86963. * Image proccessing functions.
  86964. * @hidden
  86965. */
  86966. export interface IImageProcessingConfigurationDefines {
  86967. IMAGEPROCESSING: boolean;
  86968. VIGNETTE: boolean;
  86969. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86970. VIGNETTEBLENDMODEOPAQUE: boolean;
  86971. TONEMAPPING: boolean;
  86972. TONEMAPPING_ACES: boolean;
  86973. CONTRAST: boolean;
  86974. EXPOSURE: boolean;
  86975. COLORCURVES: boolean;
  86976. COLORGRADING: boolean;
  86977. COLORGRADING3D: boolean;
  86978. SAMPLER3DGREENDEPTH: boolean;
  86979. SAMPLER3DBGRMAP: boolean;
  86980. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86981. }
  86982. /**
  86983. * @hidden
  86984. */
  86985. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  86986. IMAGEPROCESSING: boolean;
  86987. VIGNETTE: boolean;
  86988. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86989. VIGNETTEBLENDMODEOPAQUE: boolean;
  86990. TONEMAPPING: boolean;
  86991. TONEMAPPING_ACES: boolean;
  86992. CONTRAST: boolean;
  86993. COLORCURVES: boolean;
  86994. COLORGRADING: boolean;
  86995. COLORGRADING3D: boolean;
  86996. SAMPLER3DGREENDEPTH: boolean;
  86997. SAMPLER3DBGRMAP: boolean;
  86998. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86999. EXPOSURE: boolean;
  87000. constructor();
  87001. }
  87002. /**
  87003. * This groups together the common properties used for image processing either in direct forward pass
  87004. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87005. * or not.
  87006. */
  87007. export class ImageProcessingConfiguration {
  87008. /**
  87009. * Default tone mapping applied in BabylonJS.
  87010. */
  87011. static readonly TONEMAPPING_STANDARD: number;
  87012. /**
  87013. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87014. * to other engines rendering to increase portability.
  87015. */
  87016. static readonly TONEMAPPING_ACES: number;
  87017. /**
  87018. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87019. */
  87020. colorCurves: Nullable<ColorCurves>;
  87021. private _colorCurvesEnabled;
  87022. /**
  87023. * Gets wether the color curves effect is enabled.
  87024. */
  87025. get colorCurvesEnabled(): boolean;
  87026. /**
  87027. * Sets wether the color curves effect is enabled.
  87028. */
  87029. set colorCurvesEnabled(value: boolean);
  87030. private _colorGradingTexture;
  87031. /**
  87032. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87033. */
  87034. get colorGradingTexture(): Nullable<BaseTexture>;
  87035. /**
  87036. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87037. */
  87038. set colorGradingTexture(value: Nullable<BaseTexture>);
  87039. private _colorGradingEnabled;
  87040. /**
  87041. * Gets wether the color grading effect is enabled.
  87042. */
  87043. get colorGradingEnabled(): boolean;
  87044. /**
  87045. * Sets wether the color grading effect is enabled.
  87046. */
  87047. set colorGradingEnabled(value: boolean);
  87048. private _colorGradingWithGreenDepth;
  87049. /**
  87050. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  87051. */
  87052. get colorGradingWithGreenDepth(): boolean;
  87053. /**
  87054. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  87055. */
  87056. set colorGradingWithGreenDepth(value: boolean);
  87057. private _colorGradingBGR;
  87058. /**
  87059. * Gets wether the color grading texture contains BGR values.
  87060. */
  87061. get colorGradingBGR(): boolean;
  87062. /**
  87063. * Sets wether the color grading texture contains BGR values.
  87064. */
  87065. set colorGradingBGR(value: boolean);
  87066. /** @hidden */
  87067. _exposure: number;
  87068. /**
  87069. * Gets the Exposure used in the effect.
  87070. */
  87071. get exposure(): number;
  87072. /**
  87073. * Sets the Exposure used in the effect.
  87074. */
  87075. set exposure(value: number);
  87076. private _toneMappingEnabled;
  87077. /**
  87078. * Gets wether the tone mapping effect is enabled.
  87079. */
  87080. get toneMappingEnabled(): boolean;
  87081. /**
  87082. * Sets wether the tone mapping effect is enabled.
  87083. */
  87084. set toneMappingEnabled(value: boolean);
  87085. private _toneMappingType;
  87086. /**
  87087. * Gets the type of tone mapping effect.
  87088. */
  87089. get toneMappingType(): number;
  87090. /**
  87091. * Sets the type of tone mapping effect used in BabylonJS.
  87092. */
  87093. set toneMappingType(value: number);
  87094. protected _contrast: number;
  87095. /**
  87096. * Gets the contrast used in the effect.
  87097. */
  87098. get contrast(): number;
  87099. /**
  87100. * Sets the contrast used in the effect.
  87101. */
  87102. set contrast(value: number);
  87103. /**
  87104. * Vignette stretch size.
  87105. */
  87106. vignetteStretch: number;
  87107. /**
  87108. * Vignette centre X Offset.
  87109. */
  87110. vignetteCentreX: number;
  87111. /**
  87112. * Vignette centre Y Offset.
  87113. */
  87114. vignetteCentreY: number;
  87115. /**
  87116. * Vignette weight or intensity of the vignette effect.
  87117. */
  87118. vignetteWeight: number;
  87119. /**
  87120. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  87121. * if vignetteEnabled is set to true.
  87122. */
  87123. vignetteColor: Color4;
  87124. /**
  87125. * Camera field of view used by the Vignette effect.
  87126. */
  87127. vignetteCameraFov: number;
  87128. private _vignetteBlendMode;
  87129. /**
  87130. * Gets the vignette blend mode allowing different kind of effect.
  87131. */
  87132. get vignetteBlendMode(): number;
  87133. /**
  87134. * Sets the vignette blend mode allowing different kind of effect.
  87135. */
  87136. set vignetteBlendMode(value: number);
  87137. private _vignetteEnabled;
  87138. /**
  87139. * Gets wether the vignette effect is enabled.
  87140. */
  87141. get vignetteEnabled(): boolean;
  87142. /**
  87143. * Sets wether the vignette effect is enabled.
  87144. */
  87145. set vignetteEnabled(value: boolean);
  87146. private _applyByPostProcess;
  87147. /**
  87148. * Gets wether the image processing is applied through a post process or not.
  87149. */
  87150. get applyByPostProcess(): boolean;
  87151. /**
  87152. * Sets wether the image processing is applied through a post process or not.
  87153. */
  87154. set applyByPostProcess(value: boolean);
  87155. private _isEnabled;
  87156. /**
  87157. * Gets wether the image processing is enabled or not.
  87158. */
  87159. get isEnabled(): boolean;
  87160. /**
  87161. * Sets wether the image processing is enabled or not.
  87162. */
  87163. set isEnabled(value: boolean);
  87164. /**
  87165. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  87166. */
  87167. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  87168. /**
  87169. * Method called each time the image processing information changes requires to recompile the effect.
  87170. */
  87171. protected _updateParameters(): void;
  87172. /**
  87173. * Gets the current class name.
  87174. * @return "ImageProcessingConfiguration"
  87175. */
  87176. getClassName(): string;
  87177. /**
  87178. * Prepare the list of uniforms associated with the Image Processing effects.
  87179. * @param uniforms The list of uniforms used in the effect
  87180. * @param defines the list of defines currently in use
  87181. */
  87182. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  87183. /**
  87184. * Prepare the list of samplers associated with the Image Processing effects.
  87185. * @param samplersList The list of uniforms used in the effect
  87186. * @param defines the list of defines currently in use
  87187. */
  87188. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  87189. /**
  87190. * Prepare the list of defines associated to the shader.
  87191. * @param defines the list of defines to complete
  87192. * @param forPostProcess Define if we are currently in post process mode or not
  87193. */
  87194. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  87195. /**
  87196. * Returns true if all the image processing information are ready.
  87197. * @returns True if ready, otherwise, false
  87198. */
  87199. isReady(): boolean;
  87200. /**
  87201. * Binds the image processing to the shader.
  87202. * @param effect The effect to bind to
  87203. * @param overrideAspectRatio Override the aspect ratio of the effect
  87204. */
  87205. bind(effect: Effect, overrideAspectRatio?: number): void;
  87206. /**
  87207. * Clones the current image processing instance.
  87208. * @return The cloned image processing
  87209. */
  87210. clone(): ImageProcessingConfiguration;
  87211. /**
  87212. * Serializes the current image processing instance to a json representation.
  87213. * @return a JSON representation
  87214. */
  87215. serialize(): any;
  87216. /**
  87217. * Parses the image processing from a json representation.
  87218. * @param source the JSON source to parse
  87219. * @return The parsed image processing
  87220. */
  87221. static Parse(source: any): ImageProcessingConfiguration;
  87222. private static _VIGNETTEMODE_MULTIPLY;
  87223. private static _VIGNETTEMODE_OPAQUE;
  87224. /**
  87225. * Used to apply the vignette as a mix with the pixel color.
  87226. */
  87227. static get VIGNETTEMODE_MULTIPLY(): number;
  87228. /**
  87229. * Used to apply the vignette as a replacement of the pixel color.
  87230. */
  87231. static get VIGNETTEMODE_OPAQUE(): number;
  87232. }
  87233. }
  87234. declare module BABYLON {
  87235. /** @hidden */
  87236. export var postprocessVertexShader: {
  87237. name: string;
  87238. shader: string;
  87239. };
  87240. }
  87241. declare module BABYLON {
  87242. interface ThinEngine {
  87243. /**
  87244. * Creates a new render target texture
  87245. * @param size defines the size of the texture
  87246. * @param options defines the options used to create the texture
  87247. * @returns a new render target texture stored in an InternalTexture
  87248. */
  87249. createRenderTargetTexture(size: number | {
  87250. width: number;
  87251. height: number;
  87252. layers?: number;
  87253. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  87254. /**
  87255. * Creates a depth stencil texture.
  87256. * This is only available in WebGL 2 or with the depth texture extension available.
  87257. * @param size The size of face edge in the texture.
  87258. * @param options The options defining the texture.
  87259. * @returns The texture
  87260. */
  87261. createDepthStencilTexture(size: number | {
  87262. width: number;
  87263. height: number;
  87264. layers?: number;
  87265. }, options: DepthTextureCreationOptions): InternalTexture;
  87266. /** @hidden */
  87267. _createDepthStencilTexture(size: number | {
  87268. width: number;
  87269. height: number;
  87270. layers?: number;
  87271. }, options: DepthTextureCreationOptions): InternalTexture;
  87272. }
  87273. }
  87274. declare module BABYLON {
  87275. /**
  87276. * Defines the kind of connection point for node based material
  87277. */
  87278. export enum NodeMaterialBlockConnectionPointTypes {
  87279. /** Float */
  87280. Float = 1,
  87281. /** Int */
  87282. Int = 2,
  87283. /** Vector2 */
  87284. Vector2 = 4,
  87285. /** Vector3 */
  87286. Vector3 = 8,
  87287. /** Vector4 */
  87288. Vector4 = 16,
  87289. /** Color3 */
  87290. Color3 = 32,
  87291. /** Color4 */
  87292. Color4 = 64,
  87293. /** Matrix */
  87294. Matrix = 128,
  87295. /** Custom object */
  87296. Object = 256,
  87297. /** Detect type based on connection */
  87298. AutoDetect = 1024,
  87299. /** Output type that will be defined by input type */
  87300. BasedOnInput = 2048
  87301. }
  87302. }
  87303. declare module BABYLON {
  87304. /**
  87305. * Enum used to define the target of a block
  87306. */
  87307. export enum NodeMaterialBlockTargets {
  87308. /** Vertex shader */
  87309. Vertex = 1,
  87310. /** Fragment shader */
  87311. Fragment = 2,
  87312. /** Neutral */
  87313. Neutral = 4,
  87314. /** Vertex and Fragment */
  87315. VertexAndFragment = 3
  87316. }
  87317. }
  87318. declare module BABYLON {
  87319. /**
  87320. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  87321. */
  87322. export enum NodeMaterialBlockConnectionPointMode {
  87323. /** Value is an uniform */
  87324. Uniform = 0,
  87325. /** Value is a mesh attribute */
  87326. Attribute = 1,
  87327. /** Value is a varying between vertex and fragment shaders */
  87328. Varying = 2,
  87329. /** Mode is undefined */
  87330. Undefined = 3
  87331. }
  87332. }
  87333. declare module BABYLON {
  87334. /**
  87335. * Enum used to define system values e.g. values automatically provided by the system
  87336. */
  87337. export enum NodeMaterialSystemValues {
  87338. /** World */
  87339. World = 1,
  87340. /** View */
  87341. View = 2,
  87342. /** Projection */
  87343. Projection = 3,
  87344. /** ViewProjection */
  87345. ViewProjection = 4,
  87346. /** WorldView */
  87347. WorldView = 5,
  87348. /** WorldViewProjection */
  87349. WorldViewProjection = 6,
  87350. /** CameraPosition */
  87351. CameraPosition = 7,
  87352. /** Fog Color */
  87353. FogColor = 8,
  87354. /** Delta time */
  87355. DeltaTime = 9
  87356. }
  87357. }
  87358. declare module BABYLON {
  87359. /** Defines supported spaces */
  87360. export enum Space {
  87361. /** Local (object) space */
  87362. LOCAL = 0,
  87363. /** World space */
  87364. WORLD = 1,
  87365. /** Bone space */
  87366. BONE = 2
  87367. }
  87368. /** Defines the 3 main axes */
  87369. export class Axis {
  87370. /** X axis */
  87371. static X: Vector3;
  87372. /** Y axis */
  87373. static Y: Vector3;
  87374. /** Z axis */
  87375. static Z: Vector3;
  87376. }
  87377. }
  87378. declare module BABYLON {
  87379. /**
  87380. * Represents a camera frustum
  87381. */
  87382. export class Frustum {
  87383. /**
  87384. * Gets the planes representing the frustum
  87385. * @param transform matrix to be applied to the returned planes
  87386. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  87387. */
  87388. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  87389. /**
  87390. * Gets the near frustum plane transformed by the transform matrix
  87391. * @param transform transformation matrix to be applied to the resulting frustum plane
  87392. * @param frustumPlane the resuling frustum plane
  87393. */
  87394. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87395. /**
  87396. * Gets the far frustum plane transformed by the transform matrix
  87397. * @param transform transformation matrix to be applied to the resulting frustum plane
  87398. * @param frustumPlane the resuling frustum plane
  87399. */
  87400. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87401. /**
  87402. * Gets the left frustum plane transformed by the transform matrix
  87403. * @param transform transformation matrix to be applied to the resulting frustum plane
  87404. * @param frustumPlane the resuling frustum plane
  87405. */
  87406. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87407. /**
  87408. * Gets the right frustum plane transformed by the transform matrix
  87409. * @param transform transformation matrix to be applied to the resulting frustum plane
  87410. * @param frustumPlane the resuling frustum plane
  87411. */
  87412. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87413. /**
  87414. * Gets the top frustum plane transformed by the transform matrix
  87415. * @param transform transformation matrix to be applied to the resulting frustum plane
  87416. * @param frustumPlane the resuling frustum plane
  87417. */
  87418. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87419. /**
  87420. * Gets the bottom frustum plane transformed by the transform matrix
  87421. * @param transform transformation matrix to be applied to the resulting frustum plane
  87422. * @param frustumPlane the resuling frustum plane
  87423. */
  87424. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87425. /**
  87426. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  87427. * @param transform transformation matrix to be applied to the resulting frustum planes
  87428. * @param frustumPlanes the resuling frustum planes
  87429. */
  87430. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  87431. }
  87432. }
  87433. declare module BABYLON {
  87434. /**
  87435. * Interface for the size containing width and height
  87436. */
  87437. export interface ISize {
  87438. /**
  87439. * Width
  87440. */
  87441. width: number;
  87442. /**
  87443. * Heighht
  87444. */
  87445. height: number;
  87446. }
  87447. /**
  87448. * Size containing widht and height
  87449. */
  87450. export class Size implements ISize {
  87451. /**
  87452. * Width
  87453. */
  87454. width: number;
  87455. /**
  87456. * Height
  87457. */
  87458. height: number;
  87459. /**
  87460. * Creates a Size object from the given width and height (floats).
  87461. * @param width width of the new size
  87462. * @param height height of the new size
  87463. */
  87464. constructor(width: number, height: number);
  87465. /**
  87466. * Returns a string with the Size width and height
  87467. * @returns a string with the Size width and height
  87468. */
  87469. toString(): string;
  87470. /**
  87471. * "Size"
  87472. * @returns the string "Size"
  87473. */
  87474. getClassName(): string;
  87475. /**
  87476. * Returns the Size hash code.
  87477. * @returns a hash code for a unique width and height
  87478. */
  87479. getHashCode(): number;
  87480. /**
  87481. * Updates the current size from the given one.
  87482. * @param src the given size
  87483. */
  87484. copyFrom(src: Size): void;
  87485. /**
  87486. * Updates in place the current Size from the given floats.
  87487. * @param width width of the new size
  87488. * @param height height of the new size
  87489. * @returns the updated Size.
  87490. */
  87491. copyFromFloats(width: number, height: number): Size;
  87492. /**
  87493. * Updates in place the current Size from the given floats.
  87494. * @param width width to set
  87495. * @param height height to set
  87496. * @returns the updated Size.
  87497. */
  87498. set(width: number, height: number): Size;
  87499. /**
  87500. * Multiplies the width and height by numbers
  87501. * @param w factor to multiple the width by
  87502. * @param h factor to multiple the height by
  87503. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  87504. */
  87505. multiplyByFloats(w: number, h: number): Size;
  87506. /**
  87507. * Clones the size
  87508. * @returns a new Size copied from the given one.
  87509. */
  87510. clone(): Size;
  87511. /**
  87512. * True if the current Size and the given one width and height are strictly equal.
  87513. * @param other the other size to compare against
  87514. * @returns True if the current Size and the given one width and height are strictly equal.
  87515. */
  87516. equals(other: Size): boolean;
  87517. /**
  87518. * The surface of the Size : width * height (float).
  87519. */
  87520. get surface(): number;
  87521. /**
  87522. * Create a new size of zero
  87523. * @returns a new Size set to (0.0, 0.0)
  87524. */
  87525. static Zero(): Size;
  87526. /**
  87527. * Sums the width and height of two sizes
  87528. * @param otherSize size to add to this size
  87529. * @returns a new Size set as the addition result of the current Size and the given one.
  87530. */
  87531. add(otherSize: Size): Size;
  87532. /**
  87533. * Subtracts the width and height of two
  87534. * @param otherSize size to subtract to this size
  87535. * @returns a new Size set as the subtraction result of the given one from the current Size.
  87536. */
  87537. subtract(otherSize: Size): Size;
  87538. /**
  87539. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  87540. * @param start starting size to lerp between
  87541. * @param end end size to lerp between
  87542. * @param amount amount to lerp between the start and end values
  87543. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  87544. */
  87545. static Lerp(start: Size, end: Size, amount: number): Size;
  87546. }
  87547. }
  87548. declare module BABYLON {
  87549. /**
  87550. * Contains position and normal vectors for a vertex
  87551. */
  87552. export class PositionNormalVertex {
  87553. /** the position of the vertex (defaut: 0,0,0) */
  87554. position: Vector3;
  87555. /** the normal of the vertex (defaut: 0,1,0) */
  87556. normal: Vector3;
  87557. /**
  87558. * Creates a PositionNormalVertex
  87559. * @param position the position of the vertex (defaut: 0,0,0)
  87560. * @param normal the normal of the vertex (defaut: 0,1,0)
  87561. */
  87562. constructor(
  87563. /** the position of the vertex (defaut: 0,0,0) */
  87564. position?: Vector3,
  87565. /** the normal of the vertex (defaut: 0,1,0) */
  87566. normal?: Vector3);
  87567. /**
  87568. * Clones the PositionNormalVertex
  87569. * @returns the cloned PositionNormalVertex
  87570. */
  87571. clone(): PositionNormalVertex;
  87572. }
  87573. /**
  87574. * Contains position, normal and uv vectors for a vertex
  87575. */
  87576. export class PositionNormalTextureVertex {
  87577. /** the position of the vertex (defaut: 0,0,0) */
  87578. position: Vector3;
  87579. /** the normal of the vertex (defaut: 0,1,0) */
  87580. normal: Vector3;
  87581. /** the uv of the vertex (default: 0,0) */
  87582. uv: Vector2;
  87583. /**
  87584. * Creates a PositionNormalTextureVertex
  87585. * @param position the position of the vertex (defaut: 0,0,0)
  87586. * @param normal the normal of the vertex (defaut: 0,1,0)
  87587. * @param uv the uv of the vertex (default: 0,0)
  87588. */
  87589. constructor(
  87590. /** the position of the vertex (defaut: 0,0,0) */
  87591. position?: Vector3,
  87592. /** the normal of the vertex (defaut: 0,1,0) */
  87593. normal?: Vector3,
  87594. /** the uv of the vertex (default: 0,0) */
  87595. uv?: Vector2);
  87596. /**
  87597. * Clones the PositionNormalTextureVertex
  87598. * @returns the cloned PositionNormalTextureVertex
  87599. */
  87600. clone(): PositionNormalTextureVertex;
  87601. }
  87602. }
  87603. declare module BABYLON {
  87604. /**
  87605. * Enum defining the type of animations supported by InputBlock
  87606. */
  87607. export enum AnimatedInputBlockTypes {
  87608. /** No animation */
  87609. None = 0,
  87610. /** Time based animation. Will only work for floats */
  87611. Time = 1
  87612. }
  87613. }
  87614. declare module BABYLON {
  87615. /**
  87616. * Interface describing all the common properties and methods a shadow light needs to implement.
  87617. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  87618. * as well as binding the different shadow properties to the effects.
  87619. */
  87620. export interface IShadowLight extends Light {
  87621. /**
  87622. * The light id in the scene (used in scene.findLighById for instance)
  87623. */
  87624. id: string;
  87625. /**
  87626. * The position the shdow will be casted from.
  87627. */
  87628. position: Vector3;
  87629. /**
  87630. * In 2d mode (needCube being false), the direction used to cast the shadow.
  87631. */
  87632. direction: Vector3;
  87633. /**
  87634. * The transformed position. Position of the light in world space taking parenting in account.
  87635. */
  87636. transformedPosition: Vector3;
  87637. /**
  87638. * The transformed direction. Direction of the light in world space taking parenting in account.
  87639. */
  87640. transformedDirection: Vector3;
  87641. /**
  87642. * The friendly name of the light in the scene.
  87643. */
  87644. name: string;
  87645. /**
  87646. * Defines the shadow projection clipping minimum z value.
  87647. */
  87648. shadowMinZ: number;
  87649. /**
  87650. * Defines the shadow projection clipping maximum z value.
  87651. */
  87652. shadowMaxZ: number;
  87653. /**
  87654. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  87655. * @returns true if the information has been computed, false if it does not need to (no parenting)
  87656. */
  87657. computeTransformedInformation(): boolean;
  87658. /**
  87659. * Gets the scene the light belongs to.
  87660. * @returns The scene
  87661. */
  87662. getScene(): Scene;
  87663. /**
  87664. * Callback defining a custom Projection Matrix Builder.
  87665. * This can be used to override the default projection matrix computation.
  87666. */
  87667. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  87668. /**
  87669. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  87670. * @param matrix The materix to updated with the projection information
  87671. * @param viewMatrix The transform matrix of the light
  87672. * @param renderList The list of mesh to render in the map
  87673. * @returns The current light
  87674. */
  87675. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  87676. /**
  87677. * Gets the current depth scale used in ESM.
  87678. * @returns The scale
  87679. */
  87680. getDepthScale(): number;
  87681. /**
  87682. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  87683. * @returns true if a cube texture needs to be use
  87684. */
  87685. needCube(): boolean;
  87686. /**
  87687. * Detects if the projection matrix requires to be recomputed this frame.
  87688. * @returns true if it requires to be recomputed otherwise, false.
  87689. */
  87690. needProjectionMatrixCompute(): boolean;
  87691. /**
  87692. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  87693. */
  87694. forceProjectionMatrixCompute(): void;
  87695. /**
  87696. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  87697. * @param faceIndex The index of the face we are computed the direction to generate shadow
  87698. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  87699. */
  87700. getShadowDirection(faceIndex?: number): Vector3;
  87701. /**
  87702. * Gets the minZ used for shadow according to both the scene and the light.
  87703. * @param activeCamera The camera we are returning the min for
  87704. * @returns the depth min z
  87705. */
  87706. getDepthMinZ(activeCamera: Camera): number;
  87707. /**
  87708. * Gets the maxZ used for shadow according to both the scene and the light.
  87709. * @param activeCamera The camera we are returning the max for
  87710. * @returns the depth max z
  87711. */
  87712. getDepthMaxZ(activeCamera: Camera): number;
  87713. }
  87714. /**
  87715. * Base implementation IShadowLight
  87716. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  87717. */
  87718. export abstract class ShadowLight extends Light implements IShadowLight {
  87719. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  87720. protected _position: Vector3;
  87721. protected _setPosition(value: Vector3): void;
  87722. /**
  87723. * Sets the position the shadow will be casted from. Also use as the light position for both
  87724. * point and spot lights.
  87725. */
  87726. get position(): Vector3;
  87727. /**
  87728. * Sets the position the shadow will be casted from. Also use as the light position for both
  87729. * point and spot lights.
  87730. */
  87731. set position(value: Vector3);
  87732. protected _direction: Vector3;
  87733. protected _setDirection(value: Vector3): void;
  87734. /**
  87735. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  87736. * Also use as the light direction on spot and directional lights.
  87737. */
  87738. get direction(): Vector3;
  87739. /**
  87740. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  87741. * Also use as the light direction on spot and directional lights.
  87742. */
  87743. set direction(value: Vector3);
  87744. protected _shadowMinZ: number;
  87745. /**
  87746. * Gets the shadow projection clipping minimum z value.
  87747. */
  87748. get shadowMinZ(): number;
  87749. /**
  87750. * Sets the shadow projection clipping minimum z value.
  87751. */
  87752. set shadowMinZ(value: number);
  87753. protected _shadowMaxZ: number;
  87754. /**
  87755. * Sets the shadow projection clipping maximum z value.
  87756. */
  87757. get shadowMaxZ(): number;
  87758. /**
  87759. * Gets the shadow projection clipping maximum z value.
  87760. */
  87761. set shadowMaxZ(value: number);
  87762. /**
  87763. * Callback defining a custom Projection Matrix Builder.
  87764. * This can be used to override the default projection matrix computation.
  87765. */
  87766. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  87767. /**
  87768. * The transformed position. Position of the light in world space taking parenting in account.
  87769. */
  87770. transformedPosition: Vector3;
  87771. /**
  87772. * The transformed direction. Direction of the light in world space taking parenting in account.
  87773. */
  87774. transformedDirection: Vector3;
  87775. private _needProjectionMatrixCompute;
  87776. /**
  87777. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  87778. * @returns true if the information has been computed, false if it does not need to (no parenting)
  87779. */
  87780. computeTransformedInformation(): boolean;
  87781. /**
  87782. * Return the depth scale used for the shadow map.
  87783. * @returns the depth scale.
  87784. */
  87785. getDepthScale(): number;
  87786. /**
  87787. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  87788. * @param faceIndex The index of the face we are computed the direction to generate shadow
  87789. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  87790. */
  87791. getShadowDirection(faceIndex?: number): Vector3;
  87792. /**
  87793. * Returns the ShadowLight absolute position in the World.
  87794. * @returns the position vector in world space
  87795. */
  87796. getAbsolutePosition(): Vector3;
  87797. /**
  87798. * Sets the ShadowLight direction toward the passed target.
  87799. * @param target The point to target in local space
  87800. * @returns the updated ShadowLight direction
  87801. */
  87802. setDirectionToTarget(target: Vector3): Vector3;
  87803. /**
  87804. * Returns the light rotation in euler definition.
  87805. * @returns the x y z rotation in local space.
  87806. */
  87807. getRotation(): Vector3;
  87808. /**
  87809. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  87810. * @returns true if a cube texture needs to be use
  87811. */
  87812. needCube(): boolean;
  87813. /**
  87814. * Detects if the projection matrix requires to be recomputed this frame.
  87815. * @returns true if it requires to be recomputed otherwise, false.
  87816. */
  87817. needProjectionMatrixCompute(): boolean;
  87818. /**
  87819. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  87820. */
  87821. forceProjectionMatrixCompute(): void;
  87822. /** @hidden */
  87823. _initCache(): void;
  87824. /** @hidden */
  87825. _isSynchronized(): boolean;
  87826. /**
  87827. * Computes the world matrix of the node
  87828. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  87829. * @returns the world matrix
  87830. */
  87831. computeWorldMatrix(force?: boolean): Matrix;
  87832. /**
  87833. * Gets the minZ used for shadow according to both the scene and the light.
  87834. * @param activeCamera The camera we are returning the min for
  87835. * @returns the depth min z
  87836. */
  87837. getDepthMinZ(activeCamera: Camera): number;
  87838. /**
  87839. * Gets the maxZ used for shadow according to both the scene and the light.
  87840. * @param activeCamera The camera we are returning the max for
  87841. * @returns the depth max z
  87842. */
  87843. getDepthMaxZ(activeCamera: Camera): number;
  87844. /**
  87845. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  87846. * @param matrix The materix to updated with the projection information
  87847. * @param viewMatrix The transform matrix of the light
  87848. * @param renderList The list of mesh to render in the map
  87849. * @returns The current light
  87850. */
  87851. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  87852. }
  87853. }
  87854. declare module BABYLON {
  87855. /** @hidden */
  87856. export var packingFunctions: {
  87857. name: string;
  87858. shader: string;
  87859. };
  87860. }
  87861. declare module BABYLON {
  87862. /** @hidden */
  87863. export var bayerDitherFunctions: {
  87864. name: string;
  87865. shader: string;
  87866. };
  87867. }
  87868. declare module BABYLON {
  87869. /** @hidden */
  87870. export var shadowMapFragmentDeclaration: {
  87871. name: string;
  87872. shader: string;
  87873. };
  87874. }
  87875. declare module BABYLON {
  87876. /** @hidden */
  87877. export var clipPlaneFragmentDeclaration: {
  87878. name: string;
  87879. shader: string;
  87880. };
  87881. }
  87882. declare module BABYLON {
  87883. /** @hidden */
  87884. export var clipPlaneFragment: {
  87885. name: string;
  87886. shader: string;
  87887. };
  87888. }
  87889. declare module BABYLON {
  87890. /** @hidden */
  87891. export var shadowMapFragment: {
  87892. name: string;
  87893. shader: string;
  87894. };
  87895. }
  87896. declare module BABYLON {
  87897. /** @hidden */
  87898. export var shadowMapPixelShader: {
  87899. name: string;
  87900. shader: string;
  87901. };
  87902. }
  87903. declare module BABYLON {
  87904. /** @hidden */
  87905. export var bonesDeclaration: {
  87906. name: string;
  87907. shader: string;
  87908. };
  87909. }
  87910. declare module BABYLON {
  87911. /** @hidden */
  87912. export var morphTargetsVertexGlobalDeclaration: {
  87913. name: string;
  87914. shader: string;
  87915. };
  87916. }
  87917. declare module BABYLON {
  87918. /** @hidden */
  87919. export var morphTargetsVertexDeclaration: {
  87920. name: string;
  87921. shader: string;
  87922. };
  87923. }
  87924. declare module BABYLON {
  87925. /** @hidden */
  87926. export var instancesDeclaration: {
  87927. name: string;
  87928. shader: string;
  87929. };
  87930. }
  87931. declare module BABYLON {
  87932. /** @hidden */
  87933. export var helperFunctions: {
  87934. name: string;
  87935. shader: string;
  87936. };
  87937. }
  87938. declare module BABYLON {
  87939. /** @hidden */
  87940. export var shadowMapVertexDeclaration: {
  87941. name: string;
  87942. shader: string;
  87943. };
  87944. }
  87945. declare module BABYLON {
  87946. /** @hidden */
  87947. export var clipPlaneVertexDeclaration: {
  87948. name: string;
  87949. shader: string;
  87950. };
  87951. }
  87952. declare module BABYLON {
  87953. /** @hidden */
  87954. export var morphTargetsVertex: {
  87955. name: string;
  87956. shader: string;
  87957. };
  87958. }
  87959. declare module BABYLON {
  87960. /** @hidden */
  87961. export var instancesVertex: {
  87962. name: string;
  87963. shader: string;
  87964. };
  87965. }
  87966. declare module BABYLON {
  87967. /** @hidden */
  87968. export var bonesVertex: {
  87969. name: string;
  87970. shader: string;
  87971. };
  87972. }
  87973. declare module BABYLON {
  87974. /** @hidden */
  87975. export var shadowMapVertexNormalBias: {
  87976. name: string;
  87977. shader: string;
  87978. };
  87979. }
  87980. declare module BABYLON {
  87981. /** @hidden */
  87982. export var shadowMapVertexMetric: {
  87983. name: string;
  87984. shader: string;
  87985. };
  87986. }
  87987. declare module BABYLON {
  87988. /** @hidden */
  87989. export var clipPlaneVertex: {
  87990. name: string;
  87991. shader: string;
  87992. };
  87993. }
  87994. declare module BABYLON {
  87995. /** @hidden */
  87996. export var shadowMapVertexShader: {
  87997. name: string;
  87998. shader: string;
  87999. };
  88000. }
  88001. declare module BABYLON {
  88002. /** @hidden */
  88003. export var depthBoxBlurPixelShader: {
  88004. name: string;
  88005. shader: string;
  88006. };
  88007. }
  88008. declare module BABYLON {
  88009. /** @hidden */
  88010. export var shadowMapFragmentSoftTransparentShadow: {
  88011. name: string;
  88012. shader: string;
  88013. };
  88014. }
  88015. declare module BABYLON {
  88016. /**
  88017. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88018. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88019. */
  88020. export class EffectFallbacks implements IEffectFallbacks {
  88021. private _defines;
  88022. private _currentRank;
  88023. private _maxRank;
  88024. private _mesh;
  88025. /**
  88026. * Removes the fallback from the bound mesh.
  88027. */
  88028. unBindMesh(): void;
  88029. /**
  88030. * Adds a fallback on the specified property.
  88031. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88032. * @param define The name of the define in the shader
  88033. */
  88034. addFallback(rank: number, define: string): void;
  88035. /**
  88036. * Sets the mesh to use CPU skinning when needing to fallback.
  88037. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88038. * @param mesh The mesh to use the fallbacks.
  88039. */
  88040. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  88041. /**
  88042. * Checks to see if more fallbacks are still availible.
  88043. */
  88044. get hasMoreFallbacks(): boolean;
  88045. /**
  88046. * Removes the defines that should be removed when falling back.
  88047. * @param currentDefines defines the current define statements for the shader.
  88048. * @param effect defines the current effect we try to compile
  88049. * @returns The resulting defines with defines of the current rank removed.
  88050. */
  88051. reduce(currentDefines: string, effect: Effect): string;
  88052. }
  88053. }
  88054. declare module BABYLON {
  88055. /**
  88056. * Interface used to define Action
  88057. */
  88058. export interface IAction {
  88059. /**
  88060. * Trigger for the action
  88061. */
  88062. trigger: number;
  88063. /** Options of the trigger */
  88064. triggerOptions: any;
  88065. /**
  88066. * Gets the trigger parameters
  88067. * @returns the trigger parameters
  88068. */
  88069. getTriggerParameter(): any;
  88070. /**
  88071. * Internal only - executes current action event
  88072. * @hidden
  88073. */
  88074. _executeCurrent(evt?: ActionEvent): void;
  88075. /**
  88076. * Serialize placeholder for child classes
  88077. * @param parent of child
  88078. * @returns the serialized object
  88079. */
  88080. serialize(parent: any): any;
  88081. /**
  88082. * Internal only
  88083. * @hidden
  88084. */
  88085. _prepare(): void;
  88086. /**
  88087. * Internal only - manager for action
  88088. * @hidden
  88089. */
  88090. _actionManager: AbstractActionManager;
  88091. /**
  88092. * Adds action to chain of actions, may be a DoNothingAction
  88093. * @param action defines the next action to execute
  88094. * @returns The action passed in
  88095. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88096. */
  88097. then(action: IAction): IAction;
  88098. }
  88099. /**
  88100. * The action to be carried out following a trigger
  88101. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  88102. */
  88103. export class Action implements IAction {
  88104. /** the trigger, with or without parameters, for the action */
  88105. triggerOptions: any;
  88106. /**
  88107. * Trigger for the action
  88108. */
  88109. trigger: number;
  88110. /**
  88111. * Internal only - manager for action
  88112. * @hidden
  88113. */
  88114. _actionManager: ActionManager;
  88115. private _nextActiveAction;
  88116. private _child;
  88117. private _condition?;
  88118. private _triggerParameter;
  88119. /**
  88120. * An event triggered prior to action being executed.
  88121. */
  88122. onBeforeExecuteObservable: Observable<Action>;
  88123. /**
  88124. * Creates a new Action
  88125. * @param triggerOptions the trigger, with or without parameters, for the action
  88126. * @param condition an optional determinant of action
  88127. */
  88128. constructor(
  88129. /** the trigger, with or without parameters, for the action */
  88130. triggerOptions: any, condition?: Condition);
  88131. /**
  88132. * Internal only
  88133. * @hidden
  88134. */
  88135. _prepare(): void;
  88136. /**
  88137. * Gets the trigger parameters
  88138. * @returns the trigger parameters
  88139. */
  88140. getTriggerParameter(): any;
  88141. /**
  88142. * Internal only - executes current action event
  88143. * @hidden
  88144. */
  88145. _executeCurrent(evt?: ActionEvent): void;
  88146. /**
  88147. * Execute placeholder for child classes
  88148. * @param evt optional action event
  88149. */
  88150. execute(evt?: ActionEvent): void;
  88151. /**
  88152. * Skips to next active action
  88153. */
  88154. skipToNextActiveAction(): void;
  88155. /**
  88156. * Adds action to chain of actions, may be a DoNothingAction
  88157. * @param action defines the next action to execute
  88158. * @returns The action passed in
  88159. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88160. */
  88161. then(action: Action): Action;
  88162. /**
  88163. * Internal only
  88164. * @hidden
  88165. */
  88166. _getProperty(propertyPath: string): string;
  88167. /**
  88168. * Internal only
  88169. * @hidden
  88170. */
  88171. _getEffectiveTarget(target: any, propertyPath: string): any;
  88172. /**
  88173. * Serialize placeholder for child classes
  88174. * @param parent of child
  88175. * @returns the serialized object
  88176. */
  88177. serialize(parent: any): any;
  88178. /**
  88179. * Internal only called by serialize
  88180. * @hidden
  88181. */
  88182. protected _serialize(serializedAction: any, parent?: any): any;
  88183. /**
  88184. * Internal only
  88185. * @hidden
  88186. */
  88187. static _SerializeValueAsString: (value: any) => string;
  88188. /**
  88189. * Internal only
  88190. * @hidden
  88191. */
  88192. static _GetTargetProperty: (target: Scene | Node) => {
  88193. name: string;
  88194. targetType: string;
  88195. value: string;
  88196. };
  88197. }
  88198. }
  88199. declare module BABYLON {
  88200. /**
  88201. * A Condition applied to an Action
  88202. */
  88203. export class Condition {
  88204. /**
  88205. * Internal only - manager for action
  88206. * @hidden
  88207. */
  88208. _actionManager: ActionManager;
  88209. /**
  88210. * Internal only
  88211. * @hidden
  88212. */
  88213. _evaluationId: number;
  88214. /**
  88215. * Internal only
  88216. * @hidden
  88217. */
  88218. _currentResult: boolean;
  88219. /**
  88220. * Creates a new Condition
  88221. * @param actionManager the manager of the action the condition is applied to
  88222. */
  88223. constructor(actionManager: ActionManager);
  88224. /**
  88225. * Check if the current condition is valid
  88226. * @returns a boolean
  88227. */
  88228. isValid(): boolean;
  88229. /**
  88230. * Internal only
  88231. * @hidden
  88232. */
  88233. _getProperty(propertyPath: string): string;
  88234. /**
  88235. * Internal only
  88236. * @hidden
  88237. */
  88238. _getEffectiveTarget(target: any, propertyPath: string): any;
  88239. /**
  88240. * Serialize placeholder for child classes
  88241. * @returns the serialized object
  88242. */
  88243. serialize(): any;
  88244. /**
  88245. * Internal only
  88246. * @hidden
  88247. */
  88248. protected _serialize(serializedCondition: any): any;
  88249. }
  88250. /**
  88251. * Defines specific conditional operators as extensions of Condition
  88252. */
  88253. export class ValueCondition extends Condition {
  88254. /** path to specify the property of the target the conditional operator uses */
  88255. propertyPath: string;
  88256. /** the value compared by the conditional operator against the current value of the property */
  88257. value: any;
  88258. /** the conditional operator, default ValueCondition.IsEqual */
  88259. operator: number;
  88260. /**
  88261. * Internal only
  88262. * @hidden
  88263. */
  88264. private static _IsEqual;
  88265. /**
  88266. * Internal only
  88267. * @hidden
  88268. */
  88269. private static _IsDifferent;
  88270. /**
  88271. * Internal only
  88272. * @hidden
  88273. */
  88274. private static _IsGreater;
  88275. /**
  88276. * Internal only
  88277. * @hidden
  88278. */
  88279. private static _IsLesser;
  88280. /**
  88281. * returns the number for IsEqual
  88282. */
  88283. static get IsEqual(): number;
  88284. /**
  88285. * Returns the number for IsDifferent
  88286. */
  88287. static get IsDifferent(): number;
  88288. /**
  88289. * Returns the number for IsGreater
  88290. */
  88291. static get IsGreater(): number;
  88292. /**
  88293. * Returns the number for IsLesser
  88294. */
  88295. static get IsLesser(): number;
  88296. /**
  88297. * Internal only The action manager for the condition
  88298. * @hidden
  88299. */
  88300. _actionManager: ActionManager;
  88301. /**
  88302. * Internal only
  88303. * @hidden
  88304. */
  88305. private _target;
  88306. /**
  88307. * Internal only
  88308. * @hidden
  88309. */
  88310. private _effectiveTarget;
  88311. /**
  88312. * Internal only
  88313. * @hidden
  88314. */
  88315. private _property;
  88316. /**
  88317. * Creates a new ValueCondition
  88318. * @param actionManager manager for the action the condition applies to
  88319. * @param target for the action
  88320. * @param propertyPath path to specify the property of the target the conditional operator uses
  88321. * @param value the value compared by the conditional operator against the current value of the property
  88322. * @param operator the conditional operator, default ValueCondition.IsEqual
  88323. */
  88324. constructor(actionManager: ActionManager, target: any,
  88325. /** path to specify the property of the target the conditional operator uses */
  88326. propertyPath: string,
  88327. /** the value compared by the conditional operator against the current value of the property */
  88328. value: any,
  88329. /** the conditional operator, default ValueCondition.IsEqual */
  88330. operator?: number);
  88331. /**
  88332. * Compares the given value with the property value for the specified conditional operator
  88333. * @returns the result of the comparison
  88334. */
  88335. isValid(): boolean;
  88336. /**
  88337. * Serialize the ValueCondition into a JSON compatible object
  88338. * @returns serialization object
  88339. */
  88340. serialize(): any;
  88341. /**
  88342. * Gets the name of the conditional operator for the ValueCondition
  88343. * @param operator the conditional operator
  88344. * @returns the name
  88345. */
  88346. static GetOperatorName(operator: number): string;
  88347. }
  88348. /**
  88349. * Defines a predicate condition as an extension of Condition
  88350. */
  88351. export class PredicateCondition extends Condition {
  88352. /** defines the predicate function used to validate the condition */
  88353. predicate: () => boolean;
  88354. /**
  88355. * Internal only - manager for action
  88356. * @hidden
  88357. */
  88358. _actionManager: ActionManager;
  88359. /**
  88360. * Creates a new PredicateCondition
  88361. * @param actionManager manager for the action the condition applies to
  88362. * @param predicate defines the predicate function used to validate the condition
  88363. */
  88364. constructor(actionManager: ActionManager,
  88365. /** defines the predicate function used to validate the condition */
  88366. predicate: () => boolean);
  88367. /**
  88368. * @returns the validity of the predicate condition
  88369. */
  88370. isValid(): boolean;
  88371. }
  88372. /**
  88373. * Defines a state condition as an extension of Condition
  88374. */
  88375. export class StateCondition extends Condition {
  88376. /** Value to compare with target state */
  88377. value: string;
  88378. /**
  88379. * Internal only - manager for action
  88380. * @hidden
  88381. */
  88382. _actionManager: ActionManager;
  88383. /**
  88384. * Internal only
  88385. * @hidden
  88386. */
  88387. private _target;
  88388. /**
  88389. * Creates a new StateCondition
  88390. * @param actionManager manager for the action the condition applies to
  88391. * @param target of the condition
  88392. * @param value to compare with target state
  88393. */
  88394. constructor(actionManager: ActionManager, target: any,
  88395. /** Value to compare with target state */
  88396. value: string);
  88397. /**
  88398. * Gets a boolean indicating if the current condition is met
  88399. * @returns the validity of the state
  88400. */
  88401. isValid(): boolean;
  88402. /**
  88403. * Serialize the StateCondition into a JSON compatible object
  88404. * @returns serialization object
  88405. */
  88406. serialize(): any;
  88407. }
  88408. }
  88409. declare module BABYLON {
  88410. /**
  88411. * This defines an action responsible to toggle a boolean once triggered.
  88412. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88413. */
  88414. export class SwitchBooleanAction extends Action {
  88415. /**
  88416. * The path to the boolean property in the target object
  88417. */
  88418. propertyPath: string;
  88419. private _target;
  88420. private _effectiveTarget;
  88421. private _property;
  88422. /**
  88423. * Instantiate the action
  88424. * @param triggerOptions defines the trigger options
  88425. * @param target defines the object containing the boolean
  88426. * @param propertyPath defines the path to the boolean property in the target object
  88427. * @param condition defines the trigger related conditions
  88428. */
  88429. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  88430. /** @hidden */
  88431. _prepare(): void;
  88432. /**
  88433. * Execute the action toggle the boolean value.
  88434. */
  88435. execute(): void;
  88436. /**
  88437. * Serializes the actions and its related information.
  88438. * @param parent defines the object to serialize in
  88439. * @returns the serialized object
  88440. */
  88441. serialize(parent: any): any;
  88442. }
  88443. /**
  88444. * This defines an action responsible to set a the state field of the target
  88445. * to a desired value once triggered.
  88446. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88447. */
  88448. export class SetStateAction extends Action {
  88449. /**
  88450. * The value to store in the state field.
  88451. */
  88452. value: string;
  88453. private _target;
  88454. /**
  88455. * Instantiate the action
  88456. * @param triggerOptions defines the trigger options
  88457. * @param target defines the object containing the state property
  88458. * @param value defines the value to store in the state field
  88459. * @param condition defines the trigger related conditions
  88460. */
  88461. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  88462. /**
  88463. * Execute the action and store the value on the target state property.
  88464. */
  88465. execute(): void;
  88466. /**
  88467. * Serializes the actions and its related information.
  88468. * @param parent defines the object to serialize in
  88469. * @returns the serialized object
  88470. */
  88471. serialize(parent: any): any;
  88472. }
  88473. /**
  88474. * This defines an action responsible to set a property of the target
  88475. * to a desired value once triggered.
  88476. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88477. */
  88478. export class SetValueAction extends Action {
  88479. /**
  88480. * The path of the property to set in the target.
  88481. */
  88482. propertyPath: string;
  88483. /**
  88484. * The value to set in the property
  88485. */
  88486. value: any;
  88487. private _target;
  88488. private _effectiveTarget;
  88489. private _property;
  88490. /**
  88491. * Instantiate the action
  88492. * @param triggerOptions defines the trigger options
  88493. * @param target defines the object containing the property
  88494. * @param propertyPath defines the path of the property to set in the target
  88495. * @param value defines the value to set in the property
  88496. * @param condition defines the trigger related conditions
  88497. */
  88498. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  88499. /** @hidden */
  88500. _prepare(): void;
  88501. /**
  88502. * Execute the action and set the targetted property to the desired value.
  88503. */
  88504. execute(): void;
  88505. /**
  88506. * Serializes the actions and its related information.
  88507. * @param parent defines the object to serialize in
  88508. * @returns the serialized object
  88509. */
  88510. serialize(parent: any): any;
  88511. }
  88512. /**
  88513. * This defines an action responsible to increment the target value
  88514. * to a desired value once triggered.
  88515. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88516. */
  88517. export class IncrementValueAction extends Action {
  88518. /**
  88519. * The path of the property to increment in the target.
  88520. */
  88521. propertyPath: string;
  88522. /**
  88523. * The value we should increment the property by.
  88524. */
  88525. value: any;
  88526. private _target;
  88527. private _effectiveTarget;
  88528. private _property;
  88529. /**
  88530. * Instantiate the action
  88531. * @param triggerOptions defines the trigger options
  88532. * @param target defines the object containing the property
  88533. * @param propertyPath defines the path of the property to increment in the target
  88534. * @param value defines the value value we should increment the property by
  88535. * @param condition defines the trigger related conditions
  88536. */
  88537. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  88538. /** @hidden */
  88539. _prepare(): void;
  88540. /**
  88541. * Execute the action and increment the target of the value amount.
  88542. */
  88543. execute(): void;
  88544. /**
  88545. * Serializes the actions and its related information.
  88546. * @param parent defines the object to serialize in
  88547. * @returns the serialized object
  88548. */
  88549. serialize(parent: any): any;
  88550. }
  88551. /**
  88552. * This defines an action responsible to start an animation once triggered.
  88553. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88554. */
  88555. export class PlayAnimationAction extends Action {
  88556. /**
  88557. * Where the animation should start (animation frame)
  88558. */
  88559. from: number;
  88560. /**
  88561. * Where the animation should stop (animation frame)
  88562. */
  88563. to: number;
  88564. /**
  88565. * Define if the animation should loop or stop after the first play.
  88566. */
  88567. loop?: boolean;
  88568. private _target;
  88569. /**
  88570. * Instantiate the action
  88571. * @param triggerOptions defines the trigger options
  88572. * @param target defines the target animation or animation name
  88573. * @param from defines from where the animation should start (animation frame)
  88574. * @param end defines where the animation should stop (animation frame)
  88575. * @param loop defines if the animation should loop or stop after the first play
  88576. * @param condition defines the trigger related conditions
  88577. */
  88578. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  88579. /** @hidden */
  88580. _prepare(): void;
  88581. /**
  88582. * Execute the action and play the animation.
  88583. */
  88584. execute(): void;
  88585. /**
  88586. * Serializes the actions and its related information.
  88587. * @param parent defines the object to serialize in
  88588. * @returns the serialized object
  88589. */
  88590. serialize(parent: any): any;
  88591. }
  88592. /**
  88593. * This defines an action responsible to stop an animation once triggered.
  88594. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88595. */
  88596. export class StopAnimationAction extends Action {
  88597. private _target;
  88598. /**
  88599. * Instantiate the action
  88600. * @param triggerOptions defines the trigger options
  88601. * @param target defines the target animation or animation name
  88602. * @param condition defines the trigger related conditions
  88603. */
  88604. constructor(triggerOptions: any, target: any, condition?: Condition);
  88605. /** @hidden */
  88606. _prepare(): void;
  88607. /**
  88608. * Execute the action and stop the animation.
  88609. */
  88610. execute(): void;
  88611. /**
  88612. * Serializes the actions and its related information.
  88613. * @param parent defines the object to serialize in
  88614. * @returns the serialized object
  88615. */
  88616. serialize(parent: any): any;
  88617. }
  88618. /**
  88619. * This defines an action responsible that does nothing once triggered.
  88620. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88621. */
  88622. export class DoNothingAction extends Action {
  88623. /**
  88624. * Instantiate the action
  88625. * @param triggerOptions defines the trigger options
  88626. * @param condition defines the trigger related conditions
  88627. */
  88628. constructor(triggerOptions?: any, condition?: Condition);
  88629. /**
  88630. * Execute the action and do nothing.
  88631. */
  88632. execute(): void;
  88633. /**
  88634. * Serializes the actions and its related information.
  88635. * @param parent defines the object to serialize in
  88636. * @returns the serialized object
  88637. */
  88638. serialize(parent: any): any;
  88639. }
  88640. /**
  88641. * This defines an action responsible to trigger several actions once triggered.
  88642. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88643. */
  88644. export class CombineAction extends Action {
  88645. /**
  88646. * The list of aggregated animations to run.
  88647. */
  88648. children: Action[];
  88649. /**
  88650. * Instantiate the action
  88651. * @param triggerOptions defines the trigger options
  88652. * @param children defines the list of aggregated animations to run
  88653. * @param condition defines the trigger related conditions
  88654. */
  88655. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  88656. /** @hidden */
  88657. _prepare(): void;
  88658. /**
  88659. * Execute the action and executes all the aggregated actions.
  88660. */
  88661. execute(evt: ActionEvent): void;
  88662. /**
  88663. * Serializes the actions and its related information.
  88664. * @param parent defines the object to serialize in
  88665. * @returns the serialized object
  88666. */
  88667. serialize(parent: any): any;
  88668. }
  88669. /**
  88670. * This defines an action responsible to run code (external event) once triggered.
  88671. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88672. */
  88673. export class ExecuteCodeAction extends Action {
  88674. /**
  88675. * The callback function to run.
  88676. */
  88677. func: (evt: ActionEvent) => void;
  88678. /**
  88679. * Instantiate the action
  88680. * @param triggerOptions defines the trigger options
  88681. * @param func defines the callback function to run
  88682. * @param condition defines the trigger related conditions
  88683. */
  88684. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  88685. /**
  88686. * Execute the action and run the attached code.
  88687. */
  88688. execute(evt: ActionEvent): void;
  88689. }
  88690. /**
  88691. * This defines an action responsible to set the parent property of the target once triggered.
  88692. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88693. */
  88694. export class SetParentAction extends Action {
  88695. private _parent;
  88696. private _target;
  88697. /**
  88698. * Instantiate the action
  88699. * @param triggerOptions defines the trigger options
  88700. * @param target defines the target containing the parent property
  88701. * @param parent defines from where the animation should start (animation frame)
  88702. * @param condition defines the trigger related conditions
  88703. */
  88704. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  88705. /** @hidden */
  88706. _prepare(): void;
  88707. /**
  88708. * Execute the action and set the parent property.
  88709. */
  88710. execute(): void;
  88711. /**
  88712. * Serializes the actions and its related information.
  88713. * @param parent defines the object to serialize in
  88714. * @returns the serialized object
  88715. */
  88716. serialize(parent: any): any;
  88717. }
  88718. }
  88719. declare module BABYLON {
  88720. /**
  88721. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  88722. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  88723. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88724. */
  88725. export class ActionManager extends AbstractActionManager {
  88726. /**
  88727. * Nothing
  88728. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88729. */
  88730. static readonly NothingTrigger: number;
  88731. /**
  88732. * On pick
  88733. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88734. */
  88735. static readonly OnPickTrigger: number;
  88736. /**
  88737. * On left pick
  88738. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88739. */
  88740. static readonly OnLeftPickTrigger: number;
  88741. /**
  88742. * On right pick
  88743. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88744. */
  88745. static readonly OnRightPickTrigger: number;
  88746. /**
  88747. * On center pick
  88748. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88749. */
  88750. static readonly OnCenterPickTrigger: number;
  88751. /**
  88752. * On pick down
  88753. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88754. */
  88755. static readonly OnPickDownTrigger: number;
  88756. /**
  88757. * On double pick
  88758. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88759. */
  88760. static readonly OnDoublePickTrigger: number;
  88761. /**
  88762. * On pick up
  88763. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88764. */
  88765. static readonly OnPickUpTrigger: number;
  88766. /**
  88767. * On pick out.
  88768. * This trigger will only be raised if you also declared a OnPickDown
  88769. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88770. */
  88771. static readonly OnPickOutTrigger: number;
  88772. /**
  88773. * On long press
  88774. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88775. */
  88776. static readonly OnLongPressTrigger: number;
  88777. /**
  88778. * On pointer over
  88779. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88780. */
  88781. static readonly OnPointerOverTrigger: number;
  88782. /**
  88783. * On pointer out
  88784. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88785. */
  88786. static readonly OnPointerOutTrigger: number;
  88787. /**
  88788. * On every frame
  88789. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88790. */
  88791. static readonly OnEveryFrameTrigger: number;
  88792. /**
  88793. * On intersection enter
  88794. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88795. */
  88796. static readonly OnIntersectionEnterTrigger: number;
  88797. /**
  88798. * On intersection exit
  88799. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88800. */
  88801. static readonly OnIntersectionExitTrigger: number;
  88802. /**
  88803. * On key down
  88804. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88805. */
  88806. static readonly OnKeyDownTrigger: number;
  88807. /**
  88808. * On key up
  88809. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88810. */
  88811. static readonly OnKeyUpTrigger: number;
  88812. private _scene;
  88813. /**
  88814. * Creates a new action manager
  88815. * @param scene defines the hosting scene
  88816. */
  88817. constructor(scene: Scene);
  88818. /**
  88819. * Releases all associated resources
  88820. */
  88821. dispose(): void;
  88822. /**
  88823. * Gets hosting scene
  88824. * @returns the hosting scene
  88825. */
  88826. getScene(): Scene;
  88827. /**
  88828. * Does this action manager handles actions of any of the given triggers
  88829. * @param triggers defines the triggers to be tested
  88830. * @return a boolean indicating whether one (or more) of the triggers is handled
  88831. */
  88832. hasSpecificTriggers(triggers: number[]): boolean;
  88833. /**
  88834. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  88835. * speed.
  88836. * @param triggerA defines the trigger to be tested
  88837. * @param triggerB defines the trigger to be tested
  88838. * @return a boolean indicating whether one (or more) of the triggers is handled
  88839. */
  88840. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  88841. /**
  88842. * Does this action manager handles actions of a given trigger
  88843. * @param trigger defines the trigger to be tested
  88844. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  88845. * @return whether the trigger is handled
  88846. */
  88847. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  88848. /**
  88849. * Does this action manager has pointer triggers
  88850. */
  88851. get hasPointerTriggers(): boolean;
  88852. /**
  88853. * Does this action manager has pick triggers
  88854. */
  88855. get hasPickTriggers(): boolean;
  88856. /**
  88857. * Registers an action to this action manager
  88858. * @param action defines the action to be registered
  88859. * @return the action amended (prepared) after registration
  88860. */
  88861. registerAction(action: IAction): Nullable<IAction>;
  88862. /**
  88863. * Unregisters an action to this action manager
  88864. * @param action defines the action to be unregistered
  88865. * @return a boolean indicating whether the action has been unregistered
  88866. */
  88867. unregisterAction(action: IAction): Boolean;
  88868. /**
  88869. * Process a specific trigger
  88870. * @param trigger defines the trigger to process
  88871. * @param evt defines the event details to be processed
  88872. */
  88873. processTrigger(trigger: number, evt?: IActionEvent): void;
  88874. /** @hidden */
  88875. _getEffectiveTarget(target: any, propertyPath: string): any;
  88876. /** @hidden */
  88877. _getProperty(propertyPath: string): string;
  88878. /**
  88879. * Serialize this manager to a JSON object
  88880. * @param name defines the property name to store this manager
  88881. * @returns a JSON representation of this manager
  88882. */
  88883. serialize(name: string): any;
  88884. /**
  88885. * Creates a new ActionManager from a JSON data
  88886. * @param parsedActions defines the JSON data to read from
  88887. * @param object defines the hosting mesh
  88888. * @param scene defines the hosting scene
  88889. */
  88890. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  88891. /**
  88892. * Get a trigger name by index
  88893. * @param trigger defines the trigger index
  88894. * @returns a trigger name
  88895. */
  88896. static GetTriggerName(trigger: number): string;
  88897. }
  88898. }
  88899. declare module BABYLON {
  88900. /**
  88901. * Class used to represent a sprite
  88902. * @see https://doc.babylonjs.com/babylon101/sprites
  88903. */
  88904. export class Sprite implements IAnimatable {
  88905. /** defines the name */
  88906. name: string;
  88907. /** Gets or sets the current world position */
  88908. position: Vector3;
  88909. /** Gets or sets the main color */
  88910. color: Color4;
  88911. /** Gets or sets the width */
  88912. width: number;
  88913. /** Gets or sets the height */
  88914. height: number;
  88915. /** Gets or sets rotation angle */
  88916. angle: number;
  88917. /** Gets or sets the cell index in the sprite sheet */
  88918. cellIndex: number;
  88919. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  88920. cellRef: string;
  88921. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  88922. invertU: boolean;
  88923. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  88924. invertV: boolean;
  88925. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  88926. disposeWhenFinishedAnimating: boolean;
  88927. /** Gets the list of attached animations */
  88928. animations: Nullable<Array<Animation>>;
  88929. /** Gets or sets a boolean indicating if the sprite can be picked */
  88930. isPickable: boolean;
  88931. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  88932. useAlphaForPicking: boolean;
  88933. /** @hidden */
  88934. _xOffset: number;
  88935. /** @hidden */
  88936. _yOffset: number;
  88937. /** @hidden */
  88938. _xSize: number;
  88939. /** @hidden */
  88940. _ySize: number;
  88941. /**
  88942. * Gets or sets the associated action manager
  88943. */
  88944. actionManager: Nullable<ActionManager>;
  88945. /**
  88946. * An event triggered when the control has been disposed
  88947. */
  88948. onDisposeObservable: Observable<Sprite>;
  88949. private _animationStarted;
  88950. private _loopAnimation;
  88951. private _fromIndex;
  88952. private _toIndex;
  88953. private _delay;
  88954. private _direction;
  88955. private _manager;
  88956. private _time;
  88957. private _onAnimationEnd;
  88958. /**
  88959. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  88960. */
  88961. isVisible: boolean;
  88962. /**
  88963. * Gets or sets the sprite size
  88964. */
  88965. get size(): number;
  88966. set size(value: number);
  88967. /**
  88968. * Returns a boolean indicating if the animation is started
  88969. */
  88970. get animationStarted(): boolean;
  88971. /**
  88972. * Gets or sets the unique id of the sprite
  88973. */
  88974. uniqueId: number;
  88975. /**
  88976. * Gets the manager of this sprite
  88977. */
  88978. get manager(): ISpriteManager;
  88979. /**
  88980. * Creates a new Sprite
  88981. * @param name defines the name
  88982. * @param manager defines the manager
  88983. */
  88984. constructor(
  88985. /** defines the name */
  88986. name: string, manager: ISpriteManager);
  88987. /**
  88988. * Returns the string "Sprite"
  88989. * @returns "Sprite"
  88990. */
  88991. getClassName(): string;
  88992. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  88993. get fromIndex(): number;
  88994. set fromIndex(value: number);
  88995. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  88996. get toIndex(): number;
  88997. set toIndex(value: number);
  88998. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  88999. get loopAnimation(): boolean;
  89000. set loopAnimation(value: boolean);
  89001. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89002. get delay(): number;
  89003. set delay(value: number);
  89004. /**
  89005. * Starts an animation
  89006. * @param from defines the initial key
  89007. * @param to defines the end key
  89008. * @param loop defines if the animation must loop
  89009. * @param delay defines the start delay (in ms)
  89010. * @param onAnimationEnd defines a callback to call when animation ends
  89011. */
  89012. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89013. /** Stops current animation (if any) */
  89014. stopAnimation(): void;
  89015. /** @hidden */
  89016. _animate(deltaTime: number): void;
  89017. /** Release associated resources */
  89018. dispose(): void;
  89019. /**
  89020. * Serializes the sprite to a JSON object
  89021. * @returns the JSON object
  89022. */
  89023. serialize(): any;
  89024. /**
  89025. * Parses a JSON object to create a new sprite
  89026. * @param parsedSprite The JSON object to parse
  89027. * @param manager defines the hosting manager
  89028. * @returns the new sprite
  89029. */
  89030. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89031. }
  89032. }
  89033. declare module BABYLON {
  89034. /**
  89035. * Information about the result of picking within a scene
  89036. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  89037. */
  89038. export class PickingInfo {
  89039. /** @hidden */
  89040. _pickingUnavailable: boolean;
  89041. /**
  89042. * If the pick collided with an object
  89043. */
  89044. hit: boolean;
  89045. /**
  89046. * Distance away where the pick collided
  89047. */
  89048. distance: number;
  89049. /**
  89050. * The location of pick collision
  89051. */
  89052. pickedPoint: Nullable<Vector3>;
  89053. /**
  89054. * The mesh corresponding the the pick collision
  89055. */
  89056. pickedMesh: Nullable<AbstractMesh>;
  89057. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  89058. bu: number;
  89059. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  89060. bv: number;
  89061. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89062. faceId: number;
  89063. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89064. subMeshFaceId: number;
  89065. /** Id of the the submesh that was picked */
  89066. subMeshId: number;
  89067. /** If a sprite was picked, this will be the sprite the pick collided with */
  89068. pickedSprite: Nullable<Sprite>;
  89069. /**
  89070. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  89071. */
  89072. originMesh: Nullable<AbstractMesh>;
  89073. /**
  89074. * The ray that was used to perform the picking.
  89075. */
  89076. ray: Nullable<Ray>;
  89077. /**
  89078. * Gets the normal correspodning to the face the pick collided with
  89079. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  89080. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  89081. * @returns The normal correspodning to the face the pick collided with
  89082. */
  89083. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  89084. /**
  89085. * Gets the texture coordinates of where the pick occured
  89086. * @returns the vector containing the coordnates of the texture
  89087. */
  89088. getTextureCoordinates(): Nullable<Vector2>;
  89089. }
  89090. }
  89091. declare module BABYLON {
  89092. /**
  89093. * Class representing a ray with position and direction
  89094. */
  89095. export class Ray {
  89096. /** origin point */
  89097. origin: Vector3;
  89098. /** direction */
  89099. direction: Vector3;
  89100. /** length of the ray */
  89101. length: number;
  89102. private static readonly TmpVector3;
  89103. private _tmpRay;
  89104. /**
  89105. * Creates a new ray
  89106. * @param origin origin point
  89107. * @param direction direction
  89108. * @param length length of the ray
  89109. */
  89110. constructor(
  89111. /** origin point */
  89112. origin: Vector3,
  89113. /** direction */
  89114. direction: Vector3,
  89115. /** length of the ray */
  89116. length?: number);
  89117. /**
  89118. * Checks if the ray intersects a box
  89119. * This does not account for the ray lenght by design to improve perfs.
  89120. * @param minimum bound of the box
  89121. * @param maximum bound of the box
  89122. * @param intersectionTreshold extra extend to be added to the box in all direction
  89123. * @returns if the box was hit
  89124. */
  89125. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  89126. /**
  89127. * Checks if the ray intersects a box
  89128. * This does not account for the ray lenght by design to improve perfs.
  89129. * @param box the bounding box to check
  89130. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  89131. * @returns if the box was hit
  89132. */
  89133. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  89134. /**
  89135. * If the ray hits a sphere
  89136. * @param sphere the bounding sphere to check
  89137. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  89138. * @returns true if it hits the sphere
  89139. */
  89140. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  89141. /**
  89142. * If the ray hits a triange
  89143. * @param vertex0 triangle vertex
  89144. * @param vertex1 triangle vertex
  89145. * @param vertex2 triangle vertex
  89146. * @returns intersection information if hit
  89147. */
  89148. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  89149. /**
  89150. * Checks if ray intersects a plane
  89151. * @param plane the plane to check
  89152. * @returns the distance away it was hit
  89153. */
  89154. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  89155. /**
  89156. * Calculate the intercept of a ray on a given axis
  89157. * @param axis to check 'x' | 'y' | 'z'
  89158. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  89159. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  89160. */
  89161. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  89162. /**
  89163. * Checks if ray intersects a mesh
  89164. * @param mesh the mesh to check
  89165. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89166. * @returns picking info of the intersecton
  89167. */
  89168. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  89169. /**
  89170. * Checks if ray intersects a mesh
  89171. * @param meshes the meshes to check
  89172. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89173. * @param results array to store result in
  89174. * @returns Array of picking infos
  89175. */
  89176. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  89177. private _comparePickingInfo;
  89178. private static smallnum;
  89179. private static rayl;
  89180. /**
  89181. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  89182. * @param sega the first point of the segment to test the intersection against
  89183. * @param segb the second point of the segment to test the intersection against
  89184. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  89185. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  89186. */
  89187. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  89188. /**
  89189. * Update the ray from viewport position
  89190. * @param x position
  89191. * @param y y position
  89192. * @param viewportWidth viewport width
  89193. * @param viewportHeight viewport height
  89194. * @param world world matrix
  89195. * @param view view matrix
  89196. * @param projection projection matrix
  89197. * @returns this ray updated
  89198. */
  89199. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89200. /**
  89201. * Creates a ray with origin and direction of 0,0,0
  89202. * @returns the new ray
  89203. */
  89204. static Zero(): Ray;
  89205. /**
  89206. * Creates a new ray from screen space and viewport
  89207. * @param x position
  89208. * @param y y position
  89209. * @param viewportWidth viewport width
  89210. * @param viewportHeight viewport height
  89211. * @param world world matrix
  89212. * @param view view matrix
  89213. * @param projection projection matrix
  89214. * @returns new ray
  89215. */
  89216. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89217. /**
  89218. * 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
  89219. * transformed to the given world matrix.
  89220. * @param origin The origin point
  89221. * @param end The end point
  89222. * @param world a matrix to transform the ray to. Default is the identity matrix.
  89223. * @returns the new ray
  89224. */
  89225. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  89226. /**
  89227. * Transforms a ray by a matrix
  89228. * @param ray ray to transform
  89229. * @param matrix matrix to apply
  89230. * @returns the resulting new ray
  89231. */
  89232. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  89233. /**
  89234. * Transforms a ray by a matrix
  89235. * @param ray ray to transform
  89236. * @param matrix matrix to apply
  89237. * @param result ray to store result in
  89238. */
  89239. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  89240. /**
  89241. * Unproject a ray from screen space to object space
  89242. * @param sourceX defines the screen space x coordinate to use
  89243. * @param sourceY defines the screen space y coordinate to use
  89244. * @param viewportWidth defines the current width of the viewport
  89245. * @param viewportHeight defines the current height of the viewport
  89246. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  89247. * @param view defines the view matrix to use
  89248. * @param projection defines the projection matrix to use
  89249. */
  89250. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  89251. }
  89252. /**
  89253. * Type used to define predicate used to select faces when a mesh intersection is detected
  89254. */
  89255. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  89256. interface Scene {
  89257. /** @hidden */
  89258. _tempPickingRay: Nullable<Ray>;
  89259. /** @hidden */
  89260. _cachedRayForTransform: Ray;
  89261. /** @hidden */
  89262. _pickWithRayInverseMatrix: Matrix;
  89263. /** @hidden */
  89264. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89265. /** @hidden */
  89266. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  89267. }
  89268. }
  89269. declare module BABYLON {
  89270. /**
  89271. * Groups all the scene component constants in one place to ease maintenance.
  89272. * @hidden
  89273. */
  89274. export class SceneComponentConstants {
  89275. static readonly NAME_EFFECTLAYER: string;
  89276. static readonly NAME_LAYER: string;
  89277. static readonly NAME_LENSFLARESYSTEM: string;
  89278. static readonly NAME_BOUNDINGBOXRENDERER: string;
  89279. static readonly NAME_PARTICLESYSTEM: string;
  89280. static readonly NAME_GAMEPAD: string;
  89281. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  89282. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  89283. static readonly NAME_PREPASSRENDERER: string;
  89284. static readonly NAME_DEPTHRENDERER: string;
  89285. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  89286. static readonly NAME_SPRITE: string;
  89287. static readonly NAME_OUTLINERENDERER: string;
  89288. static readonly NAME_PROCEDURALTEXTURE: string;
  89289. static readonly NAME_SHADOWGENERATOR: string;
  89290. static readonly NAME_OCTREE: string;
  89291. static readonly NAME_PHYSICSENGINE: string;
  89292. static readonly NAME_AUDIO: string;
  89293. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  89294. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89295. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  89296. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89297. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  89298. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  89299. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  89300. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  89301. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  89302. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  89303. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  89304. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  89305. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  89306. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  89307. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  89308. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  89309. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  89310. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  89311. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  89312. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  89313. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  89314. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  89315. static readonly STEP_AFTERRENDER_AUDIO: number;
  89316. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  89317. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  89318. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  89319. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  89320. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  89321. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  89322. static readonly STEP_POINTERMOVE_SPRITE: number;
  89323. static readonly STEP_POINTERDOWN_SPRITE: number;
  89324. static readonly STEP_POINTERUP_SPRITE: number;
  89325. }
  89326. /**
  89327. * This represents a scene component.
  89328. *
  89329. * This is used to decouple the dependency the scene is having on the different workloads like
  89330. * layers, post processes...
  89331. */
  89332. export interface ISceneComponent {
  89333. /**
  89334. * The name of the component. Each component must have a unique name.
  89335. */
  89336. name: string;
  89337. /**
  89338. * The scene the component belongs to.
  89339. */
  89340. scene: Scene;
  89341. /**
  89342. * Register the component to one instance of a scene.
  89343. */
  89344. register(): void;
  89345. /**
  89346. * Rebuilds the elements related to this component in case of
  89347. * context lost for instance.
  89348. */
  89349. rebuild(): void;
  89350. /**
  89351. * Disposes the component and the associated ressources.
  89352. */
  89353. dispose(): void;
  89354. }
  89355. /**
  89356. * This represents a SERIALIZABLE scene component.
  89357. *
  89358. * This extends Scene Component to add Serialization methods on top.
  89359. */
  89360. export interface ISceneSerializableComponent extends ISceneComponent {
  89361. /**
  89362. * Adds all the elements from the container to the scene
  89363. * @param container the container holding the elements
  89364. */
  89365. addFromContainer(container: AbstractScene): void;
  89366. /**
  89367. * Removes all the elements in the container from the scene
  89368. * @param container contains the elements to remove
  89369. * @param dispose if the removed element should be disposed (default: false)
  89370. */
  89371. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  89372. /**
  89373. * Serializes the component data to the specified json object
  89374. * @param serializationObject The object to serialize to
  89375. */
  89376. serialize(serializationObject: any): void;
  89377. }
  89378. /**
  89379. * Strong typing of a Mesh related stage step action
  89380. */
  89381. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  89382. /**
  89383. * Strong typing of a Evaluate Sub Mesh related stage step action
  89384. */
  89385. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  89386. /**
  89387. * Strong typing of a Active Mesh related stage step action
  89388. */
  89389. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  89390. /**
  89391. * Strong typing of a Camera related stage step action
  89392. */
  89393. export type CameraStageAction = (camera: Camera) => void;
  89394. /**
  89395. * Strong typing of a Camera Frame buffer related stage step action
  89396. */
  89397. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  89398. /**
  89399. * Strong typing of a Render Target related stage step action
  89400. */
  89401. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  89402. /**
  89403. * Strong typing of a RenderingGroup related stage step action
  89404. */
  89405. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  89406. /**
  89407. * Strong typing of a Mesh Render related stage step action
  89408. */
  89409. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  89410. /**
  89411. * Strong typing of a simple stage step action
  89412. */
  89413. export type SimpleStageAction = () => void;
  89414. /**
  89415. * Strong typing of a render target action.
  89416. */
  89417. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  89418. /**
  89419. * Strong typing of a pointer move action.
  89420. */
  89421. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  89422. /**
  89423. * Strong typing of a pointer up/down action.
  89424. */
  89425. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  89426. /**
  89427. * Representation of a stage in the scene (Basically a list of ordered steps)
  89428. * @hidden
  89429. */
  89430. export class Stage<T extends Function> extends Array<{
  89431. index: number;
  89432. component: ISceneComponent;
  89433. action: T;
  89434. }> {
  89435. /**
  89436. * Hide ctor from the rest of the world.
  89437. * @param items The items to add.
  89438. */
  89439. private constructor();
  89440. /**
  89441. * Creates a new Stage.
  89442. * @returns A new instance of a Stage
  89443. */
  89444. static Create<T extends Function>(): Stage<T>;
  89445. /**
  89446. * Registers a step in an ordered way in the targeted stage.
  89447. * @param index Defines the position to register the step in
  89448. * @param component Defines the component attached to the step
  89449. * @param action Defines the action to launch during the step
  89450. */
  89451. registerStep(index: number, component: ISceneComponent, action: T): void;
  89452. /**
  89453. * Clears all the steps from the stage.
  89454. */
  89455. clear(): void;
  89456. }
  89457. }
  89458. declare module BABYLON {
  89459. interface Scene {
  89460. /** @hidden */
  89461. _pointerOverSprite: Nullable<Sprite>;
  89462. /** @hidden */
  89463. _pickedDownSprite: Nullable<Sprite>;
  89464. /** @hidden */
  89465. _tempSpritePickingRay: Nullable<Ray>;
  89466. /**
  89467. * All of the sprite managers added to this scene
  89468. * @see https://doc.babylonjs.com/babylon101/sprites
  89469. */
  89470. spriteManagers: Array<ISpriteManager>;
  89471. /**
  89472. * An event triggered when sprites rendering is about to start
  89473. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  89474. */
  89475. onBeforeSpritesRenderingObservable: Observable<Scene>;
  89476. /**
  89477. * An event triggered when sprites rendering is done
  89478. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  89479. */
  89480. onAfterSpritesRenderingObservable: Observable<Scene>;
  89481. /** @hidden */
  89482. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89483. /** Launch a ray to try to pick a sprite in the scene
  89484. * @param x position on screen
  89485. * @param y position on screen
  89486. * @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
  89487. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89488. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  89489. * @returns a PickingInfo
  89490. */
  89491. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89492. /** Use the given ray to pick a sprite in the scene
  89493. * @param ray The ray (in world space) to use to pick meshes
  89494. * @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
  89495. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89496. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  89497. * @returns a PickingInfo
  89498. */
  89499. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89500. /** @hidden */
  89501. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89502. /** Launch a ray to try to pick sprites in the scene
  89503. * @param x position on screen
  89504. * @param y position on screen
  89505. * @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
  89506. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  89507. * @returns a PickingInfo array
  89508. */
  89509. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89510. /** Use the given ray to pick sprites in the scene
  89511. * @param ray The ray (in world space) to use to pick meshes
  89512. * @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
  89513. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  89514. * @returns a PickingInfo array
  89515. */
  89516. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89517. /**
  89518. * Force the sprite under the pointer
  89519. * @param sprite defines the sprite to use
  89520. */
  89521. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  89522. /**
  89523. * Gets the sprite under the pointer
  89524. * @returns a Sprite or null if no sprite is under the pointer
  89525. */
  89526. getPointerOverSprite(): Nullable<Sprite>;
  89527. }
  89528. /**
  89529. * Defines the sprite scene component responsible to manage sprites
  89530. * in a given scene.
  89531. */
  89532. export class SpriteSceneComponent implements ISceneComponent {
  89533. /**
  89534. * The component name helpfull to identify the component in the list of scene components.
  89535. */
  89536. readonly name: string;
  89537. /**
  89538. * The scene the component belongs to.
  89539. */
  89540. scene: Scene;
  89541. /** @hidden */
  89542. private _spritePredicate;
  89543. /**
  89544. * Creates a new instance of the component for the given scene
  89545. * @param scene Defines the scene to register the component in
  89546. */
  89547. constructor(scene: Scene);
  89548. /**
  89549. * Registers the component in a given scene
  89550. */
  89551. register(): void;
  89552. /**
  89553. * Rebuilds the elements related to this component in case of
  89554. * context lost for instance.
  89555. */
  89556. rebuild(): void;
  89557. /**
  89558. * Disposes the component and the associated ressources.
  89559. */
  89560. dispose(): void;
  89561. private _pickSpriteButKeepRay;
  89562. private _pointerMove;
  89563. private _pointerDown;
  89564. private _pointerUp;
  89565. }
  89566. }
  89567. declare module BABYLON {
  89568. /** @hidden */
  89569. export var fogFragmentDeclaration: {
  89570. name: string;
  89571. shader: string;
  89572. };
  89573. }
  89574. declare module BABYLON {
  89575. /** @hidden */
  89576. export var fogFragment: {
  89577. name: string;
  89578. shader: string;
  89579. };
  89580. }
  89581. declare module BABYLON {
  89582. /** @hidden */
  89583. export var spritesPixelShader: {
  89584. name: string;
  89585. shader: string;
  89586. };
  89587. }
  89588. declare module BABYLON {
  89589. /** @hidden */
  89590. export var fogVertexDeclaration: {
  89591. name: string;
  89592. shader: string;
  89593. };
  89594. }
  89595. declare module BABYLON {
  89596. /** @hidden */
  89597. export var spritesVertexShader: {
  89598. name: string;
  89599. shader: string;
  89600. };
  89601. }
  89602. declare module BABYLON {
  89603. /**
  89604. * Defines the minimum interface to fullfil in order to be a sprite manager.
  89605. */
  89606. export interface ISpriteManager extends IDisposable {
  89607. /**
  89608. * Gets manager's name
  89609. */
  89610. name: string;
  89611. /**
  89612. * Restricts the camera to viewing objects with the same layerMask.
  89613. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  89614. */
  89615. layerMask: number;
  89616. /**
  89617. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  89618. */
  89619. isPickable: boolean;
  89620. /**
  89621. * Gets the hosting scene
  89622. */
  89623. scene: Scene;
  89624. /**
  89625. * Specifies the rendering group id for this mesh (0 by default)
  89626. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  89627. */
  89628. renderingGroupId: number;
  89629. /**
  89630. * Defines the list of sprites managed by the manager.
  89631. */
  89632. sprites: Array<Sprite>;
  89633. /**
  89634. * Gets or sets the spritesheet texture
  89635. */
  89636. texture: Texture;
  89637. /** Defines the default width of a cell in the spritesheet */
  89638. cellWidth: number;
  89639. /** Defines the default height of a cell in the spritesheet */
  89640. cellHeight: number;
  89641. /**
  89642. * Tests the intersection of a sprite with a specific ray.
  89643. * @param ray The ray we are sending to test the collision
  89644. * @param camera The camera space we are sending rays in
  89645. * @param predicate A predicate allowing excluding sprites from the list of object to test
  89646. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89647. * @returns picking info or null.
  89648. */
  89649. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  89650. /**
  89651. * Intersects the sprites with a ray
  89652. * @param ray defines the ray to intersect with
  89653. * @param camera defines the current active camera
  89654. * @param predicate defines a predicate used to select candidate sprites
  89655. * @returns null if no hit or a PickingInfo array
  89656. */
  89657. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  89658. /**
  89659. * Renders the list of sprites on screen.
  89660. */
  89661. render(): void;
  89662. }
  89663. /**
  89664. * Class used to manage multiple sprites on the same spritesheet
  89665. * @see https://doc.babylonjs.com/babylon101/sprites
  89666. */
  89667. export class SpriteManager implements ISpriteManager {
  89668. /** defines the manager's name */
  89669. name: string;
  89670. /** Define the Url to load snippets */
  89671. static SnippetUrl: string;
  89672. /** Snippet ID if the manager was created from the snippet server */
  89673. snippetId: string;
  89674. /** Gets the list of sprites */
  89675. sprites: Sprite[];
  89676. /** Gets or sets the rendering group id (0 by default) */
  89677. renderingGroupId: number;
  89678. /** Gets or sets camera layer mask */
  89679. layerMask: number;
  89680. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  89681. fogEnabled: boolean;
  89682. /** Gets or sets a boolean indicating if the sprites are pickable */
  89683. isPickable: boolean;
  89684. /** Defines the default width of a cell in the spritesheet */
  89685. cellWidth: number;
  89686. /** Defines the default height of a cell in the spritesheet */
  89687. cellHeight: number;
  89688. /** Associative array from JSON sprite data file */
  89689. private _cellData;
  89690. /** Array of sprite names from JSON sprite data file */
  89691. private _spriteMap;
  89692. /** True when packed cell data from JSON file is ready*/
  89693. private _packedAndReady;
  89694. private _textureContent;
  89695. /**
  89696. * An event triggered when the manager is disposed.
  89697. */
  89698. onDisposeObservable: Observable<SpriteManager>;
  89699. private _onDisposeObserver;
  89700. /**
  89701. * Callback called when the manager is disposed
  89702. */
  89703. set onDispose(callback: () => void);
  89704. private _capacity;
  89705. private _fromPacked;
  89706. private _spriteTexture;
  89707. private _epsilon;
  89708. private _scene;
  89709. private _vertexData;
  89710. private _buffer;
  89711. private _vertexBuffers;
  89712. private _indexBuffer;
  89713. private _effectBase;
  89714. private _effectFog;
  89715. /**
  89716. * Gets or sets the unique id of the sprite
  89717. */
  89718. uniqueId: number;
  89719. /**
  89720. * Gets the array of sprites
  89721. */
  89722. get children(): Sprite[];
  89723. /**
  89724. * Gets the hosting scene
  89725. */
  89726. get scene(): Scene;
  89727. /**
  89728. * Gets the capacity of the manager
  89729. */
  89730. get capacity(): number;
  89731. /**
  89732. * Gets or sets the spritesheet texture
  89733. */
  89734. get texture(): Texture;
  89735. set texture(value: Texture);
  89736. private _blendMode;
  89737. /**
  89738. * Blend mode use to render the particle, it can be any of
  89739. * the static Constants.ALPHA_x properties provided in this class.
  89740. * Default value is Constants.ALPHA_COMBINE
  89741. */
  89742. get blendMode(): number;
  89743. set blendMode(blendMode: number);
  89744. /** Disables writing to the depth buffer when rendering the sprites.
  89745. * It can be handy to disable depth writing when using textures without alpha channel
  89746. * and setting some specific blend modes.
  89747. */
  89748. disableDepthWrite: boolean;
  89749. /**
  89750. * Creates a new sprite manager
  89751. * @param name defines the manager's name
  89752. * @param imgUrl defines the sprite sheet url
  89753. * @param capacity defines the maximum allowed number of sprites
  89754. * @param cellSize defines the size of a sprite cell
  89755. * @param scene defines the hosting scene
  89756. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  89757. * @param samplingMode defines the smapling mode to use with spritesheet
  89758. * @param fromPacked set to false; do not alter
  89759. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  89760. */
  89761. constructor(
  89762. /** defines the manager's name */
  89763. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  89764. /**
  89765. * Returns the string "SpriteManager"
  89766. * @returns "SpriteManager"
  89767. */
  89768. getClassName(): string;
  89769. private _makePacked;
  89770. private _appendSpriteVertex;
  89771. private _checkTextureAlpha;
  89772. /**
  89773. * Intersects the sprites with a ray
  89774. * @param ray defines the ray to intersect with
  89775. * @param camera defines the current active camera
  89776. * @param predicate defines a predicate used to select candidate sprites
  89777. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  89778. * @returns null if no hit or a PickingInfo
  89779. */
  89780. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  89781. /**
  89782. * Intersects the sprites with a ray
  89783. * @param ray defines the ray to intersect with
  89784. * @param camera defines the current active camera
  89785. * @param predicate defines a predicate used to select candidate sprites
  89786. * @returns null if no hit or a PickingInfo array
  89787. */
  89788. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  89789. /**
  89790. * Render all child sprites
  89791. */
  89792. render(): void;
  89793. /**
  89794. * Release associated resources
  89795. */
  89796. dispose(): void;
  89797. /**
  89798. * Serializes the sprite manager to a JSON object
  89799. * @param serializeTexture defines if the texture must be serialized as well
  89800. * @returns the JSON object
  89801. */
  89802. serialize(serializeTexture?: boolean): any;
  89803. /**
  89804. * Parses a JSON object to create a new sprite manager.
  89805. * @param parsedManager The JSON object to parse
  89806. * @param scene The scene to create the sprite managerin
  89807. * @param rootUrl The root url to use to load external dependencies like texture
  89808. * @returns the new sprite manager
  89809. */
  89810. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  89811. /**
  89812. * Creates a sprite manager from a snippet saved in a remote file
  89813. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  89814. * @param url defines the url to load from
  89815. * @param scene defines the hosting scene
  89816. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  89817. * @returns a promise that will resolve to the new sprite manager
  89818. */
  89819. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  89820. /**
  89821. * Creates a sprite manager from a snippet saved by the sprite editor
  89822. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  89823. * @param scene defines the hosting scene
  89824. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  89825. * @returns a promise that will resolve to the new sprite manager
  89826. */
  89827. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  89828. }
  89829. }
  89830. declare module BABYLON {
  89831. /** Interface used by value gradients (color, factor, ...) */
  89832. export interface IValueGradient {
  89833. /**
  89834. * Gets or sets the gradient value (between 0 and 1)
  89835. */
  89836. gradient: number;
  89837. }
  89838. /** Class used to store color4 gradient */
  89839. export class ColorGradient implements IValueGradient {
  89840. /**
  89841. * Gets or sets the gradient value (between 0 and 1)
  89842. */
  89843. gradient: number;
  89844. /**
  89845. * Gets or sets first associated color
  89846. */
  89847. color1: Color4;
  89848. /**
  89849. * Gets or sets second associated color
  89850. */
  89851. color2?: Color4 | undefined;
  89852. /**
  89853. * Creates a new color4 gradient
  89854. * @param gradient gets or sets the gradient value (between 0 and 1)
  89855. * @param color1 gets or sets first associated color
  89856. * @param color2 gets or sets first second color
  89857. */
  89858. constructor(
  89859. /**
  89860. * Gets or sets the gradient value (between 0 and 1)
  89861. */
  89862. gradient: number,
  89863. /**
  89864. * Gets or sets first associated color
  89865. */
  89866. color1: Color4,
  89867. /**
  89868. * Gets or sets second associated color
  89869. */
  89870. color2?: Color4 | undefined);
  89871. /**
  89872. * Will get a color picked randomly between color1 and color2.
  89873. * If color2 is undefined then color1 will be used
  89874. * @param result defines the target Color4 to store the result in
  89875. */
  89876. getColorToRef(result: Color4): void;
  89877. }
  89878. /** Class used to store color 3 gradient */
  89879. export class Color3Gradient implements IValueGradient {
  89880. /**
  89881. * Gets or sets the gradient value (between 0 and 1)
  89882. */
  89883. gradient: number;
  89884. /**
  89885. * Gets or sets the associated color
  89886. */
  89887. color: Color3;
  89888. /**
  89889. * Creates a new color3 gradient
  89890. * @param gradient gets or sets the gradient value (between 0 and 1)
  89891. * @param color gets or sets associated color
  89892. */
  89893. constructor(
  89894. /**
  89895. * Gets or sets the gradient value (between 0 and 1)
  89896. */
  89897. gradient: number,
  89898. /**
  89899. * Gets or sets the associated color
  89900. */
  89901. color: Color3);
  89902. }
  89903. /** Class used to store factor gradient */
  89904. export class FactorGradient implements IValueGradient {
  89905. /**
  89906. * Gets or sets the gradient value (between 0 and 1)
  89907. */
  89908. gradient: number;
  89909. /**
  89910. * Gets or sets first associated factor
  89911. */
  89912. factor1: number;
  89913. /**
  89914. * Gets or sets second associated factor
  89915. */
  89916. factor2?: number | undefined;
  89917. /**
  89918. * Creates a new factor gradient
  89919. * @param gradient gets or sets the gradient value (between 0 and 1)
  89920. * @param factor1 gets or sets first associated factor
  89921. * @param factor2 gets or sets second associated factor
  89922. */
  89923. constructor(
  89924. /**
  89925. * Gets or sets the gradient value (between 0 and 1)
  89926. */
  89927. gradient: number,
  89928. /**
  89929. * Gets or sets first associated factor
  89930. */
  89931. factor1: number,
  89932. /**
  89933. * Gets or sets second associated factor
  89934. */
  89935. factor2?: number | undefined);
  89936. /**
  89937. * Will get a number picked randomly between factor1 and factor2.
  89938. * If factor2 is undefined then factor1 will be used
  89939. * @returns the picked number
  89940. */
  89941. getFactor(): number;
  89942. }
  89943. /**
  89944. * Helper used to simplify some generic gradient tasks
  89945. */
  89946. export class GradientHelper {
  89947. /**
  89948. * Gets the current gradient from an array of IValueGradient
  89949. * @param ratio defines the current ratio to get
  89950. * @param gradients defines the array of IValueGradient
  89951. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  89952. */
  89953. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  89954. }
  89955. }
  89956. declare module BABYLON {
  89957. interface ThinEngine {
  89958. /**
  89959. * Creates a raw texture
  89960. * @param data defines the data to store in the texture
  89961. * @param width defines the width of the texture
  89962. * @param height defines the height of the texture
  89963. * @param format defines the format of the data
  89964. * @param generateMipMaps defines if the engine should generate the mip levels
  89965. * @param invertY defines if data must be stored with Y axis inverted
  89966. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  89967. * @param compression defines the compression used (null by default)
  89968. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89969. * @returns the raw texture inside an InternalTexture
  89970. */
  89971. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  89972. /**
  89973. * Update a raw texture
  89974. * @param texture defines the texture to update
  89975. * @param data defines the data to store in the texture
  89976. * @param format defines the format of the data
  89977. * @param invertY defines if data must be stored with Y axis inverted
  89978. */
  89979. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89980. /**
  89981. * Update a raw texture
  89982. * @param texture defines the texture to update
  89983. * @param data defines the data to store in the texture
  89984. * @param format defines the format of the data
  89985. * @param invertY defines if data must be stored with Y axis inverted
  89986. * @param compression defines the compression used (null by default)
  89987. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89988. */
  89989. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  89990. /**
  89991. * Creates a new raw cube texture
  89992. * @param data defines the array of data to use to create each face
  89993. * @param size defines the size of the textures
  89994. * @param format defines the format of the data
  89995. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89996. * @param generateMipMaps defines if the engine should generate the mip levels
  89997. * @param invertY defines if data must be stored with Y axis inverted
  89998. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89999. * @param compression defines the compression used (null by default)
  90000. * @returns the cube texture as an InternalTexture
  90001. */
  90002. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90003. /**
  90004. * Update a raw cube texture
  90005. * @param texture defines the texture to udpdate
  90006. * @param data defines the data to store
  90007. * @param format defines the data format
  90008. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90009. * @param invertY defines if data must be stored with Y axis inverted
  90010. */
  90011. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90012. /**
  90013. * Update a raw cube texture
  90014. * @param texture defines the texture to udpdate
  90015. * @param data defines the data to store
  90016. * @param format defines the data format
  90017. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90018. * @param invertY defines if data must be stored with Y axis inverted
  90019. * @param compression defines the compression used (null by default)
  90020. */
  90021. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90022. /**
  90023. * Update a raw cube texture
  90024. * @param texture defines the texture to udpdate
  90025. * @param data defines the data to store
  90026. * @param format defines the data format
  90027. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90028. * @param invertY defines if data must be stored with Y axis inverted
  90029. * @param compression defines the compression used (null by default)
  90030. * @param level defines which level of the texture to update
  90031. */
  90032. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  90033. /**
  90034. * Creates a new raw cube texture from a specified url
  90035. * @param url defines the url where the data is located
  90036. * @param scene defines the current scene
  90037. * @param size defines the size of the textures
  90038. * @param format defines the format of the data
  90039. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90040. * @param noMipmap defines if the engine should avoid generating the mip levels
  90041. * @param callback defines a callback used to extract texture data from loaded data
  90042. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90043. * @param onLoad defines a callback called when texture is loaded
  90044. * @param onError defines a callback called if there is an error
  90045. * @returns the cube texture as an InternalTexture
  90046. */
  90047. 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;
  90048. /**
  90049. * Creates a new raw cube texture from a specified url
  90050. * @param url defines the url where the data is located
  90051. * @param scene defines the current scene
  90052. * @param size defines the size of the textures
  90053. * @param format defines the format of the data
  90054. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90055. * @param noMipmap defines if the engine should avoid generating the mip levels
  90056. * @param callback defines a callback used to extract texture data from loaded data
  90057. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90058. * @param onLoad defines a callback called when texture is loaded
  90059. * @param onError defines a callback called if there is an error
  90060. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90061. * @param invertY defines if data must be stored with Y axis inverted
  90062. * @returns the cube texture as an InternalTexture
  90063. */
  90064. 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;
  90065. /**
  90066. * Creates a new raw 3D texture
  90067. * @param data defines the data used to create the texture
  90068. * @param width defines the width of the texture
  90069. * @param height defines the height of the texture
  90070. * @param depth defines the depth of the texture
  90071. * @param format defines the format of the texture
  90072. * @param generateMipMaps defines if the engine must generate mip levels
  90073. * @param invertY defines if data must be stored with Y axis inverted
  90074. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90075. * @param compression defines the compressed used (can be null)
  90076. * @param textureType defines the compressed used (can be null)
  90077. * @returns a new raw 3D texture (stored in an InternalTexture)
  90078. */
  90079. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90080. /**
  90081. * Update a raw 3D texture
  90082. * @param texture defines the texture to update
  90083. * @param data defines the data to store
  90084. * @param format defines the data format
  90085. * @param invertY defines if data must be stored with Y axis inverted
  90086. */
  90087. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90088. /**
  90089. * Update a raw 3D texture
  90090. * @param texture defines the texture to update
  90091. * @param data defines the data to store
  90092. * @param format defines the data format
  90093. * @param invertY defines if data must be stored with Y axis inverted
  90094. * @param compression defines the used compression (can be null)
  90095. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90096. */
  90097. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90098. /**
  90099. * Creates a new raw 2D array texture
  90100. * @param data defines the data used to create the texture
  90101. * @param width defines the width of the texture
  90102. * @param height defines the height of the texture
  90103. * @param depth defines the number of layers of the texture
  90104. * @param format defines the format of the texture
  90105. * @param generateMipMaps defines if the engine must generate mip levels
  90106. * @param invertY defines if data must be stored with Y axis inverted
  90107. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90108. * @param compression defines the compressed used (can be null)
  90109. * @param textureType defines the compressed used (can be null)
  90110. * @returns a new raw 2D array texture (stored in an InternalTexture)
  90111. */
  90112. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90113. /**
  90114. * Update a raw 2D array texture
  90115. * @param texture defines the texture to update
  90116. * @param data defines the data to store
  90117. * @param format defines the data format
  90118. * @param invertY defines if data must be stored with Y axis inverted
  90119. */
  90120. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90121. /**
  90122. * Update a raw 2D array texture
  90123. * @param texture defines the texture to update
  90124. * @param data defines the data to store
  90125. * @param format defines the data format
  90126. * @param invertY defines if data must be stored with Y axis inverted
  90127. * @param compression defines the used compression (can be null)
  90128. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90129. */
  90130. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90131. }
  90132. }
  90133. declare module BABYLON {
  90134. /**
  90135. * Raw texture can help creating a texture directly from an array of data.
  90136. * This can be super useful if you either get the data from an uncompressed source or
  90137. * if you wish to create your texture pixel by pixel.
  90138. */
  90139. export class RawTexture extends Texture {
  90140. /**
  90141. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90142. */
  90143. format: number;
  90144. /**
  90145. * Instantiates a new RawTexture.
  90146. * Raw texture can help creating a texture directly from an array of data.
  90147. * This can be super useful if you either get the data from an uncompressed source or
  90148. * if you wish to create your texture pixel by pixel.
  90149. * @param data define the array of data to use to create the texture
  90150. * @param width define the width of the texture
  90151. * @param height define the height of the texture
  90152. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90153. * @param scene define the scene the texture belongs to
  90154. * @param generateMipMaps define whether mip maps should be generated or not
  90155. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90156. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90157. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90158. */
  90159. constructor(data: ArrayBufferView, width: number, height: number,
  90160. /**
  90161. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90162. */
  90163. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  90164. /**
  90165. * Updates the texture underlying data.
  90166. * @param data Define the new data of the texture
  90167. */
  90168. update(data: ArrayBufferView): void;
  90169. /**
  90170. * Creates a luminance texture from some data.
  90171. * @param data Define the texture data
  90172. * @param width Define the width of the texture
  90173. * @param height Define the height of the texture
  90174. * @param scene Define the scene the texture belongs to
  90175. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90176. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90177. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90178. * @returns the luminance texture
  90179. */
  90180. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90181. /**
  90182. * Creates a luminance alpha texture from some data.
  90183. * @param data Define the texture data
  90184. * @param width Define the width of the texture
  90185. * @param height Define the height of the texture
  90186. * @param scene Define the scene the texture belongs to
  90187. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90188. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90189. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90190. * @returns the luminance alpha texture
  90191. */
  90192. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90193. /**
  90194. * Creates an alpha texture from some data.
  90195. * @param data Define the texture data
  90196. * @param width Define the width of the texture
  90197. * @param height Define the height of the texture
  90198. * @param scene Define the scene the texture belongs to
  90199. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90200. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90201. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90202. * @returns the alpha texture
  90203. */
  90204. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90205. /**
  90206. * Creates a RGB texture from some data.
  90207. * @param data Define the texture data
  90208. * @param width Define the width of the texture
  90209. * @param height Define the height of the texture
  90210. * @param scene Define the scene the texture belongs to
  90211. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90212. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90213. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90214. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90215. * @returns the RGB alpha texture
  90216. */
  90217. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90218. /**
  90219. * Creates a RGBA texture from some data.
  90220. * @param data Define the texture data
  90221. * @param width Define the width of the texture
  90222. * @param height Define the height of the texture
  90223. * @param scene Define the scene the texture belongs to
  90224. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90225. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90226. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90227. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90228. * @returns the RGBA texture
  90229. */
  90230. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90231. /**
  90232. * Creates a R texture from some data.
  90233. * @param data Define the texture data
  90234. * @param width Define the width of the texture
  90235. * @param height Define the height of the texture
  90236. * @param scene Define the scene the texture belongs to
  90237. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90238. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90239. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90240. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90241. * @returns the R texture
  90242. */
  90243. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90244. }
  90245. }
  90246. declare module BABYLON {
  90247. interface AbstractScene {
  90248. /**
  90249. * The list of procedural textures added to the scene
  90250. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90251. */
  90252. proceduralTextures: Array<ProceduralTexture>;
  90253. }
  90254. /**
  90255. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  90256. * in a given scene.
  90257. */
  90258. export class ProceduralTextureSceneComponent implements ISceneComponent {
  90259. /**
  90260. * The component name helpfull to identify the component in the list of scene components.
  90261. */
  90262. readonly name: string;
  90263. /**
  90264. * The scene the component belongs to.
  90265. */
  90266. scene: Scene;
  90267. /**
  90268. * Creates a new instance of the component for the given scene
  90269. * @param scene Defines the scene to register the component in
  90270. */
  90271. constructor(scene: Scene);
  90272. /**
  90273. * Registers the component in a given scene
  90274. */
  90275. register(): void;
  90276. /**
  90277. * Rebuilds the elements related to this component in case of
  90278. * context lost for instance.
  90279. */
  90280. rebuild(): void;
  90281. /**
  90282. * Disposes the component and the associated ressources.
  90283. */
  90284. dispose(): void;
  90285. private _beforeClear;
  90286. }
  90287. }
  90288. declare module BABYLON {
  90289. interface ThinEngine {
  90290. /**
  90291. * Creates a new render target cube texture
  90292. * @param size defines the size of the texture
  90293. * @param options defines the options used to create the texture
  90294. * @returns a new render target cube texture stored in an InternalTexture
  90295. */
  90296. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  90297. }
  90298. }
  90299. declare module BABYLON {
  90300. /** @hidden */
  90301. export var proceduralVertexShader: {
  90302. name: string;
  90303. shader: string;
  90304. };
  90305. }
  90306. declare module BABYLON {
  90307. /**
  90308. * 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.
  90309. * This is the base class of any Procedural texture and contains most of the shareable code.
  90310. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90311. */
  90312. export class ProceduralTexture extends Texture {
  90313. isCube: boolean;
  90314. /**
  90315. * Define if the texture is enabled or not (disabled texture will not render)
  90316. */
  90317. isEnabled: boolean;
  90318. /**
  90319. * Define if the texture must be cleared before rendering (default is true)
  90320. */
  90321. autoClear: boolean;
  90322. /**
  90323. * Callback called when the texture is generated
  90324. */
  90325. onGenerated: () => void;
  90326. /**
  90327. * Event raised when the texture is generated
  90328. */
  90329. onGeneratedObservable: Observable<ProceduralTexture>;
  90330. /** @hidden */
  90331. _generateMipMaps: boolean;
  90332. /** @hidden **/
  90333. _effect: Effect;
  90334. /** @hidden */
  90335. _textures: {
  90336. [key: string]: Texture;
  90337. };
  90338. /** @hidden */
  90339. protected _fallbackTexture: Nullable<Texture>;
  90340. private _size;
  90341. private _currentRefreshId;
  90342. private _frameId;
  90343. private _refreshRate;
  90344. private _vertexBuffers;
  90345. private _indexBuffer;
  90346. private _uniforms;
  90347. private _samplers;
  90348. private _fragment;
  90349. private _floats;
  90350. private _ints;
  90351. private _floatsArrays;
  90352. private _colors3;
  90353. private _colors4;
  90354. private _vectors2;
  90355. private _vectors3;
  90356. private _matrices;
  90357. private _fallbackTextureUsed;
  90358. private _fullEngine;
  90359. private _cachedDefines;
  90360. private _contentUpdateId;
  90361. private _contentData;
  90362. /**
  90363. * Instantiates a new procedural texture.
  90364. * 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.
  90365. * This is the base class of any Procedural texture and contains most of the shareable code.
  90366. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90367. * @param name Define the name of the texture
  90368. * @param size Define the size of the texture to create
  90369. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  90370. * @param scene Define the scene the texture belongs to
  90371. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  90372. * @param generateMipMaps Define if the texture should creates mip maps or not
  90373. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  90374. */
  90375. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  90376. /**
  90377. * The effect that is created when initializing the post process.
  90378. * @returns The created effect corresponding the the postprocess.
  90379. */
  90380. getEffect(): Effect;
  90381. /**
  90382. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  90383. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  90384. */
  90385. getContent(): Nullable<ArrayBufferView>;
  90386. private _createIndexBuffer;
  90387. /** @hidden */
  90388. _rebuild(): void;
  90389. /**
  90390. * Resets the texture in order to recreate its associated resources.
  90391. * This can be called in case of context loss
  90392. */
  90393. reset(): void;
  90394. protected _getDefines(): string;
  90395. /**
  90396. * Is the texture ready to be used ? (rendered at least once)
  90397. * @returns true if ready, otherwise, false.
  90398. */
  90399. isReady(): boolean;
  90400. /**
  90401. * Resets the refresh counter of the texture and start bak from scratch.
  90402. * Could be useful to regenerate the texture if it is setup to render only once.
  90403. */
  90404. resetRefreshCounter(): void;
  90405. /**
  90406. * Set the fragment shader to use in order to render the texture.
  90407. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  90408. */
  90409. setFragment(fragment: any): void;
  90410. /**
  90411. * Define the refresh rate of the texture or the rendering frequency.
  90412. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  90413. */
  90414. get refreshRate(): number;
  90415. set refreshRate(value: number);
  90416. /** @hidden */
  90417. _shouldRender(): boolean;
  90418. /**
  90419. * Get the size the texture is rendering at.
  90420. * @returns the size (texture is always squared)
  90421. */
  90422. getRenderSize(): number;
  90423. /**
  90424. * Resize the texture to new value.
  90425. * @param size Define the new size the texture should have
  90426. * @param generateMipMaps Define whether the new texture should create mip maps
  90427. */
  90428. resize(size: number, generateMipMaps: boolean): void;
  90429. private _checkUniform;
  90430. /**
  90431. * Set a texture in the shader program used to render.
  90432. * @param name Define the name of the uniform samplers as defined in the shader
  90433. * @param texture Define the texture to bind to this sampler
  90434. * @return the texture itself allowing "fluent" like uniform updates
  90435. */
  90436. setTexture(name: string, texture: Texture): ProceduralTexture;
  90437. /**
  90438. * Set a float in the shader.
  90439. * @param name Define the name of the uniform as defined in the shader
  90440. * @param value Define the value to give to the uniform
  90441. * @return the texture itself allowing "fluent" like uniform updates
  90442. */
  90443. setFloat(name: string, value: number): ProceduralTexture;
  90444. /**
  90445. * Set a int in the shader.
  90446. * @param name Define the name of the uniform as defined in the shader
  90447. * @param value Define the value to give to the uniform
  90448. * @return the texture itself allowing "fluent" like uniform updates
  90449. */
  90450. setInt(name: string, value: number): ProceduralTexture;
  90451. /**
  90452. * Set an array of floats in the shader.
  90453. * @param name Define the name of the uniform as defined in the shader
  90454. * @param value Define the value to give to the uniform
  90455. * @return the texture itself allowing "fluent" like uniform updates
  90456. */
  90457. setFloats(name: string, value: number[]): ProceduralTexture;
  90458. /**
  90459. * Set a vec3 in the shader from a Color3.
  90460. * @param name Define the name of the uniform as defined in the shader
  90461. * @param value Define the value to give to the uniform
  90462. * @return the texture itself allowing "fluent" like uniform updates
  90463. */
  90464. setColor3(name: string, value: Color3): ProceduralTexture;
  90465. /**
  90466. * Set a vec4 in the shader from a Color4.
  90467. * @param name Define the name of the uniform as defined in the shader
  90468. * @param value Define the value to give to the uniform
  90469. * @return the texture itself allowing "fluent" like uniform updates
  90470. */
  90471. setColor4(name: string, value: Color4): ProceduralTexture;
  90472. /**
  90473. * Set a vec2 in the shader from a Vector2.
  90474. * @param name Define the name of the uniform as defined in the shader
  90475. * @param value Define the value to give to the uniform
  90476. * @return the texture itself allowing "fluent" like uniform updates
  90477. */
  90478. setVector2(name: string, value: Vector2): ProceduralTexture;
  90479. /**
  90480. * Set a vec3 in the shader from a Vector3.
  90481. * @param name Define the name of the uniform as defined in the shader
  90482. * @param value Define the value to give to the uniform
  90483. * @return the texture itself allowing "fluent" like uniform updates
  90484. */
  90485. setVector3(name: string, value: Vector3): ProceduralTexture;
  90486. /**
  90487. * Set a mat4 in the shader from a MAtrix.
  90488. * @param name Define the name of the uniform as defined in the shader
  90489. * @param value Define the value to give to the uniform
  90490. * @return the texture itself allowing "fluent" like uniform updates
  90491. */
  90492. setMatrix(name: string, value: Matrix): ProceduralTexture;
  90493. /**
  90494. * Render the texture to its associated render target.
  90495. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  90496. */
  90497. render(useCameraPostProcess?: boolean): void;
  90498. /**
  90499. * Clone the texture.
  90500. * @returns the cloned texture
  90501. */
  90502. clone(): ProceduralTexture;
  90503. /**
  90504. * Dispose the texture and release its asoociated resources.
  90505. */
  90506. dispose(): void;
  90507. }
  90508. }
  90509. declare module BABYLON {
  90510. /**
  90511. * This represents the base class for particle system in Babylon.
  90512. * 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.
  90513. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  90514. * @example https://doc.babylonjs.com/babylon101/particles
  90515. */
  90516. export class BaseParticleSystem {
  90517. /**
  90518. * Source color is added to the destination color without alpha affecting the result
  90519. */
  90520. static BLENDMODE_ONEONE: number;
  90521. /**
  90522. * Blend current color and particle color using particle’s alpha
  90523. */
  90524. static BLENDMODE_STANDARD: number;
  90525. /**
  90526. * Add current color and particle color multiplied by particle’s alpha
  90527. */
  90528. static BLENDMODE_ADD: number;
  90529. /**
  90530. * Multiply current color with particle color
  90531. */
  90532. static BLENDMODE_MULTIPLY: number;
  90533. /**
  90534. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  90535. */
  90536. static BLENDMODE_MULTIPLYADD: number;
  90537. /**
  90538. * List of animations used by the particle system.
  90539. */
  90540. animations: Animation[];
  90541. /**
  90542. * Gets or sets the unique id of the particle system
  90543. */
  90544. uniqueId: number;
  90545. /**
  90546. * The id of the Particle system.
  90547. */
  90548. id: string;
  90549. /**
  90550. * The friendly name of the Particle system.
  90551. */
  90552. name: string;
  90553. /**
  90554. * Snippet ID if the particle system was created from the snippet server
  90555. */
  90556. snippetId: string;
  90557. /**
  90558. * The rendering group used by the Particle system to chose when to render.
  90559. */
  90560. renderingGroupId: number;
  90561. /**
  90562. * The emitter represents the Mesh or position we are attaching the particle system to.
  90563. */
  90564. emitter: Nullable<AbstractMesh | Vector3>;
  90565. /**
  90566. * The maximum number of particles to emit per frame
  90567. */
  90568. emitRate: number;
  90569. /**
  90570. * If you want to launch only a few particles at once, that can be done, as well.
  90571. */
  90572. manualEmitCount: number;
  90573. /**
  90574. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  90575. */
  90576. updateSpeed: number;
  90577. /**
  90578. * The amount of time the particle system is running (depends of the overall update speed).
  90579. */
  90580. targetStopDuration: number;
  90581. /**
  90582. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  90583. */
  90584. disposeOnStop: boolean;
  90585. /**
  90586. * Minimum power of emitting particles.
  90587. */
  90588. minEmitPower: number;
  90589. /**
  90590. * Maximum power of emitting particles.
  90591. */
  90592. maxEmitPower: number;
  90593. /**
  90594. * Minimum life time of emitting particles.
  90595. */
  90596. minLifeTime: number;
  90597. /**
  90598. * Maximum life time of emitting particles.
  90599. */
  90600. maxLifeTime: number;
  90601. /**
  90602. * Minimum Size of emitting particles.
  90603. */
  90604. minSize: number;
  90605. /**
  90606. * Maximum Size of emitting particles.
  90607. */
  90608. maxSize: number;
  90609. /**
  90610. * Minimum scale of emitting particles on X axis.
  90611. */
  90612. minScaleX: number;
  90613. /**
  90614. * Maximum scale of emitting particles on X axis.
  90615. */
  90616. maxScaleX: number;
  90617. /**
  90618. * Minimum scale of emitting particles on Y axis.
  90619. */
  90620. minScaleY: number;
  90621. /**
  90622. * Maximum scale of emitting particles on Y axis.
  90623. */
  90624. maxScaleY: number;
  90625. /**
  90626. * Gets or sets the minimal initial rotation in radians.
  90627. */
  90628. minInitialRotation: number;
  90629. /**
  90630. * Gets or sets the maximal initial rotation in radians.
  90631. */
  90632. maxInitialRotation: number;
  90633. /**
  90634. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  90635. */
  90636. minAngularSpeed: number;
  90637. /**
  90638. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  90639. */
  90640. maxAngularSpeed: number;
  90641. /**
  90642. * The texture used to render each particle. (this can be a spritesheet)
  90643. */
  90644. particleTexture: Nullable<Texture>;
  90645. /**
  90646. * The layer mask we are rendering the particles through.
  90647. */
  90648. layerMask: number;
  90649. /**
  90650. * This can help using your own shader to render the particle system.
  90651. * The according effect will be created
  90652. */
  90653. customShader: any;
  90654. /**
  90655. * By default particle system starts as soon as they are created. This prevents the
  90656. * automatic start to happen and let you decide when to start emitting particles.
  90657. */
  90658. preventAutoStart: boolean;
  90659. private _noiseTexture;
  90660. /**
  90661. * Gets or sets a texture used to add random noise to particle positions
  90662. */
  90663. get noiseTexture(): Nullable<ProceduralTexture>;
  90664. set noiseTexture(value: Nullable<ProceduralTexture>);
  90665. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  90666. noiseStrength: Vector3;
  90667. /**
  90668. * Callback triggered when the particle animation is ending.
  90669. */
  90670. onAnimationEnd: Nullable<() => void>;
  90671. /**
  90672. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  90673. */
  90674. blendMode: number;
  90675. /**
  90676. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  90677. * to override the particles.
  90678. */
  90679. forceDepthWrite: boolean;
  90680. /** 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 */
  90681. preWarmCycles: number;
  90682. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  90683. preWarmStepOffset: number;
  90684. /**
  90685. * 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)
  90686. */
  90687. spriteCellChangeSpeed: number;
  90688. /**
  90689. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  90690. */
  90691. startSpriteCellID: number;
  90692. /**
  90693. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  90694. */
  90695. endSpriteCellID: number;
  90696. /**
  90697. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  90698. */
  90699. spriteCellWidth: number;
  90700. /**
  90701. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  90702. */
  90703. spriteCellHeight: number;
  90704. /**
  90705. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  90706. */
  90707. spriteRandomStartCell: boolean;
  90708. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  90709. translationPivot: Vector2;
  90710. /** @hidden */
  90711. protected _isAnimationSheetEnabled: boolean;
  90712. /**
  90713. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  90714. */
  90715. beginAnimationOnStart: boolean;
  90716. /**
  90717. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  90718. */
  90719. beginAnimationFrom: number;
  90720. /**
  90721. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  90722. */
  90723. beginAnimationTo: number;
  90724. /**
  90725. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  90726. */
  90727. beginAnimationLoop: boolean;
  90728. /**
  90729. * Gets or sets a world offset applied to all particles
  90730. */
  90731. worldOffset: Vector3;
  90732. /**
  90733. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  90734. */
  90735. get isAnimationSheetEnabled(): boolean;
  90736. set isAnimationSheetEnabled(value: boolean);
  90737. /**
  90738. * Get hosting scene
  90739. * @returns the scene
  90740. */
  90741. getScene(): Scene;
  90742. /**
  90743. * You can use gravity if you want to give an orientation to your particles.
  90744. */
  90745. gravity: Vector3;
  90746. protected _colorGradients: Nullable<Array<ColorGradient>>;
  90747. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  90748. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  90749. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  90750. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  90751. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  90752. protected _dragGradients: Nullable<Array<FactorGradient>>;
  90753. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  90754. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  90755. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  90756. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  90757. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  90758. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  90759. /**
  90760. * Defines the delay in milliseconds before starting the system (0 by default)
  90761. */
  90762. startDelay: number;
  90763. /**
  90764. * Gets the current list of drag gradients.
  90765. * You must use addDragGradient and removeDragGradient to udpate this list
  90766. * @returns the list of drag gradients
  90767. */
  90768. getDragGradients(): Nullable<Array<FactorGradient>>;
  90769. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  90770. limitVelocityDamping: number;
  90771. /**
  90772. * Gets the current list of limit velocity gradients.
  90773. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  90774. * @returns the list of limit velocity gradients
  90775. */
  90776. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  90777. /**
  90778. * Gets the current list of color gradients.
  90779. * You must use addColorGradient and removeColorGradient to udpate this list
  90780. * @returns the list of color gradients
  90781. */
  90782. getColorGradients(): Nullable<Array<ColorGradient>>;
  90783. /**
  90784. * Gets the current list of size gradients.
  90785. * You must use addSizeGradient and removeSizeGradient to udpate this list
  90786. * @returns the list of size gradients
  90787. */
  90788. getSizeGradients(): Nullable<Array<FactorGradient>>;
  90789. /**
  90790. * Gets the current list of color remap gradients.
  90791. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  90792. * @returns the list of color remap gradients
  90793. */
  90794. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  90795. /**
  90796. * Gets the current list of alpha remap gradients.
  90797. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  90798. * @returns the list of alpha remap gradients
  90799. */
  90800. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  90801. /**
  90802. * Gets the current list of life time gradients.
  90803. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  90804. * @returns the list of life time gradients
  90805. */
  90806. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  90807. /**
  90808. * Gets the current list of angular speed gradients.
  90809. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  90810. * @returns the list of angular speed gradients
  90811. */
  90812. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  90813. /**
  90814. * Gets the current list of velocity gradients.
  90815. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  90816. * @returns the list of velocity gradients
  90817. */
  90818. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  90819. /**
  90820. * Gets the current list of start size gradients.
  90821. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  90822. * @returns the list of start size gradients
  90823. */
  90824. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  90825. /**
  90826. * Gets the current list of emit rate gradients.
  90827. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  90828. * @returns the list of emit rate gradients
  90829. */
  90830. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  90831. /**
  90832. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90833. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90834. */
  90835. get direction1(): Vector3;
  90836. set direction1(value: Vector3);
  90837. /**
  90838. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90839. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90840. */
  90841. get direction2(): Vector3;
  90842. set direction2(value: Vector3);
  90843. /**
  90844. * 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.
  90845. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90846. */
  90847. get minEmitBox(): Vector3;
  90848. set minEmitBox(value: Vector3);
  90849. /**
  90850. * 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.
  90851. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90852. */
  90853. get maxEmitBox(): Vector3;
  90854. set maxEmitBox(value: Vector3);
  90855. /**
  90856. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  90857. */
  90858. color1: Color4;
  90859. /**
  90860. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  90861. */
  90862. color2: Color4;
  90863. /**
  90864. * Color the particle will have at the end of its lifetime
  90865. */
  90866. colorDead: Color4;
  90867. /**
  90868. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  90869. */
  90870. textureMask: Color4;
  90871. /**
  90872. * The particle emitter type defines the emitter used by the particle system.
  90873. * It can be for example box, sphere, or cone...
  90874. */
  90875. particleEmitterType: IParticleEmitterType;
  90876. /** @hidden */
  90877. _isSubEmitter: boolean;
  90878. /**
  90879. * Gets or sets the billboard mode to use when isBillboardBased = true.
  90880. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  90881. */
  90882. billboardMode: number;
  90883. protected _isBillboardBased: boolean;
  90884. /**
  90885. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  90886. */
  90887. get isBillboardBased(): boolean;
  90888. set isBillboardBased(value: boolean);
  90889. /**
  90890. * The scene the particle system belongs to.
  90891. */
  90892. protected _scene: Scene;
  90893. /**
  90894. * Local cache of defines for image processing.
  90895. */
  90896. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  90897. /**
  90898. * Default configuration related to image processing available in the standard Material.
  90899. */
  90900. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  90901. /**
  90902. * Gets the image processing configuration used either in this material.
  90903. */
  90904. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  90905. /**
  90906. * Sets the Default image processing configuration used either in the this material.
  90907. *
  90908. * If sets to null, the scene one is in use.
  90909. */
  90910. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  90911. /**
  90912. * Attaches a new image processing configuration to the Standard Material.
  90913. * @param configuration
  90914. */
  90915. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  90916. /** @hidden */
  90917. protected _reset(): void;
  90918. /** @hidden */
  90919. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  90920. /**
  90921. * Instantiates a particle system.
  90922. * 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.
  90923. * @param name The name of the particle system
  90924. */
  90925. constructor(name: string);
  90926. /**
  90927. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  90928. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  90929. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  90930. * @returns the emitter
  90931. */
  90932. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  90933. /**
  90934. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  90935. * @param radius The radius of the hemisphere to emit from
  90936. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90937. * @returns the emitter
  90938. */
  90939. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  90940. /**
  90941. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  90942. * @param radius The radius of the sphere to emit from
  90943. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90944. * @returns the emitter
  90945. */
  90946. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  90947. /**
  90948. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  90949. * @param radius The radius of the sphere to emit from
  90950. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  90951. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  90952. * @returns the emitter
  90953. */
  90954. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  90955. /**
  90956. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  90957. * @param radius The radius of the emission cylinder
  90958. * @param height The height of the emission cylinder
  90959. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  90960. * @param directionRandomizer How much to randomize the particle direction [0-1]
  90961. * @returns the emitter
  90962. */
  90963. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  90964. /**
  90965. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  90966. * @param radius The radius of the cylinder to emit from
  90967. * @param height The height of the emission cylinder
  90968. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  90969. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  90970. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  90971. * @returns the emitter
  90972. */
  90973. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  90974. /**
  90975. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  90976. * @param radius The radius of the cone to emit from
  90977. * @param angle The base angle of the cone
  90978. * @returns the emitter
  90979. */
  90980. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  90981. /**
  90982. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  90983. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  90984. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  90985. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90986. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90987. * @returns the emitter
  90988. */
  90989. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  90990. }
  90991. }
  90992. declare module BABYLON {
  90993. /**
  90994. * Type of sub emitter
  90995. */
  90996. export enum SubEmitterType {
  90997. /**
  90998. * Attached to the particle over it's lifetime
  90999. */
  91000. ATTACHED = 0,
  91001. /**
  91002. * Created when the particle dies
  91003. */
  91004. END = 1
  91005. }
  91006. /**
  91007. * Sub emitter class used to emit particles from an existing particle
  91008. */
  91009. export class SubEmitter {
  91010. /**
  91011. * the particle system to be used by the sub emitter
  91012. */
  91013. particleSystem: ParticleSystem;
  91014. /**
  91015. * Type of the submitter (Default: END)
  91016. */
  91017. type: SubEmitterType;
  91018. /**
  91019. * 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)
  91020. * Note: This only is supported when using an emitter of type Mesh
  91021. */
  91022. inheritDirection: boolean;
  91023. /**
  91024. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  91025. */
  91026. inheritedVelocityAmount: number;
  91027. /**
  91028. * Creates a sub emitter
  91029. * @param particleSystem the particle system to be used by the sub emitter
  91030. */
  91031. constructor(
  91032. /**
  91033. * the particle system to be used by the sub emitter
  91034. */
  91035. particleSystem: ParticleSystem);
  91036. /**
  91037. * Clones the sub emitter
  91038. * @returns the cloned sub emitter
  91039. */
  91040. clone(): SubEmitter;
  91041. /**
  91042. * Serialize current object to a JSON object
  91043. * @returns the serialized object
  91044. */
  91045. serialize(): any;
  91046. /** @hidden */
  91047. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  91048. /**
  91049. * Creates a new SubEmitter from a serialized JSON version
  91050. * @param serializationObject defines the JSON object to read from
  91051. * @param scene defines the hosting scene
  91052. * @param rootUrl defines the rootUrl for data loading
  91053. * @returns a new SubEmitter
  91054. */
  91055. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  91056. /** Release associated resources */
  91057. dispose(): void;
  91058. }
  91059. }
  91060. declare module BABYLON {
  91061. /** @hidden */
  91062. export var imageProcessingDeclaration: {
  91063. name: string;
  91064. shader: string;
  91065. };
  91066. }
  91067. declare module BABYLON {
  91068. /** @hidden */
  91069. export var imageProcessingFunctions: {
  91070. name: string;
  91071. shader: string;
  91072. };
  91073. }
  91074. declare module BABYLON {
  91075. /** @hidden */
  91076. export var particlesPixelShader: {
  91077. name: string;
  91078. shader: string;
  91079. };
  91080. }
  91081. declare module BABYLON {
  91082. /** @hidden */
  91083. export var particlesVertexShader: {
  91084. name: string;
  91085. shader: string;
  91086. };
  91087. }
  91088. declare module BABYLON {
  91089. /**
  91090. * This represents a particle system in Babylon.
  91091. * 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.
  91092. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91093. * @example https://doc.babylonjs.com/babylon101/particles
  91094. */
  91095. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  91096. /**
  91097. * Billboard mode will only apply to Y axis
  91098. */
  91099. static readonly BILLBOARDMODE_Y: number;
  91100. /**
  91101. * Billboard mode will apply to all axes
  91102. */
  91103. static readonly BILLBOARDMODE_ALL: number;
  91104. /**
  91105. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  91106. */
  91107. static readonly BILLBOARDMODE_STRETCHED: number;
  91108. /**
  91109. * This function can be defined to provide custom update for active particles.
  91110. * This function will be called instead of regular update (age, position, color, etc.).
  91111. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  91112. */
  91113. updateFunction: (particles: Particle[]) => void;
  91114. private _emitterWorldMatrix;
  91115. /**
  91116. * This function can be defined to specify initial direction for every new particle.
  91117. * It by default use the emitterType defined function
  91118. */
  91119. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91120. /**
  91121. * This function can be defined to specify initial position for every new particle.
  91122. * It by default use the emitterType defined function
  91123. */
  91124. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91125. /**
  91126. * @hidden
  91127. */
  91128. _inheritedVelocityOffset: Vector3;
  91129. /**
  91130. * An event triggered when the system is disposed
  91131. */
  91132. onDisposeObservable: Observable<IParticleSystem>;
  91133. private _onDisposeObserver;
  91134. /**
  91135. * Sets a callback that will be triggered when the system is disposed
  91136. */
  91137. set onDispose(callback: () => void);
  91138. private _particles;
  91139. private _epsilon;
  91140. private _capacity;
  91141. private _stockParticles;
  91142. private _newPartsExcess;
  91143. private _vertexData;
  91144. private _vertexBuffer;
  91145. private _vertexBuffers;
  91146. private _spriteBuffer;
  91147. private _indexBuffer;
  91148. private _effect;
  91149. private _customEffect;
  91150. private _cachedDefines;
  91151. private _scaledColorStep;
  91152. private _colorDiff;
  91153. private _scaledDirection;
  91154. private _scaledGravity;
  91155. private _currentRenderId;
  91156. private _alive;
  91157. private _useInstancing;
  91158. private _started;
  91159. private _stopped;
  91160. private _actualFrame;
  91161. private _scaledUpdateSpeed;
  91162. private _vertexBufferSize;
  91163. /** @hidden */
  91164. _currentEmitRateGradient: Nullable<FactorGradient>;
  91165. /** @hidden */
  91166. _currentEmitRate1: number;
  91167. /** @hidden */
  91168. _currentEmitRate2: number;
  91169. /** @hidden */
  91170. _currentStartSizeGradient: Nullable<FactorGradient>;
  91171. /** @hidden */
  91172. _currentStartSize1: number;
  91173. /** @hidden */
  91174. _currentStartSize2: number;
  91175. private readonly _rawTextureWidth;
  91176. private _rampGradientsTexture;
  91177. private _useRampGradients;
  91178. /** Gets or sets a boolean indicating that ramp gradients must be used
  91179. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  91180. */
  91181. get useRampGradients(): boolean;
  91182. set useRampGradients(value: boolean);
  91183. /**
  91184. * 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.
  91185. * 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: [])
  91186. */
  91187. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  91188. private _subEmitters;
  91189. /**
  91190. * @hidden
  91191. * If the particle systems emitter should be disposed when the particle system is disposed
  91192. */
  91193. _disposeEmitterOnDispose: boolean;
  91194. /**
  91195. * The current active Sub-systems, this property is used by the root particle system only.
  91196. */
  91197. activeSubSystems: Array<ParticleSystem>;
  91198. /**
  91199. * Specifies if the particles are updated in emitter local space or world space
  91200. */
  91201. isLocal: boolean;
  91202. private _rootParticleSystem;
  91203. /**
  91204. * Gets the current list of active particles
  91205. */
  91206. get particles(): Particle[];
  91207. /**
  91208. * Gets the number of particles active at the same time.
  91209. * @returns The number of active particles.
  91210. */
  91211. getActiveCount(): number;
  91212. /**
  91213. * Returns the string "ParticleSystem"
  91214. * @returns a string containing the class name
  91215. */
  91216. getClassName(): string;
  91217. /**
  91218. * Gets a boolean indicating that the system is stopping
  91219. * @returns true if the system is currently stopping
  91220. */
  91221. isStopping(): boolean;
  91222. /**
  91223. * Gets the custom effect used to render the particles
  91224. * @param blendMode Blend mode for which the effect should be retrieved
  91225. * @returns The effect
  91226. */
  91227. getCustomEffect(blendMode?: number): Nullable<Effect>;
  91228. /**
  91229. * Sets the custom effect used to render the particles
  91230. * @param effect The effect to set
  91231. * @param blendMode Blend mode for which the effect should be set
  91232. */
  91233. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  91234. /** @hidden */
  91235. private _onBeforeDrawParticlesObservable;
  91236. /**
  91237. * Observable that will be called just before the particles are drawn
  91238. */
  91239. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  91240. /**
  91241. * Gets the name of the particle vertex shader
  91242. */
  91243. get vertexShaderName(): string;
  91244. /**
  91245. * Instantiates a particle system.
  91246. * 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.
  91247. * @param name The name of the particle system
  91248. * @param capacity The max number of particles alive at the same time
  91249. * @param scene The scene the particle system belongs to
  91250. * @param customEffect a custom effect used to change the way particles are rendered by default
  91251. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  91252. * @param epsilon Offset used to render the particles
  91253. */
  91254. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  91255. private _addFactorGradient;
  91256. private _removeFactorGradient;
  91257. /**
  91258. * Adds a new life time gradient
  91259. * @param gradient defines the gradient to use (between 0 and 1)
  91260. * @param factor defines the life time factor to affect to the specified gradient
  91261. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91262. * @returns the current particle system
  91263. */
  91264. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91265. /**
  91266. * Remove a specific life time gradient
  91267. * @param gradient defines the gradient to remove
  91268. * @returns the current particle system
  91269. */
  91270. removeLifeTimeGradient(gradient: number): IParticleSystem;
  91271. /**
  91272. * Adds a new size gradient
  91273. * @param gradient defines the gradient to use (between 0 and 1)
  91274. * @param factor defines the size factor to affect to the specified gradient
  91275. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91276. * @returns the current particle system
  91277. */
  91278. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91279. /**
  91280. * Remove a specific size gradient
  91281. * @param gradient defines the gradient to remove
  91282. * @returns the current particle system
  91283. */
  91284. removeSizeGradient(gradient: number): IParticleSystem;
  91285. /**
  91286. * Adds a new color remap gradient
  91287. * @param gradient defines the gradient to use (between 0 and 1)
  91288. * @param min defines the color remap minimal range
  91289. * @param max defines the color remap maximal range
  91290. * @returns the current particle system
  91291. */
  91292. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  91293. /**
  91294. * Remove a specific color remap gradient
  91295. * @param gradient defines the gradient to remove
  91296. * @returns the current particle system
  91297. */
  91298. removeColorRemapGradient(gradient: number): IParticleSystem;
  91299. /**
  91300. * Adds a new alpha remap gradient
  91301. * @param gradient defines the gradient to use (between 0 and 1)
  91302. * @param min defines the alpha remap minimal range
  91303. * @param max defines the alpha remap maximal range
  91304. * @returns the current particle system
  91305. */
  91306. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  91307. /**
  91308. * Remove a specific alpha remap gradient
  91309. * @param gradient defines the gradient to remove
  91310. * @returns the current particle system
  91311. */
  91312. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  91313. /**
  91314. * Adds a new angular speed gradient
  91315. * @param gradient defines the gradient to use (between 0 and 1)
  91316. * @param factor defines the angular speed to affect to the specified gradient
  91317. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91318. * @returns the current particle system
  91319. */
  91320. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91321. /**
  91322. * Remove a specific angular speed gradient
  91323. * @param gradient defines the gradient to remove
  91324. * @returns the current particle system
  91325. */
  91326. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  91327. /**
  91328. * Adds a new velocity gradient
  91329. * @param gradient defines the gradient to use (between 0 and 1)
  91330. * @param factor defines the velocity to affect to the specified gradient
  91331. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91332. * @returns the current particle system
  91333. */
  91334. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91335. /**
  91336. * Remove a specific velocity gradient
  91337. * @param gradient defines the gradient to remove
  91338. * @returns the current particle system
  91339. */
  91340. removeVelocityGradient(gradient: number): IParticleSystem;
  91341. /**
  91342. * Adds a new limit velocity gradient
  91343. * @param gradient defines the gradient to use (between 0 and 1)
  91344. * @param factor defines the limit velocity value to affect to the specified gradient
  91345. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91346. * @returns the current particle system
  91347. */
  91348. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91349. /**
  91350. * Remove a specific limit velocity gradient
  91351. * @param gradient defines the gradient to remove
  91352. * @returns the current particle system
  91353. */
  91354. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  91355. /**
  91356. * Adds a new drag gradient
  91357. * @param gradient defines the gradient to use (between 0 and 1)
  91358. * @param factor defines the drag value to affect to the specified gradient
  91359. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91360. * @returns the current particle system
  91361. */
  91362. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91363. /**
  91364. * Remove a specific drag gradient
  91365. * @param gradient defines the gradient to remove
  91366. * @returns the current particle system
  91367. */
  91368. removeDragGradient(gradient: number): IParticleSystem;
  91369. /**
  91370. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  91371. * @param gradient defines the gradient to use (between 0 and 1)
  91372. * @param factor defines the emit rate value to affect to the specified gradient
  91373. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91374. * @returns the current particle system
  91375. */
  91376. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91377. /**
  91378. * Remove a specific emit rate gradient
  91379. * @param gradient defines the gradient to remove
  91380. * @returns the current particle system
  91381. */
  91382. removeEmitRateGradient(gradient: number): IParticleSystem;
  91383. /**
  91384. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  91385. * @param gradient defines the gradient to use (between 0 and 1)
  91386. * @param factor defines the start size value to affect to the specified gradient
  91387. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91388. * @returns the current particle system
  91389. */
  91390. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91391. /**
  91392. * Remove a specific start size gradient
  91393. * @param gradient defines the gradient to remove
  91394. * @returns the current particle system
  91395. */
  91396. removeStartSizeGradient(gradient: number): IParticleSystem;
  91397. private _createRampGradientTexture;
  91398. /**
  91399. * Gets the current list of ramp gradients.
  91400. * You must use addRampGradient and removeRampGradient to udpate this list
  91401. * @returns the list of ramp gradients
  91402. */
  91403. getRampGradients(): Nullable<Array<Color3Gradient>>;
  91404. /** Force the system to rebuild all gradients that need to be resync */
  91405. forceRefreshGradients(): void;
  91406. private _syncRampGradientTexture;
  91407. /**
  91408. * Adds a new ramp gradient used to remap particle colors
  91409. * @param gradient defines the gradient to use (between 0 and 1)
  91410. * @param color defines the color to affect to the specified gradient
  91411. * @returns the current particle system
  91412. */
  91413. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  91414. /**
  91415. * Remove a specific ramp gradient
  91416. * @param gradient defines the gradient to remove
  91417. * @returns the current particle system
  91418. */
  91419. removeRampGradient(gradient: number): ParticleSystem;
  91420. /**
  91421. * Adds a new color gradient
  91422. * @param gradient defines the gradient to use (between 0 and 1)
  91423. * @param color1 defines the color to affect to the specified gradient
  91424. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  91425. * @returns this particle system
  91426. */
  91427. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  91428. /**
  91429. * Remove a specific color gradient
  91430. * @param gradient defines the gradient to remove
  91431. * @returns this particle system
  91432. */
  91433. removeColorGradient(gradient: number): IParticleSystem;
  91434. private _fetchR;
  91435. protected _reset(): void;
  91436. private _resetEffect;
  91437. private _createVertexBuffers;
  91438. private _createIndexBuffer;
  91439. /**
  91440. * Gets the maximum number of particles active at the same time.
  91441. * @returns The max number of active particles.
  91442. */
  91443. getCapacity(): number;
  91444. /**
  91445. * Gets whether there are still active particles in the system.
  91446. * @returns True if it is alive, otherwise false.
  91447. */
  91448. isAlive(): boolean;
  91449. /**
  91450. * Gets if the system has been started. (Note: this will still be true after stop is called)
  91451. * @returns True if it has been started, otherwise false.
  91452. */
  91453. isStarted(): boolean;
  91454. private _prepareSubEmitterInternalArray;
  91455. /**
  91456. * Starts the particle system and begins to emit
  91457. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  91458. */
  91459. start(delay?: number): void;
  91460. /**
  91461. * Stops the particle system.
  91462. * @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.
  91463. */
  91464. stop(stopSubEmitters?: boolean): void;
  91465. /**
  91466. * Remove all active particles
  91467. */
  91468. reset(): void;
  91469. /**
  91470. * @hidden (for internal use only)
  91471. */
  91472. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  91473. /**
  91474. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  91475. * Its lifetime will start back at 0.
  91476. */
  91477. recycleParticle: (particle: Particle) => void;
  91478. private _stopSubEmitters;
  91479. private _createParticle;
  91480. private _removeFromRoot;
  91481. private _emitFromParticle;
  91482. private _update;
  91483. /** @hidden */
  91484. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  91485. /** @hidden */
  91486. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  91487. /**
  91488. * Fill the defines array according to the current settings of the particle system
  91489. * @param defines Array to be updated
  91490. * @param blendMode blend mode to take into account when updating the array
  91491. */
  91492. fillDefines(defines: Array<string>, blendMode: number): void;
  91493. /**
  91494. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  91495. * @param uniforms Uniforms array to fill
  91496. * @param attributes Attributes array to fill
  91497. * @param samplers Samplers array to fill
  91498. */
  91499. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  91500. /** @hidden */
  91501. private _getEffect;
  91502. /**
  91503. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  91504. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  91505. */
  91506. animate(preWarmOnly?: boolean): void;
  91507. private _appendParticleVertices;
  91508. /**
  91509. * Rebuilds the particle system.
  91510. */
  91511. rebuild(): void;
  91512. /**
  91513. * Is this system ready to be used/rendered
  91514. * @return true if the system is ready
  91515. */
  91516. isReady(): boolean;
  91517. private _render;
  91518. /**
  91519. * Renders the particle system in its current state.
  91520. * @returns the current number of particles
  91521. */
  91522. render(): number;
  91523. /**
  91524. * Disposes the particle system and free the associated resources
  91525. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  91526. */
  91527. dispose(disposeTexture?: boolean): void;
  91528. /**
  91529. * Clones the particle system.
  91530. * @param name The name of the cloned object
  91531. * @param newEmitter The new emitter to use
  91532. * @returns the cloned particle system
  91533. */
  91534. clone(name: string, newEmitter: any): ParticleSystem;
  91535. /**
  91536. * Serializes the particle system to a JSON object
  91537. * @param serializeTexture defines if the texture must be serialized as well
  91538. * @returns the JSON object
  91539. */
  91540. serialize(serializeTexture?: boolean): any;
  91541. /** @hidden */
  91542. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  91543. /** @hidden */
  91544. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  91545. /**
  91546. * Parses a JSON object to create a particle system.
  91547. * @param parsedParticleSystem The JSON object to parse
  91548. * @param scene The scene to create the particle system in
  91549. * @param rootUrl The root url to use to load external dependencies like texture
  91550. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  91551. * @returns the Parsed particle system
  91552. */
  91553. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  91554. }
  91555. }
  91556. declare module BABYLON {
  91557. /**
  91558. * A particle represents one of the element emitted by a particle system.
  91559. * This is mainly define by its coordinates, direction, velocity and age.
  91560. */
  91561. export class Particle {
  91562. /**
  91563. * The particle system the particle belongs to.
  91564. */
  91565. particleSystem: ParticleSystem;
  91566. private static _Count;
  91567. /**
  91568. * Unique ID of the particle
  91569. */
  91570. id: number;
  91571. /**
  91572. * The world position of the particle in the scene.
  91573. */
  91574. position: Vector3;
  91575. /**
  91576. * The world direction of the particle in the scene.
  91577. */
  91578. direction: Vector3;
  91579. /**
  91580. * The color of the particle.
  91581. */
  91582. color: Color4;
  91583. /**
  91584. * The color change of the particle per step.
  91585. */
  91586. colorStep: Color4;
  91587. /**
  91588. * Defines how long will the life of the particle be.
  91589. */
  91590. lifeTime: number;
  91591. /**
  91592. * The current age of the particle.
  91593. */
  91594. age: number;
  91595. /**
  91596. * The current size of the particle.
  91597. */
  91598. size: number;
  91599. /**
  91600. * The current scale of the particle.
  91601. */
  91602. scale: Vector2;
  91603. /**
  91604. * The current angle of the particle.
  91605. */
  91606. angle: number;
  91607. /**
  91608. * Defines how fast is the angle changing.
  91609. */
  91610. angularSpeed: number;
  91611. /**
  91612. * Defines the cell index used by the particle to be rendered from a sprite.
  91613. */
  91614. cellIndex: number;
  91615. /**
  91616. * The information required to support color remapping
  91617. */
  91618. remapData: Vector4;
  91619. /** @hidden */
  91620. _randomCellOffset?: number;
  91621. /** @hidden */
  91622. _initialDirection: Nullable<Vector3>;
  91623. /** @hidden */
  91624. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  91625. /** @hidden */
  91626. _initialStartSpriteCellID: number;
  91627. /** @hidden */
  91628. _initialEndSpriteCellID: number;
  91629. /** @hidden */
  91630. _currentColorGradient: Nullable<ColorGradient>;
  91631. /** @hidden */
  91632. _currentColor1: Color4;
  91633. /** @hidden */
  91634. _currentColor2: Color4;
  91635. /** @hidden */
  91636. _currentSizeGradient: Nullable<FactorGradient>;
  91637. /** @hidden */
  91638. _currentSize1: number;
  91639. /** @hidden */
  91640. _currentSize2: number;
  91641. /** @hidden */
  91642. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  91643. /** @hidden */
  91644. _currentAngularSpeed1: number;
  91645. /** @hidden */
  91646. _currentAngularSpeed2: number;
  91647. /** @hidden */
  91648. _currentVelocityGradient: Nullable<FactorGradient>;
  91649. /** @hidden */
  91650. _currentVelocity1: number;
  91651. /** @hidden */
  91652. _currentVelocity2: number;
  91653. /** @hidden */
  91654. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  91655. /** @hidden */
  91656. _currentLimitVelocity1: number;
  91657. /** @hidden */
  91658. _currentLimitVelocity2: number;
  91659. /** @hidden */
  91660. _currentDragGradient: Nullable<FactorGradient>;
  91661. /** @hidden */
  91662. _currentDrag1: number;
  91663. /** @hidden */
  91664. _currentDrag2: number;
  91665. /** @hidden */
  91666. _randomNoiseCoordinates1: Vector3;
  91667. /** @hidden */
  91668. _randomNoiseCoordinates2: Vector3;
  91669. /** @hidden */
  91670. _localPosition?: Vector3;
  91671. /**
  91672. * Creates a new instance Particle
  91673. * @param particleSystem the particle system the particle belongs to
  91674. */
  91675. constructor(
  91676. /**
  91677. * The particle system the particle belongs to.
  91678. */
  91679. particleSystem: ParticleSystem);
  91680. private updateCellInfoFromSystem;
  91681. /**
  91682. * Defines how the sprite cell index is updated for the particle
  91683. */
  91684. updateCellIndex(): void;
  91685. /** @hidden */
  91686. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  91687. /** @hidden */
  91688. _inheritParticleInfoToSubEmitters(): void;
  91689. /** @hidden */
  91690. _reset(): void;
  91691. /**
  91692. * Copy the properties of particle to another one.
  91693. * @param other the particle to copy the information to.
  91694. */
  91695. copyTo(other: Particle): void;
  91696. }
  91697. }
  91698. declare module BABYLON {
  91699. /**
  91700. * Particle emitter represents a volume emitting particles.
  91701. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  91702. */
  91703. export interface IParticleEmitterType {
  91704. /**
  91705. * Called by the particle System when the direction is computed for the created particle.
  91706. * @param worldMatrix is the world matrix of the particle system
  91707. * @param directionToUpdate is the direction vector to update with the result
  91708. * @param particle is the particle we are computed the direction for
  91709. * @param isLocal defines if the direction should be set in local space
  91710. */
  91711. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91712. /**
  91713. * Called by the particle System when the position is computed for the created particle.
  91714. * @param worldMatrix is the world matrix of the particle system
  91715. * @param positionToUpdate is the position vector to update with the result
  91716. * @param particle is the particle we are computed the position for
  91717. * @param isLocal defines if the position should be set in local space
  91718. */
  91719. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91720. /**
  91721. * Clones the current emitter and returns a copy of it
  91722. * @returns the new emitter
  91723. */
  91724. clone(): IParticleEmitterType;
  91725. /**
  91726. * Called by the GPUParticleSystem to setup the update shader
  91727. * @param effect defines the update shader
  91728. */
  91729. applyToShader(effect: Effect): void;
  91730. /**
  91731. * Returns a string to use to update the GPU particles update shader
  91732. * @returns the effect defines string
  91733. */
  91734. getEffectDefines(): string;
  91735. /**
  91736. * Returns a string representing the class name
  91737. * @returns a string containing the class name
  91738. */
  91739. getClassName(): string;
  91740. /**
  91741. * Serializes the particle system to a JSON object.
  91742. * @returns the JSON object
  91743. */
  91744. serialize(): any;
  91745. /**
  91746. * Parse properties from a JSON object
  91747. * @param serializationObject defines the JSON object
  91748. * @param scene defines the hosting scene
  91749. */
  91750. parse(serializationObject: any, scene: Scene): void;
  91751. }
  91752. }
  91753. declare module BABYLON {
  91754. /**
  91755. * Particle emitter emitting particles from the inside of a box.
  91756. * It emits the particles randomly between 2 given directions.
  91757. */
  91758. export class BoxParticleEmitter implements IParticleEmitterType {
  91759. /**
  91760. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91761. */
  91762. direction1: Vector3;
  91763. /**
  91764. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91765. */
  91766. direction2: Vector3;
  91767. /**
  91768. * 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.
  91769. */
  91770. minEmitBox: Vector3;
  91771. /**
  91772. * 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.
  91773. */
  91774. maxEmitBox: Vector3;
  91775. /**
  91776. * Creates a new instance BoxParticleEmitter
  91777. */
  91778. constructor();
  91779. /**
  91780. * Called by the particle System when the direction is computed for the created particle.
  91781. * @param worldMatrix is the world matrix of the particle system
  91782. * @param directionToUpdate is the direction vector to update with the result
  91783. * @param particle is the particle we are computed the direction for
  91784. * @param isLocal defines if the direction should be set in local space
  91785. */
  91786. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91787. /**
  91788. * Called by the particle System when the position is computed for the created particle.
  91789. * @param worldMatrix is the world matrix of the particle system
  91790. * @param positionToUpdate is the position vector to update with the result
  91791. * @param particle is the particle we are computed the position for
  91792. * @param isLocal defines if the position should be set in local space
  91793. */
  91794. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91795. /**
  91796. * Clones the current emitter and returns a copy of it
  91797. * @returns the new emitter
  91798. */
  91799. clone(): BoxParticleEmitter;
  91800. /**
  91801. * Called by the GPUParticleSystem to setup the update shader
  91802. * @param effect defines the update shader
  91803. */
  91804. applyToShader(effect: Effect): void;
  91805. /**
  91806. * Returns a string to use to update the GPU particles update shader
  91807. * @returns a string containng the defines string
  91808. */
  91809. getEffectDefines(): string;
  91810. /**
  91811. * Returns the string "BoxParticleEmitter"
  91812. * @returns a string containing the class name
  91813. */
  91814. getClassName(): string;
  91815. /**
  91816. * Serializes the particle system to a JSON object.
  91817. * @returns the JSON object
  91818. */
  91819. serialize(): any;
  91820. /**
  91821. * Parse properties from a JSON object
  91822. * @param serializationObject defines the JSON object
  91823. */
  91824. parse(serializationObject: any): void;
  91825. }
  91826. }
  91827. declare module BABYLON {
  91828. /**
  91829. * Particle emitter emitting particles from the inside of a cone.
  91830. * It emits the particles alongside the cone volume from the base to the particle.
  91831. * The emission direction might be randomized.
  91832. */
  91833. export class ConeParticleEmitter implements IParticleEmitterType {
  91834. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  91835. directionRandomizer: number;
  91836. private _radius;
  91837. private _angle;
  91838. private _height;
  91839. /**
  91840. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  91841. */
  91842. radiusRange: number;
  91843. /**
  91844. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  91845. */
  91846. heightRange: number;
  91847. /**
  91848. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  91849. */
  91850. emitFromSpawnPointOnly: boolean;
  91851. /**
  91852. * Gets or sets the radius of the emission cone
  91853. */
  91854. get radius(): number;
  91855. set radius(value: number);
  91856. /**
  91857. * Gets or sets the angle of the emission cone
  91858. */
  91859. get angle(): number;
  91860. set angle(value: number);
  91861. private _buildHeight;
  91862. /**
  91863. * Creates a new instance ConeParticleEmitter
  91864. * @param radius the radius of the emission cone (1 by default)
  91865. * @param angle the cone base angle (PI by default)
  91866. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  91867. */
  91868. constructor(radius?: number, angle?: number,
  91869. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  91870. directionRandomizer?: number);
  91871. /**
  91872. * Called by the particle System when the direction is computed for the created particle.
  91873. * @param worldMatrix is the world matrix of the particle system
  91874. * @param directionToUpdate is the direction vector to update with the result
  91875. * @param particle is the particle we are computed the direction for
  91876. * @param isLocal defines if the direction should be set in local space
  91877. */
  91878. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91879. /**
  91880. * Called by the particle System when the position is computed for the created particle.
  91881. * @param worldMatrix is the world matrix of the particle system
  91882. * @param positionToUpdate is the position vector to update with the result
  91883. * @param particle is the particle we are computed the position for
  91884. * @param isLocal defines if the position should be set in local space
  91885. */
  91886. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91887. /**
  91888. * Clones the current emitter and returns a copy of it
  91889. * @returns the new emitter
  91890. */
  91891. clone(): ConeParticleEmitter;
  91892. /**
  91893. * Called by the GPUParticleSystem to setup the update shader
  91894. * @param effect defines the update shader
  91895. */
  91896. applyToShader(effect: Effect): void;
  91897. /**
  91898. * Returns a string to use to update the GPU particles update shader
  91899. * @returns a string containng the defines string
  91900. */
  91901. getEffectDefines(): string;
  91902. /**
  91903. * Returns the string "ConeParticleEmitter"
  91904. * @returns a string containing the class name
  91905. */
  91906. getClassName(): string;
  91907. /**
  91908. * Serializes the particle system to a JSON object.
  91909. * @returns the JSON object
  91910. */
  91911. serialize(): any;
  91912. /**
  91913. * Parse properties from a JSON object
  91914. * @param serializationObject defines the JSON object
  91915. */
  91916. parse(serializationObject: any): void;
  91917. }
  91918. }
  91919. declare module BABYLON {
  91920. /**
  91921. * Particle emitter emitting particles from the inside of a cylinder.
  91922. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  91923. */
  91924. export class CylinderParticleEmitter implements IParticleEmitterType {
  91925. /**
  91926. * The radius of the emission cylinder.
  91927. */
  91928. radius: number;
  91929. /**
  91930. * The height of the emission cylinder.
  91931. */
  91932. height: number;
  91933. /**
  91934. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91935. */
  91936. radiusRange: number;
  91937. /**
  91938. * How much to randomize the particle direction [0-1].
  91939. */
  91940. directionRandomizer: number;
  91941. /**
  91942. * Creates a new instance CylinderParticleEmitter
  91943. * @param radius the radius of the emission cylinder (1 by default)
  91944. * @param height the height of the emission cylinder (1 by default)
  91945. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91946. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91947. */
  91948. constructor(
  91949. /**
  91950. * The radius of the emission cylinder.
  91951. */
  91952. radius?: number,
  91953. /**
  91954. * The height of the emission cylinder.
  91955. */
  91956. height?: number,
  91957. /**
  91958. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91959. */
  91960. radiusRange?: number,
  91961. /**
  91962. * How much to randomize the particle direction [0-1].
  91963. */
  91964. directionRandomizer?: number);
  91965. /**
  91966. * Called by the particle System when the direction is computed for the created particle.
  91967. * @param worldMatrix is the world matrix of the particle system
  91968. * @param directionToUpdate is the direction vector to update with the result
  91969. * @param particle is the particle we are computed the direction for
  91970. * @param isLocal defines if the direction should be set in local space
  91971. */
  91972. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91973. /**
  91974. * Called by the particle System when the position is computed for the created particle.
  91975. * @param worldMatrix is the world matrix of the particle system
  91976. * @param positionToUpdate is the position vector to update with the result
  91977. * @param particle is the particle we are computed the position for
  91978. * @param isLocal defines if the position should be set in local space
  91979. */
  91980. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91981. /**
  91982. * Clones the current emitter and returns a copy of it
  91983. * @returns the new emitter
  91984. */
  91985. clone(): CylinderParticleEmitter;
  91986. /**
  91987. * Called by the GPUParticleSystem to setup the update shader
  91988. * @param effect defines the update shader
  91989. */
  91990. applyToShader(effect: Effect): void;
  91991. /**
  91992. * Returns a string to use to update the GPU particles update shader
  91993. * @returns a string containng the defines string
  91994. */
  91995. getEffectDefines(): string;
  91996. /**
  91997. * Returns the string "CylinderParticleEmitter"
  91998. * @returns a string containing the class name
  91999. */
  92000. getClassName(): string;
  92001. /**
  92002. * Serializes the particle system to a JSON object.
  92003. * @returns the JSON object
  92004. */
  92005. serialize(): any;
  92006. /**
  92007. * Parse properties from a JSON object
  92008. * @param serializationObject defines the JSON object
  92009. */
  92010. parse(serializationObject: any): void;
  92011. }
  92012. /**
  92013. * Particle emitter emitting particles from the inside of a cylinder.
  92014. * It emits the particles randomly between two vectors.
  92015. */
  92016. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  92017. /**
  92018. * The min limit of the emission direction.
  92019. */
  92020. direction1: Vector3;
  92021. /**
  92022. * The max limit of the emission direction.
  92023. */
  92024. direction2: Vector3;
  92025. /**
  92026. * Creates a new instance CylinderDirectedParticleEmitter
  92027. * @param radius the radius of the emission cylinder (1 by default)
  92028. * @param height the height of the emission cylinder (1 by default)
  92029. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92030. * @param direction1 the min limit of the emission direction (up vector by default)
  92031. * @param direction2 the max limit of the emission direction (up vector by default)
  92032. */
  92033. constructor(radius?: number, height?: number, radiusRange?: number,
  92034. /**
  92035. * The min limit of the emission direction.
  92036. */
  92037. direction1?: Vector3,
  92038. /**
  92039. * The max limit of the emission direction.
  92040. */
  92041. direction2?: Vector3);
  92042. /**
  92043. * Called by the particle System when the direction is computed for the created particle.
  92044. * @param worldMatrix is the world matrix of the particle system
  92045. * @param directionToUpdate is the direction vector to update with the result
  92046. * @param particle is the particle we are computed the direction for
  92047. */
  92048. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  92049. /**
  92050. * Clones the current emitter and returns a copy of it
  92051. * @returns the new emitter
  92052. */
  92053. clone(): CylinderDirectedParticleEmitter;
  92054. /**
  92055. * Called by the GPUParticleSystem to setup the update shader
  92056. * @param effect defines the update shader
  92057. */
  92058. applyToShader(effect: Effect): void;
  92059. /**
  92060. * Returns a string to use to update the GPU particles update shader
  92061. * @returns a string containng the defines string
  92062. */
  92063. getEffectDefines(): string;
  92064. /**
  92065. * Returns the string "CylinderDirectedParticleEmitter"
  92066. * @returns a string containing the class name
  92067. */
  92068. getClassName(): string;
  92069. /**
  92070. * Serializes the particle system to a JSON object.
  92071. * @returns the JSON object
  92072. */
  92073. serialize(): any;
  92074. /**
  92075. * Parse properties from a JSON object
  92076. * @param serializationObject defines the JSON object
  92077. */
  92078. parse(serializationObject: any): void;
  92079. }
  92080. }
  92081. declare module BABYLON {
  92082. /**
  92083. * Particle emitter emitting particles from the inside of a hemisphere.
  92084. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  92085. */
  92086. export class HemisphericParticleEmitter implements IParticleEmitterType {
  92087. /**
  92088. * The radius of the emission hemisphere.
  92089. */
  92090. radius: number;
  92091. /**
  92092. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92093. */
  92094. radiusRange: number;
  92095. /**
  92096. * How much to randomize the particle direction [0-1].
  92097. */
  92098. directionRandomizer: number;
  92099. /**
  92100. * Creates a new instance HemisphericParticleEmitter
  92101. * @param radius the radius of the emission hemisphere (1 by default)
  92102. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92103. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92104. */
  92105. constructor(
  92106. /**
  92107. * The radius of the emission hemisphere.
  92108. */
  92109. radius?: number,
  92110. /**
  92111. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92112. */
  92113. radiusRange?: number,
  92114. /**
  92115. * How much to randomize the particle direction [0-1].
  92116. */
  92117. directionRandomizer?: number);
  92118. /**
  92119. * Called by the particle System when the direction is computed for the created particle.
  92120. * @param worldMatrix is the world matrix of the particle system
  92121. * @param directionToUpdate is the direction vector to update with the result
  92122. * @param particle is the particle we are computed the direction for
  92123. * @param isLocal defines if the direction should be set in local space
  92124. */
  92125. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92126. /**
  92127. * Called by the particle System when the position is computed for the created particle.
  92128. * @param worldMatrix is the world matrix of the particle system
  92129. * @param positionToUpdate is the position vector to update with the result
  92130. * @param particle is the particle we are computed the position for
  92131. * @param isLocal defines if the position should be set in local space
  92132. */
  92133. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92134. /**
  92135. * Clones the current emitter and returns a copy of it
  92136. * @returns the new emitter
  92137. */
  92138. clone(): HemisphericParticleEmitter;
  92139. /**
  92140. * Called by the GPUParticleSystem to setup the update shader
  92141. * @param effect defines the update shader
  92142. */
  92143. applyToShader(effect: Effect): void;
  92144. /**
  92145. * Returns a string to use to update the GPU particles update shader
  92146. * @returns a string containng the defines string
  92147. */
  92148. getEffectDefines(): string;
  92149. /**
  92150. * Returns the string "HemisphericParticleEmitter"
  92151. * @returns a string containing the class name
  92152. */
  92153. getClassName(): string;
  92154. /**
  92155. * Serializes the particle system to a JSON object.
  92156. * @returns the JSON object
  92157. */
  92158. serialize(): any;
  92159. /**
  92160. * Parse properties from a JSON object
  92161. * @param serializationObject defines the JSON object
  92162. */
  92163. parse(serializationObject: any): void;
  92164. }
  92165. }
  92166. declare module BABYLON {
  92167. /**
  92168. * Particle emitter emitting particles from a point.
  92169. * It emits the particles randomly between 2 given directions.
  92170. */
  92171. export class PointParticleEmitter implements IParticleEmitterType {
  92172. /**
  92173. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92174. */
  92175. direction1: Vector3;
  92176. /**
  92177. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92178. */
  92179. direction2: Vector3;
  92180. /**
  92181. * Creates a new instance PointParticleEmitter
  92182. */
  92183. constructor();
  92184. /**
  92185. * Called by the particle System when the direction is computed for the created particle.
  92186. * @param worldMatrix is the world matrix of the particle system
  92187. * @param directionToUpdate is the direction vector to update with the result
  92188. * @param particle is the particle we are computed the direction for
  92189. * @param isLocal defines if the direction should be set in local space
  92190. */
  92191. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92192. /**
  92193. * Called by the particle System when the position is computed for the created particle.
  92194. * @param worldMatrix is the world matrix of the particle system
  92195. * @param positionToUpdate is the position vector to update with the result
  92196. * @param particle is the particle we are computed the position for
  92197. * @param isLocal defines if the position should be set in local space
  92198. */
  92199. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92200. /**
  92201. * Clones the current emitter and returns a copy of it
  92202. * @returns the new emitter
  92203. */
  92204. clone(): PointParticleEmitter;
  92205. /**
  92206. * Called by the GPUParticleSystem to setup the update shader
  92207. * @param effect defines the update shader
  92208. */
  92209. applyToShader(effect: Effect): void;
  92210. /**
  92211. * Returns a string to use to update the GPU particles update shader
  92212. * @returns a string containng the defines string
  92213. */
  92214. getEffectDefines(): string;
  92215. /**
  92216. * Returns the string "PointParticleEmitter"
  92217. * @returns a string containing the class name
  92218. */
  92219. getClassName(): string;
  92220. /**
  92221. * Serializes the particle system to a JSON object.
  92222. * @returns the JSON object
  92223. */
  92224. serialize(): any;
  92225. /**
  92226. * Parse properties from a JSON object
  92227. * @param serializationObject defines the JSON object
  92228. */
  92229. parse(serializationObject: any): void;
  92230. }
  92231. }
  92232. declare module BABYLON {
  92233. /**
  92234. * Particle emitter emitting particles from the inside of a sphere.
  92235. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  92236. */
  92237. export class SphereParticleEmitter implements IParticleEmitterType {
  92238. /**
  92239. * The radius of the emission sphere.
  92240. */
  92241. radius: number;
  92242. /**
  92243. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92244. */
  92245. radiusRange: number;
  92246. /**
  92247. * How much to randomize the particle direction [0-1].
  92248. */
  92249. directionRandomizer: number;
  92250. /**
  92251. * Creates a new instance SphereParticleEmitter
  92252. * @param radius the radius of the emission sphere (1 by default)
  92253. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92254. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92255. */
  92256. constructor(
  92257. /**
  92258. * The radius of the emission sphere.
  92259. */
  92260. radius?: number,
  92261. /**
  92262. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92263. */
  92264. radiusRange?: number,
  92265. /**
  92266. * How much to randomize the particle direction [0-1].
  92267. */
  92268. directionRandomizer?: number);
  92269. /**
  92270. * Called by the particle System when the direction is computed for the created particle.
  92271. * @param worldMatrix is the world matrix of the particle system
  92272. * @param directionToUpdate is the direction vector to update with the result
  92273. * @param particle is the particle we are computed the direction for
  92274. * @param isLocal defines if the direction should be set in local space
  92275. */
  92276. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92277. /**
  92278. * Called by the particle System when the position is computed for the created particle.
  92279. * @param worldMatrix is the world matrix of the particle system
  92280. * @param positionToUpdate is the position vector to update with the result
  92281. * @param particle is the particle we are computed the position for
  92282. * @param isLocal defines if the position should be set in local space
  92283. */
  92284. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92285. /**
  92286. * Clones the current emitter and returns a copy of it
  92287. * @returns the new emitter
  92288. */
  92289. clone(): SphereParticleEmitter;
  92290. /**
  92291. * Called by the GPUParticleSystem to setup the update shader
  92292. * @param effect defines the update shader
  92293. */
  92294. applyToShader(effect: Effect): void;
  92295. /**
  92296. * Returns a string to use to update the GPU particles update shader
  92297. * @returns a string containng the defines string
  92298. */
  92299. getEffectDefines(): string;
  92300. /**
  92301. * Returns the string "SphereParticleEmitter"
  92302. * @returns a string containing the class name
  92303. */
  92304. getClassName(): string;
  92305. /**
  92306. * Serializes the particle system to a JSON object.
  92307. * @returns the JSON object
  92308. */
  92309. serialize(): any;
  92310. /**
  92311. * Parse properties from a JSON object
  92312. * @param serializationObject defines the JSON object
  92313. */
  92314. parse(serializationObject: any): void;
  92315. }
  92316. /**
  92317. * Particle emitter emitting particles from the inside of a sphere.
  92318. * It emits the particles randomly between two vectors.
  92319. */
  92320. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  92321. /**
  92322. * The min limit of the emission direction.
  92323. */
  92324. direction1: Vector3;
  92325. /**
  92326. * The max limit of the emission direction.
  92327. */
  92328. direction2: Vector3;
  92329. /**
  92330. * Creates a new instance SphereDirectedParticleEmitter
  92331. * @param radius the radius of the emission sphere (1 by default)
  92332. * @param direction1 the min limit of the emission direction (up vector by default)
  92333. * @param direction2 the max limit of the emission direction (up vector by default)
  92334. */
  92335. constructor(radius?: number,
  92336. /**
  92337. * The min limit of the emission direction.
  92338. */
  92339. direction1?: Vector3,
  92340. /**
  92341. * The max limit of the emission direction.
  92342. */
  92343. direction2?: Vector3);
  92344. /**
  92345. * Called by the particle System when the direction is computed for the created particle.
  92346. * @param worldMatrix is the world matrix of the particle system
  92347. * @param directionToUpdate is the direction vector to update with the result
  92348. * @param particle is the particle we are computed the direction for
  92349. */
  92350. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  92351. /**
  92352. * Clones the current emitter and returns a copy of it
  92353. * @returns the new emitter
  92354. */
  92355. clone(): SphereDirectedParticleEmitter;
  92356. /**
  92357. * Called by the GPUParticleSystem to setup the update shader
  92358. * @param effect defines the update shader
  92359. */
  92360. applyToShader(effect: Effect): void;
  92361. /**
  92362. * Returns a string to use to update the GPU particles update shader
  92363. * @returns a string containng the defines string
  92364. */
  92365. getEffectDefines(): string;
  92366. /**
  92367. * Returns the string "SphereDirectedParticleEmitter"
  92368. * @returns a string containing the class name
  92369. */
  92370. getClassName(): string;
  92371. /**
  92372. * Serializes the particle system to a JSON object.
  92373. * @returns the JSON object
  92374. */
  92375. serialize(): any;
  92376. /**
  92377. * Parse properties from a JSON object
  92378. * @param serializationObject defines the JSON object
  92379. */
  92380. parse(serializationObject: any): void;
  92381. }
  92382. }
  92383. declare module BABYLON {
  92384. /**
  92385. * Particle emitter emitting particles from a custom list of positions.
  92386. */
  92387. export class CustomParticleEmitter implements IParticleEmitterType {
  92388. /**
  92389. * Gets or sets the position generator that will create the inital position of each particle.
  92390. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  92391. */
  92392. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  92393. /**
  92394. * Gets or sets the destination generator that will create the final destination of each particle.
  92395. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  92396. */
  92397. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  92398. /**
  92399. * Creates a new instance CustomParticleEmitter
  92400. */
  92401. constructor();
  92402. /**
  92403. * Called by the particle System when the direction is computed for the created particle.
  92404. * @param worldMatrix is the world matrix of the particle system
  92405. * @param directionToUpdate is the direction vector to update with the result
  92406. * @param particle is the particle we are computed the direction for
  92407. * @param isLocal defines if the direction should be set in local space
  92408. */
  92409. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92410. /**
  92411. * Called by the particle System when the position is computed for the created particle.
  92412. * @param worldMatrix is the world matrix of the particle system
  92413. * @param positionToUpdate is the position vector to update with the result
  92414. * @param particle is the particle we are computed the position for
  92415. * @param isLocal defines if the position should be set in local space
  92416. */
  92417. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92418. /**
  92419. * Clones the current emitter and returns a copy of it
  92420. * @returns the new emitter
  92421. */
  92422. clone(): CustomParticleEmitter;
  92423. /**
  92424. * Called by the GPUParticleSystem to setup the update shader
  92425. * @param effect defines the update shader
  92426. */
  92427. applyToShader(effect: Effect): void;
  92428. /**
  92429. * Returns a string to use to update the GPU particles update shader
  92430. * @returns a string containng the defines string
  92431. */
  92432. getEffectDefines(): string;
  92433. /**
  92434. * Returns the string "PointParticleEmitter"
  92435. * @returns a string containing the class name
  92436. */
  92437. getClassName(): string;
  92438. /**
  92439. * Serializes the particle system to a JSON object.
  92440. * @returns the JSON object
  92441. */
  92442. serialize(): any;
  92443. /**
  92444. * Parse properties from a JSON object
  92445. * @param serializationObject defines the JSON object
  92446. */
  92447. parse(serializationObject: any): void;
  92448. }
  92449. }
  92450. declare module BABYLON {
  92451. /**
  92452. * Particle emitter emitting particles from the inside of a box.
  92453. * It emits the particles randomly between 2 given directions.
  92454. */
  92455. export class MeshParticleEmitter implements IParticleEmitterType {
  92456. private _indices;
  92457. private _positions;
  92458. private _normals;
  92459. private _storedNormal;
  92460. private _mesh;
  92461. /**
  92462. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92463. */
  92464. direction1: Vector3;
  92465. /**
  92466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92467. */
  92468. direction2: Vector3;
  92469. /**
  92470. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  92471. */
  92472. useMeshNormalsForDirection: boolean;
  92473. /** Defines the mesh to use as source */
  92474. get mesh(): Nullable<AbstractMesh>;
  92475. set mesh(value: Nullable<AbstractMesh>);
  92476. /**
  92477. * Creates a new instance MeshParticleEmitter
  92478. * @param mesh defines the mesh to use as source
  92479. */
  92480. constructor(mesh?: Nullable<AbstractMesh>);
  92481. /**
  92482. * Called by the particle System when the direction is computed for the created particle.
  92483. * @param worldMatrix is the world matrix of the particle system
  92484. * @param directionToUpdate is the direction vector to update with the result
  92485. * @param particle is the particle we are computed the direction for
  92486. * @param isLocal defines if the direction should be set in local space
  92487. */
  92488. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92489. /**
  92490. * Called by the particle System when the position is computed for the created particle.
  92491. * @param worldMatrix is the world matrix of the particle system
  92492. * @param positionToUpdate is the position vector to update with the result
  92493. * @param particle is the particle we are computed the position for
  92494. * @param isLocal defines if the position should be set in local space
  92495. */
  92496. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92497. /**
  92498. * Clones the current emitter and returns a copy of it
  92499. * @returns the new emitter
  92500. */
  92501. clone(): MeshParticleEmitter;
  92502. /**
  92503. * Called by the GPUParticleSystem to setup the update shader
  92504. * @param effect defines the update shader
  92505. */
  92506. applyToShader(effect: Effect): void;
  92507. /**
  92508. * Returns a string to use to update the GPU particles update shader
  92509. * @returns a string containng the defines string
  92510. */
  92511. getEffectDefines(): string;
  92512. /**
  92513. * Returns the string "BoxParticleEmitter"
  92514. * @returns a string containing the class name
  92515. */
  92516. getClassName(): string;
  92517. /**
  92518. * Serializes the particle system to a JSON object.
  92519. * @returns the JSON object
  92520. */
  92521. serialize(): any;
  92522. /**
  92523. * Parse properties from a JSON object
  92524. * @param serializationObject defines the JSON object
  92525. * @param scene defines the hosting scene
  92526. */
  92527. parse(serializationObject: any, scene: Scene): void;
  92528. }
  92529. }
  92530. declare module BABYLON {
  92531. /**
  92532. * Interface representing a particle system in Babylon.js.
  92533. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  92534. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  92535. */
  92536. export interface IParticleSystem {
  92537. /**
  92538. * List of animations used by the particle system.
  92539. */
  92540. animations: Animation[];
  92541. /**
  92542. * The id of the Particle system.
  92543. */
  92544. id: string;
  92545. /**
  92546. * The name of the Particle system.
  92547. */
  92548. name: string;
  92549. /**
  92550. * The emitter represents the Mesh or position we are attaching the particle system to.
  92551. */
  92552. emitter: Nullable<AbstractMesh | Vector3>;
  92553. /**
  92554. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  92555. */
  92556. isBillboardBased: boolean;
  92557. /**
  92558. * The rendering group used by the Particle system to chose when to render.
  92559. */
  92560. renderingGroupId: number;
  92561. /**
  92562. * The layer mask we are rendering the particles through.
  92563. */
  92564. layerMask: number;
  92565. /**
  92566. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  92567. */
  92568. updateSpeed: number;
  92569. /**
  92570. * The amount of time the particle system is running (depends of the overall update speed).
  92571. */
  92572. targetStopDuration: number;
  92573. /**
  92574. * The texture used to render each particle. (this can be a spritesheet)
  92575. */
  92576. particleTexture: Nullable<Texture>;
  92577. /**
  92578. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  92579. */
  92580. blendMode: number;
  92581. /**
  92582. * Minimum life time of emitting particles.
  92583. */
  92584. minLifeTime: number;
  92585. /**
  92586. * Maximum life time of emitting particles.
  92587. */
  92588. maxLifeTime: number;
  92589. /**
  92590. * Minimum Size of emitting particles.
  92591. */
  92592. minSize: number;
  92593. /**
  92594. * Maximum Size of emitting particles.
  92595. */
  92596. maxSize: number;
  92597. /**
  92598. * Minimum scale of emitting particles on X axis.
  92599. */
  92600. minScaleX: number;
  92601. /**
  92602. * Maximum scale of emitting particles on X axis.
  92603. */
  92604. maxScaleX: number;
  92605. /**
  92606. * Minimum scale of emitting particles on Y axis.
  92607. */
  92608. minScaleY: number;
  92609. /**
  92610. * Maximum scale of emitting particles on Y axis.
  92611. */
  92612. maxScaleY: number;
  92613. /**
  92614. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  92615. */
  92616. color1: Color4;
  92617. /**
  92618. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  92619. */
  92620. color2: Color4;
  92621. /**
  92622. * Color the particle will have at the end of its lifetime.
  92623. */
  92624. colorDead: Color4;
  92625. /**
  92626. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  92627. */
  92628. emitRate: number;
  92629. /**
  92630. * You can use gravity if you want to give an orientation to your particles.
  92631. */
  92632. gravity: Vector3;
  92633. /**
  92634. * Minimum power of emitting particles.
  92635. */
  92636. minEmitPower: number;
  92637. /**
  92638. * Maximum power of emitting particles.
  92639. */
  92640. maxEmitPower: number;
  92641. /**
  92642. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  92643. */
  92644. minAngularSpeed: number;
  92645. /**
  92646. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  92647. */
  92648. maxAngularSpeed: number;
  92649. /**
  92650. * Gets or sets the minimal initial rotation in radians.
  92651. */
  92652. minInitialRotation: number;
  92653. /**
  92654. * Gets or sets the maximal initial rotation in radians.
  92655. */
  92656. maxInitialRotation: number;
  92657. /**
  92658. * The particle emitter type defines the emitter used by the particle system.
  92659. * It can be for example box, sphere, or cone...
  92660. */
  92661. particleEmitterType: Nullable<IParticleEmitterType>;
  92662. /**
  92663. * Defines the delay in milliseconds before starting the system (0 by default)
  92664. */
  92665. startDelay: number;
  92666. /**
  92667. * 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
  92668. */
  92669. preWarmCycles: number;
  92670. /**
  92671. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  92672. */
  92673. preWarmStepOffset: number;
  92674. /**
  92675. * 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)
  92676. */
  92677. spriteCellChangeSpeed: number;
  92678. /**
  92679. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  92680. */
  92681. startSpriteCellID: number;
  92682. /**
  92683. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  92684. */
  92685. endSpriteCellID: number;
  92686. /**
  92687. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  92688. */
  92689. spriteCellWidth: number;
  92690. /**
  92691. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  92692. */
  92693. spriteCellHeight: number;
  92694. /**
  92695. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  92696. */
  92697. spriteRandomStartCell: boolean;
  92698. /**
  92699. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  92700. */
  92701. isAnimationSheetEnabled: boolean;
  92702. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  92703. translationPivot: Vector2;
  92704. /**
  92705. * Gets or sets a texture used to add random noise to particle positions
  92706. */
  92707. noiseTexture: Nullable<BaseTexture>;
  92708. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  92709. noiseStrength: Vector3;
  92710. /**
  92711. * Gets or sets the billboard mode to use when isBillboardBased = true.
  92712. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  92713. */
  92714. billboardMode: number;
  92715. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  92716. limitVelocityDamping: number;
  92717. /**
  92718. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  92719. */
  92720. beginAnimationOnStart: boolean;
  92721. /**
  92722. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  92723. */
  92724. beginAnimationFrom: number;
  92725. /**
  92726. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  92727. */
  92728. beginAnimationTo: number;
  92729. /**
  92730. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  92731. */
  92732. beginAnimationLoop: boolean;
  92733. /**
  92734. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  92735. */
  92736. disposeOnStop: boolean;
  92737. /**
  92738. * Specifies if the particles are updated in emitter local space or world space
  92739. */
  92740. isLocal: boolean;
  92741. /** Snippet ID if the particle system was created from the snippet server */
  92742. snippetId: string;
  92743. /**
  92744. * Gets the maximum number of particles active at the same time.
  92745. * @returns The max number of active particles.
  92746. */
  92747. getCapacity(): number;
  92748. /**
  92749. * Gets the number of particles active at the same time.
  92750. * @returns The number of active particles.
  92751. */
  92752. getActiveCount(): number;
  92753. /**
  92754. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92755. * @returns True if it has been started, otherwise false.
  92756. */
  92757. isStarted(): boolean;
  92758. /**
  92759. * Animates the particle system for this frame.
  92760. */
  92761. animate(): void;
  92762. /**
  92763. * Renders the particle system in its current state.
  92764. * @returns the current number of particles
  92765. */
  92766. render(): number;
  92767. /**
  92768. * Dispose the particle system and frees its associated resources.
  92769. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92770. */
  92771. dispose(disposeTexture?: boolean): void;
  92772. /**
  92773. * An event triggered when the system is disposed
  92774. */
  92775. onDisposeObservable: Observable<IParticleSystem>;
  92776. /**
  92777. * Clones the particle system.
  92778. * @param name The name of the cloned object
  92779. * @param newEmitter The new emitter to use
  92780. * @returns the cloned particle system
  92781. */
  92782. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  92783. /**
  92784. * Serializes the particle system to a JSON object
  92785. * @param serializeTexture defines if the texture must be serialized as well
  92786. * @returns the JSON object
  92787. */
  92788. serialize(serializeTexture: boolean): any;
  92789. /**
  92790. * Rebuild the particle system
  92791. */
  92792. rebuild(): void;
  92793. /** Force the system to rebuild all gradients that need to be resync */
  92794. forceRefreshGradients(): void;
  92795. /**
  92796. * Starts the particle system and begins to emit
  92797. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  92798. */
  92799. start(delay?: number): void;
  92800. /**
  92801. * Stops the particle system.
  92802. */
  92803. stop(): void;
  92804. /**
  92805. * Remove all active particles
  92806. */
  92807. reset(): void;
  92808. /**
  92809. * Gets a boolean indicating that the system is stopping
  92810. * @returns true if the system is currently stopping
  92811. */
  92812. isStopping(): boolean;
  92813. /**
  92814. * Is this system ready to be used/rendered
  92815. * @return true if the system is ready
  92816. */
  92817. isReady(): boolean;
  92818. /**
  92819. * Returns the string "ParticleSystem"
  92820. * @returns a string containing the class name
  92821. */
  92822. getClassName(): string;
  92823. /**
  92824. * Gets the custom effect used to render the particles
  92825. * @param blendMode Blend mode for which the effect should be retrieved
  92826. * @returns The effect
  92827. */
  92828. getCustomEffect(blendMode: number): Nullable<Effect>;
  92829. /**
  92830. * Sets the custom effect used to render the particles
  92831. * @param effect The effect to set
  92832. * @param blendMode Blend mode for which the effect should be set
  92833. */
  92834. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  92835. /**
  92836. * Fill the defines array according to the current settings of the particle system
  92837. * @param defines Array to be updated
  92838. * @param blendMode blend mode to take into account when updating the array
  92839. */
  92840. fillDefines(defines: Array<string>, blendMode: number): void;
  92841. /**
  92842. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92843. * @param uniforms Uniforms array to fill
  92844. * @param attributes Attributes array to fill
  92845. * @param samplers Samplers array to fill
  92846. */
  92847. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92848. /**
  92849. * Observable that will be called just before the particles are drawn
  92850. */
  92851. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  92852. /**
  92853. * Gets the name of the particle vertex shader
  92854. */
  92855. vertexShaderName: string;
  92856. /**
  92857. * Adds a new color gradient
  92858. * @param gradient defines the gradient to use (between 0 and 1)
  92859. * @param color1 defines the color to affect to the specified gradient
  92860. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92861. * @returns the current particle system
  92862. */
  92863. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92864. /**
  92865. * Remove a specific color gradient
  92866. * @param gradient defines the gradient to remove
  92867. * @returns the current particle system
  92868. */
  92869. removeColorGradient(gradient: number): IParticleSystem;
  92870. /**
  92871. * Adds a new size gradient
  92872. * @param gradient defines the gradient to use (between 0 and 1)
  92873. * @param factor defines the size factor to affect to the specified gradient
  92874. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92875. * @returns the current particle system
  92876. */
  92877. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92878. /**
  92879. * Remove a specific size gradient
  92880. * @param gradient defines the gradient to remove
  92881. * @returns the current particle system
  92882. */
  92883. removeSizeGradient(gradient: number): IParticleSystem;
  92884. /**
  92885. * Gets the current list of color gradients.
  92886. * You must use addColorGradient and removeColorGradient to udpate this list
  92887. * @returns the list of color gradients
  92888. */
  92889. getColorGradients(): Nullable<Array<ColorGradient>>;
  92890. /**
  92891. * Gets the current list of size gradients.
  92892. * You must use addSizeGradient and removeSizeGradient to udpate this list
  92893. * @returns the list of size gradients
  92894. */
  92895. getSizeGradients(): Nullable<Array<FactorGradient>>;
  92896. /**
  92897. * Gets the current list of angular speed gradients.
  92898. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  92899. * @returns the list of angular speed gradients
  92900. */
  92901. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  92902. /**
  92903. * Adds a new angular speed gradient
  92904. * @param gradient defines the gradient to use (between 0 and 1)
  92905. * @param factor defines the angular speed to affect to the specified gradient
  92906. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92907. * @returns the current particle system
  92908. */
  92909. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92910. /**
  92911. * Remove a specific angular speed gradient
  92912. * @param gradient defines the gradient to remove
  92913. * @returns the current particle system
  92914. */
  92915. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92916. /**
  92917. * Gets the current list of velocity gradients.
  92918. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  92919. * @returns the list of velocity gradients
  92920. */
  92921. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  92922. /**
  92923. * Adds a new velocity gradient
  92924. * @param gradient defines the gradient to use (between 0 and 1)
  92925. * @param factor defines the velocity to affect to the specified gradient
  92926. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92927. * @returns the current particle system
  92928. */
  92929. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92930. /**
  92931. * Remove a specific velocity gradient
  92932. * @param gradient defines the gradient to remove
  92933. * @returns the current particle system
  92934. */
  92935. removeVelocityGradient(gradient: number): IParticleSystem;
  92936. /**
  92937. * Gets the current list of limit velocity gradients.
  92938. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92939. * @returns the list of limit velocity gradients
  92940. */
  92941. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  92942. /**
  92943. * Adds a new limit velocity gradient
  92944. * @param gradient defines the gradient to use (between 0 and 1)
  92945. * @param factor defines the limit velocity to affect to the specified gradient
  92946. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92947. * @returns the current particle system
  92948. */
  92949. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92950. /**
  92951. * Remove a specific limit velocity gradient
  92952. * @param gradient defines the gradient to remove
  92953. * @returns the current particle system
  92954. */
  92955. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92956. /**
  92957. * Adds a new drag gradient
  92958. * @param gradient defines the gradient to use (between 0 and 1)
  92959. * @param factor defines the drag to affect to the specified gradient
  92960. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92961. * @returns the current particle system
  92962. */
  92963. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92964. /**
  92965. * Remove a specific drag gradient
  92966. * @param gradient defines the gradient to remove
  92967. * @returns the current particle system
  92968. */
  92969. removeDragGradient(gradient: number): IParticleSystem;
  92970. /**
  92971. * Gets the current list of drag gradients.
  92972. * You must use addDragGradient and removeDragGradient to udpate this list
  92973. * @returns the list of drag gradients
  92974. */
  92975. getDragGradients(): Nullable<Array<FactorGradient>>;
  92976. /**
  92977. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92978. * @param gradient defines the gradient to use (between 0 and 1)
  92979. * @param factor defines the emit rate to affect to the specified gradient
  92980. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92981. * @returns the current particle system
  92982. */
  92983. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92984. /**
  92985. * Remove a specific emit rate gradient
  92986. * @param gradient defines the gradient to remove
  92987. * @returns the current particle system
  92988. */
  92989. removeEmitRateGradient(gradient: number): IParticleSystem;
  92990. /**
  92991. * Gets the current list of emit rate gradients.
  92992. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  92993. * @returns the list of emit rate gradients
  92994. */
  92995. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  92996. /**
  92997. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92998. * @param gradient defines the gradient to use (between 0 and 1)
  92999. * @param factor defines the start size to affect to the specified gradient
  93000. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93001. * @returns the current particle system
  93002. */
  93003. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93004. /**
  93005. * Remove a specific start size gradient
  93006. * @param gradient defines the gradient to remove
  93007. * @returns the current particle system
  93008. */
  93009. removeStartSizeGradient(gradient: number): IParticleSystem;
  93010. /**
  93011. * Gets the current list of start size gradients.
  93012. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  93013. * @returns the list of start size gradients
  93014. */
  93015. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  93016. /**
  93017. * Adds a new life time gradient
  93018. * @param gradient defines the gradient to use (between 0 and 1)
  93019. * @param factor defines the life time factor to affect to the specified gradient
  93020. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93021. * @returns the current particle system
  93022. */
  93023. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93024. /**
  93025. * Remove a specific life time gradient
  93026. * @param gradient defines the gradient to remove
  93027. * @returns the current particle system
  93028. */
  93029. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93030. /**
  93031. * Gets the current list of life time gradients.
  93032. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  93033. * @returns the list of life time gradients
  93034. */
  93035. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  93036. /**
  93037. * Gets the current list of color gradients.
  93038. * You must use addColorGradient and removeColorGradient to udpate this list
  93039. * @returns the list of color gradients
  93040. */
  93041. getColorGradients(): Nullable<Array<ColorGradient>>;
  93042. /**
  93043. * Adds a new ramp gradient used to remap particle colors
  93044. * @param gradient defines the gradient to use (between 0 and 1)
  93045. * @param color defines the color to affect to the specified gradient
  93046. * @returns the current particle system
  93047. */
  93048. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  93049. /**
  93050. * Gets the current list of ramp gradients.
  93051. * You must use addRampGradient and removeRampGradient to udpate this list
  93052. * @returns the list of ramp gradients
  93053. */
  93054. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93055. /** Gets or sets a boolean indicating that ramp gradients must be used
  93056. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  93057. */
  93058. useRampGradients: boolean;
  93059. /**
  93060. * Adds a new color remap gradient
  93061. * @param gradient defines the gradient to use (between 0 and 1)
  93062. * @param min defines the color remap minimal range
  93063. * @param max defines the color remap maximal range
  93064. * @returns the current particle system
  93065. */
  93066. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93067. /**
  93068. * Gets the current list of color remap gradients.
  93069. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  93070. * @returns the list of color remap gradients
  93071. */
  93072. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  93073. /**
  93074. * Adds a new alpha remap gradient
  93075. * @param gradient defines the gradient to use (between 0 and 1)
  93076. * @param min defines the alpha remap minimal range
  93077. * @param max defines the alpha remap maximal range
  93078. * @returns the current particle system
  93079. */
  93080. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93081. /**
  93082. * Gets the current list of alpha remap gradients.
  93083. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  93084. * @returns the list of alpha remap gradients
  93085. */
  93086. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  93087. /**
  93088. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  93089. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93090. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93091. * @returns the emitter
  93092. */
  93093. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  93094. /**
  93095. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  93096. * @param radius The radius of the hemisphere to emit from
  93097. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93098. * @returns the emitter
  93099. */
  93100. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  93101. /**
  93102. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  93103. * @param radius The radius of the sphere to emit from
  93104. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93105. * @returns the emitter
  93106. */
  93107. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  93108. /**
  93109. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  93110. * @param radius The radius of the sphere to emit from
  93111. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  93112. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  93113. * @returns the emitter
  93114. */
  93115. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93116. /**
  93117. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  93118. * @param radius The radius of the emission cylinder
  93119. * @param height The height of the emission cylinder
  93120. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  93121. * @param directionRandomizer How much to randomize the particle direction [0-1]
  93122. * @returns the emitter
  93123. */
  93124. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  93125. /**
  93126. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  93127. * @param radius The radius of the cylinder to emit from
  93128. * @param height The height of the emission cylinder
  93129. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93130. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  93131. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  93132. * @returns the emitter
  93133. */
  93134. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93135. /**
  93136. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  93137. * @param radius The radius of the cone to emit from
  93138. * @param angle The base angle of the cone
  93139. * @returns the emitter
  93140. */
  93141. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  93142. /**
  93143. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  93144. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93145. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93146. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93147. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93148. * @returns the emitter
  93149. */
  93150. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  93151. /**
  93152. * Get hosting scene
  93153. * @returns the scene
  93154. */
  93155. getScene(): Scene;
  93156. }
  93157. }
  93158. declare module BABYLON {
  93159. /**
  93160. * 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.
  93161. * @see https://doc.babylonjs.com/how_to/transformnode
  93162. */
  93163. export class TransformNode extends Node {
  93164. /**
  93165. * Object will not rotate to face the camera
  93166. */
  93167. static BILLBOARDMODE_NONE: number;
  93168. /**
  93169. * Object will rotate to face the camera but only on the x axis
  93170. */
  93171. static BILLBOARDMODE_X: number;
  93172. /**
  93173. * Object will rotate to face the camera but only on the y axis
  93174. */
  93175. static BILLBOARDMODE_Y: number;
  93176. /**
  93177. * Object will rotate to face the camera but only on the z axis
  93178. */
  93179. static BILLBOARDMODE_Z: number;
  93180. /**
  93181. * Object will rotate to face the camera
  93182. */
  93183. static BILLBOARDMODE_ALL: number;
  93184. /**
  93185. * Object will rotate to face the camera's position instead of orientation
  93186. */
  93187. static BILLBOARDMODE_USE_POSITION: number;
  93188. private static _TmpRotation;
  93189. private static _TmpScaling;
  93190. private static _TmpTranslation;
  93191. private _forward;
  93192. private _forwardInverted;
  93193. private _up;
  93194. private _right;
  93195. private _rightInverted;
  93196. private _position;
  93197. private _rotation;
  93198. private _rotationQuaternion;
  93199. protected _scaling: Vector3;
  93200. protected _isDirty: boolean;
  93201. private _transformToBoneReferal;
  93202. private _isAbsoluteSynced;
  93203. private _billboardMode;
  93204. /**
  93205. * Gets or sets the billboard mode. Default is 0.
  93206. *
  93207. * | Value | Type | Description |
  93208. * | --- | --- | --- |
  93209. * | 0 | BILLBOARDMODE_NONE | |
  93210. * | 1 | BILLBOARDMODE_X | |
  93211. * | 2 | BILLBOARDMODE_Y | |
  93212. * | 4 | BILLBOARDMODE_Z | |
  93213. * | 7 | BILLBOARDMODE_ALL | |
  93214. *
  93215. */
  93216. get billboardMode(): number;
  93217. set billboardMode(value: number);
  93218. private _preserveParentRotationForBillboard;
  93219. /**
  93220. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  93221. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  93222. */
  93223. get preserveParentRotationForBillboard(): boolean;
  93224. set preserveParentRotationForBillboard(value: boolean);
  93225. /**
  93226. * 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
  93227. */
  93228. scalingDeterminant: number;
  93229. private _infiniteDistance;
  93230. /**
  93231. * Gets or sets the distance of the object to max, often used by skybox
  93232. */
  93233. get infiniteDistance(): boolean;
  93234. set infiniteDistance(value: boolean);
  93235. /**
  93236. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  93237. * By default the system will update normals to compensate
  93238. */
  93239. ignoreNonUniformScaling: boolean;
  93240. /**
  93241. * 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
  93242. */
  93243. reIntegrateRotationIntoRotationQuaternion: boolean;
  93244. /** @hidden */
  93245. _poseMatrix: Nullable<Matrix>;
  93246. /** @hidden */
  93247. _localMatrix: Matrix;
  93248. private _usePivotMatrix;
  93249. private _absolutePosition;
  93250. private _absoluteScaling;
  93251. private _absoluteRotationQuaternion;
  93252. private _pivotMatrix;
  93253. private _pivotMatrixInverse;
  93254. protected _postMultiplyPivotMatrix: boolean;
  93255. protected _isWorldMatrixFrozen: boolean;
  93256. /** @hidden */
  93257. _indexInSceneTransformNodesArray: number;
  93258. /**
  93259. * An event triggered after the world matrix is updated
  93260. */
  93261. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  93262. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  93263. /**
  93264. * Gets a string identifying the name of the class
  93265. * @returns "TransformNode" string
  93266. */
  93267. getClassName(): string;
  93268. /**
  93269. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  93270. */
  93271. get position(): Vector3;
  93272. set position(newPosition: Vector3);
  93273. /**
  93274. * 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)).
  93275. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  93276. */
  93277. get rotation(): Vector3;
  93278. set rotation(newRotation: Vector3);
  93279. /**
  93280. * 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)).
  93281. */
  93282. get scaling(): Vector3;
  93283. set scaling(newScaling: Vector3);
  93284. /**
  93285. * 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).
  93286. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  93287. */
  93288. get rotationQuaternion(): Nullable<Quaternion>;
  93289. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  93290. /**
  93291. * The forward direction of that transform in world space.
  93292. */
  93293. get forward(): Vector3;
  93294. /**
  93295. * The up direction of that transform in world space.
  93296. */
  93297. get up(): Vector3;
  93298. /**
  93299. * The right direction of that transform in world space.
  93300. */
  93301. get right(): Vector3;
  93302. /**
  93303. * Copies the parameter passed Matrix into the mesh Pose matrix.
  93304. * @param matrix the matrix to copy the pose from
  93305. * @returns this TransformNode.
  93306. */
  93307. updatePoseMatrix(matrix: Matrix): TransformNode;
  93308. /**
  93309. * Returns the mesh Pose matrix.
  93310. * @returns the pose matrix
  93311. */
  93312. getPoseMatrix(): Matrix;
  93313. /** @hidden */
  93314. _isSynchronized(): boolean;
  93315. /** @hidden */
  93316. _initCache(): void;
  93317. /**
  93318. * Flag the transform node as dirty (Forcing it to update everything)
  93319. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  93320. * @returns this transform node
  93321. */
  93322. markAsDirty(property: string): TransformNode;
  93323. /**
  93324. * Returns the current mesh absolute position.
  93325. * Returns a Vector3.
  93326. */
  93327. get absolutePosition(): Vector3;
  93328. /**
  93329. * Returns the current mesh absolute scaling.
  93330. * Returns a Vector3.
  93331. */
  93332. get absoluteScaling(): Vector3;
  93333. /**
  93334. * Returns the current mesh absolute rotation.
  93335. * Returns a Quaternion.
  93336. */
  93337. get absoluteRotationQuaternion(): Quaternion;
  93338. /**
  93339. * Sets a new matrix to apply before all other transformation
  93340. * @param matrix defines the transform matrix
  93341. * @returns the current TransformNode
  93342. */
  93343. setPreTransformMatrix(matrix: Matrix): TransformNode;
  93344. /**
  93345. * Sets a new pivot matrix to the current node
  93346. * @param matrix defines the new pivot matrix to use
  93347. * @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
  93348. * @returns the current TransformNode
  93349. */
  93350. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  93351. /**
  93352. * Returns the mesh pivot matrix.
  93353. * Default : Identity.
  93354. * @returns the matrix
  93355. */
  93356. getPivotMatrix(): Matrix;
  93357. /**
  93358. * Instantiate (when possible) or clone that node with its hierarchy
  93359. * @param newParent defines the new parent to use for the instance (or clone)
  93360. * @param options defines options to configure how copy is done
  93361. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  93362. * @returns an instance (or a clone) of the current node with its hiearchy
  93363. */
  93364. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  93365. doNotInstantiate: boolean;
  93366. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  93367. /**
  93368. * Prevents the World matrix to be computed any longer
  93369. * @param newWorldMatrix defines an optional matrix to use as world matrix
  93370. * @returns the TransformNode.
  93371. */
  93372. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  93373. /**
  93374. * Allows back the World matrix computation.
  93375. * @returns the TransformNode.
  93376. */
  93377. unfreezeWorldMatrix(): this;
  93378. /**
  93379. * True if the World matrix has been frozen.
  93380. */
  93381. get isWorldMatrixFrozen(): boolean;
  93382. /**
  93383. * Retuns the mesh absolute position in the World.
  93384. * @returns a Vector3.
  93385. */
  93386. getAbsolutePosition(): Vector3;
  93387. /**
  93388. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  93389. * @param absolutePosition the absolute position to set
  93390. * @returns the TransformNode.
  93391. */
  93392. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  93393. /**
  93394. * Sets the mesh position in its local space.
  93395. * @param vector3 the position to set in localspace
  93396. * @returns the TransformNode.
  93397. */
  93398. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  93399. /**
  93400. * Returns the mesh position in the local space from the current World matrix values.
  93401. * @returns a new Vector3.
  93402. */
  93403. getPositionExpressedInLocalSpace(): Vector3;
  93404. /**
  93405. * Translates the mesh along the passed Vector3 in its local space.
  93406. * @param vector3 the distance to translate in localspace
  93407. * @returns the TransformNode.
  93408. */
  93409. locallyTranslate(vector3: Vector3): TransformNode;
  93410. private static _lookAtVectorCache;
  93411. /**
  93412. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  93413. * @param targetPoint the position (must be in same space as current mesh) to look at
  93414. * @param yawCor optional yaw (y-axis) correction in radians
  93415. * @param pitchCor optional pitch (x-axis) correction in radians
  93416. * @param rollCor optional roll (z-axis) correction in radians
  93417. * @param space the choosen space of the target
  93418. * @returns the TransformNode.
  93419. */
  93420. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  93421. /**
  93422. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  93423. * This Vector3 is expressed in the World space.
  93424. * @param localAxis axis to rotate
  93425. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  93426. */
  93427. getDirection(localAxis: Vector3): Vector3;
  93428. /**
  93429. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  93430. * localAxis is expressed in the mesh local space.
  93431. * result is computed in the Wordl space from the mesh World matrix.
  93432. * @param localAxis axis to rotate
  93433. * @param result the resulting transformnode
  93434. * @returns this TransformNode.
  93435. */
  93436. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  93437. /**
  93438. * Sets this transform node rotation to the given local axis.
  93439. * @param localAxis the axis in local space
  93440. * @param yawCor optional yaw (y-axis) correction in radians
  93441. * @param pitchCor optional pitch (x-axis) correction in radians
  93442. * @param rollCor optional roll (z-axis) correction in radians
  93443. * @returns this TransformNode
  93444. */
  93445. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  93446. /**
  93447. * Sets a new pivot point to the current node
  93448. * @param point defines the new pivot point to use
  93449. * @param space defines if the point is in world or local space (local by default)
  93450. * @returns the current TransformNode
  93451. */
  93452. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  93453. /**
  93454. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  93455. * @returns the pivot point
  93456. */
  93457. getPivotPoint(): Vector3;
  93458. /**
  93459. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  93460. * @param result the vector3 to store the result
  93461. * @returns this TransformNode.
  93462. */
  93463. getPivotPointToRef(result: Vector3): TransformNode;
  93464. /**
  93465. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  93466. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  93467. */
  93468. getAbsolutePivotPoint(): Vector3;
  93469. /**
  93470. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  93471. * @param result vector3 to store the result
  93472. * @returns this TransformNode.
  93473. */
  93474. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  93475. /**
  93476. * Defines the passed node as the parent of the current node.
  93477. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  93478. * @see https://doc.babylonjs.com/how_to/parenting
  93479. * @param node the node ot set as the parent
  93480. * @returns this TransformNode.
  93481. */
  93482. setParent(node: Nullable<Node>): TransformNode;
  93483. private _nonUniformScaling;
  93484. /**
  93485. * True if the scaling property of this object is non uniform eg. (1,2,1)
  93486. */
  93487. get nonUniformScaling(): boolean;
  93488. /** @hidden */
  93489. _updateNonUniformScalingState(value: boolean): boolean;
  93490. /**
  93491. * Attach the current TransformNode to another TransformNode associated with a bone
  93492. * @param bone Bone affecting the TransformNode
  93493. * @param affectedTransformNode TransformNode associated with the bone
  93494. * @returns this object
  93495. */
  93496. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  93497. /**
  93498. * Detach the transform node if its associated with a bone
  93499. * @returns this object
  93500. */
  93501. detachFromBone(): TransformNode;
  93502. private static _rotationAxisCache;
  93503. /**
  93504. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  93505. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  93506. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  93507. * The passed axis is also normalized.
  93508. * @param axis the axis to rotate around
  93509. * @param amount the amount to rotate in radians
  93510. * @param space Space to rotate in (Default: local)
  93511. * @returns the TransformNode.
  93512. */
  93513. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  93514. /**
  93515. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  93516. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  93517. * The passed axis is also normalized. .
  93518. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  93519. * @param point the point to rotate around
  93520. * @param axis the axis to rotate around
  93521. * @param amount the amount to rotate in radians
  93522. * @returns the TransformNode
  93523. */
  93524. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  93525. /**
  93526. * Translates the mesh along the axis vector for the passed distance in the given space.
  93527. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  93528. * @param axis the axis to translate in
  93529. * @param distance the distance to translate
  93530. * @param space Space to rotate in (Default: local)
  93531. * @returns the TransformNode.
  93532. */
  93533. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  93534. /**
  93535. * Adds a rotation step to the mesh current rotation.
  93536. * x, y, z are Euler angles expressed in radians.
  93537. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  93538. * This means this rotation is made in the mesh local space only.
  93539. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  93540. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  93541. * ```javascript
  93542. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  93543. * ```
  93544. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  93545. * 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.
  93546. * @param x Rotation to add
  93547. * @param y Rotation to add
  93548. * @param z Rotation to add
  93549. * @returns the TransformNode.
  93550. */
  93551. addRotation(x: number, y: number, z: number): TransformNode;
  93552. /**
  93553. * @hidden
  93554. */
  93555. protected _getEffectiveParent(): Nullable<Node>;
  93556. /**
  93557. * Computes the world matrix of the node
  93558. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  93559. * @returns the world matrix
  93560. */
  93561. computeWorldMatrix(force?: boolean): Matrix;
  93562. /**
  93563. * Resets this nodeTransform's local matrix to Matrix.Identity().
  93564. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  93565. */
  93566. resetLocalMatrix(independentOfChildren?: boolean): void;
  93567. protected _afterComputeWorldMatrix(): void;
  93568. /**
  93569. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  93570. * @param func callback function to add
  93571. *
  93572. * @returns the TransformNode.
  93573. */
  93574. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  93575. /**
  93576. * Removes a registered callback function.
  93577. * @param func callback function to remove
  93578. * @returns the TransformNode.
  93579. */
  93580. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  93581. /**
  93582. * Gets the position of the current mesh in camera space
  93583. * @param camera defines the camera to use
  93584. * @returns a position
  93585. */
  93586. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  93587. /**
  93588. * Returns the distance from the mesh to the active camera
  93589. * @param camera defines the camera to use
  93590. * @returns the distance
  93591. */
  93592. getDistanceToCamera(camera?: Nullable<Camera>): number;
  93593. /**
  93594. * Clone the current transform node
  93595. * @param name Name of the new clone
  93596. * @param newParent New parent for the clone
  93597. * @param doNotCloneChildren Do not clone children hierarchy
  93598. * @returns the new transform node
  93599. */
  93600. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  93601. /**
  93602. * Serializes the objects information.
  93603. * @param currentSerializationObject defines the object to serialize in
  93604. * @returns the serialized object
  93605. */
  93606. serialize(currentSerializationObject?: any): any;
  93607. /**
  93608. * Returns a new TransformNode object parsed from the source provided.
  93609. * @param parsedTransformNode is the source.
  93610. * @param scene the scne the object belongs to
  93611. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  93612. * @returns a new TransformNode object parsed from the source provided.
  93613. */
  93614. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  93615. /**
  93616. * Get all child-transformNodes of this node
  93617. * @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
  93618. * @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
  93619. * @returns an array of TransformNode
  93620. */
  93621. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  93622. /**
  93623. * Releases resources associated with this transform node.
  93624. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  93625. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  93626. */
  93627. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  93628. /**
  93629. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  93630. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  93631. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  93632. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  93633. * @returns the current mesh
  93634. */
  93635. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  93636. private _syncAbsoluteScalingAndRotation;
  93637. }
  93638. }
  93639. declare module BABYLON {
  93640. /**
  93641. * Class used to override all child animations of a given target
  93642. */
  93643. export class AnimationPropertiesOverride {
  93644. /**
  93645. * Gets or sets a value indicating if animation blending must be used
  93646. */
  93647. enableBlending: boolean;
  93648. /**
  93649. * Gets or sets the blending speed to use when enableBlending is true
  93650. */
  93651. blendingSpeed: number;
  93652. /**
  93653. * Gets or sets the default loop mode to use
  93654. */
  93655. loopMode: number;
  93656. }
  93657. }
  93658. declare module BABYLON {
  93659. /**
  93660. * Class used to store bone information
  93661. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  93662. */
  93663. export class Bone extends Node {
  93664. /**
  93665. * defines the bone name
  93666. */
  93667. name: string;
  93668. private static _tmpVecs;
  93669. private static _tmpQuat;
  93670. private static _tmpMats;
  93671. /**
  93672. * Gets the list of child bones
  93673. */
  93674. children: Bone[];
  93675. /** Gets the animations associated with this bone */
  93676. animations: Animation[];
  93677. /**
  93678. * Gets or sets bone length
  93679. */
  93680. length: number;
  93681. /**
  93682. * @hidden Internal only
  93683. * Set this value to map this bone to a different index in the transform matrices
  93684. * Set this value to -1 to exclude the bone from the transform matrices
  93685. */
  93686. _index: Nullable<number>;
  93687. private _skeleton;
  93688. private _localMatrix;
  93689. private _restPose;
  93690. private _baseMatrix;
  93691. private _absoluteTransform;
  93692. private _invertedAbsoluteTransform;
  93693. private _parent;
  93694. private _scalingDeterminant;
  93695. private _worldTransform;
  93696. private _localScaling;
  93697. private _localRotation;
  93698. private _localPosition;
  93699. private _needToDecompose;
  93700. private _needToCompose;
  93701. /** @hidden */
  93702. _linkedTransformNode: Nullable<TransformNode>;
  93703. /** @hidden */
  93704. _waitingTransformNodeId: Nullable<string>;
  93705. /** @hidden */
  93706. get _matrix(): Matrix;
  93707. /** @hidden */
  93708. set _matrix(value: Matrix);
  93709. /**
  93710. * Create a new bone
  93711. * @param name defines the bone name
  93712. * @param skeleton defines the parent skeleton
  93713. * @param parentBone defines the parent (can be null if the bone is the root)
  93714. * @param localMatrix defines the local matrix
  93715. * @param restPose defines the rest pose matrix
  93716. * @param baseMatrix defines the base matrix
  93717. * @param index defines index of the bone in the hiearchy
  93718. */
  93719. constructor(
  93720. /**
  93721. * defines the bone name
  93722. */
  93723. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  93724. /**
  93725. * Gets the current object class name.
  93726. * @return the class name
  93727. */
  93728. getClassName(): string;
  93729. /**
  93730. * Gets the parent skeleton
  93731. * @returns a skeleton
  93732. */
  93733. getSkeleton(): Skeleton;
  93734. /**
  93735. * Gets parent bone
  93736. * @returns a bone or null if the bone is the root of the bone hierarchy
  93737. */
  93738. getParent(): Nullable<Bone>;
  93739. /**
  93740. * Returns an array containing the root bones
  93741. * @returns an array containing the root bones
  93742. */
  93743. getChildren(): Array<Bone>;
  93744. /**
  93745. * Gets the node index in matrix array generated for rendering
  93746. * @returns the node index
  93747. */
  93748. getIndex(): number;
  93749. /**
  93750. * Sets the parent bone
  93751. * @param parent defines the parent (can be null if the bone is the root)
  93752. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  93753. */
  93754. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  93755. /**
  93756. * Gets the local matrix
  93757. * @returns a matrix
  93758. */
  93759. getLocalMatrix(): Matrix;
  93760. /**
  93761. * Gets the base matrix (initial matrix which remains unchanged)
  93762. * @returns a matrix
  93763. */
  93764. getBaseMatrix(): Matrix;
  93765. /**
  93766. * Gets the rest pose matrix
  93767. * @returns a matrix
  93768. */
  93769. getRestPose(): Matrix;
  93770. /**
  93771. * Sets the rest pose matrix
  93772. * @param matrix the local-space rest pose to set for this bone
  93773. */
  93774. setRestPose(matrix: Matrix): void;
  93775. /**
  93776. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  93777. */
  93778. getWorldMatrix(): Matrix;
  93779. /**
  93780. * Sets the local matrix to rest pose matrix
  93781. */
  93782. returnToRest(): void;
  93783. /**
  93784. * Gets the inverse of the absolute transform matrix.
  93785. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  93786. * @returns a matrix
  93787. */
  93788. getInvertedAbsoluteTransform(): Matrix;
  93789. /**
  93790. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  93791. * @returns a matrix
  93792. */
  93793. getAbsoluteTransform(): Matrix;
  93794. /**
  93795. * Links with the given transform node.
  93796. * The local matrix of this bone is copied from the transform node every frame.
  93797. * @param transformNode defines the transform node to link to
  93798. */
  93799. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  93800. /**
  93801. * Gets the node used to drive the bone's transformation
  93802. * @returns a transform node or null
  93803. */
  93804. getTransformNode(): Nullable<TransformNode>;
  93805. /** Gets or sets current position (in local space) */
  93806. get position(): Vector3;
  93807. set position(newPosition: Vector3);
  93808. /** Gets or sets current rotation (in local space) */
  93809. get rotation(): Vector3;
  93810. set rotation(newRotation: Vector3);
  93811. /** Gets or sets current rotation quaternion (in local space) */
  93812. get rotationQuaternion(): Quaternion;
  93813. set rotationQuaternion(newRotation: Quaternion);
  93814. /** Gets or sets current scaling (in local space) */
  93815. get scaling(): Vector3;
  93816. set scaling(newScaling: Vector3);
  93817. /**
  93818. * Gets the animation properties override
  93819. */
  93820. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  93821. private _decompose;
  93822. private _compose;
  93823. /**
  93824. * Update the base and local matrices
  93825. * @param matrix defines the new base or local matrix
  93826. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  93827. * @param updateLocalMatrix defines if the local matrix should be updated
  93828. */
  93829. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  93830. /** @hidden */
  93831. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  93832. /**
  93833. * Flag the bone as dirty (Forcing it to update everything)
  93834. */
  93835. markAsDirty(): void;
  93836. /** @hidden */
  93837. _markAsDirtyAndCompose(): void;
  93838. private _markAsDirtyAndDecompose;
  93839. /**
  93840. * Translate the bone in local or world space
  93841. * @param vec The amount to translate the bone
  93842. * @param space The space that the translation is in
  93843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93844. */
  93845. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93846. /**
  93847. * Set the postion of the bone in local or world space
  93848. * @param position The position to set the bone
  93849. * @param space The space that the position is in
  93850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93851. */
  93852. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93853. /**
  93854. * Set the absolute position of the bone (world space)
  93855. * @param position The position to set the bone
  93856. * @param mesh The mesh that this bone is attached to
  93857. */
  93858. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  93859. /**
  93860. * Scale the bone on the x, y and z axes (in local space)
  93861. * @param x The amount to scale the bone on the x axis
  93862. * @param y The amount to scale the bone on the y axis
  93863. * @param z The amount to scale the bone on the z axis
  93864. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  93865. */
  93866. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  93867. /**
  93868. * Set the bone scaling in local space
  93869. * @param scale defines the scaling vector
  93870. */
  93871. setScale(scale: Vector3): void;
  93872. /**
  93873. * Gets the current scaling in local space
  93874. * @returns the current scaling vector
  93875. */
  93876. getScale(): Vector3;
  93877. /**
  93878. * Gets the current scaling in local space and stores it in a target vector
  93879. * @param result defines the target vector
  93880. */
  93881. getScaleToRef(result: Vector3): void;
  93882. /**
  93883. * Set the yaw, pitch, and roll of the bone in local or world space
  93884. * @param yaw The rotation of the bone on the y axis
  93885. * @param pitch The rotation of the bone on the x axis
  93886. * @param roll The rotation of the bone on the z axis
  93887. * @param space The space that the axes of rotation are in
  93888. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93889. */
  93890. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  93891. /**
  93892. * Add a rotation to the bone on an axis in local or world space
  93893. * @param axis The axis to rotate the bone on
  93894. * @param amount The amount to rotate the bone
  93895. * @param space The space that the axis is in
  93896. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93897. */
  93898. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  93899. /**
  93900. * Set the rotation of the bone to a particular axis angle in local or world space
  93901. * @param axis The axis to rotate the bone on
  93902. * @param angle The angle that the bone should be rotated to
  93903. * @param space The space that the axis is in
  93904. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93905. */
  93906. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  93907. /**
  93908. * Set the euler rotation of the bone in local of world space
  93909. * @param rotation The euler rotation that the bone should be set to
  93910. * @param space The space that the rotation is in
  93911. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93912. */
  93913. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93914. /**
  93915. * Set the quaternion rotation of the bone in local of world space
  93916. * @param quat The quaternion rotation that the bone should be set to
  93917. * @param space The space that the rotation is in
  93918. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93919. */
  93920. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  93921. /**
  93922. * Set the rotation matrix of the bone in local of world space
  93923. * @param rotMat The rotation matrix that the bone should be set to
  93924. * @param space The space that the rotation is in
  93925. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93926. */
  93927. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  93928. private _rotateWithMatrix;
  93929. private _getNegativeRotationToRef;
  93930. /**
  93931. * Get the position of the bone in local or world space
  93932. * @param space The space that the returned position is in
  93933. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93934. * @returns The position of the bone
  93935. */
  93936. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93937. /**
  93938. * Copy the position of the bone to a vector3 in local or world space
  93939. * @param space The space that the returned position is in
  93940. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93941. * @param result The vector3 to copy the position to
  93942. */
  93943. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  93944. /**
  93945. * Get the absolute position of the bone (world space)
  93946. * @param mesh The mesh that this bone is attached to
  93947. * @returns The absolute position of the bone
  93948. */
  93949. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  93950. /**
  93951. * Copy the absolute position of the bone (world space) to the result param
  93952. * @param mesh The mesh that this bone is attached to
  93953. * @param result The vector3 to copy the absolute position to
  93954. */
  93955. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  93956. /**
  93957. * Compute the absolute transforms of this bone and its children
  93958. */
  93959. computeAbsoluteTransforms(): void;
  93960. /**
  93961. * Get the world direction from an axis that is in the local space of the bone
  93962. * @param localAxis The local direction that is used to compute the world direction
  93963. * @param mesh The mesh that this bone is attached to
  93964. * @returns The world direction
  93965. */
  93966. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93967. /**
  93968. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  93969. * @param localAxis The local direction that is used to compute the world direction
  93970. * @param mesh The mesh that this bone is attached to
  93971. * @param result The vector3 that the world direction will be copied to
  93972. */
  93973. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93974. /**
  93975. * Get the euler rotation of the bone in local or world space
  93976. * @param space The space that the rotation should be in
  93977. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93978. * @returns The euler rotation
  93979. */
  93980. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93981. /**
  93982. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  93983. * @param space The space that the rotation should be in
  93984. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93985. * @param result The vector3 that the rotation should be copied to
  93986. */
  93987. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93988. /**
  93989. * Get the quaternion rotation of the bone in either local or world space
  93990. * @param space The space that the rotation should be in
  93991. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93992. * @returns The quaternion rotation
  93993. */
  93994. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  93995. /**
  93996. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  93997. * @param space The space that the rotation should be in
  93998. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93999. * @param result The quaternion that the rotation should be copied to
  94000. */
  94001. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  94002. /**
  94003. * Get the rotation matrix of the bone in local or world space
  94004. * @param space The space that the rotation should be in
  94005. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94006. * @returns The rotation matrix
  94007. */
  94008. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  94009. /**
  94010. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  94011. * @param space The space that the rotation should be in
  94012. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94013. * @param result The quaternion that the rotation should be copied to
  94014. */
  94015. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  94016. /**
  94017. * Get the world position of a point that is in the local space of the bone
  94018. * @param position The local position
  94019. * @param mesh The mesh that this bone is attached to
  94020. * @returns The world position
  94021. */
  94022. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94023. /**
  94024. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  94025. * @param position The local position
  94026. * @param mesh The mesh that this bone is attached to
  94027. * @param result The vector3 that the world position should be copied to
  94028. */
  94029. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94030. /**
  94031. * Get the local position of a point that is in world space
  94032. * @param position The world position
  94033. * @param mesh The mesh that this bone is attached to
  94034. * @returns The local position
  94035. */
  94036. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94037. /**
  94038. * Get the local position of a point that is in world space and copy it to the result param
  94039. * @param position The world position
  94040. * @param mesh The mesh that this bone is attached to
  94041. * @param result The vector3 that the local position should be copied to
  94042. */
  94043. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94044. }
  94045. }
  94046. declare module BABYLON {
  94047. /**
  94048. * Defines a runtime animation
  94049. */
  94050. export class RuntimeAnimation {
  94051. private _events;
  94052. /**
  94053. * The current frame of the runtime animation
  94054. */
  94055. private _currentFrame;
  94056. /**
  94057. * The animation used by the runtime animation
  94058. */
  94059. private _animation;
  94060. /**
  94061. * The target of the runtime animation
  94062. */
  94063. private _target;
  94064. /**
  94065. * The initiating animatable
  94066. */
  94067. private _host;
  94068. /**
  94069. * The original value of the runtime animation
  94070. */
  94071. private _originalValue;
  94072. /**
  94073. * The original blend value of the runtime animation
  94074. */
  94075. private _originalBlendValue;
  94076. /**
  94077. * The offsets cache of the runtime animation
  94078. */
  94079. private _offsetsCache;
  94080. /**
  94081. * The high limits cache of the runtime animation
  94082. */
  94083. private _highLimitsCache;
  94084. /**
  94085. * Specifies if the runtime animation has been stopped
  94086. */
  94087. private _stopped;
  94088. /**
  94089. * The blending factor of the runtime animation
  94090. */
  94091. private _blendingFactor;
  94092. /**
  94093. * The BabylonJS scene
  94094. */
  94095. private _scene;
  94096. /**
  94097. * The current value of the runtime animation
  94098. */
  94099. private _currentValue;
  94100. /** @hidden */
  94101. _animationState: _IAnimationState;
  94102. /**
  94103. * The active target of the runtime animation
  94104. */
  94105. private _activeTargets;
  94106. private _currentActiveTarget;
  94107. private _directTarget;
  94108. /**
  94109. * The target path of the runtime animation
  94110. */
  94111. private _targetPath;
  94112. /**
  94113. * The weight of the runtime animation
  94114. */
  94115. private _weight;
  94116. /**
  94117. * The ratio offset of the runtime animation
  94118. */
  94119. private _ratioOffset;
  94120. /**
  94121. * The previous delay of the runtime animation
  94122. */
  94123. private _previousDelay;
  94124. /**
  94125. * The previous ratio of the runtime animation
  94126. */
  94127. private _previousRatio;
  94128. private _enableBlending;
  94129. private _keys;
  94130. private _minFrame;
  94131. private _maxFrame;
  94132. private _minValue;
  94133. private _maxValue;
  94134. private _targetIsArray;
  94135. /**
  94136. * Gets the current frame of the runtime animation
  94137. */
  94138. get currentFrame(): number;
  94139. /**
  94140. * Gets the weight of the runtime animation
  94141. */
  94142. get weight(): number;
  94143. /**
  94144. * Gets the current value of the runtime animation
  94145. */
  94146. get currentValue(): any;
  94147. /**
  94148. * Gets the target path of the runtime animation
  94149. */
  94150. get targetPath(): string;
  94151. /**
  94152. * Gets the actual target of the runtime animation
  94153. */
  94154. get target(): any;
  94155. /**
  94156. * Gets the additive state of the runtime animation
  94157. */
  94158. get isAdditive(): boolean;
  94159. /** @hidden */
  94160. _onLoop: () => void;
  94161. /**
  94162. * Create a new RuntimeAnimation object
  94163. * @param target defines the target of the animation
  94164. * @param animation defines the source animation object
  94165. * @param scene defines the hosting scene
  94166. * @param host defines the initiating Animatable
  94167. */
  94168. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  94169. private _preparePath;
  94170. /**
  94171. * Gets the animation from the runtime animation
  94172. */
  94173. get animation(): Animation;
  94174. /**
  94175. * Resets the runtime animation to the beginning
  94176. * @param restoreOriginal defines whether to restore the target property to the original value
  94177. */
  94178. reset(restoreOriginal?: boolean): void;
  94179. /**
  94180. * Specifies if the runtime animation is stopped
  94181. * @returns Boolean specifying if the runtime animation is stopped
  94182. */
  94183. isStopped(): boolean;
  94184. /**
  94185. * Disposes of the runtime animation
  94186. */
  94187. dispose(): void;
  94188. /**
  94189. * Apply the interpolated value to the target
  94190. * @param currentValue defines the value computed by the animation
  94191. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  94192. */
  94193. setValue(currentValue: any, weight: number): void;
  94194. private _getOriginalValues;
  94195. private _setValue;
  94196. /**
  94197. * Gets the loop pmode of the runtime animation
  94198. * @returns Loop Mode
  94199. */
  94200. private _getCorrectLoopMode;
  94201. /**
  94202. * Move the current animation to a given frame
  94203. * @param frame defines the frame to move to
  94204. */
  94205. goToFrame(frame: number): void;
  94206. /**
  94207. * @hidden Internal use only
  94208. */
  94209. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  94210. /**
  94211. * Execute the current animation
  94212. * @param delay defines the delay to add to the current frame
  94213. * @param from defines the lower bound of the animation range
  94214. * @param to defines the upper bound of the animation range
  94215. * @param loop defines if the current animation must loop
  94216. * @param speedRatio defines the current speed ratio
  94217. * @param weight defines the weight of the animation (default is -1 so no weight)
  94218. * @param onLoop optional callback called when animation loops
  94219. * @returns a boolean indicating if the animation is running
  94220. */
  94221. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  94222. }
  94223. }
  94224. declare module BABYLON {
  94225. /**
  94226. * Class used to store an actual running animation
  94227. */
  94228. export class Animatable {
  94229. /** defines the target object */
  94230. target: any;
  94231. /** defines the starting frame number (default is 0) */
  94232. fromFrame: number;
  94233. /** defines the ending frame number (default is 100) */
  94234. toFrame: number;
  94235. /** defines if the animation must loop (default is false) */
  94236. loopAnimation: boolean;
  94237. /** defines a callback to call when animation ends if it is not looping */
  94238. onAnimationEnd?: (() => void) | null | undefined;
  94239. /** defines a callback to call when animation loops */
  94240. onAnimationLoop?: (() => void) | null | undefined;
  94241. /** defines whether the animation should be evaluated additively */
  94242. isAdditive: boolean;
  94243. private _localDelayOffset;
  94244. private _pausedDelay;
  94245. private _runtimeAnimations;
  94246. private _paused;
  94247. private _scene;
  94248. private _speedRatio;
  94249. private _weight;
  94250. private _syncRoot;
  94251. /**
  94252. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  94253. * This will only apply for non looping animation (default is true)
  94254. */
  94255. disposeOnEnd: boolean;
  94256. /**
  94257. * Gets a boolean indicating if the animation has started
  94258. */
  94259. animationStarted: boolean;
  94260. /**
  94261. * Observer raised when the animation ends
  94262. */
  94263. onAnimationEndObservable: Observable<Animatable>;
  94264. /**
  94265. * Observer raised when the animation loops
  94266. */
  94267. onAnimationLoopObservable: Observable<Animatable>;
  94268. /**
  94269. * Gets the root Animatable used to synchronize and normalize animations
  94270. */
  94271. get syncRoot(): Nullable<Animatable>;
  94272. /**
  94273. * Gets the current frame of the first RuntimeAnimation
  94274. * Used to synchronize Animatables
  94275. */
  94276. get masterFrame(): number;
  94277. /**
  94278. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  94279. */
  94280. get weight(): number;
  94281. set weight(value: number);
  94282. /**
  94283. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  94284. */
  94285. get speedRatio(): number;
  94286. set speedRatio(value: number);
  94287. /**
  94288. * Creates a new Animatable
  94289. * @param scene defines the hosting scene
  94290. * @param target defines the target object
  94291. * @param fromFrame defines the starting frame number (default is 0)
  94292. * @param toFrame defines the ending frame number (default is 100)
  94293. * @param loopAnimation defines if the animation must loop (default is false)
  94294. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  94295. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  94296. * @param animations defines a group of animation to add to the new Animatable
  94297. * @param onAnimationLoop defines a callback to call when animation loops
  94298. * @param isAdditive defines whether the animation should be evaluated additively
  94299. */
  94300. constructor(scene: Scene,
  94301. /** defines the target object */
  94302. target: any,
  94303. /** defines the starting frame number (default is 0) */
  94304. fromFrame?: number,
  94305. /** defines the ending frame number (default is 100) */
  94306. toFrame?: number,
  94307. /** defines if the animation must loop (default is false) */
  94308. loopAnimation?: boolean, speedRatio?: number,
  94309. /** defines a callback to call when animation ends if it is not looping */
  94310. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  94311. /** defines a callback to call when animation loops */
  94312. onAnimationLoop?: (() => void) | null | undefined,
  94313. /** defines whether the animation should be evaluated additively */
  94314. isAdditive?: boolean);
  94315. /**
  94316. * Synchronize and normalize current Animatable with a source Animatable
  94317. * This is useful when using animation weights and when animations are not of the same length
  94318. * @param root defines the root Animatable to synchronize with
  94319. * @returns the current Animatable
  94320. */
  94321. syncWith(root: Animatable): Animatable;
  94322. /**
  94323. * Gets the list of runtime animations
  94324. * @returns an array of RuntimeAnimation
  94325. */
  94326. getAnimations(): RuntimeAnimation[];
  94327. /**
  94328. * Adds more animations to the current animatable
  94329. * @param target defines the target of the animations
  94330. * @param animations defines the new animations to add
  94331. */
  94332. appendAnimations(target: any, animations: Animation[]): void;
  94333. /**
  94334. * Gets the source animation for a specific property
  94335. * @param property defines the propertyu to look for
  94336. * @returns null or the source animation for the given property
  94337. */
  94338. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  94339. /**
  94340. * Gets the runtime animation for a specific property
  94341. * @param property defines the propertyu to look for
  94342. * @returns null or the runtime animation for the given property
  94343. */
  94344. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  94345. /**
  94346. * Resets the animatable to its original state
  94347. */
  94348. reset(): void;
  94349. /**
  94350. * Allows the animatable to blend with current running animations
  94351. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94352. * @param blendingSpeed defines the blending speed to use
  94353. */
  94354. enableBlending(blendingSpeed: number): void;
  94355. /**
  94356. * Disable animation blending
  94357. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94358. */
  94359. disableBlending(): void;
  94360. /**
  94361. * Jump directly to a given frame
  94362. * @param frame defines the frame to jump to
  94363. */
  94364. goToFrame(frame: number): void;
  94365. /**
  94366. * Pause the animation
  94367. */
  94368. pause(): void;
  94369. /**
  94370. * Restart the animation
  94371. */
  94372. restart(): void;
  94373. private _raiseOnAnimationEnd;
  94374. /**
  94375. * Stop and delete the current animation
  94376. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  94377. * @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)
  94378. */
  94379. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  94380. /**
  94381. * Wait asynchronously for the animation to end
  94382. * @returns a promise which will be fullfilled when the animation ends
  94383. */
  94384. waitAsync(): Promise<Animatable>;
  94385. /** @hidden */
  94386. _animate(delay: number): boolean;
  94387. }
  94388. interface Scene {
  94389. /** @hidden */
  94390. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  94391. /** @hidden */
  94392. _processLateAnimationBindingsForMatrices(holder: {
  94393. totalWeight: number;
  94394. totalAdditiveWeight: number;
  94395. animations: RuntimeAnimation[];
  94396. additiveAnimations: RuntimeAnimation[];
  94397. originalValue: Matrix;
  94398. }): any;
  94399. /** @hidden */
  94400. _processLateAnimationBindingsForQuaternions(holder: {
  94401. totalWeight: number;
  94402. totalAdditiveWeight: number;
  94403. animations: RuntimeAnimation[];
  94404. additiveAnimations: RuntimeAnimation[];
  94405. originalValue: Quaternion;
  94406. }, refQuaternion: Quaternion): Quaternion;
  94407. /** @hidden */
  94408. _processLateAnimationBindings(): void;
  94409. /**
  94410. * Will start the animation sequence of a given target
  94411. * @param target defines the target
  94412. * @param from defines from which frame should animation start
  94413. * @param to defines until which frame should animation run.
  94414. * @param weight defines the weight to apply to the animation (1.0 by default)
  94415. * @param loop defines if the animation loops
  94416. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94417. * @param onAnimationEnd defines the function to be executed when the animation ends
  94418. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94419. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  94420. * @param onAnimationLoop defines the callback to call when an animation loops
  94421. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94422. * @returns the animatable object created for this animation
  94423. */
  94424. 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;
  94425. /**
  94426. * Will start the animation sequence of a given target
  94427. * @param target defines the target
  94428. * @param from defines from which frame should animation start
  94429. * @param to defines until which frame should animation run.
  94430. * @param loop defines if the animation loops
  94431. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94432. * @param onAnimationEnd defines the function to be executed when the animation ends
  94433. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94434. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  94435. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  94436. * @param onAnimationLoop defines the callback to call when an animation loops
  94437. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94438. * @returns the animatable object created for this animation
  94439. */
  94440. 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;
  94441. /**
  94442. * Will start the animation sequence of a given target and its hierarchy
  94443. * @param target defines the target
  94444. * @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.
  94445. * @param from defines from which frame should animation start
  94446. * @param to defines until which frame should animation run.
  94447. * @param loop defines if the animation loops
  94448. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94449. * @param onAnimationEnd defines the function to be executed when the animation ends
  94450. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94451. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  94452. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  94453. * @param onAnimationLoop defines the callback to call when an animation loops
  94454. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94455. * @returns the list of created animatables
  94456. */
  94457. 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[];
  94458. /**
  94459. * Begin a new animation on a given node
  94460. * @param target defines the target where the animation will take place
  94461. * @param animations defines the list of animations to start
  94462. * @param from defines the initial value
  94463. * @param to defines the final value
  94464. * @param loop defines if you want animation to loop (off by default)
  94465. * @param speedRatio defines the speed ratio to apply to all animations
  94466. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  94467. * @param onAnimationLoop defines the callback to call when an animation loops
  94468. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94469. * @returns the list of created animatables
  94470. */
  94471. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  94472. /**
  94473. * Begin a new animation on a given node and its hierarchy
  94474. * @param target defines the root node where the animation will take place
  94475. * @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.
  94476. * @param animations defines the list of animations to start
  94477. * @param from defines the initial value
  94478. * @param to defines the final value
  94479. * @param loop defines if you want animation to loop (off by default)
  94480. * @param speedRatio defines the speed ratio to apply to all animations
  94481. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  94482. * @param onAnimationLoop defines the callback to call when an animation loops
  94483. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94484. * @returns the list of animatables created for all nodes
  94485. */
  94486. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  94487. /**
  94488. * Gets the animatable associated with a specific target
  94489. * @param target defines the target of the animatable
  94490. * @returns the required animatable if found
  94491. */
  94492. getAnimatableByTarget(target: any): Nullable<Animatable>;
  94493. /**
  94494. * Gets all animatables associated with a given target
  94495. * @param target defines the target to look animatables for
  94496. * @returns an array of Animatables
  94497. */
  94498. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  94499. /**
  94500. * Stops and removes all animations that have been applied to the scene
  94501. */
  94502. stopAllAnimations(): void;
  94503. /**
  94504. * Gets the current delta time used by animation engine
  94505. */
  94506. deltaTime: number;
  94507. }
  94508. interface Bone {
  94509. /**
  94510. * Copy an animation range from another bone
  94511. * @param source defines the source bone
  94512. * @param rangeName defines the range name to copy
  94513. * @param frameOffset defines the frame offset
  94514. * @param rescaleAsRequired defines if rescaling must be applied if required
  94515. * @param skelDimensionsRatio defines the scaling ratio
  94516. * @returns true if operation was successful
  94517. */
  94518. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  94519. }
  94520. }
  94521. declare module BABYLON {
  94522. /**
  94523. * Class used to handle skinning animations
  94524. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94525. */
  94526. export class Skeleton implements IAnimatable {
  94527. /** defines the skeleton name */
  94528. name: string;
  94529. /** defines the skeleton Id */
  94530. id: string;
  94531. /**
  94532. * Defines the list of child bones
  94533. */
  94534. bones: Bone[];
  94535. /**
  94536. * Defines an estimate of the dimension of the skeleton at rest
  94537. */
  94538. dimensionsAtRest: Vector3;
  94539. /**
  94540. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  94541. */
  94542. needInitialSkinMatrix: boolean;
  94543. /**
  94544. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  94545. */
  94546. overrideMesh: Nullable<AbstractMesh>;
  94547. /**
  94548. * Gets the list of animations attached to this skeleton
  94549. */
  94550. animations: Array<Animation>;
  94551. private _scene;
  94552. private _isDirty;
  94553. private _transformMatrices;
  94554. private _transformMatrixTexture;
  94555. private _meshesWithPoseMatrix;
  94556. private _animatables;
  94557. private _identity;
  94558. private _synchronizedWithMesh;
  94559. private _ranges;
  94560. private _lastAbsoluteTransformsUpdateId;
  94561. private _canUseTextureForBones;
  94562. private _uniqueId;
  94563. /** @hidden */
  94564. _numBonesWithLinkedTransformNode: number;
  94565. /** @hidden */
  94566. _hasWaitingData: Nullable<boolean>;
  94567. /**
  94568. * Specifies if the skeleton should be serialized
  94569. */
  94570. doNotSerialize: boolean;
  94571. private _useTextureToStoreBoneMatrices;
  94572. /**
  94573. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  94574. * Please note that this option is not available if the hardware does not support it
  94575. */
  94576. get useTextureToStoreBoneMatrices(): boolean;
  94577. set useTextureToStoreBoneMatrices(value: boolean);
  94578. private _animationPropertiesOverride;
  94579. /**
  94580. * Gets or sets the animation properties override
  94581. */
  94582. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94583. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  94584. /**
  94585. * List of inspectable custom properties (used by the Inspector)
  94586. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  94587. */
  94588. inspectableCustomProperties: IInspectable[];
  94589. /**
  94590. * An observable triggered before computing the skeleton's matrices
  94591. */
  94592. onBeforeComputeObservable: Observable<Skeleton>;
  94593. /**
  94594. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  94595. */
  94596. get isUsingTextureForMatrices(): boolean;
  94597. /**
  94598. * Gets the unique ID of this skeleton
  94599. */
  94600. get uniqueId(): number;
  94601. /**
  94602. * Creates a new skeleton
  94603. * @param name defines the skeleton name
  94604. * @param id defines the skeleton Id
  94605. * @param scene defines the hosting scene
  94606. */
  94607. constructor(
  94608. /** defines the skeleton name */
  94609. name: string,
  94610. /** defines the skeleton Id */
  94611. id: string, scene: Scene);
  94612. /**
  94613. * Gets the current object class name.
  94614. * @return the class name
  94615. */
  94616. getClassName(): string;
  94617. /**
  94618. * Returns an array containing the root bones
  94619. * @returns an array containing the root bones
  94620. */
  94621. getChildren(): Array<Bone>;
  94622. /**
  94623. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  94624. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  94625. * @returns a Float32Array containing matrices data
  94626. */
  94627. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  94628. /**
  94629. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  94630. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  94631. * @returns a raw texture containing the data
  94632. */
  94633. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  94634. /**
  94635. * Gets the current hosting scene
  94636. * @returns a scene object
  94637. */
  94638. getScene(): Scene;
  94639. /**
  94640. * Gets a string representing the current skeleton data
  94641. * @param fullDetails defines a boolean indicating if we want a verbose version
  94642. * @returns a string representing the current skeleton data
  94643. */
  94644. toString(fullDetails?: boolean): string;
  94645. /**
  94646. * Get bone's index searching by name
  94647. * @param name defines bone's name to search for
  94648. * @return the indice of the bone. Returns -1 if not found
  94649. */
  94650. getBoneIndexByName(name: string): number;
  94651. /**
  94652. * Creater a new animation range
  94653. * @param name defines the name of the range
  94654. * @param from defines the start key
  94655. * @param to defines the end key
  94656. */
  94657. createAnimationRange(name: string, from: number, to: number): void;
  94658. /**
  94659. * Delete a specific animation range
  94660. * @param name defines the name of the range
  94661. * @param deleteFrames defines if frames must be removed as well
  94662. */
  94663. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  94664. /**
  94665. * Gets a specific animation range
  94666. * @param name defines the name of the range to look for
  94667. * @returns the requested animation range or null if not found
  94668. */
  94669. getAnimationRange(name: string): Nullable<AnimationRange>;
  94670. /**
  94671. * Gets the list of all animation ranges defined on this skeleton
  94672. * @returns an array
  94673. */
  94674. getAnimationRanges(): Nullable<AnimationRange>[];
  94675. /**
  94676. * Copy animation range from a source skeleton.
  94677. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  94678. * @param source defines the source skeleton
  94679. * @param name defines the name of the range to copy
  94680. * @param rescaleAsRequired defines if rescaling must be applied if required
  94681. * @returns true if operation was successful
  94682. */
  94683. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  94684. /**
  94685. * Forces the skeleton to go to rest pose
  94686. */
  94687. returnToRest(): void;
  94688. private _getHighestAnimationFrame;
  94689. /**
  94690. * Begin a specific animation range
  94691. * @param name defines the name of the range to start
  94692. * @param loop defines if looping must be turned on (false by default)
  94693. * @param speedRatio defines the speed ratio to apply (1 by default)
  94694. * @param onAnimationEnd defines a callback which will be called when animation will end
  94695. * @returns a new animatable
  94696. */
  94697. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  94698. /**
  94699. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  94700. * @param skeleton defines the Skeleton containing the animation range to convert
  94701. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  94702. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  94703. * @returns the original skeleton
  94704. */
  94705. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  94706. /** @hidden */
  94707. _markAsDirty(): void;
  94708. /** @hidden */
  94709. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  94710. /** @hidden */
  94711. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  94712. private _computeTransformMatrices;
  94713. /**
  94714. * Build all resources required to render a skeleton
  94715. */
  94716. prepare(): void;
  94717. /**
  94718. * Gets the list of animatables currently running for this skeleton
  94719. * @returns an array of animatables
  94720. */
  94721. getAnimatables(): IAnimatable[];
  94722. /**
  94723. * Clone the current skeleton
  94724. * @param name defines the name of the new skeleton
  94725. * @param id defines the id of the new skeleton
  94726. * @returns the new skeleton
  94727. */
  94728. clone(name: string, id?: string): Skeleton;
  94729. /**
  94730. * Enable animation blending for this skeleton
  94731. * @param blendingSpeed defines the blending speed to apply
  94732. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94733. */
  94734. enableBlending(blendingSpeed?: number): void;
  94735. /**
  94736. * Releases all resources associated with the current skeleton
  94737. */
  94738. dispose(): void;
  94739. /**
  94740. * Serialize the skeleton in a JSON object
  94741. * @returns a JSON object
  94742. */
  94743. serialize(): any;
  94744. /**
  94745. * Creates a new skeleton from serialized data
  94746. * @param parsedSkeleton defines the serialized data
  94747. * @param scene defines the hosting scene
  94748. * @returns a new skeleton
  94749. */
  94750. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  94751. /**
  94752. * Compute all node absolute transforms
  94753. * @param forceUpdate defines if computation must be done even if cache is up to date
  94754. */
  94755. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  94756. /**
  94757. * Gets the root pose matrix
  94758. * @returns a matrix
  94759. */
  94760. getPoseMatrix(): Nullable<Matrix>;
  94761. /**
  94762. * Sorts bones per internal index
  94763. */
  94764. sortBones(): void;
  94765. private _sortBones;
  94766. }
  94767. }
  94768. declare module BABYLON {
  94769. /**
  94770. * Creates an instance based on a source mesh.
  94771. */
  94772. export class InstancedMesh extends AbstractMesh {
  94773. private _sourceMesh;
  94774. private _currentLOD;
  94775. /** @hidden */
  94776. _indexInSourceMeshInstanceArray: number;
  94777. constructor(name: string, source: Mesh);
  94778. /**
  94779. * Returns the string "InstancedMesh".
  94780. */
  94781. getClassName(): string;
  94782. /** Gets the list of lights affecting that mesh */
  94783. get lightSources(): Light[];
  94784. _resyncLightSources(): void;
  94785. _resyncLightSource(light: Light): void;
  94786. _removeLightSource(light: Light, dispose: boolean): void;
  94787. /**
  94788. * If the source mesh receives shadows
  94789. */
  94790. get receiveShadows(): boolean;
  94791. /**
  94792. * The material of the source mesh
  94793. */
  94794. get material(): Nullable<Material>;
  94795. /**
  94796. * Visibility of the source mesh
  94797. */
  94798. get visibility(): number;
  94799. /**
  94800. * Skeleton of the source mesh
  94801. */
  94802. get skeleton(): Nullable<Skeleton>;
  94803. /**
  94804. * Rendering ground id of the source mesh
  94805. */
  94806. get renderingGroupId(): number;
  94807. set renderingGroupId(value: number);
  94808. /**
  94809. * Returns the total number of vertices (integer).
  94810. */
  94811. getTotalVertices(): number;
  94812. /**
  94813. * Returns a positive integer : the total number of indices in this mesh geometry.
  94814. * @returns the numner of indices or zero if the mesh has no geometry.
  94815. */
  94816. getTotalIndices(): number;
  94817. /**
  94818. * The source mesh of the instance
  94819. */
  94820. get sourceMesh(): Mesh;
  94821. /**
  94822. * Creates a new InstancedMesh object from the mesh model.
  94823. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  94824. * @param name defines the name of the new instance
  94825. * @returns a new InstancedMesh
  94826. */
  94827. createInstance(name: string): InstancedMesh;
  94828. /**
  94829. * Is this node ready to be used/rendered
  94830. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  94831. * @return {boolean} is it ready
  94832. */
  94833. isReady(completeCheck?: boolean): boolean;
  94834. /**
  94835. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  94836. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  94837. * @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.
  94838. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  94839. */
  94840. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  94841. /**
  94842. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94843. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94844. * The `data` are either a numeric array either a Float32Array.
  94845. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  94846. * 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).
  94847. * Note that a new underlying VertexBuffer object is created each call.
  94848. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94849. *
  94850. * Possible `kind` values :
  94851. * - VertexBuffer.PositionKind
  94852. * - VertexBuffer.UVKind
  94853. * - VertexBuffer.UV2Kind
  94854. * - VertexBuffer.UV3Kind
  94855. * - VertexBuffer.UV4Kind
  94856. * - VertexBuffer.UV5Kind
  94857. * - VertexBuffer.UV6Kind
  94858. * - VertexBuffer.ColorKind
  94859. * - VertexBuffer.MatricesIndicesKind
  94860. * - VertexBuffer.MatricesIndicesExtraKind
  94861. * - VertexBuffer.MatricesWeightsKind
  94862. * - VertexBuffer.MatricesWeightsExtraKind
  94863. *
  94864. * Returns the Mesh.
  94865. */
  94866. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94867. /**
  94868. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94869. * If the mesh has no geometry, it is simply returned as it is.
  94870. * The `data` are either a numeric array either a Float32Array.
  94871. * No new underlying VertexBuffer object is created.
  94872. * 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.
  94873. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  94874. *
  94875. * Possible `kind` values :
  94876. * - VertexBuffer.PositionKind
  94877. * - VertexBuffer.UVKind
  94878. * - VertexBuffer.UV2Kind
  94879. * - VertexBuffer.UV3Kind
  94880. * - VertexBuffer.UV4Kind
  94881. * - VertexBuffer.UV5Kind
  94882. * - VertexBuffer.UV6Kind
  94883. * - VertexBuffer.ColorKind
  94884. * - VertexBuffer.MatricesIndicesKind
  94885. * - VertexBuffer.MatricesIndicesExtraKind
  94886. * - VertexBuffer.MatricesWeightsKind
  94887. * - VertexBuffer.MatricesWeightsExtraKind
  94888. *
  94889. * Returns the Mesh.
  94890. */
  94891. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  94892. /**
  94893. * Sets the mesh indices.
  94894. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  94895. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94896. * This method creates a new index buffer each call.
  94897. * Returns the Mesh.
  94898. */
  94899. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  94900. /**
  94901. * Boolean : True if the mesh owns the requested kind of data.
  94902. */
  94903. isVerticesDataPresent(kind: string): boolean;
  94904. /**
  94905. * Returns an array of indices (IndicesArray).
  94906. */
  94907. getIndices(): Nullable<IndicesArray>;
  94908. get _positions(): Nullable<Vector3[]>;
  94909. /**
  94910. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  94911. * This means the mesh underlying bounding box and sphere are recomputed.
  94912. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  94913. * @returns the current mesh
  94914. */
  94915. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  94916. /** @hidden */
  94917. _preActivate(): InstancedMesh;
  94918. /** @hidden */
  94919. _activate(renderId: number, intermediateRendering: boolean): boolean;
  94920. /** @hidden */
  94921. _postActivate(): void;
  94922. getWorldMatrix(): Matrix;
  94923. get isAnInstance(): boolean;
  94924. /**
  94925. * Returns the current associated LOD AbstractMesh.
  94926. */
  94927. getLOD(camera: Camera): AbstractMesh;
  94928. /** @hidden */
  94929. _preActivateForIntermediateRendering(renderId: number): Mesh;
  94930. /** @hidden */
  94931. _syncSubMeshes(): InstancedMesh;
  94932. /** @hidden */
  94933. _generatePointsArray(): boolean;
  94934. /**
  94935. * Creates a new InstancedMesh from the current mesh.
  94936. * - name (string) : the cloned mesh name
  94937. * - newParent (optional Node) : the optional Node to parent the clone to.
  94938. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  94939. *
  94940. * Returns the clone.
  94941. */
  94942. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  94943. /**
  94944. * Disposes the InstancedMesh.
  94945. * Returns nothing.
  94946. */
  94947. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94948. }
  94949. interface Mesh {
  94950. /**
  94951. * Register a custom buffer that will be instanced
  94952. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94953. * @param kind defines the buffer kind
  94954. * @param stride defines the stride in floats
  94955. */
  94956. registerInstancedBuffer(kind: string, stride: number): void;
  94957. /**
  94958. * true to use the edge renderer for all instances of this mesh
  94959. */
  94960. edgesShareWithInstances: boolean;
  94961. /** @hidden */
  94962. _userInstancedBuffersStorage: {
  94963. data: {
  94964. [key: string]: Float32Array;
  94965. };
  94966. sizes: {
  94967. [key: string]: number;
  94968. };
  94969. vertexBuffers: {
  94970. [key: string]: Nullable<VertexBuffer>;
  94971. };
  94972. strides: {
  94973. [key: string]: number;
  94974. };
  94975. };
  94976. }
  94977. interface AbstractMesh {
  94978. /**
  94979. * Object used to store instanced buffers defined by user
  94980. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94981. */
  94982. instancedBuffers: {
  94983. [key: string]: any;
  94984. };
  94985. }
  94986. }
  94987. declare module BABYLON {
  94988. /**
  94989. * Defines the options associated with the creation of a shader material.
  94990. */
  94991. export interface IShaderMaterialOptions {
  94992. /**
  94993. * Does the material work in alpha blend mode
  94994. */
  94995. needAlphaBlending: boolean;
  94996. /**
  94997. * Does the material work in alpha test mode
  94998. */
  94999. needAlphaTesting: boolean;
  95000. /**
  95001. * The list of attribute names used in the shader
  95002. */
  95003. attributes: string[];
  95004. /**
  95005. * The list of unifrom names used in the shader
  95006. */
  95007. uniforms: string[];
  95008. /**
  95009. * The list of UBO names used in the shader
  95010. */
  95011. uniformBuffers: string[];
  95012. /**
  95013. * The list of sampler names used in the shader
  95014. */
  95015. samplers: string[];
  95016. /**
  95017. * The list of defines used in the shader
  95018. */
  95019. defines: string[];
  95020. }
  95021. /**
  95022. * 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.
  95023. *
  95024. * This returned material effects how the mesh will look based on the code in the shaders.
  95025. *
  95026. * @see https://doc.babylonjs.com/how_to/shader_material
  95027. */
  95028. export class ShaderMaterial extends Material {
  95029. private _shaderPath;
  95030. private _options;
  95031. private _textures;
  95032. private _textureArrays;
  95033. private _floats;
  95034. private _ints;
  95035. private _floatsArrays;
  95036. private _colors3;
  95037. private _colors3Arrays;
  95038. private _colors4;
  95039. private _colors4Arrays;
  95040. private _vectors2;
  95041. private _vectors3;
  95042. private _vectors4;
  95043. private _matrices;
  95044. private _matrixArrays;
  95045. private _matrices3x3;
  95046. private _matrices2x2;
  95047. private _vectors2Arrays;
  95048. private _vectors3Arrays;
  95049. private _vectors4Arrays;
  95050. private _cachedWorldViewMatrix;
  95051. private _cachedWorldViewProjectionMatrix;
  95052. private _renderId;
  95053. private _multiview;
  95054. private _cachedDefines;
  95055. /** Define the Url to load snippets */
  95056. static SnippetUrl: string;
  95057. /** Snippet ID if the material was created from the snippet server */
  95058. snippetId: string;
  95059. /**
  95060. * Instantiate a new shader material.
  95061. * 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.
  95062. * This returned material effects how the mesh will look based on the code in the shaders.
  95063. * @see https://doc.babylonjs.com/how_to/shader_material
  95064. * @param name Define the name of the material in the scene
  95065. * @param scene Define the scene the material belongs to
  95066. * @param shaderPath Defines the route to the shader code in one of three ways:
  95067. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  95068. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  95069. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  95070. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  95071. * @param options Define the options used to create the shader
  95072. */
  95073. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  95074. /**
  95075. * Gets the shader path used to define the shader code
  95076. * It can be modified to trigger a new compilation
  95077. */
  95078. get shaderPath(): any;
  95079. /**
  95080. * Sets the shader path used to define the shader code
  95081. * It can be modified to trigger a new compilation
  95082. */
  95083. set shaderPath(shaderPath: any);
  95084. /**
  95085. * Gets the options used to compile the shader.
  95086. * They can be modified to trigger a new compilation
  95087. */
  95088. get options(): IShaderMaterialOptions;
  95089. /**
  95090. * Gets the current class name of the material e.g. "ShaderMaterial"
  95091. * Mainly use in serialization.
  95092. * @returns the class name
  95093. */
  95094. getClassName(): string;
  95095. /**
  95096. * Specifies if the material will require alpha blending
  95097. * @returns a boolean specifying if alpha blending is needed
  95098. */
  95099. needAlphaBlending(): boolean;
  95100. /**
  95101. * Specifies if this material should be rendered in alpha test mode
  95102. * @returns a boolean specifying if an alpha test is needed.
  95103. */
  95104. needAlphaTesting(): boolean;
  95105. private _checkUniform;
  95106. /**
  95107. * Set a texture in the shader.
  95108. * @param name Define the name of the uniform samplers as defined in the shader
  95109. * @param texture Define the texture to bind to this sampler
  95110. * @return the material itself allowing "fluent" like uniform updates
  95111. */
  95112. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  95113. /**
  95114. * Set a texture array in the shader.
  95115. * @param name Define the name of the uniform sampler array as defined in the shader
  95116. * @param textures Define the list of textures to bind to this sampler
  95117. * @return the material itself allowing "fluent" like uniform updates
  95118. */
  95119. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  95120. /**
  95121. * Set a float in the shader.
  95122. * @param name Define the name of the uniform as defined in the shader
  95123. * @param value Define the value to give to the uniform
  95124. * @return the material itself allowing "fluent" like uniform updates
  95125. */
  95126. setFloat(name: string, value: number): ShaderMaterial;
  95127. /**
  95128. * Set a int in the shader.
  95129. * @param name Define the name of the uniform as defined in the shader
  95130. * @param value Define the value to give to the uniform
  95131. * @return the material itself allowing "fluent" like uniform updates
  95132. */
  95133. setInt(name: string, value: number): ShaderMaterial;
  95134. /**
  95135. * Set an array of floats in the shader.
  95136. * @param name Define the name of the uniform as defined in the shader
  95137. * @param value Define the value to give to the uniform
  95138. * @return the material itself allowing "fluent" like uniform updates
  95139. */
  95140. setFloats(name: string, value: number[]): ShaderMaterial;
  95141. /**
  95142. * Set a vec3 in the shader from a Color3.
  95143. * @param name Define the name of the uniform as defined in the shader
  95144. * @param value Define the value to give to the uniform
  95145. * @return the material itself allowing "fluent" like uniform updates
  95146. */
  95147. setColor3(name: string, value: Color3): ShaderMaterial;
  95148. /**
  95149. * Set a vec3 array in the shader from a Color3 array.
  95150. * @param name Define the name of the uniform as defined in the shader
  95151. * @param value Define the value to give to the uniform
  95152. * @return the material itself allowing "fluent" like uniform updates
  95153. */
  95154. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  95155. /**
  95156. * Set a vec4 in the shader from a Color4.
  95157. * @param name Define the name of the uniform as defined in the shader
  95158. * @param value Define the value to give to the uniform
  95159. * @return the material itself allowing "fluent" like uniform updates
  95160. */
  95161. setColor4(name: string, value: Color4): ShaderMaterial;
  95162. /**
  95163. * Set a vec4 array in the shader from a Color4 array.
  95164. * @param name Define the name of the uniform as defined in the shader
  95165. * @param value Define the value to give to the uniform
  95166. * @return the material itself allowing "fluent" like uniform updates
  95167. */
  95168. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  95169. /**
  95170. * Set a vec2 in the shader from a Vector2.
  95171. * @param name Define the name of the uniform as defined in the shader
  95172. * @param value Define the value to give to the uniform
  95173. * @return the material itself allowing "fluent" like uniform updates
  95174. */
  95175. setVector2(name: string, value: Vector2): ShaderMaterial;
  95176. /**
  95177. * Set a vec3 in the shader from a Vector3.
  95178. * @param name Define the name of the uniform as defined in the shader
  95179. * @param value Define the value to give to the uniform
  95180. * @return the material itself allowing "fluent" like uniform updates
  95181. */
  95182. setVector3(name: string, value: Vector3): ShaderMaterial;
  95183. /**
  95184. * Set a vec4 in the shader from a Vector4.
  95185. * @param name Define the name of the uniform as defined in the shader
  95186. * @param value Define the value to give to the uniform
  95187. * @return the material itself allowing "fluent" like uniform updates
  95188. */
  95189. setVector4(name: string, value: Vector4): ShaderMaterial;
  95190. /**
  95191. * Set a mat4 in the shader from a Matrix.
  95192. * @param name Define the name of the uniform as defined in the shader
  95193. * @param value Define the value to give to the uniform
  95194. * @return the material itself allowing "fluent" like uniform updates
  95195. */
  95196. setMatrix(name: string, value: Matrix): ShaderMaterial;
  95197. /**
  95198. * Set a float32Array in the shader from a matrix array.
  95199. * @param name Define the name of the uniform as defined in the shader
  95200. * @param value Define the value to give to the uniform
  95201. * @return the material itself allowing "fluent" like uniform updates
  95202. */
  95203. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  95204. /**
  95205. * Set a mat3 in the shader from a Float32Array.
  95206. * @param name Define the name of the uniform as defined in the shader
  95207. * @param value Define the value to give to the uniform
  95208. * @return the material itself allowing "fluent" like uniform updates
  95209. */
  95210. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95211. /**
  95212. * Set a mat2 in the shader from a Float32Array.
  95213. * @param name Define the name of the uniform as defined in the shader
  95214. * @param value Define the value to give to the uniform
  95215. * @return the material itself allowing "fluent" like uniform updates
  95216. */
  95217. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95218. /**
  95219. * Set a vec2 array in the shader from a number array.
  95220. * @param name Define the name of the uniform as defined in the shader
  95221. * @param value Define the value to give to the uniform
  95222. * @return the material itself allowing "fluent" like uniform updates
  95223. */
  95224. setArray2(name: string, value: number[]): ShaderMaterial;
  95225. /**
  95226. * Set a vec3 array in the shader from a number array.
  95227. * @param name Define the name of the uniform as defined in the shader
  95228. * @param value Define the value to give to the uniform
  95229. * @return the material itself allowing "fluent" like uniform updates
  95230. */
  95231. setArray3(name: string, value: number[]): ShaderMaterial;
  95232. /**
  95233. * Set a vec4 array in the shader from a number array.
  95234. * @param name Define the name of the uniform as defined in the shader
  95235. * @param value Define the value to give to the uniform
  95236. * @return the material itself allowing "fluent" like uniform updates
  95237. */
  95238. setArray4(name: string, value: number[]): ShaderMaterial;
  95239. private _checkCache;
  95240. /**
  95241. * Specifies that the submesh is ready to be used
  95242. * @param mesh defines the mesh to check
  95243. * @param subMesh defines which submesh to check
  95244. * @param useInstances specifies that instances should be used
  95245. * @returns a boolean indicating that the submesh is ready or not
  95246. */
  95247. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  95248. /**
  95249. * Checks if the material is ready to render the requested mesh
  95250. * @param mesh Define the mesh to render
  95251. * @param useInstances Define whether or not the material is used with instances
  95252. * @returns true if ready, otherwise false
  95253. */
  95254. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  95255. /**
  95256. * Binds the world matrix to the material
  95257. * @param world defines the world transformation matrix
  95258. * @param effectOverride - If provided, use this effect instead of internal effect
  95259. */
  95260. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  95261. /**
  95262. * Binds the submesh to this material by preparing the effect and shader to draw
  95263. * @param world defines the world transformation matrix
  95264. * @param mesh defines the mesh containing the submesh
  95265. * @param subMesh defines the submesh to bind the material to
  95266. */
  95267. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  95268. /**
  95269. * Binds the material to the mesh
  95270. * @param world defines the world transformation matrix
  95271. * @param mesh defines the mesh to bind the material to
  95272. * @param effectOverride - If provided, use this effect instead of internal effect
  95273. */
  95274. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  95275. protected _afterBind(mesh?: Mesh): void;
  95276. /**
  95277. * Gets the active textures from the material
  95278. * @returns an array of textures
  95279. */
  95280. getActiveTextures(): BaseTexture[];
  95281. /**
  95282. * Specifies if the material uses a texture
  95283. * @param texture defines the texture to check against the material
  95284. * @returns a boolean specifying if the material uses the texture
  95285. */
  95286. hasTexture(texture: BaseTexture): boolean;
  95287. /**
  95288. * Makes a duplicate of the material, and gives it a new name
  95289. * @param name defines the new name for the duplicated material
  95290. * @returns the cloned material
  95291. */
  95292. clone(name: string): ShaderMaterial;
  95293. /**
  95294. * Disposes the material
  95295. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  95296. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  95297. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  95298. */
  95299. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  95300. /**
  95301. * Serializes this material in a JSON representation
  95302. * @returns the serialized material object
  95303. */
  95304. serialize(): any;
  95305. /**
  95306. * Creates a shader material from parsed shader material data
  95307. * @param source defines the JSON represnetation of the material
  95308. * @param scene defines the hosting scene
  95309. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95310. * @returns a new material
  95311. */
  95312. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  95313. /**
  95314. * Creates a new ShaderMaterial from a snippet saved in a remote file
  95315. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  95316. * @param url defines the url to load from
  95317. * @param scene defines the hosting scene
  95318. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95319. * @returns a promise that will resolve to the new ShaderMaterial
  95320. */
  95321. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  95322. /**
  95323. * Creates a ShaderMaterial from a snippet saved by the Inspector
  95324. * @param snippetId defines the snippet to load
  95325. * @param scene defines the hosting scene
  95326. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95327. * @returns a promise that will resolve to the new ShaderMaterial
  95328. */
  95329. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  95330. }
  95331. }
  95332. declare module BABYLON {
  95333. /** @hidden */
  95334. export var colorPixelShader: {
  95335. name: string;
  95336. shader: string;
  95337. };
  95338. }
  95339. declare module BABYLON {
  95340. /** @hidden */
  95341. export var colorVertexShader: {
  95342. name: string;
  95343. shader: string;
  95344. };
  95345. }
  95346. declare module BABYLON {
  95347. /**
  95348. * Line mesh
  95349. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  95350. */
  95351. export class LinesMesh extends Mesh {
  95352. /**
  95353. * If vertex color should be applied to the mesh
  95354. */
  95355. readonly useVertexColor?: boolean | undefined;
  95356. /**
  95357. * If vertex alpha should be applied to the mesh
  95358. */
  95359. readonly useVertexAlpha?: boolean | undefined;
  95360. /**
  95361. * Color of the line (Default: White)
  95362. */
  95363. color: Color3;
  95364. /**
  95365. * Alpha of the line (Default: 1)
  95366. */
  95367. alpha: number;
  95368. /**
  95369. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  95370. * This margin is expressed in world space coordinates, so its value may vary.
  95371. * Default value is 0.1
  95372. */
  95373. intersectionThreshold: number;
  95374. private _colorShader;
  95375. private color4;
  95376. /**
  95377. * Creates a new LinesMesh
  95378. * @param name defines the name
  95379. * @param scene defines the hosting scene
  95380. * @param parent defines the parent mesh if any
  95381. * @param source defines the optional source LinesMesh used to clone data from
  95382. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  95383. * When false, achieved by calling a clone(), also passing False.
  95384. * This will make creation of children, recursive.
  95385. * @param useVertexColor defines if this LinesMesh supports vertex color
  95386. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  95387. */
  95388. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  95389. /**
  95390. * If vertex color should be applied to the mesh
  95391. */
  95392. useVertexColor?: boolean | undefined,
  95393. /**
  95394. * If vertex alpha should be applied to the mesh
  95395. */
  95396. useVertexAlpha?: boolean | undefined);
  95397. private _addClipPlaneDefine;
  95398. private _removeClipPlaneDefine;
  95399. isReady(): boolean;
  95400. /**
  95401. * Returns the string "LineMesh"
  95402. */
  95403. getClassName(): string;
  95404. /**
  95405. * @hidden
  95406. */
  95407. get material(): Material;
  95408. /**
  95409. * @hidden
  95410. */
  95411. set material(value: Material);
  95412. /**
  95413. * @hidden
  95414. */
  95415. get checkCollisions(): boolean;
  95416. /** @hidden */
  95417. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  95418. /** @hidden */
  95419. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  95420. /**
  95421. * Disposes of the line mesh
  95422. * @param doNotRecurse If children should be disposed
  95423. */
  95424. dispose(doNotRecurse?: boolean): void;
  95425. /**
  95426. * Returns a new LineMesh object cloned from the current one.
  95427. */
  95428. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  95429. /**
  95430. * Creates a new InstancedLinesMesh object from the mesh model.
  95431. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95432. * @param name defines the name of the new instance
  95433. * @returns a new InstancedLinesMesh
  95434. */
  95435. createInstance(name: string): InstancedLinesMesh;
  95436. }
  95437. /**
  95438. * Creates an instance based on a source LinesMesh
  95439. */
  95440. export class InstancedLinesMesh extends InstancedMesh {
  95441. /**
  95442. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  95443. * This margin is expressed in world space coordinates, so its value may vary.
  95444. * Initilized with the intersectionThreshold value of the source LinesMesh
  95445. */
  95446. intersectionThreshold: number;
  95447. constructor(name: string, source: LinesMesh);
  95448. /**
  95449. * Returns the string "InstancedLinesMesh".
  95450. */
  95451. getClassName(): string;
  95452. }
  95453. }
  95454. declare module BABYLON {
  95455. /** @hidden */
  95456. export var linePixelShader: {
  95457. name: string;
  95458. shader: string;
  95459. };
  95460. }
  95461. declare module BABYLON {
  95462. /** @hidden */
  95463. export var lineVertexShader: {
  95464. name: string;
  95465. shader: string;
  95466. };
  95467. }
  95468. declare module BABYLON {
  95469. interface Scene {
  95470. /** @hidden */
  95471. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  95472. }
  95473. interface AbstractMesh {
  95474. /**
  95475. * Gets the edgesRenderer associated with the mesh
  95476. */
  95477. edgesRenderer: Nullable<EdgesRenderer>;
  95478. }
  95479. interface LinesMesh {
  95480. /**
  95481. * Enables the edge rendering mode on the mesh.
  95482. * This mode makes the mesh edges visible
  95483. * @param epsilon defines the maximal distance between two angles to detect a face
  95484. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95485. * @returns the currentAbstractMesh
  95486. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95487. */
  95488. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  95489. }
  95490. interface InstancedLinesMesh {
  95491. /**
  95492. * Enables the edge rendering mode on the mesh.
  95493. * This mode makes the mesh edges visible
  95494. * @param epsilon defines the maximal distance between two angles to detect a face
  95495. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95496. * @returns the current InstancedLinesMesh
  95497. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95498. */
  95499. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  95500. }
  95501. /**
  95502. * Defines the minimum contract an Edges renderer should follow.
  95503. */
  95504. export interface IEdgesRenderer extends IDisposable {
  95505. /**
  95506. * Gets or sets a boolean indicating if the edgesRenderer is active
  95507. */
  95508. isEnabled: boolean;
  95509. /**
  95510. * Renders the edges of the attached mesh,
  95511. */
  95512. render(): void;
  95513. /**
  95514. * Checks wether or not the edges renderer is ready to render.
  95515. * @return true if ready, otherwise false.
  95516. */
  95517. isReady(): boolean;
  95518. /**
  95519. * List of instances to render in case the source mesh has instances
  95520. */
  95521. customInstances: SmartArray<Matrix>;
  95522. }
  95523. /**
  95524. * Defines the additional options of the edges renderer
  95525. */
  95526. export interface IEdgesRendererOptions {
  95527. /**
  95528. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  95529. * If not defined, the default value is true
  95530. */
  95531. useAlternateEdgeFinder?: boolean;
  95532. /**
  95533. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  95534. * If not defined, the default value is true.
  95535. * 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)
  95536. * This option is used only if useAlternateEdgeFinder = true
  95537. */
  95538. useFastVertexMerger?: boolean;
  95539. /**
  95540. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  95541. * The default value is 1e-6
  95542. * This option is used only if useAlternateEdgeFinder = true
  95543. */
  95544. epsilonVertexMerge?: number;
  95545. /**
  95546. * 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
  95547. * 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.
  95548. * This option is used only if useAlternateEdgeFinder = true
  95549. */
  95550. applyTessellation?: boolean;
  95551. /**
  95552. * 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
  95553. * The default value is 1e-6
  95554. * This option is used only if useAlternateEdgeFinder = true
  95555. */
  95556. epsilonVertexAligned?: number;
  95557. }
  95558. /**
  95559. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  95560. */
  95561. export class EdgesRenderer implements IEdgesRenderer {
  95562. /**
  95563. * Define the size of the edges with an orthographic camera
  95564. */
  95565. edgesWidthScalerForOrthographic: number;
  95566. /**
  95567. * Define the size of the edges with a perspective camera
  95568. */
  95569. edgesWidthScalerForPerspective: number;
  95570. protected _source: AbstractMesh;
  95571. protected _linesPositions: number[];
  95572. protected _linesNormals: number[];
  95573. protected _linesIndices: number[];
  95574. protected _epsilon: number;
  95575. protected _indicesCount: number;
  95576. protected _lineShader: ShaderMaterial;
  95577. protected _ib: DataBuffer;
  95578. protected _buffers: {
  95579. [key: string]: Nullable<VertexBuffer>;
  95580. };
  95581. protected _buffersForInstances: {
  95582. [key: string]: Nullable<VertexBuffer>;
  95583. };
  95584. protected _checkVerticesInsteadOfIndices: boolean;
  95585. protected _options: Nullable<IEdgesRendererOptions>;
  95586. private _meshRebuildObserver;
  95587. private _meshDisposeObserver;
  95588. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  95589. isEnabled: boolean;
  95590. /**
  95591. * List of instances to render in case the source mesh has instances
  95592. */
  95593. customInstances: SmartArray<Matrix>;
  95594. private static GetShader;
  95595. /**
  95596. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  95597. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  95598. * @param source Mesh used to create edges
  95599. * @param epsilon sum of angles in adjacency to check for edge
  95600. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  95601. * @param generateEdgesLines - should generate Lines or only prepare resources.
  95602. * @param options The options to apply when generating the edges
  95603. */
  95604. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  95605. protected _prepareRessources(): void;
  95606. /** @hidden */
  95607. _rebuild(): void;
  95608. /**
  95609. * Releases the required resources for the edges renderer
  95610. */
  95611. dispose(): void;
  95612. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  95613. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  95614. /**
  95615. * Checks if the pair of p0 and p1 is en edge
  95616. * @param faceIndex
  95617. * @param edge
  95618. * @param faceNormals
  95619. * @param p0
  95620. * @param p1
  95621. * @private
  95622. */
  95623. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  95624. /**
  95625. * push line into the position, normal and index buffer
  95626. * @protected
  95627. */
  95628. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  95629. /**
  95630. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  95631. */
  95632. private _tessellateTriangle;
  95633. private _generateEdgesLinesAlternate;
  95634. /**
  95635. * Generates lines edges from adjacencjes
  95636. * @private
  95637. */
  95638. _generateEdgesLines(): void;
  95639. /**
  95640. * Checks wether or not the edges renderer is ready to render.
  95641. * @return true if ready, otherwise false.
  95642. */
  95643. isReady(): boolean;
  95644. /**
  95645. * Renders the edges of the attached mesh,
  95646. */
  95647. render(): void;
  95648. }
  95649. /**
  95650. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  95651. */
  95652. export class LineEdgesRenderer extends EdgesRenderer {
  95653. /**
  95654. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  95655. * @param source LineMesh used to generate edges
  95656. * @param epsilon not important (specified angle for edge detection)
  95657. * @param checkVerticesInsteadOfIndices not important for LineMesh
  95658. */
  95659. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  95660. /**
  95661. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  95662. */
  95663. _generateEdgesLines(): void;
  95664. }
  95665. }
  95666. declare module BABYLON {
  95667. /**
  95668. * This represents the object necessary to create a rendering group.
  95669. * This is exclusively used and created by the rendering manager.
  95670. * To modify the behavior, you use the available helpers in your scene or meshes.
  95671. * @hidden
  95672. */
  95673. export class RenderingGroup {
  95674. index: number;
  95675. private static _zeroVector;
  95676. private _scene;
  95677. private _opaqueSubMeshes;
  95678. private _transparentSubMeshes;
  95679. private _alphaTestSubMeshes;
  95680. private _depthOnlySubMeshes;
  95681. private _particleSystems;
  95682. private _spriteManagers;
  95683. private _opaqueSortCompareFn;
  95684. private _alphaTestSortCompareFn;
  95685. private _transparentSortCompareFn;
  95686. private _renderOpaque;
  95687. private _renderAlphaTest;
  95688. private _renderTransparent;
  95689. /** @hidden */
  95690. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  95691. onBeforeTransparentRendering: () => void;
  95692. /**
  95693. * Set the opaque sort comparison function.
  95694. * If null the sub meshes will be render in the order they were created
  95695. */
  95696. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95697. /**
  95698. * Set the alpha test sort comparison function.
  95699. * If null the sub meshes will be render in the order they were created
  95700. */
  95701. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95702. /**
  95703. * Set the transparent sort comparison function.
  95704. * If null the sub meshes will be render in the order they were created
  95705. */
  95706. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95707. /**
  95708. * Creates a new rendering group.
  95709. * @param index The rendering group index
  95710. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  95711. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  95712. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  95713. */
  95714. 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>);
  95715. /**
  95716. * Render all the sub meshes contained in the group.
  95717. * @param customRenderFunction Used to override the default render behaviour of the group.
  95718. * @returns true if rendered some submeshes.
  95719. */
  95720. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  95721. /**
  95722. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  95723. * @param subMeshes The submeshes to render
  95724. */
  95725. private renderOpaqueSorted;
  95726. /**
  95727. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  95728. * @param subMeshes The submeshes to render
  95729. */
  95730. private renderAlphaTestSorted;
  95731. /**
  95732. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  95733. * @param subMeshes The submeshes to render
  95734. */
  95735. private renderTransparentSorted;
  95736. /**
  95737. * Renders the submeshes in a specified order.
  95738. * @param subMeshes The submeshes to sort before render
  95739. * @param sortCompareFn The comparison function use to sort
  95740. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  95741. * @param transparent Specifies to activate blending if true
  95742. */
  95743. private static renderSorted;
  95744. /**
  95745. * Renders the submeshes in the order they were dispatched (no sort applied).
  95746. * @param subMeshes The submeshes to render
  95747. */
  95748. private static renderUnsorted;
  95749. /**
  95750. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95751. * are rendered back to front if in the same alpha index.
  95752. *
  95753. * @param a The first submesh
  95754. * @param b The second submesh
  95755. * @returns The result of the comparison
  95756. */
  95757. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  95758. /**
  95759. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95760. * are rendered back to front.
  95761. *
  95762. * @param a The first submesh
  95763. * @param b The second submesh
  95764. * @returns The result of the comparison
  95765. */
  95766. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  95767. /**
  95768. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95769. * are rendered front to back (prevent overdraw).
  95770. *
  95771. * @param a The first submesh
  95772. * @param b The second submesh
  95773. * @returns The result of the comparison
  95774. */
  95775. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  95776. /**
  95777. * Resets the different lists of submeshes to prepare a new frame.
  95778. */
  95779. prepare(): void;
  95780. dispose(): void;
  95781. /**
  95782. * Inserts the submesh in its correct queue depending on its material.
  95783. * @param subMesh The submesh to dispatch
  95784. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  95785. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  95786. */
  95787. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  95788. dispatchSprites(spriteManager: ISpriteManager): void;
  95789. dispatchParticles(particleSystem: IParticleSystem): void;
  95790. private _renderParticles;
  95791. private _renderSprites;
  95792. }
  95793. }
  95794. declare module BABYLON {
  95795. /**
  95796. * Interface describing the different options available in the rendering manager
  95797. * regarding Auto Clear between groups.
  95798. */
  95799. export interface IRenderingManagerAutoClearSetup {
  95800. /**
  95801. * Defines whether or not autoclear is enable.
  95802. */
  95803. autoClear: boolean;
  95804. /**
  95805. * Defines whether or not to autoclear the depth buffer.
  95806. */
  95807. depth: boolean;
  95808. /**
  95809. * Defines whether or not to autoclear the stencil buffer.
  95810. */
  95811. stencil: boolean;
  95812. }
  95813. /**
  95814. * This class is used by the onRenderingGroupObservable
  95815. */
  95816. export class RenderingGroupInfo {
  95817. /**
  95818. * The Scene that being rendered
  95819. */
  95820. scene: Scene;
  95821. /**
  95822. * The camera currently used for the rendering pass
  95823. */
  95824. camera: Nullable<Camera>;
  95825. /**
  95826. * The ID of the renderingGroup being processed
  95827. */
  95828. renderingGroupId: number;
  95829. }
  95830. /**
  95831. * This is the manager responsible of all the rendering for meshes sprites and particles.
  95832. * It is enable to manage the different groups as well as the different necessary sort functions.
  95833. * This should not be used directly aside of the few static configurations
  95834. */
  95835. export class RenderingManager {
  95836. /**
  95837. * The max id used for rendering groups (not included)
  95838. */
  95839. static MAX_RENDERINGGROUPS: number;
  95840. /**
  95841. * The min id used for rendering groups (included)
  95842. */
  95843. static MIN_RENDERINGGROUPS: number;
  95844. /**
  95845. * Used to globally prevent autoclearing scenes.
  95846. */
  95847. static AUTOCLEAR: boolean;
  95848. /**
  95849. * @hidden
  95850. */
  95851. _useSceneAutoClearSetup: boolean;
  95852. private _scene;
  95853. private _renderingGroups;
  95854. private _depthStencilBufferAlreadyCleaned;
  95855. private _autoClearDepthStencil;
  95856. private _customOpaqueSortCompareFn;
  95857. private _customAlphaTestSortCompareFn;
  95858. private _customTransparentSortCompareFn;
  95859. private _renderingGroupInfo;
  95860. /**
  95861. * Instantiates a new rendering group for a particular scene
  95862. * @param scene Defines the scene the groups belongs to
  95863. */
  95864. constructor(scene: Scene);
  95865. private _clearDepthStencilBuffer;
  95866. /**
  95867. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  95868. * @hidden
  95869. */
  95870. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  95871. /**
  95872. * Resets the different information of the group to prepare a new frame
  95873. * @hidden
  95874. */
  95875. reset(): void;
  95876. /**
  95877. * Dispose and release the group and its associated resources.
  95878. * @hidden
  95879. */
  95880. dispose(): void;
  95881. /**
  95882. * Clear the info related to rendering groups preventing retention points during dispose.
  95883. */
  95884. freeRenderingGroups(): void;
  95885. private _prepareRenderingGroup;
  95886. /**
  95887. * Add a sprite manager to the rendering manager in order to render it this frame.
  95888. * @param spriteManager Define the sprite manager to render
  95889. */
  95890. dispatchSprites(spriteManager: ISpriteManager): void;
  95891. /**
  95892. * Add a particle system to the rendering manager in order to render it this frame.
  95893. * @param particleSystem Define the particle system to render
  95894. */
  95895. dispatchParticles(particleSystem: IParticleSystem): void;
  95896. /**
  95897. * Add a submesh to the manager in order to render it this frame
  95898. * @param subMesh The submesh to dispatch
  95899. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  95900. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  95901. */
  95902. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  95903. /**
  95904. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  95905. * This allowed control for front to back rendering or reversly depending of the special needs.
  95906. *
  95907. * @param renderingGroupId The rendering group id corresponding to its index
  95908. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  95909. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  95910. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  95911. */
  95912. 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;
  95913. /**
  95914. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  95915. *
  95916. * @param renderingGroupId The rendering group id corresponding to its index
  95917. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  95918. * @param depth Automatically clears depth between groups if true and autoClear is true.
  95919. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  95920. */
  95921. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  95922. /**
  95923. * Gets the current auto clear configuration for one rendering group of the rendering
  95924. * manager.
  95925. * @param index the rendering group index to get the information for
  95926. * @returns The auto clear setup for the requested rendering group
  95927. */
  95928. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  95929. }
  95930. }
  95931. declare module BABYLON {
  95932. /**
  95933. * Defines the options associated with the creation of a custom shader for a shadow generator.
  95934. */
  95935. export interface ICustomShaderOptions {
  95936. /**
  95937. * Gets or sets the custom shader name to use
  95938. */
  95939. shaderName: string;
  95940. /**
  95941. * The list of attribute names used in the shader
  95942. */
  95943. attributes?: string[];
  95944. /**
  95945. * The list of unifrom names used in the shader
  95946. */
  95947. uniforms?: string[];
  95948. /**
  95949. * The list of sampler names used in the shader
  95950. */
  95951. samplers?: string[];
  95952. /**
  95953. * The list of defines used in the shader
  95954. */
  95955. defines?: string[];
  95956. }
  95957. /**
  95958. * Interface to implement to create a shadow generator compatible with BJS.
  95959. */
  95960. export interface IShadowGenerator {
  95961. /**
  95962. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  95963. * @returns The render target texture if present otherwise, null
  95964. */
  95965. getShadowMap(): Nullable<RenderTargetTexture>;
  95966. /**
  95967. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  95968. * @param subMesh The submesh we want to render in the shadow map
  95969. * @param useInstances Defines wether will draw in the map using instances
  95970. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  95971. * @returns true if ready otherwise, false
  95972. */
  95973. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  95974. /**
  95975. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  95976. * @param defines Defines of the material we want to update
  95977. * @param lightIndex Index of the light in the enabled light list of the material
  95978. */
  95979. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  95980. /**
  95981. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  95982. * defined in the generator but impacting the effect).
  95983. * It implies the unifroms available on the materials are the standard BJS ones.
  95984. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  95985. * @param effect The effect we are binfing the information for
  95986. */
  95987. bindShadowLight(lightIndex: string, effect: Effect): void;
  95988. /**
  95989. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  95990. * (eq to shadow prjection matrix * light transform matrix)
  95991. * @returns The transform matrix used to create the shadow map
  95992. */
  95993. getTransformMatrix(): Matrix;
  95994. /**
  95995. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  95996. * Cube and 2D textures for instance.
  95997. */
  95998. recreateShadowMap(): void;
  95999. /**
  96000. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96001. * @param onCompiled Callback triggered at the and of the effects compilation
  96002. * @param options Sets of optional options forcing the compilation with different modes
  96003. */
  96004. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  96005. useInstances: boolean;
  96006. }>): void;
  96007. /**
  96008. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96009. * @param options Sets of optional options forcing the compilation with different modes
  96010. * @returns A promise that resolves when the compilation completes
  96011. */
  96012. forceCompilationAsync(options?: Partial<{
  96013. useInstances: boolean;
  96014. }>): Promise<void>;
  96015. /**
  96016. * Serializes the shadow generator setup to a json object.
  96017. * @returns The serialized JSON object
  96018. */
  96019. serialize(): any;
  96020. /**
  96021. * Disposes the Shadow map and related Textures and effects.
  96022. */
  96023. dispose(): void;
  96024. }
  96025. /**
  96026. * Default implementation IShadowGenerator.
  96027. * This is the main object responsible of generating shadows in the framework.
  96028. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  96029. */
  96030. export class ShadowGenerator implements IShadowGenerator {
  96031. /**
  96032. * Name of the shadow generator class
  96033. */
  96034. static CLASSNAME: string;
  96035. /**
  96036. * Shadow generator mode None: no filtering applied.
  96037. */
  96038. static readonly FILTER_NONE: number;
  96039. /**
  96040. * Shadow generator mode ESM: Exponential Shadow Mapping.
  96041. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96042. */
  96043. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  96044. /**
  96045. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  96046. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  96047. */
  96048. static readonly FILTER_POISSONSAMPLING: number;
  96049. /**
  96050. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  96051. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96052. */
  96053. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  96054. /**
  96055. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  96056. * edge artifacts on steep falloff.
  96057. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96058. */
  96059. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  96060. /**
  96061. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  96062. * edge artifacts on steep falloff.
  96063. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96064. */
  96065. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  96066. /**
  96067. * Shadow generator mode PCF: Percentage Closer Filtering
  96068. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96069. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  96070. */
  96071. static readonly FILTER_PCF: number;
  96072. /**
  96073. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  96074. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96075. * Contact Hardening
  96076. */
  96077. static readonly FILTER_PCSS: number;
  96078. /**
  96079. * Reserved for PCF and PCSS
  96080. * Highest Quality.
  96081. *
  96082. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  96083. *
  96084. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  96085. */
  96086. static readonly QUALITY_HIGH: number;
  96087. /**
  96088. * Reserved for PCF and PCSS
  96089. * Good tradeoff for quality/perf cross devices
  96090. *
  96091. * Execute PCF on a 3*3 kernel.
  96092. *
  96093. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  96094. */
  96095. static readonly QUALITY_MEDIUM: number;
  96096. /**
  96097. * Reserved for PCF and PCSS
  96098. * The lowest quality but the fastest.
  96099. *
  96100. * Execute PCF on a 1*1 kernel.
  96101. *
  96102. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  96103. */
  96104. static readonly QUALITY_LOW: number;
  96105. /** Gets or sets the custom shader name to use */
  96106. customShaderOptions: ICustomShaderOptions;
  96107. /**
  96108. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  96109. */
  96110. onBeforeShadowMapRenderObservable: Observable<Effect>;
  96111. /**
  96112. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  96113. */
  96114. onAfterShadowMapRenderObservable: Observable<Effect>;
  96115. /**
  96116. * Observable triggered before a mesh is rendered in the shadow map.
  96117. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  96118. */
  96119. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  96120. /**
  96121. * Observable triggered after a mesh is rendered in the shadow map.
  96122. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  96123. */
  96124. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  96125. protected _bias: number;
  96126. /**
  96127. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  96128. */
  96129. get bias(): number;
  96130. /**
  96131. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  96132. */
  96133. set bias(bias: number);
  96134. protected _normalBias: number;
  96135. /**
  96136. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96137. */
  96138. get normalBias(): number;
  96139. /**
  96140. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96141. */
  96142. set normalBias(normalBias: number);
  96143. protected _blurBoxOffset: number;
  96144. /**
  96145. * Gets the blur box offset: offset applied during the blur pass.
  96146. * Only useful if useKernelBlur = false
  96147. */
  96148. get blurBoxOffset(): number;
  96149. /**
  96150. * Sets the blur box offset: offset applied during the blur pass.
  96151. * Only useful if useKernelBlur = false
  96152. */
  96153. set blurBoxOffset(value: number);
  96154. protected _blurScale: number;
  96155. /**
  96156. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  96157. * 2 means half of the size.
  96158. */
  96159. get blurScale(): number;
  96160. /**
  96161. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  96162. * 2 means half of the size.
  96163. */
  96164. set blurScale(value: number);
  96165. protected _blurKernel: number;
  96166. /**
  96167. * Gets the blur kernel: kernel size of the blur pass.
  96168. * Only useful if useKernelBlur = true
  96169. */
  96170. get blurKernel(): number;
  96171. /**
  96172. * Sets the blur kernel: kernel size of the blur pass.
  96173. * Only useful if useKernelBlur = true
  96174. */
  96175. set blurKernel(value: number);
  96176. protected _useKernelBlur: boolean;
  96177. /**
  96178. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  96179. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  96180. */
  96181. get useKernelBlur(): boolean;
  96182. /**
  96183. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  96184. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  96185. */
  96186. set useKernelBlur(value: boolean);
  96187. protected _depthScale: number;
  96188. /**
  96189. * Gets the depth scale used in ESM mode.
  96190. */
  96191. get depthScale(): number;
  96192. /**
  96193. * Sets the depth scale used in ESM mode.
  96194. * This can override the scale stored on the light.
  96195. */
  96196. set depthScale(value: number);
  96197. protected _validateFilter(filter: number): number;
  96198. protected _filter: number;
  96199. /**
  96200. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  96201. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  96202. */
  96203. get filter(): number;
  96204. /**
  96205. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  96206. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  96207. */
  96208. set filter(value: number);
  96209. /**
  96210. * Gets if the current filter is set to Poisson Sampling.
  96211. */
  96212. get usePoissonSampling(): boolean;
  96213. /**
  96214. * Sets the current filter to Poisson Sampling.
  96215. */
  96216. set usePoissonSampling(value: boolean);
  96217. /**
  96218. * Gets if the current filter is set to ESM.
  96219. */
  96220. get useExponentialShadowMap(): boolean;
  96221. /**
  96222. * Sets the current filter is to ESM.
  96223. */
  96224. set useExponentialShadowMap(value: boolean);
  96225. /**
  96226. * Gets if the current filter is set to filtered ESM.
  96227. */
  96228. get useBlurExponentialShadowMap(): boolean;
  96229. /**
  96230. * Gets if the current filter is set to filtered ESM.
  96231. */
  96232. set useBlurExponentialShadowMap(value: boolean);
  96233. /**
  96234. * Gets if the current filter is set to "close ESM" (using the inverse of the
  96235. * exponential to prevent steep falloff artifacts).
  96236. */
  96237. get useCloseExponentialShadowMap(): boolean;
  96238. /**
  96239. * Sets the current filter to "close ESM" (using the inverse of the
  96240. * exponential to prevent steep falloff artifacts).
  96241. */
  96242. set useCloseExponentialShadowMap(value: boolean);
  96243. /**
  96244. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  96245. * exponential to prevent steep falloff artifacts).
  96246. */
  96247. get useBlurCloseExponentialShadowMap(): boolean;
  96248. /**
  96249. * Sets the current filter to filtered "close ESM" (using the inverse of the
  96250. * exponential to prevent steep falloff artifacts).
  96251. */
  96252. set useBlurCloseExponentialShadowMap(value: boolean);
  96253. /**
  96254. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  96255. */
  96256. get usePercentageCloserFiltering(): boolean;
  96257. /**
  96258. * Sets the current filter to "PCF" (percentage closer filtering).
  96259. */
  96260. set usePercentageCloserFiltering(value: boolean);
  96261. protected _filteringQuality: number;
  96262. /**
  96263. * Gets the PCF or PCSS Quality.
  96264. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  96265. */
  96266. get filteringQuality(): number;
  96267. /**
  96268. * Sets the PCF or PCSS Quality.
  96269. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  96270. */
  96271. set filteringQuality(filteringQuality: number);
  96272. /**
  96273. * Gets if the current filter is set to "PCSS" (contact hardening).
  96274. */
  96275. get useContactHardeningShadow(): boolean;
  96276. /**
  96277. * Sets the current filter to "PCSS" (contact hardening).
  96278. */
  96279. set useContactHardeningShadow(value: boolean);
  96280. protected _contactHardeningLightSizeUVRatio: number;
  96281. /**
  96282. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  96283. * Using a ratio helps keeping shape stability independently of the map size.
  96284. *
  96285. * It does not account for the light projection as it was having too much
  96286. * instability during the light setup or during light position changes.
  96287. *
  96288. * Only valid if useContactHardeningShadow is true.
  96289. */
  96290. get contactHardeningLightSizeUVRatio(): number;
  96291. /**
  96292. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  96293. * Using a ratio helps keeping shape stability independently of the map size.
  96294. *
  96295. * It does not account for the light projection as it was having too much
  96296. * instability during the light setup or during light position changes.
  96297. *
  96298. * Only valid if useContactHardeningShadow is true.
  96299. */
  96300. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  96301. protected _darkness: number;
  96302. /** Gets or sets the actual darkness of a shadow */
  96303. get darkness(): number;
  96304. set darkness(value: number);
  96305. /**
  96306. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  96307. * 0 means strongest and 1 would means no shadow.
  96308. * @returns the darkness.
  96309. */
  96310. getDarkness(): number;
  96311. /**
  96312. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  96313. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  96314. * @returns the shadow generator allowing fluent coding.
  96315. */
  96316. setDarkness(darkness: number): ShadowGenerator;
  96317. protected _transparencyShadow: boolean;
  96318. /** Gets or sets the ability to have transparent shadow */
  96319. get transparencyShadow(): boolean;
  96320. set transparencyShadow(value: boolean);
  96321. /**
  96322. * Sets the ability to have transparent shadow (boolean).
  96323. * @param transparent True if transparent else False
  96324. * @returns the shadow generator allowing fluent coding
  96325. */
  96326. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  96327. /**
  96328. * Enables or disables shadows with varying strength based on the transparency
  96329. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  96330. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  96331. * mesh.visibility * alphaTexture.a
  96332. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  96333. */
  96334. enableSoftTransparentShadow: boolean;
  96335. protected _shadowMap: Nullable<RenderTargetTexture>;
  96336. protected _shadowMap2: Nullable<RenderTargetTexture>;
  96337. /**
  96338. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  96339. * @returns The render target texture if present otherwise, null
  96340. */
  96341. getShadowMap(): Nullable<RenderTargetTexture>;
  96342. /**
  96343. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  96344. * @returns The render target texture if the shadow map is present otherwise, null
  96345. */
  96346. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  96347. /**
  96348. * Gets the class name of that object
  96349. * @returns "ShadowGenerator"
  96350. */
  96351. getClassName(): string;
  96352. /**
  96353. * Helper function to add a mesh and its descendants to the list of shadow casters.
  96354. * @param mesh Mesh to add
  96355. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  96356. * @returns the Shadow Generator itself
  96357. */
  96358. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  96359. /**
  96360. * Helper function to remove a mesh and its descendants from the list of shadow casters
  96361. * @param mesh Mesh to remove
  96362. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  96363. * @returns the Shadow Generator itself
  96364. */
  96365. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  96366. /**
  96367. * Controls the extent to which the shadows fade out at the edge of the frustum
  96368. */
  96369. frustumEdgeFalloff: number;
  96370. protected _light: IShadowLight;
  96371. /**
  96372. * Returns the associated light object.
  96373. * @returns the light generating the shadow
  96374. */
  96375. getLight(): IShadowLight;
  96376. /**
  96377. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  96378. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  96379. * It might on the other hand introduce peter panning.
  96380. */
  96381. forceBackFacesOnly: boolean;
  96382. protected _scene: Scene;
  96383. protected _lightDirection: Vector3;
  96384. protected _effect: Effect;
  96385. protected _viewMatrix: Matrix;
  96386. protected _projectionMatrix: Matrix;
  96387. protected _transformMatrix: Matrix;
  96388. protected _cachedPosition: Vector3;
  96389. protected _cachedDirection: Vector3;
  96390. protected _cachedDefines: string;
  96391. protected _currentRenderID: number;
  96392. protected _boxBlurPostprocess: Nullable<PostProcess>;
  96393. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  96394. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  96395. protected _blurPostProcesses: PostProcess[];
  96396. protected _mapSize: number;
  96397. protected _currentFaceIndex: number;
  96398. protected _currentFaceIndexCache: number;
  96399. protected _textureType: number;
  96400. protected _defaultTextureMatrix: Matrix;
  96401. protected _storedUniqueId: Nullable<number>;
  96402. /** @hidden */
  96403. static _SceneComponentInitialization: (scene: Scene) => void;
  96404. /**
  96405. * Creates a ShadowGenerator object.
  96406. * A ShadowGenerator is the required tool to use the shadows.
  96407. * Each light casting shadows needs to use its own ShadowGenerator.
  96408. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  96409. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  96410. * @param light The light object generating the shadows.
  96411. * @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.
  96412. */
  96413. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  96414. protected _initializeGenerator(): void;
  96415. protected _createTargetRenderTexture(): void;
  96416. protected _initializeShadowMap(): void;
  96417. protected _initializeBlurRTTAndPostProcesses(): void;
  96418. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  96419. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  96420. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  96421. protected _applyFilterValues(): void;
  96422. /**
  96423. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96424. * @param onCompiled Callback triggered at the and of the effects compilation
  96425. * @param options Sets of optional options forcing the compilation with different modes
  96426. */
  96427. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  96428. useInstances: boolean;
  96429. }>): void;
  96430. /**
  96431. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96432. * @param options Sets of optional options forcing the compilation with different modes
  96433. * @returns A promise that resolves when the compilation completes
  96434. */
  96435. forceCompilationAsync(options?: Partial<{
  96436. useInstances: boolean;
  96437. }>): Promise<void>;
  96438. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  96439. private _prepareShadowDefines;
  96440. /**
  96441. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  96442. * @param subMesh The submesh we want to render in the shadow map
  96443. * @param useInstances Defines wether will draw in the map using instances
  96444. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  96445. * @returns true if ready otherwise, false
  96446. */
  96447. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  96448. /**
  96449. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  96450. * @param defines Defines of the material we want to update
  96451. * @param lightIndex Index of the light in the enabled light list of the material
  96452. */
  96453. prepareDefines(defines: any, lightIndex: number): void;
  96454. /**
  96455. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  96456. * defined in the generator but impacting the effect).
  96457. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  96458. * @param effect The effect we are binfing the information for
  96459. */
  96460. bindShadowLight(lightIndex: string, effect: Effect): void;
  96461. /**
  96462. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  96463. * (eq to shadow prjection matrix * light transform matrix)
  96464. * @returns The transform matrix used to create the shadow map
  96465. */
  96466. getTransformMatrix(): Matrix;
  96467. /**
  96468. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  96469. * Cube and 2D textures for instance.
  96470. */
  96471. recreateShadowMap(): void;
  96472. protected _disposeBlurPostProcesses(): void;
  96473. protected _disposeRTTandPostProcesses(): void;
  96474. /**
  96475. * Disposes the ShadowGenerator.
  96476. * Returns nothing.
  96477. */
  96478. dispose(): void;
  96479. /**
  96480. * Serializes the shadow generator setup to a json object.
  96481. * @returns The serialized JSON object
  96482. */
  96483. serialize(): any;
  96484. /**
  96485. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  96486. * @param parsedShadowGenerator The JSON object to parse
  96487. * @param scene The scene to create the shadow map for
  96488. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  96489. * @returns The parsed shadow generator
  96490. */
  96491. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  96492. }
  96493. }
  96494. declare module BABYLON {
  96495. /**
  96496. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  96497. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  96498. * 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.
  96499. */
  96500. export abstract class Light extends Node {
  96501. /**
  96502. * Falloff Default: light is falling off following the material specification:
  96503. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  96504. */
  96505. static readonly FALLOFF_DEFAULT: number;
  96506. /**
  96507. * Falloff Physical: light is falling off following the inverse squared distance law.
  96508. */
  96509. static readonly FALLOFF_PHYSICAL: number;
  96510. /**
  96511. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  96512. * to enhance interoperability with other engines.
  96513. */
  96514. static readonly FALLOFF_GLTF: number;
  96515. /**
  96516. * Falloff Standard: light is falling off like in the standard material
  96517. * to enhance interoperability with other materials.
  96518. */
  96519. static readonly FALLOFF_STANDARD: number;
  96520. /**
  96521. * If every light affecting the material is in this lightmapMode,
  96522. * material.lightmapTexture adds or multiplies
  96523. * (depends on material.useLightmapAsShadowmap)
  96524. * after every other light calculations.
  96525. */
  96526. static readonly LIGHTMAP_DEFAULT: number;
  96527. /**
  96528. * material.lightmapTexture as only diffuse lighting from this light
  96529. * adds only specular lighting from this light
  96530. * adds dynamic shadows
  96531. */
  96532. static readonly LIGHTMAP_SPECULAR: number;
  96533. /**
  96534. * material.lightmapTexture as only lighting
  96535. * no light calculation from this light
  96536. * only adds dynamic shadows from this light
  96537. */
  96538. static readonly LIGHTMAP_SHADOWSONLY: number;
  96539. /**
  96540. * Each light type uses the default quantity according to its type:
  96541. * point/spot lights use luminous intensity
  96542. * directional lights use illuminance
  96543. */
  96544. static readonly INTENSITYMODE_AUTOMATIC: number;
  96545. /**
  96546. * lumen (lm)
  96547. */
  96548. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  96549. /**
  96550. * candela (lm/sr)
  96551. */
  96552. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  96553. /**
  96554. * lux (lm/m^2)
  96555. */
  96556. static readonly INTENSITYMODE_ILLUMINANCE: number;
  96557. /**
  96558. * nit (cd/m^2)
  96559. */
  96560. static readonly INTENSITYMODE_LUMINANCE: number;
  96561. /**
  96562. * Light type const id of the point light.
  96563. */
  96564. static readonly LIGHTTYPEID_POINTLIGHT: number;
  96565. /**
  96566. * Light type const id of the directional light.
  96567. */
  96568. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  96569. /**
  96570. * Light type const id of the spot light.
  96571. */
  96572. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  96573. /**
  96574. * Light type const id of the hemispheric light.
  96575. */
  96576. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  96577. /**
  96578. * Diffuse gives the basic color to an object.
  96579. */
  96580. diffuse: Color3;
  96581. /**
  96582. * Specular produces a highlight color on an object.
  96583. * Note: This is note affecting PBR materials.
  96584. */
  96585. specular: Color3;
  96586. /**
  96587. * Defines the falloff type for this light. This lets overrriding how punctual light are
  96588. * falling off base on range or angle.
  96589. * This can be set to any values in Light.FALLOFF_x.
  96590. *
  96591. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  96592. * other types of materials.
  96593. */
  96594. falloffType: number;
  96595. /**
  96596. * Strength of the light.
  96597. * Note: By default it is define in the framework own unit.
  96598. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  96599. */
  96600. intensity: number;
  96601. private _range;
  96602. protected _inverseSquaredRange: number;
  96603. /**
  96604. * Defines how far from the source the light is impacting in scene units.
  96605. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  96606. */
  96607. get range(): number;
  96608. /**
  96609. * Defines how far from the source the light is impacting in scene units.
  96610. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  96611. */
  96612. set range(value: number);
  96613. /**
  96614. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  96615. * of light.
  96616. */
  96617. private _photometricScale;
  96618. private _intensityMode;
  96619. /**
  96620. * Gets the photometric scale used to interpret the intensity.
  96621. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  96622. */
  96623. get intensityMode(): number;
  96624. /**
  96625. * Sets the photometric scale used to interpret the intensity.
  96626. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  96627. */
  96628. set intensityMode(value: number);
  96629. private _radius;
  96630. /**
  96631. * Gets the light radius used by PBR Materials to simulate soft area lights.
  96632. */
  96633. get radius(): number;
  96634. /**
  96635. * sets the light radius used by PBR Materials to simulate soft area lights.
  96636. */
  96637. set radius(value: number);
  96638. private _renderPriority;
  96639. /**
  96640. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  96641. * exceeding the number allowed of the materials.
  96642. */
  96643. renderPriority: number;
  96644. private _shadowEnabled;
  96645. /**
  96646. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  96647. * the current shadow generator.
  96648. */
  96649. get shadowEnabled(): boolean;
  96650. /**
  96651. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  96652. * the current shadow generator.
  96653. */
  96654. set shadowEnabled(value: boolean);
  96655. private _includedOnlyMeshes;
  96656. /**
  96657. * Gets the only meshes impacted by this light.
  96658. */
  96659. get includedOnlyMeshes(): AbstractMesh[];
  96660. /**
  96661. * Sets the only meshes impacted by this light.
  96662. */
  96663. set includedOnlyMeshes(value: AbstractMesh[]);
  96664. private _excludedMeshes;
  96665. /**
  96666. * Gets the meshes not impacted by this light.
  96667. */
  96668. get excludedMeshes(): AbstractMesh[];
  96669. /**
  96670. * Sets the meshes not impacted by this light.
  96671. */
  96672. set excludedMeshes(value: AbstractMesh[]);
  96673. private _excludeWithLayerMask;
  96674. /**
  96675. * Gets the layer id use to find what meshes are not impacted by the light.
  96676. * Inactive if 0
  96677. */
  96678. get excludeWithLayerMask(): number;
  96679. /**
  96680. * Sets the layer id use to find what meshes are not impacted by the light.
  96681. * Inactive if 0
  96682. */
  96683. set excludeWithLayerMask(value: number);
  96684. private _includeOnlyWithLayerMask;
  96685. /**
  96686. * Gets the layer id use to find what meshes are impacted by the light.
  96687. * Inactive if 0
  96688. */
  96689. get includeOnlyWithLayerMask(): number;
  96690. /**
  96691. * Sets the layer id use to find what meshes are impacted by the light.
  96692. * Inactive if 0
  96693. */
  96694. set includeOnlyWithLayerMask(value: number);
  96695. private _lightmapMode;
  96696. /**
  96697. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  96698. */
  96699. get lightmapMode(): number;
  96700. /**
  96701. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  96702. */
  96703. set lightmapMode(value: number);
  96704. /**
  96705. * Shadow generator associted to the light.
  96706. * @hidden Internal use only.
  96707. */
  96708. _shadowGenerator: Nullable<IShadowGenerator>;
  96709. /**
  96710. * @hidden Internal use only.
  96711. */
  96712. _excludedMeshesIds: string[];
  96713. /**
  96714. * @hidden Internal use only.
  96715. */
  96716. _includedOnlyMeshesIds: string[];
  96717. /**
  96718. * The current light unifom buffer.
  96719. * @hidden Internal use only.
  96720. */
  96721. _uniformBuffer: UniformBuffer;
  96722. /** @hidden */
  96723. _renderId: number;
  96724. /**
  96725. * Creates a Light object in the scene.
  96726. * Documentation : https://doc.babylonjs.com/babylon101/lights
  96727. * @param name The firendly name of the light
  96728. * @param scene The scene the light belongs too
  96729. */
  96730. constructor(name: string, scene: Scene);
  96731. protected abstract _buildUniformLayout(): void;
  96732. /**
  96733. * Sets the passed Effect "effect" with the Light information.
  96734. * @param effect The effect to update
  96735. * @param lightIndex The index of the light in the effect to update
  96736. * @returns The light
  96737. */
  96738. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  96739. /**
  96740. * Sets the passed Effect "effect" with the Light textures.
  96741. * @param effect The effect to update
  96742. * @param lightIndex The index of the light in the effect to update
  96743. * @returns The light
  96744. */
  96745. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  96746. /**
  96747. * Binds the lights information from the scene to the effect for the given mesh.
  96748. * @param lightIndex Light index
  96749. * @param scene The scene where the light belongs to
  96750. * @param effect The effect we are binding the data to
  96751. * @param useSpecular Defines if specular is supported
  96752. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  96753. */
  96754. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  96755. /**
  96756. * Sets the passed Effect "effect" with the Light information.
  96757. * @param effect The effect to update
  96758. * @param lightDataUniformName The uniform used to store light data (position or direction)
  96759. * @returns The light
  96760. */
  96761. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  96762. /**
  96763. * Returns the string "Light".
  96764. * @returns the class name
  96765. */
  96766. getClassName(): string;
  96767. /** @hidden */
  96768. readonly _isLight: boolean;
  96769. /**
  96770. * Converts the light information to a readable string for debug purpose.
  96771. * @param fullDetails Supports for multiple levels of logging within scene loading
  96772. * @returns the human readable light info
  96773. */
  96774. toString(fullDetails?: boolean): string;
  96775. /** @hidden */
  96776. protected _syncParentEnabledState(): void;
  96777. /**
  96778. * Set the enabled state of this node.
  96779. * @param value - the new enabled state
  96780. */
  96781. setEnabled(value: boolean): void;
  96782. /**
  96783. * Returns the Light associated shadow generator if any.
  96784. * @return the associated shadow generator.
  96785. */
  96786. getShadowGenerator(): Nullable<IShadowGenerator>;
  96787. /**
  96788. * Returns a Vector3, the absolute light position in the World.
  96789. * @returns the world space position of the light
  96790. */
  96791. getAbsolutePosition(): Vector3;
  96792. /**
  96793. * Specifies if the light will affect the passed mesh.
  96794. * @param mesh The mesh to test against the light
  96795. * @return true the mesh is affected otherwise, false.
  96796. */
  96797. canAffectMesh(mesh: AbstractMesh): boolean;
  96798. /**
  96799. * Sort function to order lights for rendering.
  96800. * @param a First Light object to compare to second.
  96801. * @param b Second Light object to compare first.
  96802. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  96803. */
  96804. static CompareLightsPriority(a: Light, b: Light): number;
  96805. /**
  96806. * Releases resources associated with this node.
  96807. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  96808. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  96809. */
  96810. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96811. /**
  96812. * Returns the light type ID (integer).
  96813. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  96814. */
  96815. getTypeID(): number;
  96816. /**
  96817. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  96818. * @returns the scaled intensity in intensity mode unit
  96819. */
  96820. getScaledIntensity(): number;
  96821. /**
  96822. * Returns a new Light object, named "name", from the current one.
  96823. * @param name The name of the cloned light
  96824. * @param newParent The parent of this light, if it has one
  96825. * @returns the new created light
  96826. */
  96827. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  96828. /**
  96829. * Serializes the current light into a Serialization object.
  96830. * @returns the serialized object.
  96831. */
  96832. serialize(): any;
  96833. /**
  96834. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  96835. * This new light is named "name" and added to the passed scene.
  96836. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  96837. * @param name The friendly name of the light
  96838. * @param scene The scene the new light will belong to
  96839. * @returns the constructor function
  96840. */
  96841. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  96842. /**
  96843. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  96844. * @param parsedLight The JSON representation of the light
  96845. * @param scene The scene to create the parsed light in
  96846. * @returns the created light after parsing
  96847. */
  96848. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  96849. private _hookArrayForExcluded;
  96850. private _hookArrayForIncludedOnly;
  96851. private _resyncMeshes;
  96852. /**
  96853. * Forces the meshes to update their light related information in their rendering used effects
  96854. * @hidden Internal Use Only
  96855. */
  96856. _markMeshesAsLightDirty(): void;
  96857. /**
  96858. * Recomputes the cached photometric scale if needed.
  96859. */
  96860. private _computePhotometricScale;
  96861. /**
  96862. * Returns the Photometric Scale according to the light type and intensity mode.
  96863. */
  96864. private _getPhotometricScale;
  96865. /**
  96866. * Reorder the light in the scene according to their defined priority.
  96867. * @hidden Internal Use Only
  96868. */
  96869. _reorderLightsInScene(): void;
  96870. /**
  96871. * Prepares the list of defines specific to the light type.
  96872. * @param defines the list of defines
  96873. * @param lightIndex defines the index of the light for the effect
  96874. */
  96875. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  96876. }
  96877. }
  96878. declare module BABYLON {
  96879. /**
  96880. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  96881. * This is the base of the follow, arc rotate cameras and Free camera
  96882. * @see https://doc.babylonjs.com/features/cameras
  96883. */
  96884. export class TargetCamera extends Camera {
  96885. private static _RigCamTransformMatrix;
  96886. private static _TargetTransformMatrix;
  96887. private static _TargetFocalPoint;
  96888. private _tmpUpVector;
  96889. private _tmpTargetVector;
  96890. /**
  96891. * Define the current direction the camera is moving to
  96892. */
  96893. cameraDirection: Vector3;
  96894. /**
  96895. * Define the current rotation the camera is rotating to
  96896. */
  96897. cameraRotation: Vector2;
  96898. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  96899. ignoreParentScaling: boolean;
  96900. /**
  96901. * When set, the up vector of the camera will be updated by the rotation of the camera
  96902. */
  96903. updateUpVectorFromRotation: boolean;
  96904. private _tmpQuaternion;
  96905. /**
  96906. * Define the current rotation of the camera
  96907. */
  96908. rotation: Vector3;
  96909. /**
  96910. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  96911. */
  96912. rotationQuaternion: Quaternion;
  96913. /**
  96914. * Define the current speed of the camera
  96915. */
  96916. speed: number;
  96917. /**
  96918. * Add constraint to the camera to prevent it to move freely in all directions and
  96919. * around all axis.
  96920. */
  96921. noRotationConstraint: boolean;
  96922. /**
  96923. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  96924. * panning
  96925. */
  96926. invertRotation: boolean;
  96927. /**
  96928. * Speed multiplier for inverse camera panning
  96929. */
  96930. inverseRotationSpeed: number;
  96931. /**
  96932. * Define the current target of the camera as an object or a position.
  96933. */
  96934. lockedTarget: any;
  96935. /** @hidden */
  96936. _currentTarget: Vector3;
  96937. /** @hidden */
  96938. _initialFocalDistance: number;
  96939. /** @hidden */
  96940. _viewMatrix: Matrix;
  96941. /** @hidden */
  96942. _camMatrix: Matrix;
  96943. /** @hidden */
  96944. _cameraTransformMatrix: Matrix;
  96945. /** @hidden */
  96946. _cameraRotationMatrix: Matrix;
  96947. /** @hidden */
  96948. _referencePoint: Vector3;
  96949. /** @hidden */
  96950. _transformedReferencePoint: Vector3;
  96951. /** @hidden */
  96952. _reset: () => void;
  96953. private _defaultUp;
  96954. /**
  96955. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  96956. * This is the base of the follow, arc rotate cameras and Free camera
  96957. * @see https://doc.babylonjs.com/features/cameras
  96958. * @param name Defines the name of the camera in the scene
  96959. * @param position Defines the start position of the camera in the scene
  96960. * @param scene Defines the scene the camera belongs to
  96961. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  96962. */
  96963. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  96964. /**
  96965. * Gets the position in front of the camera at a given distance.
  96966. * @param distance The distance from the camera we want the position to be
  96967. * @returns the position
  96968. */
  96969. getFrontPosition(distance: number): Vector3;
  96970. /** @hidden */
  96971. _getLockedTargetPosition(): Nullable<Vector3>;
  96972. private _storedPosition;
  96973. private _storedRotation;
  96974. private _storedRotationQuaternion;
  96975. /**
  96976. * Store current camera state of the camera (fov, position, rotation, etc..)
  96977. * @returns the camera
  96978. */
  96979. storeState(): Camera;
  96980. /**
  96981. * Restored camera state. You must call storeState() first
  96982. * @returns whether it was successful or not
  96983. * @hidden
  96984. */
  96985. _restoreStateValues(): boolean;
  96986. /** @hidden */
  96987. _initCache(): void;
  96988. /** @hidden */
  96989. _updateCache(ignoreParentClass?: boolean): void;
  96990. /** @hidden */
  96991. _isSynchronizedViewMatrix(): boolean;
  96992. /** @hidden */
  96993. _computeLocalCameraSpeed(): number;
  96994. /**
  96995. * Defines the target the camera should look at.
  96996. * @param target Defines the new target as a Vector or a mesh
  96997. */
  96998. setTarget(target: Vector3): void;
  96999. /**
  97000. * Return the current target position of the camera. This value is expressed in local space.
  97001. * @returns the target position
  97002. */
  97003. getTarget(): Vector3;
  97004. /** @hidden */
  97005. _decideIfNeedsToMove(): boolean;
  97006. /** @hidden */
  97007. _updatePosition(): void;
  97008. /** @hidden */
  97009. _checkInputs(): void;
  97010. protected _updateCameraRotationMatrix(): void;
  97011. /**
  97012. * 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)
  97013. * @returns the current camera
  97014. */
  97015. private _rotateUpVectorWithCameraRotationMatrix;
  97016. private _cachedRotationZ;
  97017. private _cachedQuaternionRotationZ;
  97018. /** @hidden */
  97019. _getViewMatrix(): Matrix;
  97020. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  97021. /**
  97022. * @hidden
  97023. */
  97024. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  97025. /**
  97026. * @hidden
  97027. */
  97028. _updateRigCameras(): void;
  97029. private _getRigCamPositionAndTarget;
  97030. /**
  97031. * Gets the current object class name.
  97032. * @return the class name
  97033. */
  97034. getClassName(): string;
  97035. }
  97036. }
  97037. declare module BABYLON {
  97038. /**
  97039. * Gather the list of keyboard event types as constants.
  97040. */
  97041. export class KeyboardEventTypes {
  97042. /**
  97043. * The keydown event is fired when a key becomes active (pressed).
  97044. */
  97045. static readonly KEYDOWN: number;
  97046. /**
  97047. * The keyup event is fired when a key has been released.
  97048. */
  97049. static readonly KEYUP: number;
  97050. }
  97051. /**
  97052. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97053. */
  97054. export class KeyboardInfo {
  97055. /**
  97056. * Defines the type of event (KeyboardEventTypes)
  97057. */
  97058. type: number;
  97059. /**
  97060. * Defines the related dom event
  97061. */
  97062. event: KeyboardEvent;
  97063. /**
  97064. * Instantiates a new keyboard info.
  97065. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97066. * @param type Defines the type of event (KeyboardEventTypes)
  97067. * @param event Defines the related dom event
  97068. */
  97069. constructor(
  97070. /**
  97071. * Defines the type of event (KeyboardEventTypes)
  97072. */
  97073. type: number,
  97074. /**
  97075. * Defines the related dom event
  97076. */
  97077. event: KeyboardEvent);
  97078. }
  97079. /**
  97080. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97081. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  97082. */
  97083. export class KeyboardInfoPre extends KeyboardInfo {
  97084. /**
  97085. * Defines the type of event (KeyboardEventTypes)
  97086. */
  97087. type: number;
  97088. /**
  97089. * Defines the related dom event
  97090. */
  97091. event: KeyboardEvent;
  97092. /**
  97093. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  97094. */
  97095. skipOnPointerObservable: boolean;
  97096. /**
  97097. * Instantiates a new keyboard pre info.
  97098. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97099. * @param type Defines the type of event (KeyboardEventTypes)
  97100. * @param event Defines the related dom event
  97101. */
  97102. constructor(
  97103. /**
  97104. * Defines the type of event (KeyboardEventTypes)
  97105. */
  97106. type: number,
  97107. /**
  97108. * Defines the related dom event
  97109. */
  97110. event: KeyboardEvent);
  97111. }
  97112. }
  97113. declare module BABYLON {
  97114. /**
  97115. * Manage the keyboard inputs to control the movement of a free camera.
  97116. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97117. */
  97118. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  97119. /**
  97120. * Defines the camera the input is attached to.
  97121. */
  97122. camera: FreeCamera;
  97123. /**
  97124. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  97125. */
  97126. keysUp: number[];
  97127. /**
  97128. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  97129. */
  97130. keysUpward: number[];
  97131. /**
  97132. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  97133. */
  97134. keysDown: number[];
  97135. /**
  97136. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  97137. */
  97138. keysDownward: number[];
  97139. /**
  97140. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  97141. */
  97142. keysLeft: number[];
  97143. /**
  97144. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  97145. */
  97146. keysRight: number[];
  97147. private _keys;
  97148. private _onCanvasBlurObserver;
  97149. private _onKeyboardObserver;
  97150. private _engine;
  97151. private _scene;
  97152. /**
  97153. * Attach the input controls to a specific dom element to get the input from.
  97154. * @param element Defines the element the controls should be listened from
  97155. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97156. */
  97157. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97158. /**
  97159. * Detach the current controls from the specified dom element.
  97160. * @param element Defines the element to stop listening the inputs from
  97161. */
  97162. detachControl(element: Nullable<HTMLElement>): void;
  97163. /**
  97164. * Update the current camera state depending on the inputs that have been used this frame.
  97165. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  97166. */
  97167. checkInputs(): void;
  97168. /**
  97169. * Gets the class name of the current intput.
  97170. * @returns the class name
  97171. */
  97172. getClassName(): string;
  97173. /** @hidden */
  97174. _onLostFocus(): void;
  97175. /**
  97176. * Get the friendly name associated with the input class.
  97177. * @returns the input friendly name
  97178. */
  97179. getSimpleName(): string;
  97180. }
  97181. }
  97182. declare module BABYLON {
  97183. /**
  97184. * Gather the list of pointer event types as constants.
  97185. */
  97186. export class PointerEventTypes {
  97187. /**
  97188. * 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.
  97189. */
  97190. static readonly POINTERDOWN: number;
  97191. /**
  97192. * The pointerup event is fired when a pointer is no longer active.
  97193. */
  97194. static readonly POINTERUP: number;
  97195. /**
  97196. * The pointermove event is fired when a pointer changes coordinates.
  97197. */
  97198. static readonly POINTERMOVE: number;
  97199. /**
  97200. * The pointerwheel event is fired when a mouse wheel has been rotated.
  97201. */
  97202. static readonly POINTERWHEEL: number;
  97203. /**
  97204. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  97205. */
  97206. static readonly POINTERPICK: number;
  97207. /**
  97208. * The pointertap event is fired when a the object has been touched and released without drag.
  97209. */
  97210. static readonly POINTERTAP: number;
  97211. /**
  97212. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  97213. */
  97214. static readonly POINTERDOUBLETAP: number;
  97215. }
  97216. /**
  97217. * Base class of pointer info types.
  97218. */
  97219. export class PointerInfoBase {
  97220. /**
  97221. * Defines the type of event (PointerEventTypes)
  97222. */
  97223. type: number;
  97224. /**
  97225. * Defines the related dom event
  97226. */
  97227. event: PointerEvent | MouseWheelEvent;
  97228. /**
  97229. * Instantiates the base class of pointers info.
  97230. * @param type Defines the type of event (PointerEventTypes)
  97231. * @param event Defines the related dom event
  97232. */
  97233. constructor(
  97234. /**
  97235. * Defines the type of event (PointerEventTypes)
  97236. */
  97237. type: number,
  97238. /**
  97239. * Defines the related dom event
  97240. */
  97241. event: PointerEvent | MouseWheelEvent);
  97242. }
  97243. /**
  97244. * This class is used to store pointer related info for the onPrePointerObservable event.
  97245. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  97246. */
  97247. export class PointerInfoPre extends PointerInfoBase {
  97248. /**
  97249. * Ray from a pointer if availible (eg. 6dof controller)
  97250. */
  97251. ray: Nullable<Ray>;
  97252. /**
  97253. * Defines the local position of the pointer on the canvas.
  97254. */
  97255. localPosition: Vector2;
  97256. /**
  97257. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  97258. */
  97259. skipOnPointerObservable: boolean;
  97260. /**
  97261. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  97262. * @param type Defines the type of event (PointerEventTypes)
  97263. * @param event Defines the related dom event
  97264. * @param localX Defines the local x coordinates of the pointer when the event occured
  97265. * @param localY Defines the local y coordinates of the pointer when the event occured
  97266. */
  97267. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  97268. }
  97269. /**
  97270. * This type contains all the data related to a pointer event in Babylon.js.
  97271. * 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.
  97272. */
  97273. export class PointerInfo extends PointerInfoBase {
  97274. /**
  97275. * Defines the picking info associated to the info (if any)\
  97276. */
  97277. pickInfo: Nullable<PickingInfo>;
  97278. /**
  97279. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  97280. * @param type Defines the type of event (PointerEventTypes)
  97281. * @param event Defines the related dom event
  97282. * @param pickInfo Defines the picking info associated to the info (if any)\
  97283. */
  97284. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  97285. /**
  97286. * Defines the picking info associated to the info (if any)\
  97287. */
  97288. pickInfo: Nullable<PickingInfo>);
  97289. }
  97290. /**
  97291. * Data relating to a touch event on the screen.
  97292. */
  97293. export interface PointerTouch {
  97294. /**
  97295. * X coordinate of touch.
  97296. */
  97297. x: number;
  97298. /**
  97299. * Y coordinate of touch.
  97300. */
  97301. y: number;
  97302. /**
  97303. * Id of touch. Unique for each finger.
  97304. */
  97305. pointerId: number;
  97306. /**
  97307. * Event type passed from DOM.
  97308. */
  97309. type: any;
  97310. }
  97311. }
  97312. declare module BABYLON {
  97313. /**
  97314. * Manage the mouse inputs to control the movement of a free camera.
  97315. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97316. */
  97317. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  97318. /**
  97319. * Define if touch is enabled in the mouse input
  97320. */
  97321. touchEnabled: boolean;
  97322. /**
  97323. * Defines the camera the input is attached to.
  97324. */
  97325. camera: FreeCamera;
  97326. /**
  97327. * Defines the buttons associated with the input to handle camera move.
  97328. */
  97329. buttons: number[];
  97330. /**
  97331. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  97332. */
  97333. angularSensibility: number;
  97334. private _pointerInput;
  97335. private _onMouseMove;
  97336. private _observer;
  97337. private previousPosition;
  97338. /**
  97339. * Observable for when a pointer move event occurs containing the move offset
  97340. */
  97341. onPointerMovedObservable: Observable<{
  97342. offsetX: number;
  97343. offsetY: number;
  97344. }>;
  97345. /**
  97346. * @hidden
  97347. * If the camera should be rotated automatically based on pointer movement
  97348. */
  97349. _allowCameraRotation: boolean;
  97350. /**
  97351. * Manage the mouse inputs to control the movement of a free camera.
  97352. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97353. * @param touchEnabled Defines if touch is enabled or not
  97354. */
  97355. constructor(
  97356. /**
  97357. * Define if touch is enabled in the mouse input
  97358. */
  97359. touchEnabled?: boolean);
  97360. /**
  97361. * Attach the input controls to a specific dom element to get the input from.
  97362. * @param element Defines the element the controls should be listened from
  97363. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97364. */
  97365. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97366. /**
  97367. * Called on JS contextmenu event.
  97368. * Override this method to provide functionality.
  97369. */
  97370. protected onContextMenu(evt: PointerEvent): void;
  97371. /**
  97372. * Detach the current controls from the specified dom element.
  97373. * @param element Defines the element to stop listening the inputs from
  97374. */
  97375. detachControl(element: Nullable<HTMLElement>): void;
  97376. /**
  97377. * Gets the class name of the current intput.
  97378. * @returns the class name
  97379. */
  97380. getClassName(): string;
  97381. /**
  97382. * Get the friendly name associated with the input class.
  97383. * @returns the input friendly name
  97384. */
  97385. getSimpleName(): string;
  97386. }
  97387. }
  97388. declare module BABYLON {
  97389. /**
  97390. * Manage the touch inputs to control the movement of a free camera.
  97391. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97392. */
  97393. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  97394. /**
  97395. * Defines the camera the input is attached to.
  97396. */
  97397. camera: FreeCamera;
  97398. /**
  97399. * Defines the touch sensibility for rotation.
  97400. * The higher the faster.
  97401. */
  97402. touchAngularSensibility: number;
  97403. /**
  97404. * Defines the touch sensibility for move.
  97405. * The higher the faster.
  97406. */
  97407. touchMoveSensibility: number;
  97408. private _offsetX;
  97409. private _offsetY;
  97410. private _pointerPressed;
  97411. private _pointerInput;
  97412. private _observer;
  97413. private _onLostFocus;
  97414. /**
  97415. * Attach the input controls to a specific dom element to get the input from.
  97416. * @param element Defines the element the controls should be listened from
  97417. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97418. */
  97419. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97420. /**
  97421. * Detach the current controls from the specified dom element.
  97422. * @param element Defines the element to stop listening the inputs from
  97423. */
  97424. detachControl(element: Nullable<HTMLElement>): void;
  97425. /**
  97426. * Update the current camera state depending on the inputs that have been used this frame.
  97427. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  97428. */
  97429. checkInputs(): void;
  97430. /**
  97431. * Gets the class name of the current intput.
  97432. * @returns the class name
  97433. */
  97434. getClassName(): string;
  97435. /**
  97436. * Get the friendly name associated with the input class.
  97437. * @returns the input friendly name
  97438. */
  97439. getSimpleName(): string;
  97440. }
  97441. }
  97442. declare module BABYLON {
  97443. /**
  97444. * Default Inputs manager for the FreeCamera.
  97445. * It groups all the default supported inputs for ease of use.
  97446. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97447. */
  97448. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  97449. /**
  97450. * @hidden
  97451. */
  97452. _mouseInput: Nullable<FreeCameraMouseInput>;
  97453. /**
  97454. * Instantiates a new FreeCameraInputsManager.
  97455. * @param camera Defines the camera the inputs belong to
  97456. */
  97457. constructor(camera: FreeCamera);
  97458. /**
  97459. * Add keyboard input support to the input manager.
  97460. * @returns the current input manager
  97461. */
  97462. addKeyboard(): FreeCameraInputsManager;
  97463. /**
  97464. * Add mouse input support to the input manager.
  97465. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  97466. * @returns the current input manager
  97467. */
  97468. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  97469. /**
  97470. * Removes the mouse input support from the manager
  97471. * @returns the current input manager
  97472. */
  97473. removeMouse(): FreeCameraInputsManager;
  97474. /**
  97475. * Add touch input support to the input manager.
  97476. * @returns the current input manager
  97477. */
  97478. addTouch(): FreeCameraInputsManager;
  97479. /**
  97480. * Remove all attached input methods from a camera
  97481. */
  97482. clear(): void;
  97483. }
  97484. }
  97485. declare module BABYLON {
  97486. /**
  97487. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  97488. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  97489. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  97490. */
  97491. export class FreeCamera extends TargetCamera {
  97492. /**
  97493. * Define the collision ellipsoid of the camera.
  97494. * This is helpful to simulate a camera body like the player body around the camera
  97495. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  97496. */
  97497. ellipsoid: Vector3;
  97498. /**
  97499. * Define an offset for the position of the ellipsoid around the camera.
  97500. * This can be helpful to determine the center of the body near the gravity center of the body
  97501. * instead of its head.
  97502. */
  97503. ellipsoidOffset: Vector3;
  97504. /**
  97505. * Enable or disable collisions of the camera with the rest of the scene objects.
  97506. */
  97507. checkCollisions: boolean;
  97508. /**
  97509. * Enable or disable gravity on the camera.
  97510. */
  97511. applyGravity: boolean;
  97512. /**
  97513. * Define the input manager associated to the camera.
  97514. */
  97515. inputs: FreeCameraInputsManager;
  97516. /**
  97517. * Gets the input sensibility for a mouse input. (default is 2000.0)
  97518. * Higher values reduce sensitivity.
  97519. */
  97520. get angularSensibility(): number;
  97521. /**
  97522. * Sets the input sensibility for a mouse input. (default is 2000.0)
  97523. * Higher values reduce sensitivity.
  97524. */
  97525. set angularSensibility(value: number);
  97526. /**
  97527. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  97528. */
  97529. get keysUp(): number[];
  97530. set keysUp(value: number[]);
  97531. /**
  97532. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  97533. */
  97534. get keysUpward(): number[];
  97535. set keysUpward(value: number[]);
  97536. /**
  97537. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  97538. */
  97539. get keysDown(): number[];
  97540. set keysDown(value: number[]);
  97541. /**
  97542. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  97543. */
  97544. get keysDownward(): number[];
  97545. set keysDownward(value: number[]);
  97546. /**
  97547. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  97548. */
  97549. get keysLeft(): number[];
  97550. set keysLeft(value: number[]);
  97551. /**
  97552. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  97553. */
  97554. get keysRight(): number[];
  97555. set keysRight(value: number[]);
  97556. /**
  97557. * Event raised when the camera collide with a mesh in the scene.
  97558. */
  97559. onCollide: (collidedMesh: AbstractMesh) => void;
  97560. private _collider;
  97561. private _needMoveForGravity;
  97562. private _oldPosition;
  97563. private _diffPosition;
  97564. private _newPosition;
  97565. /** @hidden */
  97566. _localDirection: Vector3;
  97567. /** @hidden */
  97568. _transformedDirection: Vector3;
  97569. /**
  97570. * Instantiates a Free Camera.
  97571. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  97572. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  97573. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  97574. * @param name Define the name of the camera in the scene
  97575. * @param position Define the start position of the camera in the scene
  97576. * @param scene Define the scene the camera belongs to
  97577. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  97578. */
  97579. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  97580. /**
  97581. * Attached controls to the current camera.
  97582. * @param element Defines the element the controls should be listened from
  97583. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97584. */
  97585. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97586. /**
  97587. * Detach the current controls from the camera.
  97588. * The camera will stop reacting to inputs.
  97589. * @param element Defines the element to stop listening the inputs from
  97590. */
  97591. detachControl(element: HTMLElement): void;
  97592. private _collisionMask;
  97593. /**
  97594. * Define a collision mask to limit the list of object the camera can collide with
  97595. */
  97596. get collisionMask(): number;
  97597. set collisionMask(mask: number);
  97598. /** @hidden */
  97599. _collideWithWorld(displacement: Vector3): void;
  97600. private _onCollisionPositionChange;
  97601. /** @hidden */
  97602. _checkInputs(): void;
  97603. /** @hidden */
  97604. _decideIfNeedsToMove(): boolean;
  97605. /** @hidden */
  97606. _updatePosition(): void;
  97607. /**
  97608. * Destroy the camera and release the current resources hold by it.
  97609. */
  97610. dispose(): void;
  97611. /**
  97612. * Gets the current object class name.
  97613. * @return the class name
  97614. */
  97615. getClassName(): string;
  97616. }
  97617. }
  97618. declare module BABYLON {
  97619. /**
  97620. * Represents a gamepad control stick position
  97621. */
  97622. export class StickValues {
  97623. /**
  97624. * The x component of the control stick
  97625. */
  97626. x: number;
  97627. /**
  97628. * The y component of the control stick
  97629. */
  97630. y: number;
  97631. /**
  97632. * Initializes the gamepad x and y control stick values
  97633. * @param x The x component of the gamepad control stick value
  97634. * @param y The y component of the gamepad control stick value
  97635. */
  97636. constructor(
  97637. /**
  97638. * The x component of the control stick
  97639. */
  97640. x: number,
  97641. /**
  97642. * The y component of the control stick
  97643. */
  97644. y: number);
  97645. }
  97646. /**
  97647. * An interface which manages callbacks for gamepad button changes
  97648. */
  97649. export interface GamepadButtonChanges {
  97650. /**
  97651. * Called when a gamepad has been changed
  97652. */
  97653. changed: boolean;
  97654. /**
  97655. * Called when a gamepad press event has been triggered
  97656. */
  97657. pressChanged: boolean;
  97658. /**
  97659. * Called when a touch event has been triggered
  97660. */
  97661. touchChanged: boolean;
  97662. /**
  97663. * Called when a value has changed
  97664. */
  97665. valueChanged: boolean;
  97666. }
  97667. /**
  97668. * Represents a gamepad
  97669. */
  97670. export class Gamepad {
  97671. /**
  97672. * The id of the gamepad
  97673. */
  97674. id: string;
  97675. /**
  97676. * The index of the gamepad
  97677. */
  97678. index: number;
  97679. /**
  97680. * The browser gamepad
  97681. */
  97682. browserGamepad: any;
  97683. /**
  97684. * Specifies what type of gamepad this represents
  97685. */
  97686. type: number;
  97687. private _leftStick;
  97688. private _rightStick;
  97689. /** @hidden */
  97690. _isConnected: boolean;
  97691. private _leftStickAxisX;
  97692. private _leftStickAxisY;
  97693. private _rightStickAxisX;
  97694. private _rightStickAxisY;
  97695. /**
  97696. * Triggered when the left control stick has been changed
  97697. */
  97698. private _onleftstickchanged;
  97699. /**
  97700. * Triggered when the right control stick has been changed
  97701. */
  97702. private _onrightstickchanged;
  97703. /**
  97704. * Represents a gamepad controller
  97705. */
  97706. static GAMEPAD: number;
  97707. /**
  97708. * Represents a generic controller
  97709. */
  97710. static GENERIC: number;
  97711. /**
  97712. * Represents an XBox controller
  97713. */
  97714. static XBOX: number;
  97715. /**
  97716. * Represents a pose-enabled controller
  97717. */
  97718. static POSE_ENABLED: number;
  97719. /**
  97720. * Represents an Dual Shock controller
  97721. */
  97722. static DUALSHOCK: number;
  97723. /**
  97724. * Specifies whether the left control stick should be Y-inverted
  97725. */
  97726. protected _invertLeftStickY: boolean;
  97727. /**
  97728. * Specifies if the gamepad has been connected
  97729. */
  97730. get isConnected(): boolean;
  97731. /**
  97732. * Initializes the gamepad
  97733. * @param id The id of the gamepad
  97734. * @param index The index of the gamepad
  97735. * @param browserGamepad The browser gamepad
  97736. * @param leftStickX The x component of the left joystick
  97737. * @param leftStickY The y component of the left joystick
  97738. * @param rightStickX The x component of the right joystick
  97739. * @param rightStickY The y component of the right joystick
  97740. */
  97741. constructor(
  97742. /**
  97743. * The id of the gamepad
  97744. */
  97745. id: string,
  97746. /**
  97747. * The index of the gamepad
  97748. */
  97749. index: number,
  97750. /**
  97751. * The browser gamepad
  97752. */
  97753. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  97754. /**
  97755. * Callback triggered when the left joystick has changed
  97756. * @param callback
  97757. */
  97758. onleftstickchanged(callback: (values: StickValues) => void): void;
  97759. /**
  97760. * Callback triggered when the right joystick has changed
  97761. * @param callback
  97762. */
  97763. onrightstickchanged(callback: (values: StickValues) => void): void;
  97764. /**
  97765. * Gets the left joystick
  97766. */
  97767. get leftStick(): StickValues;
  97768. /**
  97769. * Sets the left joystick values
  97770. */
  97771. set leftStick(newValues: StickValues);
  97772. /**
  97773. * Gets the right joystick
  97774. */
  97775. get rightStick(): StickValues;
  97776. /**
  97777. * Sets the right joystick value
  97778. */
  97779. set rightStick(newValues: StickValues);
  97780. /**
  97781. * Updates the gamepad joystick positions
  97782. */
  97783. update(): void;
  97784. /**
  97785. * Disposes the gamepad
  97786. */
  97787. dispose(): void;
  97788. }
  97789. /**
  97790. * Represents a generic gamepad
  97791. */
  97792. export class GenericPad extends Gamepad {
  97793. private _buttons;
  97794. private _onbuttondown;
  97795. private _onbuttonup;
  97796. /**
  97797. * Observable triggered when a button has been pressed
  97798. */
  97799. onButtonDownObservable: Observable<number>;
  97800. /**
  97801. * Observable triggered when a button has been released
  97802. */
  97803. onButtonUpObservable: Observable<number>;
  97804. /**
  97805. * Callback triggered when a button has been pressed
  97806. * @param callback Called when a button has been pressed
  97807. */
  97808. onbuttondown(callback: (buttonPressed: number) => void): void;
  97809. /**
  97810. * Callback triggered when a button has been released
  97811. * @param callback Called when a button has been released
  97812. */
  97813. onbuttonup(callback: (buttonReleased: number) => void): void;
  97814. /**
  97815. * Initializes the generic gamepad
  97816. * @param id The id of the generic gamepad
  97817. * @param index The index of the generic gamepad
  97818. * @param browserGamepad The browser gamepad
  97819. */
  97820. constructor(id: string, index: number, browserGamepad: any);
  97821. private _setButtonValue;
  97822. /**
  97823. * Updates the generic gamepad
  97824. */
  97825. update(): void;
  97826. /**
  97827. * Disposes the generic gamepad
  97828. */
  97829. dispose(): void;
  97830. }
  97831. }
  97832. declare module BABYLON {
  97833. /**
  97834. * Defines the types of pose enabled controllers that are supported
  97835. */
  97836. export enum PoseEnabledControllerType {
  97837. /**
  97838. * HTC Vive
  97839. */
  97840. VIVE = 0,
  97841. /**
  97842. * Oculus Rift
  97843. */
  97844. OCULUS = 1,
  97845. /**
  97846. * Windows mixed reality
  97847. */
  97848. WINDOWS = 2,
  97849. /**
  97850. * Samsung gear VR
  97851. */
  97852. GEAR_VR = 3,
  97853. /**
  97854. * Google Daydream
  97855. */
  97856. DAYDREAM = 4,
  97857. /**
  97858. * Generic
  97859. */
  97860. GENERIC = 5
  97861. }
  97862. /**
  97863. * Defines the MutableGamepadButton interface for the state of a gamepad button
  97864. */
  97865. export interface MutableGamepadButton {
  97866. /**
  97867. * Value of the button/trigger
  97868. */
  97869. value: number;
  97870. /**
  97871. * If the button/trigger is currently touched
  97872. */
  97873. touched: boolean;
  97874. /**
  97875. * If the button/trigger is currently pressed
  97876. */
  97877. pressed: boolean;
  97878. }
  97879. /**
  97880. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  97881. * @hidden
  97882. */
  97883. export interface ExtendedGamepadButton extends GamepadButton {
  97884. /**
  97885. * If the button/trigger is currently pressed
  97886. */
  97887. readonly pressed: boolean;
  97888. /**
  97889. * If the button/trigger is currently touched
  97890. */
  97891. readonly touched: boolean;
  97892. /**
  97893. * Value of the button/trigger
  97894. */
  97895. readonly value: number;
  97896. }
  97897. /** @hidden */
  97898. export interface _GamePadFactory {
  97899. /**
  97900. * Returns whether or not the current gamepad can be created for this type of controller.
  97901. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  97902. * @returns true if it can be created, otherwise false
  97903. */
  97904. canCreate(gamepadInfo: any): boolean;
  97905. /**
  97906. * Creates a new instance of the Gamepad.
  97907. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  97908. * @returns the new gamepad instance
  97909. */
  97910. create(gamepadInfo: any): Gamepad;
  97911. }
  97912. /**
  97913. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  97914. */
  97915. export class PoseEnabledControllerHelper {
  97916. /** @hidden */
  97917. static _ControllerFactories: _GamePadFactory[];
  97918. /** @hidden */
  97919. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  97920. /**
  97921. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  97922. * @param vrGamepad the gamepad to initialized
  97923. * @returns a vr controller of the type the gamepad identified as
  97924. */
  97925. static InitiateController(vrGamepad: any): Gamepad;
  97926. }
  97927. /**
  97928. * Defines the PoseEnabledController object that contains state of a vr capable controller
  97929. */
  97930. export class PoseEnabledController extends Gamepad implements PoseControlled {
  97931. /**
  97932. * If the controller is used in a webXR session
  97933. */
  97934. isXR: boolean;
  97935. private _deviceRoomPosition;
  97936. private _deviceRoomRotationQuaternion;
  97937. /**
  97938. * The device position in babylon space
  97939. */
  97940. devicePosition: Vector3;
  97941. /**
  97942. * The device rotation in babylon space
  97943. */
  97944. deviceRotationQuaternion: Quaternion;
  97945. /**
  97946. * The scale factor of the device in babylon space
  97947. */
  97948. deviceScaleFactor: number;
  97949. /**
  97950. * (Likely devicePosition should be used instead) The device position in its room space
  97951. */
  97952. position: Vector3;
  97953. /**
  97954. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  97955. */
  97956. rotationQuaternion: Quaternion;
  97957. /**
  97958. * The type of controller (Eg. Windows mixed reality)
  97959. */
  97960. controllerType: PoseEnabledControllerType;
  97961. protected _calculatedPosition: Vector3;
  97962. private _calculatedRotation;
  97963. /**
  97964. * The raw pose from the device
  97965. */
  97966. rawPose: DevicePose;
  97967. private _trackPosition;
  97968. private _maxRotationDistFromHeadset;
  97969. private _draggedRoomRotation;
  97970. /**
  97971. * @hidden
  97972. */
  97973. _disableTrackPosition(fixedPosition: Vector3): void;
  97974. /**
  97975. * Internal, the mesh attached to the controller
  97976. * @hidden
  97977. */
  97978. _mesh: Nullable<AbstractMesh>;
  97979. private _poseControlledCamera;
  97980. private _leftHandSystemQuaternion;
  97981. /**
  97982. * Internal, matrix used to convert room space to babylon space
  97983. * @hidden
  97984. */
  97985. _deviceToWorld: Matrix;
  97986. /**
  97987. * Node to be used when casting a ray from the controller
  97988. * @hidden
  97989. */
  97990. _pointingPoseNode: Nullable<TransformNode>;
  97991. /**
  97992. * Name of the child mesh that can be used to cast a ray from the controller
  97993. */
  97994. static readonly POINTING_POSE: string;
  97995. /**
  97996. * Creates a new PoseEnabledController from a gamepad
  97997. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  97998. */
  97999. constructor(browserGamepad: any);
  98000. private _workingMatrix;
  98001. /**
  98002. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  98003. */
  98004. update(): void;
  98005. /**
  98006. * Updates only the pose device and mesh without doing any button event checking
  98007. */
  98008. protected _updatePoseAndMesh(): void;
  98009. /**
  98010. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  98011. * @param poseData raw pose fromthe device
  98012. */
  98013. updateFromDevice(poseData: DevicePose): void;
  98014. /**
  98015. * @hidden
  98016. */
  98017. _meshAttachedObservable: Observable<AbstractMesh>;
  98018. /**
  98019. * Attaches a mesh to the controller
  98020. * @param mesh the mesh to be attached
  98021. */
  98022. attachToMesh(mesh: AbstractMesh): void;
  98023. /**
  98024. * Attaches the controllers mesh to a camera
  98025. * @param camera the camera the mesh should be attached to
  98026. */
  98027. attachToPoseControlledCamera(camera: TargetCamera): void;
  98028. /**
  98029. * Disposes of the controller
  98030. */
  98031. dispose(): void;
  98032. /**
  98033. * The mesh that is attached to the controller
  98034. */
  98035. get mesh(): Nullable<AbstractMesh>;
  98036. /**
  98037. * Gets the ray of the controller in the direction the controller is pointing
  98038. * @param length the length the resulting ray should be
  98039. * @returns a ray in the direction the controller is pointing
  98040. */
  98041. getForwardRay(length?: number): Ray;
  98042. }
  98043. }
  98044. declare module BABYLON {
  98045. /**
  98046. * Defines the WebVRController object that represents controllers tracked in 3D space
  98047. */
  98048. export abstract class WebVRController extends PoseEnabledController {
  98049. /**
  98050. * Internal, the default controller model for the controller
  98051. */
  98052. protected _defaultModel: Nullable<AbstractMesh>;
  98053. /**
  98054. * Fired when the trigger state has changed
  98055. */
  98056. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  98057. /**
  98058. * Fired when the main button state has changed
  98059. */
  98060. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98061. /**
  98062. * Fired when the secondary button state has changed
  98063. */
  98064. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98065. /**
  98066. * Fired when the pad state has changed
  98067. */
  98068. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  98069. /**
  98070. * Fired when controllers stick values have changed
  98071. */
  98072. onPadValuesChangedObservable: Observable<StickValues>;
  98073. /**
  98074. * Array of button availible on the controller
  98075. */
  98076. protected _buttons: Array<MutableGamepadButton>;
  98077. private _onButtonStateChange;
  98078. /**
  98079. * Fired when a controller button's state has changed
  98080. * @param callback the callback containing the button that was modified
  98081. */
  98082. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  98083. /**
  98084. * X and Y axis corresponding to the controllers joystick
  98085. */
  98086. pad: StickValues;
  98087. /**
  98088. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  98089. */
  98090. hand: string;
  98091. /**
  98092. * The default controller model for the controller
  98093. */
  98094. get defaultModel(): Nullable<AbstractMesh>;
  98095. /**
  98096. * Creates a new WebVRController from a gamepad
  98097. * @param vrGamepad the gamepad that the WebVRController should be created from
  98098. */
  98099. constructor(vrGamepad: any);
  98100. /**
  98101. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  98102. */
  98103. update(): void;
  98104. /**
  98105. * Function to be called when a button is modified
  98106. */
  98107. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  98108. /**
  98109. * Loads a mesh and attaches it to the controller
  98110. * @param scene the scene the mesh should be added to
  98111. * @param meshLoaded callback for when the mesh has been loaded
  98112. */
  98113. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  98114. private _setButtonValue;
  98115. private _changes;
  98116. private _checkChanges;
  98117. /**
  98118. * Disposes of th webVRCOntroller
  98119. */
  98120. dispose(): void;
  98121. }
  98122. }
  98123. declare module BABYLON {
  98124. /**
  98125. * The HemisphericLight simulates the ambient environment light,
  98126. * so the passed direction is the light reflection direction, not the incoming direction.
  98127. */
  98128. export class HemisphericLight extends Light {
  98129. /**
  98130. * The groundColor is the light in the opposite direction to the one specified during creation.
  98131. * 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.
  98132. */
  98133. groundColor: Color3;
  98134. /**
  98135. * The light reflection direction, not the incoming direction.
  98136. */
  98137. direction: Vector3;
  98138. /**
  98139. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  98140. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  98141. * The HemisphericLight can't cast shadows.
  98142. * Documentation : https://doc.babylonjs.com/babylon101/lights
  98143. * @param name The friendly name of the light
  98144. * @param direction The direction of the light reflection
  98145. * @param scene The scene the light belongs to
  98146. */
  98147. constructor(name: string, direction: Vector3, scene: Scene);
  98148. protected _buildUniformLayout(): void;
  98149. /**
  98150. * Returns the string "HemisphericLight".
  98151. * @return The class name
  98152. */
  98153. getClassName(): string;
  98154. /**
  98155. * Sets the HemisphericLight direction towards the passed target (Vector3).
  98156. * Returns the updated direction.
  98157. * @param target The target the direction should point to
  98158. * @return The computed direction
  98159. */
  98160. setDirectionToTarget(target: Vector3): Vector3;
  98161. /**
  98162. * Returns the shadow generator associated to the light.
  98163. * @returns Always null for hemispheric lights because it does not support shadows.
  98164. */
  98165. getShadowGenerator(): Nullable<IShadowGenerator>;
  98166. /**
  98167. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  98168. * @param effect The effect to update
  98169. * @param lightIndex The index of the light in the effect to update
  98170. * @returns The hemispheric light
  98171. */
  98172. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  98173. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  98174. /**
  98175. * Computes the world matrix of the node
  98176. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  98177. * @param useWasUpdatedFlag defines a reserved property
  98178. * @returns the world matrix
  98179. */
  98180. computeWorldMatrix(): Matrix;
  98181. /**
  98182. * Returns the integer 3.
  98183. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98184. */
  98185. getTypeID(): number;
  98186. /**
  98187. * Prepares the list of defines specific to the light type.
  98188. * @param defines the list of defines
  98189. * @param lightIndex defines the index of the light for the effect
  98190. */
  98191. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98192. }
  98193. }
  98194. declare module BABYLON {
  98195. /** @hidden */
  98196. export var vrMultiviewToSingleviewPixelShader: {
  98197. name: string;
  98198. shader: string;
  98199. };
  98200. }
  98201. declare module BABYLON {
  98202. /**
  98203. * Renders to multiple views with a single draw call
  98204. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  98205. */
  98206. export class MultiviewRenderTarget extends RenderTargetTexture {
  98207. /**
  98208. * Creates a multiview render target
  98209. * @param scene scene used with the render target
  98210. * @param size the size of the render target (used for each view)
  98211. */
  98212. constructor(scene: Scene, size?: number | {
  98213. width: number;
  98214. height: number;
  98215. } | {
  98216. ratio: number;
  98217. });
  98218. /**
  98219. * @hidden
  98220. * @param faceIndex the face index, if its a cube texture
  98221. */
  98222. _bindFrameBuffer(faceIndex?: number): void;
  98223. /**
  98224. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  98225. * @returns the view count
  98226. */
  98227. getViewCount(): number;
  98228. }
  98229. }
  98230. declare module BABYLON {
  98231. interface Engine {
  98232. /**
  98233. * Creates a new multiview render target
  98234. * @param width defines the width of the texture
  98235. * @param height defines the height of the texture
  98236. * @returns the created multiview texture
  98237. */
  98238. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  98239. /**
  98240. * Binds a multiview framebuffer to be drawn to
  98241. * @param multiviewTexture texture to bind
  98242. */
  98243. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  98244. }
  98245. interface Camera {
  98246. /**
  98247. * @hidden
  98248. * 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)
  98249. */
  98250. _useMultiviewToSingleView: boolean;
  98251. /**
  98252. * @hidden
  98253. * 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)
  98254. */
  98255. _multiviewTexture: Nullable<RenderTargetTexture>;
  98256. /**
  98257. * @hidden
  98258. * ensures the multiview texture of the camera exists and has the specified width/height
  98259. * @param width height to set on the multiview texture
  98260. * @param height width to set on the multiview texture
  98261. */
  98262. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  98263. }
  98264. interface Scene {
  98265. /** @hidden */
  98266. _transformMatrixR: Matrix;
  98267. /** @hidden */
  98268. _multiviewSceneUbo: Nullable<UniformBuffer>;
  98269. /** @hidden */
  98270. _createMultiviewUbo(): void;
  98271. /** @hidden */
  98272. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  98273. /** @hidden */
  98274. _renderMultiviewToSingleView(camera: Camera): void;
  98275. }
  98276. }
  98277. declare module BABYLON {
  98278. /**
  98279. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  98280. * This will not be used for webXR as it supports displaying texture arrays directly
  98281. */
  98282. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  98283. /**
  98284. * Initializes a VRMultiviewToSingleview
  98285. * @param name name of the post process
  98286. * @param camera camera to be applied to
  98287. * @param scaleFactor scaling factor to the size of the output texture
  98288. */
  98289. constructor(name: string, camera: Camera, scaleFactor: number);
  98290. }
  98291. }
  98292. declare module BABYLON {
  98293. /**
  98294. * Interface used to define additional presentation attributes
  98295. */
  98296. export interface IVRPresentationAttributes {
  98297. /**
  98298. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  98299. */
  98300. highRefreshRate: boolean;
  98301. /**
  98302. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  98303. */
  98304. foveationLevel: number;
  98305. }
  98306. interface Engine {
  98307. /** @hidden */
  98308. _vrDisplay: any;
  98309. /** @hidden */
  98310. _vrSupported: boolean;
  98311. /** @hidden */
  98312. _oldSize: Size;
  98313. /** @hidden */
  98314. _oldHardwareScaleFactor: number;
  98315. /** @hidden */
  98316. _vrExclusivePointerMode: boolean;
  98317. /** @hidden */
  98318. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  98319. /** @hidden */
  98320. _onVRDisplayPointerRestricted: () => void;
  98321. /** @hidden */
  98322. _onVRDisplayPointerUnrestricted: () => void;
  98323. /** @hidden */
  98324. _onVrDisplayConnect: Nullable<(display: any) => void>;
  98325. /** @hidden */
  98326. _onVrDisplayDisconnect: Nullable<() => void>;
  98327. /** @hidden */
  98328. _onVrDisplayPresentChange: Nullable<() => void>;
  98329. /**
  98330. * Observable signaled when VR display mode changes
  98331. */
  98332. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  98333. /**
  98334. * Observable signaled when VR request present is complete
  98335. */
  98336. onVRRequestPresentComplete: Observable<boolean>;
  98337. /**
  98338. * Observable signaled when VR request present starts
  98339. */
  98340. onVRRequestPresentStart: Observable<Engine>;
  98341. /**
  98342. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  98343. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  98344. */
  98345. isInVRExclusivePointerMode: boolean;
  98346. /**
  98347. * Gets a boolean indicating if a webVR device was detected
  98348. * @returns true if a webVR device was detected
  98349. */
  98350. isVRDevicePresent(): boolean;
  98351. /**
  98352. * Gets the current webVR device
  98353. * @returns the current webVR device (or null)
  98354. */
  98355. getVRDevice(): any;
  98356. /**
  98357. * Initializes a webVR display and starts listening to display change events
  98358. * The onVRDisplayChangedObservable will be notified upon these changes
  98359. * @returns A promise containing a VRDisplay and if vr is supported
  98360. */
  98361. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  98362. /** @hidden */
  98363. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  98364. /**
  98365. * Gets or sets the presentation attributes used to configure VR rendering
  98366. */
  98367. vrPresentationAttributes?: IVRPresentationAttributes;
  98368. /**
  98369. * Call this function to switch to webVR mode
  98370. * Will do nothing if webVR is not supported or if there is no webVR device
  98371. * @param options the webvr options provided to the camera. mainly used for multiview
  98372. * @see https://doc.babylonjs.com/how_to/webvr_camera
  98373. */
  98374. enableVR(options: WebVROptions): void;
  98375. /** @hidden */
  98376. _onVRFullScreenTriggered(): void;
  98377. }
  98378. }
  98379. declare module BABYLON {
  98380. /**
  98381. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  98382. * IMPORTANT!! The data is right-hand data.
  98383. * @export
  98384. * @interface DevicePose
  98385. */
  98386. export interface DevicePose {
  98387. /**
  98388. * The position of the device, values in array are [x,y,z].
  98389. */
  98390. readonly position: Nullable<Float32Array>;
  98391. /**
  98392. * The linearVelocity of the device, values in array are [x,y,z].
  98393. */
  98394. readonly linearVelocity: Nullable<Float32Array>;
  98395. /**
  98396. * The linearAcceleration of the device, values in array are [x,y,z].
  98397. */
  98398. readonly linearAcceleration: Nullable<Float32Array>;
  98399. /**
  98400. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  98401. */
  98402. readonly orientation: Nullable<Float32Array>;
  98403. /**
  98404. * The angularVelocity of the device, values in array are [x,y,z].
  98405. */
  98406. readonly angularVelocity: Nullable<Float32Array>;
  98407. /**
  98408. * The angularAcceleration of the device, values in array are [x,y,z].
  98409. */
  98410. readonly angularAcceleration: Nullable<Float32Array>;
  98411. }
  98412. /**
  98413. * Interface representing a pose controlled object in Babylon.
  98414. * A pose controlled object has both regular pose values as well as pose values
  98415. * from an external device such as a VR head mounted display
  98416. */
  98417. export interface PoseControlled {
  98418. /**
  98419. * The position of the object in babylon space.
  98420. */
  98421. position: Vector3;
  98422. /**
  98423. * The rotation quaternion of the object in babylon space.
  98424. */
  98425. rotationQuaternion: Quaternion;
  98426. /**
  98427. * The position of the device in babylon space.
  98428. */
  98429. devicePosition?: Vector3;
  98430. /**
  98431. * The rotation quaternion of the device in babylon space.
  98432. */
  98433. deviceRotationQuaternion: Quaternion;
  98434. /**
  98435. * The raw pose coming from the device.
  98436. */
  98437. rawPose: Nullable<DevicePose>;
  98438. /**
  98439. * The scale of the device to be used when translating from device space to babylon space.
  98440. */
  98441. deviceScaleFactor: number;
  98442. /**
  98443. * Updates the poseControlled values based on the input device pose.
  98444. * @param poseData the pose data to update the object with
  98445. */
  98446. updateFromDevice(poseData: DevicePose): void;
  98447. }
  98448. /**
  98449. * Set of options to customize the webVRCamera
  98450. */
  98451. export interface WebVROptions {
  98452. /**
  98453. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  98454. */
  98455. trackPosition?: boolean;
  98456. /**
  98457. * Sets the scale of the vrDevice in babylon space. (default: 1)
  98458. */
  98459. positionScale?: number;
  98460. /**
  98461. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  98462. */
  98463. displayName?: string;
  98464. /**
  98465. * Should the native controller meshes be initialized. (default: true)
  98466. */
  98467. controllerMeshes?: boolean;
  98468. /**
  98469. * Creating a default HemiLight only on controllers. (default: true)
  98470. */
  98471. defaultLightingOnControllers?: boolean;
  98472. /**
  98473. * If you don't want to use the default VR button of the helper. (default: false)
  98474. */
  98475. useCustomVRButton?: boolean;
  98476. /**
  98477. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  98478. */
  98479. customVRButton?: HTMLButtonElement;
  98480. /**
  98481. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  98482. */
  98483. rayLength?: number;
  98484. /**
  98485. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  98486. */
  98487. defaultHeight?: number;
  98488. /**
  98489. * If multiview should be used if availible (default: false)
  98490. */
  98491. useMultiview?: boolean;
  98492. }
  98493. /**
  98494. * This represents a WebVR camera.
  98495. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  98496. * @example https://doc.babylonjs.com/how_to/webvr_camera
  98497. */
  98498. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  98499. private webVROptions;
  98500. /**
  98501. * @hidden
  98502. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  98503. */
  98504. _vrDevice: any;
  98505. /**
  98506. * The rawPose of the vrDevice.
  98507. */
  98508. rawPose: Nullable<DevicePose>;
  98509. private _onVREnabled;
  98510. private _specsVersion;
  98511. private _attached;
  98512. private _frameData;
  98513. protected _descendants: Array<Node>;
  98514. private _deviceRoomPosition;
  98515. /** @hidden */
  98516. _deviceRoomRotationQuaternion: Quaternion;
  98517. private _standingMatrix;
  98518. /**
  98519. * Represents device position in babylon space.
  98520. */
  98521. devicePosition: Vector3;
  98522. /**
  98523. * Represents device rotation in babylon space.
  98524. */
  98525. deviceRotationQuaternion: Quaternion;
  98526. /**
  98527. * The scale of the device to be used when translating from device space to babylon space.
  98528. */
  98529. deviceScaleFactor: number;
  98530. private _deviceToWorld;
  98531. private _worldToDevice;
  98532. /**
  98533. * References to the webVR controllers for the vrDevice.
  98534. */
  98535. controllers: Array<WebVRController>;
  98536. /**
  98537. * Emits an event when a controller is attached.
  98538. */
  98539. onControllersAttachedObservable: Observable<WebVRController[]>;
  98540. /**
  98541. * Emits an event when a controller's mesh has been loaded;
  98542. */
  98543. onControllerMeshLoadedObservable: Observable<WebVRController>;
  98544. /**
  98545. * Emits an event when the HMD's pose has been updated.
  98546. */
  98547. onPoseUpdatedFromDeviceObservable: Observable<any>;
  98548. private _poseSet;
  98549. /**
  98550. * If the rig cameras be used as parent instead of this camera.
  98551. */
  98552. rigParenting: boolean;
  98553. private _lightOnControllers;
  98554. private _defaultHeight?;
  98555. /**
  98556. * Instantiates a WebVRFreeCamera.
  98557. * @param name The name of the WebVRFreeCamera
  98558. * @param position The starting anchor position for the camera
  98559. * @param scene The scene the camera belongs to
  98560. * @param webVROptions a set of customizable options for the webVRCamera
  98561. */
  98562. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  98563. /**
  98564. * Gets the device distance from the ground in meters.
  98565. * @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.
  98566. */
  98567. deviceDistanceToRoomGround(): number;
  98568. /**
  98569. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  98570. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  98571. */
  98572. useStandingMatrix(callback?: (bool: boolean) => void): void;
  98573. /**
  98574. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  98575. * @returns A promise with a boolean set to if the standing matrix is supported.
  98576. */
  98577. useStandingMatrixAsync(): Promise<boolean>;
  98578. /**
  98579. * Disposes the camera
  98580. */
  98581. dispose(): void;
  98582. /**
  98583. * Gets a vrController by name.
  98584. * @param name The name of the controller to retreive
  98585. * @returns the controller matching the name specified or null if not found
  98586. */
  98587. getControllerByName(name: string): Nullable<WebVRController>;
  98588. private _leftController;
  98589. /**
  98590. * The controller corresponding to the users left hand.
  98591. */
  98592. get leftController(): Nullable<WebVRController>;
  98593. private _rightController;
  98594. /**
  98595. * The controller corresponding to the users right hand.
  98596. */
  98597. get rightController(): Nullable<WebVRController>;
  98598. /**
  98599. * Casts a ray forward from the vrCamera's gaze.
  98600. * @param length Length of the ray (default: 100)
  98601. * @returns the ray corresponding to the gaze
  98602. */
  98603. getForwardRay(length?: number): Ray;
  98604. /**
  98605. * @hidden
  98606. * Updates the camera based on device's frame data
  98607. */
  98608. _checkInputs(): void;
  98609. /**
  98610. * Updates the poseControlled values based on the input device pose.
  98611. * @param poseData Pose coming from the device
  98612. */
  98613. updateFromDevice(poseData: DevicePose): void;
  98614. private _htmlElementAttached;
  98615. private _detachIfAttached;
  98616. /**
  98617. * WebVR's attach control will start broadcasting frames to the device.
  98618. * Note that in certain browsers (chrome for example) this function must be called
  98619. * within a user-interaction callback. Example:
  98620. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  98621. *
  98622. * @param element html element to attach the vrDevice to
  98623. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  98624. */
  98625. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98626. /**
  98627. * Detaches the camera from the html element and disables VR
  98628. *
  98629. * @param element html element to detach from
  98630. */
  98631. detachControl(element: HTMLElement): void;
  98632. /**
  98633. * @returns the name of this class
  98634. */
  98635. getClassName(): string;
  98636. /**
  98637. * Calls resetPose on the vrDisplay
  98638. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  98639. */
  98640. resetToCurrentRotation(): void;
  98641. /**
  98642. * @hidden
  98643. * Updates the rig cameras (left and right eye)
  98644. */
  98645. _updateRigCameras(): void;
  98646. private _workingVector;
  98647. private _oneVector;
  98648. private _workingMatrix;
  98649. private updateCacheCalled;
  98650. private _correctPositionIfNotTrackPosition;
  98651. /**
  98652. * @hidden
  98653. * Updates the cached values of the camera
  98654. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  98655. */
  98656. _updateCache(ignoreParentClass?: boolean): void;
  98657. /**
  98658. * @hidden
  98659. * Get current device position in babylon world
  98660. */
  98661. _computeDevicePosition(): void;
  98662. /**
  98663. * Updates the current device position and rotation in the babylon world
  98664. */
  98665. update(): void;
  98666. /**
  98667. * @hidden
  98668. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  98669. * @returns an identity matrix
  98670. */
  98671. _getViewMatrix(): Matrix;
  98672. private _tmpMatrix;
  98673. /**
  98674. * This function is called by the two RIG cameras.
  98675. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  98676. * @hidden
  98677. */
  98678. _getWebVRViewMatrix(): Matrix;
  98679. /** @hidden */
  98680. _getWebVRProjectionMatrix(): Matrix;
  98681. private _onGamepadConnectedObserver;
  98682. private _onGamepadDisconnectedObserver;
  98683. private _updateCacheWhenTrackingDisabledObserver;
  98684. /**
  98685. * Initializes the controllers and their meshes
  98686. */
  98687. initControllers(): void;
  98688. }
  98689. }
  98690. declare module BABYLON {
  98691. /**
  98692. * "Static Class" containing the most commonly used helper while dealing with material for
  98693. * rendering purpose.
  98694. *
  98695. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  98696. *
  98697. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  98698. */
  98699. export class MaterialHelper {
  98700. /**
  98701. * Bind the current view position to an effect.
  98702. * @param effect The effect to be bound
  98703. * @param scene The scene the eyes position is used from
  98704. * @param variableName name of the shader variable that will hold the eye position
  98705. */
  98706. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  98707. /**
  98708. * Helps preparing the defines values about the UVs in used in the effect.
  98709. * UVs are shared as much as we can accross channels in the shaders.
  98710. * @param texture The texture we are preparing the UVs for
  98711. * @param defines The defines to update
  98712. * @param key The channel key "diffuse", "specular"... used in the shader
  98713. */
  98714. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  98715. /**
  98716. * Binds a texture matrix value to its corrsponding uniform
  98717. * @param texture The texture to bind the matrix for
  98718. * @param uniformBuffer The uniform buffer receivin the data
  98719. * @param key The channel key "diffuse", "specular"... used in the shader
  98720. */
  98721. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  98722. /**
  98723. * Gets the current status of the fog (should it be enabled?)
  98724. * @param mesh defines the mesh to evaluate for fog support
  98725. * @param scene defines the hosting scene
  98726. * @returns true if fog must be enabled
  98727. */
  98728. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  98729. /**
  98730. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  98731. * @param mesh defines the current mesh
  98732. * @param scene defines the current scene
  98733. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  98734. * @param pointsCloud defines if point cloud rendering has to be turned on
  98735. * @param fogEnabled defines if fog has to be turned on
  98736. * @param alphaTest defines if alpha testing has to be turned on
  98737. * @param defines defines the current list of defines
  98738. */
  98739. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  98740. /**
  98741. * Helper used to prepare the list of defines associated with frame values for shader compilation
  98742. * @param scene defines the current scene
  98743. * @param engine defines the current engine
  98744. * @param defines specifies the list of active defines
  98745. * @param useInstances defines if instances have to be turned on
  98746. * @param useClipPlane defines if clip plane have to be turned on
  98747. * @param useInstances defines if instances have to be turned on
  98748. * @param useThinInstances defines if thin instances have to be turned on
  98749. */
  98750. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  98751. /**
  98752. * Prepares the defines for bones
  98753. * @param mesh The mesh containing the geometry data we will draw
  98754. * @param defines The defines to update
  98755. */
  98756. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  98757. /**
  98758. * Prepares the defines for morph targets
  98759. * @param mesh The mesh containing the geometry data we will draw
  98760. * @param defines The defines to update
  98761. */
  98762. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  98763. /**
  98764. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  98765. * @param mesh The mesh containing the geometry data we will draw
  98766. * @param defines The defines to update
  98767. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  98768. * @param useBones Precise whether bones should be used or not (override mesh info)
  98769. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  98770. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  98771. * @returns false if defines are considered not dirty and have not been checked
  98772. */
  98773. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  98774. /**
  98775. * Prepares the defines related to multiview
  98776. * @param scene The scene we are intending to draw
  98777. * @param defines The defines to update
  98778. */
  98779. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  98780. /**
  98781. * Prepares the defines related to the prepass
  98782. * @param scene The scene we are intending to draw
  98783. * @param defines The defines to update
  98784. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  98785. */
  98786. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  98787. /**
  98788. * Prepares the defines related to the light information passed in parameter
  98789. * @param scene The scene we are intending to draw
  98790. * @param mesh The mesh the effect is compiling for
  98791. * @param light The light the effect is compiling for
  98792. * @param lightIndex The index of the light
  98793. * @param defines The defines to update
  98794. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  98795. * @param state Defines the current state regarding what is needed (normals, etc...)
  98796. */
  98797. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  98798. needNormals: boolean;
  98799. needRebuild: boolean;
  98800. shadowEnabled: boolean;
  98801. specularEnabled: boolean;
  98802. lightmapMode: boolean;
  98803. }): void;
  98804. /**
  98805. * Prepares the defines related to the light information passed in parameter
  98806. * @param scene The scene we are intending to draw
  98807. * @param mesh The mesh the effect is compiling for
  98808. * @param defines The defines to update
  98809. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  98810. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  98811. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  98812. * @returns true if normals will be required for the rest of the effect
  98813. */
  98814. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  98815. /**
  98816. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  98817. * @param lightIndex defines the light index
  98818. * @param uniformsList The uniform list
  98819. * @param samplersList The sampler list
  98820. * @param projectedLightTexture defines if projected texture must be used
  98821. * @param uniformBuffersList defines an optional list of uniform buffers
  98822. */
  98823. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  98824. /**
  98825. * Prepares the uniforms and samplers list to be used in the effect
  98826. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  98827. * @param samplersList The sampler list
  98828. * @param defines The defines helping in the list generation
  98829. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  98830. */
  98831. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  98832. /**
  98833. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  98834. * @param defines The defines to update while falling back
  98835. * @param fallbacks The authorized effect fallbacks
  98836. * @param maxSimultaneousLights The maximum number of lights allowed
  98837. * @param rank the current rank of the Effect
  98838. * @returns The newly affected rank
  98839. */
  98840. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  98841. private static _TmpMorphInfluencers;
  98842. /**
  98843. * Prepares the list of attributes required for morph targets according to the effect defines.
  98844. * @param attribs The current list of supported attribs
  98845. * @param mesh The mesh to prepare the morph targets attributes for
  98846. * @param influencers The number of influencers
  98847. */
  98848. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  98849. /**
  98850. * Prepares the list of attributes required for morph targets according to the effect defines.
  98851. * @param attribs The current list of supported attribs
  98852. * @param mesh The mesh to prepare the morph targets attributes for
  98853. * @param defines The current Defines of the effect
  98854. */
  98855. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  98856. /**
  98857. * Prepares the list of attributes required for bones according to the effect defines.
  98858. * @param attribs The current list of supported attribs
  98859. * @param mesh The mesh to prepare the bones attributes for
  98860. * @param defines The current Defines of the effect
  98861. * @param fallbacks The current efffect fallback strategy
  98862. */
  98863. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  98864. /**
  98865. * Check and prepare the list of attributes required for instances according to the effect defines.
  98866. * @param attribs The current list of supported attribs
  98867. * @param defines The current MaterialDefines of the effect
  98868. */
  98869. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  98870. /**
  98871. * Add the list of attributes required for instances to the attribs array.
  98872. * @param attribs The current list of supported attribs
  98873. */
  98874. static PushAttributesForInstances(attribs: string[]): void;
  98875. /**
  98876. * Binds the light information to the effect.
  98877. * @param light The light containing the generator
  98878. * @param effect The effect we are binding the data to
  98879. * @param lightIndex The light index in the effect used to render
  98880. */
  98881. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  98882. /**
  98883. * Binds the lights information from the scene to the effect for the given mesh.
  98884. * @param light Light to bind
  98885. * @param lightIndex Light index
  98886. * @param scene The scene where the light belongs to
  98887. * @param effect The effect we are binding the data to
  98888. * @param useSpecular Defines if specular is supported
  98889. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98890. */
  98891. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  98892. /**
  98893. * Binds the lights information from the scene to the effect for the given mesh.
  98894. * @param scene The scene the lights belongs to
  98895. * @param mesh The mesh we are binding the information to render
  98896. * @param effect The effect we are binding the data to
  98897. * @param defines The generated defines for the effect
  98898. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  98899. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98900. */
  98901. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  98902. private static _tempFogColor;
  98903. /**
  98904. * Binds the fog information from the scene to the effect for the given mesh.
  98905. * @param scene The scene the lights belongs to
  98906. * @param mesh The mesh we are binding the information to render
  98907. * @param effect The effect we are binding the data to
  98908. * @param linearSpace Defines if the fog effect is applied in linear space
  98909. */
  98910. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  98911. /**
  98912. * Binds the bones information from the mesh to the effect.
  98913. * @param mesh The mesh we are binding the information to render
  98914. * @param effect The effect we are binding the data to
  98915. */
  98916. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  98917. /**
  98918. * Binds the morph targets information from the mesh to the effect.
  98919. * @param abstractMesh The mesh we are binding the information to render
  98920. * @param effect The effect we are binding the data to
  98921. */
  98922. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  98923. /**
  98924. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  98925. * @param defines The generated defines used in the effect
  98926. * @param effect The effect we are binding the data to
  98927. * @param scene The scene we are willing to render with logarithmic scale for
  98928. */
  98929. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  98930. /**
  98931. * Binds the clip plane information from the scene to the effect.
  98932. * @param scene The scene the clip plane information are extracted from
  98933. * @param effect The effect we are binding the data to
  98934. */
  98935. static BindClipPlane(effect: Effect, scene: Scene): void;
  98936. }
  98937. }
  98938. declare module BABYLON {
  98939. /**
  98940. * Block used to expose an input value
  98941. */
  98942. export class InputBlock extends NodeMaterialBlock {
  98943. private _mode;
  98944. private _associatedVariableName;
  98945. private _storedValue;
  98946. private _valueCallback;
  98947. private _type;
  98948. private _animationType;
  98949. /** Gets or set a value used to limit the range of float values */
  98950. min: number;
  98951. /** Gets or set a value used to limit the range of float values */
  98952. max: number;
  98953. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  98954. isBoolean: boolean;
  98955. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  98956. matrixMode: number;
  98957. /** @hidden */
  98958. _systemValue: Nullable<NodeMaterialSystemValues>;
  98959. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  98960. visibleInInspector: boolean;
  98961. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  98962. isConstant: boolean;
  98963. /** Gets or sets the group to use to display this block in the Inspector */
  98964. groupInInspector: string;
  98965. /** Gets an observable raised when the value is changed */
  98966. onValueChangedObservable: Observable<InputBlock>;
  98967. /**
  98968. * Gets or sets the connection point type (default is float)
  98969. */
  98970. get type(): NodeMaterialBlockConnectionPointTypes;
  98971. /**
  98972. * Creates a new InputBlock
  98973. * @param name defines the block name
  98974. * @param target defines the target of that block (Vertex by default)
  98975. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  98976. */
  98977. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  98978. /**
  98979. * Validates if a name is a reserve word.
  98980. * @param newName the new name to be given to the node.
  98981. * @returns false if the name is a reserve word, else true.
  98982. */
  98983. validateBlockName(newName: string): boolean;
  98984. /**
  98985. * Gets the output component
  98986. */
  98987. get output(): NodeMaterialConnectionPoint;
  98988. /**
  98989. * Set the source of this connection point to a vertex attribute
  98990. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  98991. * @returns the current connection point
  98992. */
  98993. setAsAttribute(attributeName?: string): InputBlock;
  98994. /**
  98995. * Set the source of this connection point to a system value
  98996. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  98997. * @returns the current connection point
  98998. */
  98999. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  99000. /**
  99001. * Gets or sets the value of that point.
  99002. * Please note that this value will be ignored if valueCallback is defined
  99003. */
  99004. get value(): any;
  99005. set value(value: any);
  99006. /**
  99007. * Gets or sets a callback used to get the value of that point.
  99008. * Please note that setting this value will force the connection point to ignore the value property
  99009. */
  99010. get valueCallback(): () => any;
  99011. set valueCallback(value: () => any);
  99012. /**
  99013. * Gets or sets the associated variable name in the shader
  99014. */
  99015. get associatedVariableName(): string;
  99016. set associatedVariableName(value: string);
  99017. /** Gets or sets the type of animation applied to the input */
  99018. get animationType(): AnimatedInputBlockTypes;
  99019. set animationType(value: AnimatedInputBlockTypes);
  99020. /**
  99021. * Gets a boolean indicating that this connection point not defined yet
  99022. */
  99023. get isUndefined(): boolean;
  99024. /**
  99025. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  99026. * In this case the connection point name must be the name of the uniform to use.
  99027. * Can only be set on inputs
  99028. */
  99029. get isUniform(): boolean;
  99030. set isUniform(value: boolean);
  99031. /**
  99032. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  99033. * In this case the connection point name must be the name of the attribute to use
  99034. * Can only be set on inputs
  99035. */
  99036. get isAttribute(): boolean;
  99037. set isAttribute(value: boolean);
  99038. /**
  99039. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  99040. * Can only be set on exit points
  99041. */
  99042. get isVarying(): boolean;
  99043. set isVarying(value: boolean);
  99044. /**
  99045. * Gets a boolean indicating that the current connection point is a system value
  99046. */
  99047. get isSystemValue(): boolean;
  99048. /**
  99049. * Gets or sets the current well known value or null if not defined as a system value
  99050. */
  99051. get systemValue(): Nullable<NodeMaterialSystemValues>;
  99052. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  99053. /**
  99054. * Gets the current class name
  99055. * @returns the class name
  99056. */
  99057. getClassName(): string;
  99058. /**
  99059. * Animate the input if animationType !== None
  99060. * @param scene defines the rendering scene
  99061. */
  99062. animate(scene: Scene): void;
  99063. private _emitDefine;
  99064. initialize(state: NodeMaterialBuildState): void;
  99065. /**
  99066. * Set the input block to its default value (based on its type)
  99067. */
  99068. setDefaultValue(): void;
  99069. private _emitConstant;
  99070. /** @hidden */
  99071. get _noContextSwitch(): boolean;
  99072. private _emit;
  99073. /** @hidden */
  99074. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  99075. /** @hidden */
  99076. _transmit(effect: Effect, scene: Scene): void;
  99077. protected _buildBlock(state: NodeMaterialBuildState): void;
  99078. protected _dumpPropertiesCode(): string;
  99079. dispose(): void;
  99080. serialize(): any;
  99081. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99082. }
  99083. }
  99084. declare module BABYLON {
  99085. /**
  99086. * Enum used to define the compatibility state between two connection points
  99087. */
  99088. export enum NodeMaterialConnectionPointCompatibilityStates {
  99089. /** Points are compatibles */
  99090. Compatible = 0,
  99091. /** Points are incompatible because of their types */
  99092. TypeIncompatible = 1,
  99093. /** Points are incompatible because of their targets (vertex vs fragment) */
  99094. TargetIncompatible = 2
  99095. }
  99096. /**
  99097. * Defines the direction of a connection point
  99098. */
  99099. export enum NodeMaterialConnectionPointDirection {
  99100. /** Input */
  99101. Input = 0,
  99102. /** Output */
  99103. Output = 1
  99104. }
  99105. /**
  99106. * Defines a connection point for a block
  99107. */
  99108. export class NodeMaterialConnectionPoint {
  99109. /** @hidden */
  99110. _ownerBlock: NodeMaterialBlock;
  99111. /** @hidden */
  99112. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  99113. private _endpoints;
  99114. private _associatedVariableName;
  99115. private _direction;
  99116. /** @hidden */
  99117. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99118. /** @hidden */
  99119. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99120. private _type;
  99121. /** @hidden */
  99122. _enforceAssociatedVariableName: boolean;
  99123. /** Gets the direction of the point */
  99124. get direction(): NodeMaterialConnectionPointDirection;
  99125. /** Indicates that this connection point needs dual validation before being connected to another point */
  99126. needDualDirectionValidation: boolean;
  99127. /**
  99128. * Gets or sets the additional types supported by this connection point
  99129. */
  99130. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  99131. /**
  99132. * Gets or sets the additional types excluded by this connection point
  99133. */
  99134. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  99135. /**
  99136. * Observable triggered when this point is connected
  99137. */
  99138. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  99139. /**
  99140. * Gets or sets the associated variable name in the shader
  99141. */
  99142. get associatedVariableName(): string;
  99143. set associatedVariableName(value: string);
  99144. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  99145. get innerType(): NodeMaterialBlockConnectionPointTypes;
  99146. /**
  99147. * Gets or sets the connection point type (default is float)
  99148. */
  99149. get type(): NodeMaterialBlockConnectionPointTypes;
  99150. set type(value: NodeMaterialBlockConnectionPointTypes);
  99151. /**
  99152. * Gets or sets the connection point name
  99153. */
  99154. name: string;
  99155. /**
  99156. * Gets or sets the connection point name
  99157. */
  99158. displayName: string;
  99159. /**
  99160. * Gets or sets a boolean indicating that this connection point can be omitted
  99161. */
  99162. isOptional: boolean;
  99163. /**
  99164. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  99165. */
  99166. isExposedOnFrame: boolean;
  99167. /**
  99168. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  99169. */
  99170. define: string;
  99171. /** @hidden */
  99172. _prioritizeVertex: boolean;
  99173. private _target;
  99174. /** Gets or sets the target of that connection point */
  99175. get target(): NodeMaterialBlockTargets;
  99176. set target(value: NodeMaterialBlockTargets);
  99177. /**
  99178. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  99179. */
  99180. get isConnected(): boolean;
  99181. /**
  99182. * Gets a boolean indicating that the current point is connected to an input block
  99183. */
  99184. get isConnectedToInputBlock(): boolean;
  99185. /**
  99186. * Gets a the connected input block (if any)
  99187. */
  99188. get connectInputBlock(): Nullable<InputBlock>;
  99189. /** Get the other side of the connection (if any) */
  99190. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  99191. /** Get the block that owns this connection point */
  99192. get ownerBlock(): NodeMaterialBlock;
  99193. /** Get the block connected on the other side of this connection (if any) */
  99194. get sourceBlock(): Nullable<NodeMaterialBlock>;
  99195. /** Get the block connected on the endpoints of this connection (if any) */
  99196. get connectedBlocks(): Array<NodeMaterialBlock>;
  99197. /** Gets the list of connected endpoints */
  99198. get endpoints(): NodeMaterialConnectionPoint[];
  99199. /** Gets a boolean indicating if that output point is connected to at least one input */
  99200. get hasEndpoints(): boolean;
  99201. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  99202. get isConnectedInVertexShader(): boolean;
  99203. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  99204. get isConnectedInFragmentShader(): boolean;
  99205. /**
  99206. * Creates a block suitable to be used as an input for this input point.
  99207. * If null is returned, a block based on the point type will be created.
  99208. * @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
  99209. */
  99210. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  99211. /**
  99212. * Creates a new connection point
  99213. * @param name defines the connection point name
  99214. * @param ownerBlock defines the block hosting this connection point
  99215. * @param direction defines the direction of the connection point
  99216. */
  99217. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  99218. /**
  99219. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  99220. * @returns the class name
  99221. */
  99222. getClassName(): string;
  99223. /**
  99224. * Gets a boolean indicating if the current point can be connected to another point
  99225. * @param connectionPoint defines the other connection point
  99226. * @returns a boolean
  99227. */
  99228. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  99229. /**
  99230. * Gets a number indicating if the current point can be connected to another point
  99231. * @param connectionPoint defines the other connection point
  99232. * @returns a number defining the compatibility state
  99233. */
  99234. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  99235. /**
  99236. * Connect this point to another connection point
  99237. * @param connectionPoint defines the other connection point
  99238. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  99239. * @returns the current connection point
  99240. */
  99241. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  99242. /**
  99243. * Disconnect this point from one of his endpoint
  99244. * @param endpoint defines the other connection point
  99245. * @returns the current connection point
  99246. */
  99247. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  99248. /**
  99249. * Serializes this point in a JSON representation
  99250. * @param isInput defines if the connection point is an input (default is true)
  99251. * @returns the serialized point object
  99252. */
  99253. serialize(isInput?: boolean): any;
  99254. /**
  99255. * Release resources
  99256. */
  99257. dispose(): void;
  99258. }
  99259. }
  99260. declare module BABYLON {
  99261. /**
  99262. * Enum used to define the material modes
  99263. */
  99264. export enum NodeMaterialModes {
  99265. /** Regular material */
  99266. Material = 0,
  99267. /** For post process */
  99268. PostProcess = 1,
  99269. /** For particle system */
  99270. Particle = 2
  99271. }
  99272. }
  99273. declare module BABYLON {
  99274. /**
  99275. * Block used to read a texture from a sampler
  99276. */
  99277. export class TextureBlock extends NodeMaterialBlock {
  99278. private _defineName;
  99279. private _linearDefineName;
  99280. private _gammaDefineName;
  99281. private _tempTextureRead;
  99282. private _samplerName;
  99283. private _transformedUVName;
  99284. private _textureTransformName;
  99285. private _textureInfoName;
  99286. private _mainUVName;
  99287. private _mainUVDefineName;
  99288. private _fragmentOnly;
  99289. /**
  99290. * Gets or sets the texture associated with the node
  99291. */
  99292. texture: Nullable<Texture>;
  99293. /**
  99294. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99295. */
  99296. convertToGammaSpace: boolean;
  99297. /**
  99298. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99299. */
  99300. convertToLinearSpace: boolean;
  99301. /**
  99302. * Create a new TextureBlock
  99303. * @param name defines the block name
  99304. */
  99305. constructor(name: string, fragmentOnly?: boolean);
  99306. /**
  99307. * Gets the current class name
  99308. * @returns the class name
  99309. */
  99310. getClassName(): string;
  99311. /**
  99312. * Gets the uv input component
  99313. */
  99314. get uv(): NodeMaterialConnectionPoint;
  99315. /**
  99316. * Gets the rgba output component
  99317. */
  99318. get rgba(): NodeMaterialConnectionPoint;
  99319. /**
  99320. * Gets the rgb output component
  99321. */
  99322. get rgb(): NodeMaterialConnectionPoint;
  99323. /**
  99324. * Gets the r output component
  99325. */
  99326. get r(): NodeMaterialConnectionPoint;
  99327. /**
  99328. * Gets the g output component
  99329. */
  99330. get g(): NodeMaterialConnectionPoint;
  99331. /**
  99332. * Gets the b output component
  99333. */
  99334. get b(): NodeMaterialConnectionPoint;
  99335. /**
  99336. * Gets the a output component
  99337. */
  99338. get a(): NodeMaterialConnectionPoint;
  99339. get target(): NodeMaterialBlockTargets;
  99340. autoConfigure(material: NodeMaterial): void;
  99341. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  99342. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99343. isReady(): boolean;
  99344. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  99345. private get _isMixed();
  99346. private _injectVertexCode;
  99347. private _writeTextureRead;
  99348. private _writeOutput;
  99349. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99350. protected _dumpPropertiesCode(): string;
  99351. serialize(): any;
  99352. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99353. }
  99354. }
  99355. declare module BABYLON {
  99356. /** @hidden */
  99357. export var reflectionFunction: {
  99358. name: string;
  99359. shader: string;
  99360. };
  99361. }
  99362. declare module BABYLON {
  99363. /**
  99364. * Base block used to read a reflection texture from a sampler
  99365. */
  99366. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  99367. /** @hidden */
  99368. _define3DName: string;
  99369. /** @hidden */
  99370. _defineCubicName: string;
  99371. /** @hidden */
  99372. _defineExplicitName: string;
  99373. /** @hidden */
  99374. _defineProjectionName: string;
  99375. /** @hidden */
  99376. _defineLocalCubicName: string;
  99377. /** @hidden */
  99378. _defineSphericalName: string;
  99379. /** @hidden */
  99380. _definePlanarName: string;
  99381. /** @hidden */
  99382. _defineEquirectangularName: string;
  99383. /** @hidden */
  99384. _defineMirroredEquirectangularFixedName: string;
  99385. /** @hidden */
  99386. _defineEquirectangularFixedName: string;
  99387. /** @hidden */
  99388. _defineSkyboxName: string;
  99389. /** @hidden */
  99390. _defineOppositeZ: string;
  99391. /** @hidden */
  99392. _cubeSamplerName: string;
  99393. /** @hidden */
  99394. _2DSamplerName: string;
  99395. protected _positionUVWName: string;
  99396. protected _directionWName: string;
  99397. protected _reflectionVectorName: string;
  99398. /** @hidden */
  99399. _reflectionCoordsName: string;
  99400. /** @hidden */
  99401. _reflectionMatrixName: string;
  99402. protected _reflectionColorName: string;
  99403. /**
  99404. * Gets or sets the texture associated with the node
  99405. */
  99406. texture: Nullable<BaseTexture>;
  99407. /**
  99408. * Create a new ReflectionTextureBaseBlock
  99409. * @param name defines the block name
  99410. */
  99411. constructor(name: string);
  99412. /**
  99413. * Gets the current class name
  99414. * @returns the class name
  99415. */
  99416. getClassName(): string;
  99417. /**
  99418. * Gets the world position input component
  99419. */
  99420. abstract get position(): NodeMaterialConnectionPoint;
  99421. /**
  99422. * Gets the world position input component
  99423. */
  99424. abstract get worldPosition(): NodeMaterialConnectionPoint;
  99425. /**
  99426. * Gets the world normal input component
  99427. */
  99428. abstract get worldNormal(): NodeMaterialConnectionPoint;
  99429. /**
  99430. * Gets the world input component
  99431. */
  99432. abstract get world(): NodeMaterialConnectionPoint;
  99433. /**
  99434. * Gets the camera (or eye) position component
  99435. */
  99436. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  99437. /**
  99438. * Gets the view input component
  99439. */
  99440. abstract get view(): NodeMaterialConnectionPoint;
  99441. protected _getTexture(): Nullable<BaseTexture>;
  99442. autoConfigure(material: NodeMaterial): void;
  99443. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99444. isReady(): boolean;
  99445. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  99446. /**
  99447. * Gets the code to inject in the vertex shader
  99448. * @param state current state of the node material building
  99449. * @returns the shader code
  99450. */
  99451. handleVertexSide(state: NodeMaterialBuildState): string;
  99452. /**
  99453. * Handles the inits for the fragment code path
  99454. * @param state node material build state
  99455. */
  99456. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  99457. /**
  99458. * Generates the reflection coords code for the fragment code path
  99459. * @param worldNormalVarName name of the world normal variable
  99460. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  99461. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  99462. * @returns the shader code
  99463. */
  99464. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  99465. /**
  99466. * Generates the reflection color code for the fragment code path
  99467. * @param lodVarName name of the lod variable
  99468. * @param swizzleLookupTexture swizzle to use for the final color variable
  99469. * @returns the shader code
  99470. */
  99471. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  99472. /**
  99473. * Generates the code corresponding to the connected output points
  99474. * @param state node material build state
  99475. * @param varName name of the variable to output
  99476. * @returns the shader code
  99477. */
  99478. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  99479. protected _buildBlock(state: NodeMaterialBuildState): this;
  99480. protected _dumpPropertiesCode(): string;
  99481. serialize(): any;
  99482. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99483. }
  99484. }
  99485. declare module BABYLON {
  99486. /**
  99487. * Defines a connection point to be used for points with a custom object type
  99488. */
  99489. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  99490. private _blockType;
  99491. private _blockName;
  99492. private _nameForCheking?;
  99493. /**
  99494. * Creates a new connection point
  99495. * @param name defines the connection point name
  99496. * @param ownerBlock defines the block hosting this connection point
  99497. * @param direction defines the direction of the connection point
  99498. */
  99499. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  99500. /**
  99501. * Gets a number indicating if the current point can be connected to another point
  99502. * @param connectionPoint defines the other connection point
  99503. * @returns a number defining the compatibility state
  99504. */
  99505. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  99506. /**
  99507. * Creates a block suitable to be used as an input for this input point.
  99508. * If null is returned, a block based on the point type will be created.
  99509. * @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
  99510. */
  99511. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  99512. }
  99513. }
  99514. declare module BABYLON {
  99515. /**
  99516. * Enum defining the type of properties that can be edited in the property pages in the NME
  99517. */
  99518. export enum PropertyTypeForEdition {
  99519. /** property is a boolean */
  99520. Boolean = 0,
  99521. /** property is a float */
  99522. Float = 1,
  99523. /** property is a Vector2 */
  99524. Vector2 = 2,
  99525. /** property is a list of values */
  99526. List = 3
  99527. }
  99528. /**
  99529. * Interface that defines an option in a variable of type list
  99530. */
  99531. export interface IEditablePropertyListOption {
  99532. /** label of the option */
  99533. "label": string;
  99534. /** value of the option */
  99535. "value": number;
  99536. }
  99537. /**
  99538. * Interface that defines the options available for an editable property
  99539. */
  99540. export interface IEditablePropertyOption {
  99541. /** min value */
  99542. "min"?: number;
  99543. /** max value */
  99544. "max"?: number;
  99545. /** notifiers: indicates which actions to take when the property is changed */
  99546. "notifiers"?: {
  99547. /** the material should be rebuilt */
  99548. "rebuild"?: boolean;
  99549. /** the preview should be updated */
  99550. "update"?: boolean;
  99551. };
  99552. /** list of the options for a variable of type list */
  99553. "options"?: IEditablePropertyListOption[];
  99554. }
  99555. /**
  99556. * Interface that describes an editable property
  99557. */
  99558. export interface IPropertyDescriptionForEdition {
  99559. /** name of the property */
  99560. "propertyName": string;
  99561. /** display name of the property */
  99562. "displayName": string;
  99563. /** type of the property */
  99564. "type": PropertyTypeForEdition;
  99565. /** group of the property - all properties with the same group value will be displayed in a specific section */
  99566. "groupName": string;
  99567. /** options for the property */
  99568. "options": IEditablePropertyOption;
  99569. }
  99570. /**
  99571. * Decorator that flags a property in a node material block as being editable
  99572. */
  99573. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  99574. }
  99575. declare module BABYLON {
  99576. /**
  99577. * Block used to implement the refraction part of the sub surface module of the PBR material
  99578. */
  99579. export class RefractionBlock extends NodeMaterialBlock {
  99580. /** @hidden */
  99581. _define3DName: string;
  99582. /** @hidden */
  99583. _refractionMatrixName: string;
  99584. /** @hidden */
  99585. _defineLODRefractionAlpha: string;
  99586. /** @hidden */
  99587. _defineLinearSpecularRefraction: string;
  99588. /** @hidden */
  99589. _defineOppositeZ: string;
  99590. /** @hidden */
  99591. _cubeSamplerName: string;
  99592. /** @hidden */
  99593. _2DSamplerName: string;
  99594. /** @hidden */
  99595. _vRefractionMicrosurfaceInfosName: string;
  99596. /** @hidden */
  99597. _vRefractionInfosName: string;
  99598. private _scene;
  99599. /**
  99600. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  99601. * Materials half opaque for instance using refraction could benefit from this control.
  99602. */
  99603. linkRefractionWithTransparency: boolean;
  99604. /**
  99605. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  99606. */
  99607. invertRefractionY: boolean;
  99608. /**
  99609. * Gets or sets the texture associated with the node
  99610. */
  99611. texture: Nullable<BaseTexture>;
  99612. /**
  99613. * Create a new RefractionBlock
  99614. * @param name defines the block name
  99615. */
  99616. constructor(name: string);
  99617. /**
  99618. * Gets the current class name
  99619. * @returns the class name
  99620. */
  99621. getClassName(): string;
  99622. /**
  99623. * Gets the intensity input component
  99624. */
  99625. get intensity(): NodeMaterialConnectionPoint;
  99626. /**
  99627. * Gets the index of refraction input component
  99628. */
  99629. get indexOfRefraction(): NodeMaterialConnectionPoint;
  99630. /**
  99631. * Gets the tint at distance input component
  99632. */
  99633. get tintAtDistance(): NodeMaterialConnectionPoint;
  99634. /**
  99635. * Gets the view input component
  99636. */
  99637. get view(): NodeMaterialConnectionPoint;
  99638. /**
  99639. * Gets the refraction object output component
  99640. */
  99641. get refraction(): NodeMaterialConnectionPoint;
  99642. /**
  99643. * Returns true if the block has a texture
  99644. */
  99645. get hasTexture(): boolean;
  99646. protected _getTexture(): Nullable<BaseTexture>;
  99647. autoConfigure(material: NodeMaterial): void;
  99648. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99649. isReady(): boolean;
  99650. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  99651. /**
  99652. * Gets the main code of the block (fragment side)
  99653. * @param state current state of the node material building
  99654. * @returns the shader code
  99655. */
  99656. getCode(state: NodeMaterialBuildState): string;
  99657. protected _buildBlock(state: NodeMaterialBuildState): this;
  99658. protected _dumpPropertiesCode(): string;
  99659. serialize(): any;
  99660. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99661. }
  99662. }
  99663. declare module BABYLON {
  99664. /**
  99665. * Base block used as input for post process
  99666. */
  99667. export class CurrentScreenBlock extends NodeMaterialBlock {
  99668. private _samplerName;
  99669. private _linearDefineName;
  99670. private _gammaDefineName;
  99671. private _mainUVName;
  99672. private _tempTextureRead;
  99673. /**
  99674. * Gets or sets the texture associated with the node
  99675. */
  99676. texture: Nullable<BaseTexture>;
  99677. /**
  99678. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99679. */
  99680. convertToGammaSpace: boolean;
  99681. /**
  99682. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99683. */
  99684. convertToLinearSpace: boolean;
  99685. /**
  99686. * Create a new CurrentScreenBlock
  99687. * @param name defines the block name
  99688. */
  99689. constructor(name: string);
  99690. /**
  99691. * Gets the current class name
  99692. * @returns the class name
  99693. */
  99694. getClassName(): string;
  99695. /**
  99696. * Gets the uv input component
  99697. */
  99698. get uv(): NodeMaterialConnectionPoint;
  99699. /**
  99700. * Gets the rgba output component
  99701. */
  99702. get rgba(): NodeMaterialConnectionPoint;
  99703. /**
  99704. * Gets the rgb output component
  99705. */
  99706. get rgb(): NodeMaterialConnectionPoint;
  99707. /**
  99708. * Gets the r output component
  99709. */
  99710. get r(): NodeMaterialConnectionPoint;
  99711. /**
  99712. * Gets the g output component
  99713. */
  99714. get g(): NodeMaterialConnectionPoint;
  99715. /**
  99716. * Gets the b output component
  99717. */
  99718. get b(): NodeMaterialConnectionPoint;
  99719. /**
  99720. * Gets the a output component
  99721. */
  99722. get a(): NodeMaterialConnectionPoint;
  99723. /**
  99724. * Initialize the block and prepare the context for build
  99725. * @param state defines the state that will be used for the build
  99726. */
  99727. initialize(state: NodeMaterialBuildState): void;
  99728. get target(): NodeMaterialBlockTargets;
  99729. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99730. isReady(): boolean;
  99731. private _injectVertexCode;
  99732. private _writeTextureRead;
  99733. private _writeOutput;
  99734. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99735. serialize(): any;
  99736. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99737. }
  99738. }
  99739. declare module BABYLON {
  99740. /**
  99741. * Base block used for the particle texture
  99742. */
  99743. export class ParticleTextureBlock extends NodeMaterialBlock {
  99744. private _samplerName;
  99745. private _linearDefineName;
  99746. private _gammaDefineName;
  99747. private _tempTextureRead;
  99748. /**
  99749. * Gets or sets the texture associated with the node
  99750. */
  99751. texture: Nullable<BaseTexture>;
  99752. /**
  99753. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99754. */
  99755. convertToGammaSpace: boolean;
  99756. /**
  99757. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99758. */
  99759. convertToLinearSpace: boolean;
  99760. /**
  99761. * Create a new ParticleTextureBlock
  99762. * @param name defines the block name
  99763. */
  99764. constructor(name: string);
  99765. /**
  99766. * Gets the current class name
  99767. * @returns the class name
  99768. */
  99769. getClassName(): string;
  99770. /**
  99771. * Gets the uv input component
  99772. */
  99773. get uv(): NodeMaterialConnectionPoint;
  99774. /**
  99775. * Gets the rgba output component
  99776. */
  99777. get rgba(): NodeMaterialConnectionPoint;
  99778. /**
  99779. * Gets the rgb output component
  99780. */
  99781. get rgb(): NodeMaterialConnectionPoint;
  99782. /**
  99783. * Gets the r output component
  99784. */
  99785. get r(): NodeMaterialConnectionPoint;
  99786. /**
  99787. * Gets the g output component
  99788. */
  99789. get g(): NodeMaterialConnectionPoint;
  99790. /**
  99791. * Gets the b output component
  99792. */
  99793. get b(): NodeMaterialConnectionPoint;
  99794. /**
  99795. * Gets the a output component
  99796. */
  99797. get a(): NodeMaterialConnectionPoint;
  99798. /**
  99799. * Initialize the block and prepare the context for build
  99800. * @param state defines the state that will be used for the build
  99801. */
  99802. initialize(state: NodeMaterialBuildState): void;
  99803. autoConfigure(material: NodeMaterial): void;
  99804. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99805. isReady(): boolean;
  99806. private _writeOutput;
  99807. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99808. serialize(): any;
  99809. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99810. }
  99811. }
  99812. declare module BABYLON {
  99813. /**
  99814. * Class used to store shared data between 2 NodeMaterialBuildState
  99815. */
  99816. export class NodeMaterialBuildStateSharedData {
  99817. /**
  99818. * Gets the list of emitted varyings
  99819. */
  99820. temps: string[];
  99821. /**
  99822. * Gets the list of emitted varyings
  99823. */
  99824. varyings: string[];
  99825. /**
  99826. * Gets the varying declaration string
  99827. */
  99828. varyingDeclaration: string;
  99829. /**
  99830. * Input blocks
  99831. */
  99832. inputBlocks: InputBlock[];
  99833. /**
  99834. * Input blocks
  99835. */
  99836. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  99837. /**
  99838. * Bindable blocks (Blocks that need to set data to the effect)
  99839. */
  99840. bindableBlocks: NodeMaterialBlock[];
  99841. /**
  99842. * List of blocks that can provide a compilation fallback
  99843. */
  99844. blocksWithFallbacks: NodeMaterialBlock[];
  99845. /**
  99846. * List of blocks that can provide a define update
  99847. */
  99848. blocksWithDefines: NodeMaterialBlock[];
  99849. /**
  99850. * List of blocks that can provide a repeatable content
  99851. */
  99852. repeatableContentBlocks: NodeMaterialBlock[];
  99853. /**
  99854. * List of blocks that can provide a dynamic list of uniforms
  99855. */
  99856. dynamicUniformBlocks: NodeMaterialBlock[];
  99857. /**
  99858. * List of blocks that can block the isReady function for the material
  99859. */
  99860. blockingBlocks: NodeMaterialBlock[];
  99861. /**
  99862. * Gets the list of animated inputs
  99863. */
  99864. animatedInputs: InputBlock[];
  99865. /**
  99866. * Build Id used to avoid multiple recompilations
  99867. */
  99868. buildId: number;
  99869. /** List of emitted variables */
  99870. variableNames: {
  99871. [key: string]: number;
  99872. };
  99873. /** List of emitted defines */
  99874. defineNames: {
  99875. [key: string]: number;
  99876. };
  99877. /** Should emit comments? */
  99878. emitComments: boolean;
  99879. /** Emit build activity */
  99880. verbose: boolean;
  99881. /** Gets or sets the hosting scene */
  99882. scene: Scene;
  99883. /**
  99884. * Gets the compilation hints emitted at compilation time
  99885. */
  99886. hints: {
  99887. needWorldViewMatrix: boolean;
  99888. needWorldViewProjectionMatrix: boolean;
  99889. needAlphaBlending: boolean;
  99890. needAlphaTesting: boolean;
  99891. };
  99892. /**
  99893. * List of compilation checks
  99894. */
  99895. checks: {
  99896. emitVertex: boolean;
  99897. emitFragment: boolean;
  99898. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  99899. };
  99900. /**
  99901. * Is vertex program allowed to be empty?
  99902. */
  99903. allowEmptyVertexProgram: boolean;
  99904. /** Creates a new shared data */
  99905. constructor();
  99906. /**
  99907. * Emits console errors and exceptions if there is a failing check
  99908. */
  99909. emitErrors(): void;
  99910. }
  99911. }
  99912. declare module BABYLON {
  99913. /**
  99914. * Class used to store node based material build state
  99915. */
  99916. export class NodeMaterialBuildState {
  99917. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  99918. supportUniformBuffers: boolean;
  99919. /**
  99920. * Gets the list of emitted attributes
  99921. */
  99922. attributes: string[];
  99923. /**
  99924. * Gets the list of emitted uniforms
  99925. */
  99926. uniforms: string[];
  99927. /**
  99928. * Gets the list of emitted constants
  99929. */
  99930. constants: string[];
  99931. /**
  99932. * Gets the list of emitted samplers
  99933. */
  99934. samplers: string[];
  99935. /**
  99936. * Gets the list of emitted functions
  99937. */
  99938. functions: {
  99939. [key: string]: string;
  99940. };
  99941. /**
  99942. * Gets the list of emitted extensions
  99943. */
  99944. extensions: {
  99945. [key: string]: string;
  99946. };
  99947. /**
  99948. * Gets the target of the compilation state
  99949. */
  99950. target: NodeMaterialBlockTargets;
  99951. /**
  99952. * Gets the list of emitted counters
  99953. */
  99954. counters: {
  99955. [key: string]: number;
  99956. };
  99957. /**
  99958. * Shared data between multiple NodeMaterialBuildState instances
  99959. */
  99960. sharedData: NodeMaterialBuildStateSharedData;
  99961. /** @hidden */
  99962. _vertexState: NodeMaterialBuildState;
  99963. /** @hidden */
  99964. _attributeDeclaration: string;
  99965. /** @hidden */
  99966. _uniformDeclaration: string;
  99967. /** @hidden */
  99968. _constantDeclaration: string;
  99969. /** @hidden */
  99970. _samplerDeclaration: string;
  99971. /** @hidden */
  99972. _varyingTransfer: string;
  99973. /** @hidden */
  99974. _injectAtEnd: string;
  99975. private _repeatableContentAnchorIndex;
  99976. /** @hidden */
  99977. _builtCompilationString: string;
  99978. /**
  99979. * Gets the emitted compilation strings
  99980. */
  99981. compilationString: string;
  99982. /**
  99983. * Finalize the compilation strings
  99984. * @param state defines the current compilation state
  99985. */
  99986. finalize(state: NodeMaterialBuildState): void;
  99987. /** @hidden */
  99988. get _repeatableContentAnchor(): string;
  99989. /** @hidden */
  99990. _getFreeVariableName(prefix: string): string;
  99991. /** @hidden */
  99992. _getFreeDefineName(prefix: string): string;
  99993. /** @hidden */
  99994. _excludeVariableName(name: string): void;
  99995. /** @hidden */
  99996. _emit2DSampler(name: string): void;
  99997. /** @hidden */
  99998. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  99999. /** @hidden */
  100000. _emitExtension(name: string, extension: string, define?: string): void;
  100001. /** @hidden */
  100002. _emitFunction(name: string, code: string, comments: string): void;
  100003. /** @hidden */
  100004. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  100005. replaceStrings?: {
  100006. search: RegExp;
  100007. replace: string;
  100008. }[];
  100009. repeatKey?: string;
  100010. }): string;
  100011. /** @hidden */
  100012. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  100013. repeatKey?: string;
  100014. removeAttributes?: boolean;
  100015. removeUniforms?: boolean;
  100016. removeVaryings?: boolean;
  100017. removeIfDef?: boolean;
  100018. replaceStrings?: {
  100019. search: RegExp;
  100020. replace: string;
  100021. }[];
  100022. }, storeKey?: string): void;
  100023. /** @hidden */
  100024. _registerTempVariable(name: string): boolean;
  100025. /** @hidden */
  100026. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  100027. /** @hidden */
  100028. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  100029. /** @hidden */
  100030. _emitFloat(value: number): string;
  100031. }
  100032. }
  100033. declare module BABYLON {
  100034. /**
  100035. * Helper class used to generate session unique ID
  100036. */
  100037. export class UniqueIdGenerator {
  100038. private static _UniqueIdCounter;
  100039. /**
  100040. * Gets an unique (relatively to the current scene) Id
  100041. */
  100042. static get UniqueId(): number;
  100043. }
  100044. }
  100045. declare module BABYLON {
  100046. /**
  100047. * Defines a block that can be used inside a node based material
  100048. */
  100049. export class NodeMaterialBlock {
  100050. private _buildId;
  100051. private _buildTarget;
  100052. private _target;
  100053. private _isFinalMerger;
  100054. private _isInput;
  100055. private _name;
  100056. protected _isUnique: boolean;
  100057. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  100058. inputsAreExclusive: boolean;
  100059. /** @hidden */
  100060. _codeVariableName: string;
  100061. /** @hidden */
  100062. _inputs: NodeMaterialConnectionPoint[];
  100063. /** @hidden */
  100064. _outputs: NodeMaterialConnectionPoint[];
  100065. /** @hidden */
  100066. _preparationId: number;
  100067. /**
  100068. * Gets the name of the block
  100069. */
  100070. get name(): string;
  100071. /**
  100072. * Sets the name of the block. Will check if the name is valid.
  100073. */
  100074. set name(newName: string);
  100075. /**
  100076. * Gets or sets the unique id of the node
  100077. */
  100078. uniqueId: number;
  100079. /**
  100080. * Gets or sets the comments associated with this block
  100081. */
  100082. comments: string;
  100083. /**
  100084. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  100085. */
  100086. get isUnique(): boolean;
  100087. /**
  100088. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  100089. */
  100090. get isFinalMerger(): boolean;
  100091. /**
  100092. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  100093. */
  100094. get isInput(): boolean;
  100095. /**
  100096. * Gets or sets the build Id
  100097. */
  100098. get buildId(): number;
  100099. set buildId(value: number);
  100100. /**
  100101. * Gets or sets the target of the block
  100102. */
  100103. get target(): NodeMaterialBlockTargets;
  100104. set target(value: NodeMaterialBlockTargets);
  100105. /**
  100106. * Gets the list of input points
  100107. */
  100108. get inputs(): NodeMaterialConnectionPoint[];
  100109. /** Gets the list of output points */
  100110. get outputs(): NodeMaterialConnectionPoint[];
  100111. /**
  100112. * Find an input by its name
  100113. * @param name defines the name of the input to look for
  100114. * @returns the input or null if not found
  100115. */
  100116. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100117. /**
  100118. * Find an output by its name
  100119. * @param name defines the name of the outputto look for
  100120. * @returns the output or null if not found
  100121. */
  100122. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100123. /**
  100124. * Creates a new NodeMaterialBlock
  100125. * @param name defines the block name
  100126. * @param target defines the target of that block (Vertex by default)
  100127. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  100128. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  100129. */
  100130. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  100131. /**
  100132. * Initialize the block and prepare the context for build
  100133. * @param state defines the state that will be used for the build
  100134. */
  100135. initialize(state: NodeMaterialBuildState): void;
  100136. /**
  100137. * Bind data to effect. Will only be called for blocks with isBindable === true
  100138. * @param effect defines the effect to bind data to
  100139. * @param nodeMaterial defines the hosting NodeMaterial
  100140. * @param mesh defines the mesh that will be rendered
  100141. * @param subMesh defines the submesh that will be rendered
  100142. */
  100143. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100144. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  100145. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  100146. protected _writeFloat(value: number): string;
  100147. /**
  100148. * Gets the current class name e.g. "NodeMaterialBlock"
  100149. * @returns the class name
  100150. */
  100151. getClassName(): string;
  100152. /**
  100153. * Register a new input. Must be called inside a block constructor
  100154. * @param name defines the connection point name
  100155. * @param type defines the connection point type
  100156. * @param isOptional defines a boolean indicating that this input can be omitted
  100157. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  100158. * @param point an already created connection point. If not provided, create a new one
  100159. * @returns the current block
  100160. */
  100161. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  100162. /**
  100163. * Register a new output. Must be called inside a block constructor
  100164. * @param name defines the connection point name
  100165. * @param type defines the connection point type
  100166. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  100167. * @param point an already created connection point. If not provided, create a new one
  100168. * @returns the current block
  100169. */
  100170. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  100171. /**
  100172. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  100173. * @param forOutput defines an optional connection point to check compatibility with
  100174. * @returns the first available input or null
  100175. */
  100176. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  100177. /**
  100178. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  100179. * @param forBlock defines an optional block to check compatibility with
  100180. * @returns the first available input or null
  100181. */
  100182. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  100183. /**
  100184. * Gets the sibling of the given output
  100185. * @param current defines the current output
  100186. * @returns the next output in the list or null
  100187. */
  100188. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  100189. /**
  100190. * Connect current block with another block
  100191. * @param other defines the block to connect with
  100192. * @param options define the various options to help pick the right connections
  100193. * @returns the current block
  100194. */
  100195. connectTo(other: NodeMaterialBlock, options?: {
  100196. input?: string;
  100197. output?: string;
  100198. outputSwizzle?: string;
  100199. }): this | undefined;
  100200. protected _buildBlock(state: NodeMaterialBuildState): void;
  100201. /**
  100202. * Add uniforms, samplers and uniform buffers at compilation time
  100203. * @param state defines the state to update
  100204. * @param nodeMaterial defines the node material requesting the update
  100205. * @param defines defines the material defines to update
  100206. * @param uniformBuffers defines the list of uniform buffer names
  100207. */
  100208. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  100209. /**
  100210. * Add potential fallbacks if shader compilation fails
  100211. * @param mesh defines the mesh to be rendered
  100212. * @param fallbacks defines the current prioritized list of fallbacks
  100213. */
  100214. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  100215. /**
  100216. * Initialize defines for shader compilation
  100217. * @param mesh defines the mesh to be rendered
  100218. * @param nodeMaterial defines the node material requesting the update
  100219. * @param defines defines the material defines to update
  100220. * @param useInstances specifies that instances should be used
  100221. */
  100222. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100223. /**
  100224. * Update defines for shader compilation
  100225. * @param mesh defines the mesh to be rendered
  100226. * @param nodeMaterial defines the node material requesting the update
  100227. * @param defines defines the material defines to update
  100228. * @param useInstances specifies that instances should be used
  100229. * @param subMesh defines which submesh to render
  100230. */
  100231. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  100232. /**
  100233. * Lets the block try to connect some inputs automatically
  100234. * @param material defines the hosting NodeMaterial
  100235. */
  100236. autoConfigure(material: NodeMaterial): void;
  100237. /**
  100238. * Function called when a block is declared as repeatable content generator
  100239. * @param vertexShaderState defines the current compilation state for the vertex shader
  100240. * @param fragmentShaderState defines the current compilation state for the fragment shader
  100241. * @param mesh defines the mesh to be rendered
  100242. * @param defines defines the material defines to update
  100243. */
  100244. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  100245. /**
  100246. * Checks if the block is ready
  100247. * @param mesh defines the mesh to be rendered
  100248. * @param nodeMaterial defines the node material requesting the update
  100249. * @param defines defines the material defines to update
  100250. * @param useInstances specifies that instances should be used
  100251. * @returns true if the block is ready
  100252. */
  100253. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  100254. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  100255. private _processBuild;
  100256. /**
  100257. * Validates the new name for the block node.
  100258. * @param newName the new name to be given to the node.
  100259. * @returns false if the name is a reserve word, else true.
  100260. */
  100261. validateBlockName(newName: string): boolean;
  100262. /**
  100263. * Compile the current node and generate the shader code
  100264. * @param state defines the current compilation state (uniforms, samplers, current string)
  100265. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  100266. * @returns true if already built
  100267. */
  100268. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  100269. protected _inputRename(name: string): string;
  100270. protected _outputRename(name: string): string;
  100271. protected _dumpPropertiesCode(): string;
  100272. /** @hidden */
  100273. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  100274. /** @hidden */
  100275. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  100276. /**
  100277. * Clone the current block to a new identical block
  100278. * @param scene defines the hosting scene
  100279. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100280. * @returns a copy of the current block
  100281. */
  100282. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  100283. /**
  100284. * Serializes this block in a JSON representation
  100285. * @returns the serialized block object
  100286. */
  100287. serialize(): any;
  100288. /** @hidden */
  100289. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100290. private _deserializePortDisplayNamesAndExposedOnFrame;
  100291. /**
  100292. * Release resources
  100293. */
  100294. dispose(): void;
  100295. }
  100296. }
  100297. declare module BABYLON {
  100298. /**
  100299. * Base class of materials working in push mode in babylon JS
  100300. * @hidden
  100301. */
  100302. export class PushMaterial extends Material {
  100303. protected _activeEffect: Effect;
  100304. protected _normalMatrix: Matrix;
  100305. constructor(name: string, scene: Scene);
  100306. getEffect(): Effect;
  100307. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  100308. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  100309. /**
  100310. * Binds the given world matrix to the active effect
  100311. *
  100312. * @param world the matrix to bind
  100313. */
  100314. bindOnlyWorldMatrix(world: Matrix): void;
  100315. /**
  100316. * Binds the given normal matrix to the active effect
  100317. *
  100318. * @param normalMatrix the matrix to bind
  100319. */
  100320. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  100321. bind(world: Matrix, mesh?: Mesh): void;
  100322. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  100323. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  100324. }
  100325. }
  100326. declare module BABYLON {
  100327. /**
  100328. * Root class for all node material optimizers
  100329. */
  100330. export class NodeMaterialOptimizer {
  100331. /**
  100332. * Function used to optimize a NodeMaterial graph
  100333. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  100334. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  100335. */
  100336. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  100337. }
  100338. }
  100339. declare module BABYLON {
  100340. /**
  100341. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  100342. */
  100343. export class TransformBlock extends NodeMaterialBlock {
  100344. /**
  100345. * Defines the value to use to complement W value to transform it to a Vector4
  100346. */
  100347. complementW: number;
  100348. /**
  100349. * Defines the value to use to complement z value to transform it to a Vector4
  100350. */
  100351. complementZ: number;
  100352. /**
  100353. * Creates a new TransformBlock
  100354. * @param name defines the block name
  100355. */
  100356. constructor(name: string);
  100357. /**
  100358. * Gets the current class name
  100359. * @returns the class name
  100360. */
  100361. getClassName(): string;
  100362. /**
  100363. * Gets the vector input
  100364. */
  100365. get vector(): NodeMaterialConnectionPoint;
  100366. /**
  100367. * Gets the output component
  100368. */
  100369. get output(): NodeMaterialConnectionPoint;
  100370. /**
  100371. * Gets the xyz output component
  100372. */
  100373. get xyz(): NodeMaterialConnectionPoint;
  100374. /**
  100375. * Gets the matrix transform input
  100376. */
  100377. get transform(): NodeMaterialConnectionPoint;
  100378. protected _buildBlock(state: NodeMaterialBuildState): this;
  100379. /**
  100380. * Update defines for shader compilation
  100381. * @param mesh defines the mesh to be rendered
  100382. * @param nodeMaterial defines the node material requesting the update
  100383. * @param defines defines the material defines to update
  100384. * @param useInstances specifies that instances should be used
  100385. * @param subMesh defines which submesh to render
  100386. */
  100387. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  100388. serialize(): any;
  100389. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100390. protected _dumpPropertiesCode(): string;
  100391. }
  100392. }
  100393. declare module BABYLON {
  100394. /**
  100395. * Block used to output the vertex position
  100396. */
  100397. export class VertexOutputBlock extends NodeMaterialBlock {
  100398. /**
  100399. * Creates a new VertexOutputBlock
  100400. * @param name defines the block name
  100401. */
  100402. constructor(name: string);
  100403. /**
  100404. * Gets the current class name
  100405. * @returns the class name
  100406. */
  100407. getClassName(): string;
  100408. /**
  100409. * Gets the vector input component
  100410. */
  100411. get vector(): NodeMaterialConnectionPoint;
  100412. protected _buildBlock(state: NodeMaterialBuildState): this;
  100413. }
  100414. }
  100415. declare module BABYLON {
  100416. /**
  100417. * Block used to output the final color
  100418. */
  100419. export class FragmentOutputBlock extends NodeMaterialBlock {
  100420. /**
  100421. * Create a new FragmentOutputBlock
  100422. * @param name defines the block name
  100423. */
  100424. constructor(name: string);
  100425. /**
  100426. * Gets the current class name
  100427. * @returns the class name
  100428. */
  100429. getClassName(): string;
  100430. /**
  100431. * Gets the rgba input component
  100432. */
  100433. get rgba(): NodeMaterialConnectionPoint;
  100434. /**
  100435. * Gets the rgb input component
  100436. */
  100437. get rgb(): NodeMaterialConnectionPoint;
  100438. /**
  100439. * Gets the a input component
  100440. */
  100441. get a(): NodeMaterialConnectionPoint;
  100442. protected _buildBlock(state: NodeMaterialBuildState): this;
  100443. }
  100444. }
  100445. declare module BABYLON {
  100446. /**
  100447. * Block used for the particle ramp gradient section
  100448. */
  100449. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  100450. /**
  100451. * Create a new ParticleRampGradientBlock
  100452. * @param name defines the block name
  100453. */
  100454. constructor(name: string);
  100455. /**
  100456. * Gets the current class name
  100457. * @returns the class name
  100458. */
  100459. getClassName(): string;
  100460. /**
  100461. * Gets the color input component
  100462. */
  100463. get color(): NodeMaterialConnectionPoint;
  100464. /**
  100465. * Gets the rampColor output component
  100466. */
  100467. get rampColor(): NodeMaterialConnectionPoint;
  100468. /**
  100469. * Initialize the block and prepare the context for build
  100470. * @param state defines the state that will be used for the build
  100471. */
  100472. initialize(state: NodeMaterialBuildState): void;
  100473. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100474. }
  100475. }
  100476. declare module BABYLON {
  100477. /**
  100478. * Block used for the particle blend multiply section
  100479. */
  100480. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  100481. /**
  100482. * Create a new ParticleBlendMultiplyBlock
  100483. * @param name defines the block name
  100484. */
  100485. constructor(name: string);
  100486. /**
  100487. * Gets the current class name
  100488. * @returns the class name
  100489. */
  100490. getClassName(): string;
  100491. /**
  100492. * Gets the color input component
  100493. */
  100494. get color(): NodeMaterialConnectionPoint;
  100495. /**
  100496. * Gets the alphaTexture input component
  100497. */
  100498. get alphaTexture(): NodeMaterialConnectionPoint;
  100499. /**
  100500. * Gets the alphaColor input component
  100501. */
  100502. get alphaColor(): NodeMaterialConnectionPoint;
  100503. /**
  100504. * Gets the blendColor output component
  100505. */
  100506. get blendColor(): NodeMaterialConnectionPoint;
  100507. /**
  100508. * Initialize the block and prepare the context for build
  100509. * @param state defines the state that will be used for the build
  100510. */
  100511. initialize(state: NodeMaterialBuildState): void;
  100512. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100513. }
  100514. }
  100515. declare module BABYLON {
  100516. /**
  100517. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  100518. */
  100519. export class VectorMergerBlock extends NodeMaterialBlock {
  100520. /**
  100521. * Create a new VectorMergerBlock
  100522. * @param name defines the block name
  100523. */
  100524. constructor(name: string);
  100525. /**
  100526. * Gets the current class name
  100527. * @returns the class name
  100528. */
  100529. getClassName(): string;
  100530. /**
  100531. * Gets the xyz component (input)
  100532. */
  100533. get xyzIn(): NodeMaterialConnectionPoint;
  100534. /**
  100535. * Gets the xy component (input)
  100536. */
  100537. get xyIn(): NodeMaterialConnectionPoint;
  100538. /**
  100539. * Gets the x component (input)
  100540. */
  100541. get x(): NodeMaterialConnectionPoint;
  100542. /**
  100543. * Gets the y component (input)
  100544. */
  100545. get y(): NodeMaterialConnectionPoint;
  100546. /**
  100547. * Gets the z component (input)
  100548. */
  100549. get z(): NodeMaterialConnectionPoint;
  100550. /**
  100551. * Gets the w component (input)
  100552. */
  100553. get w(): NodeMaterialConnectionPoint;
  100554. /**
  100555. * Gets the xyzw component (output)
  100556. */
  100557. get xyzw(): NodeMaterialConnectionPoint;
  100558. /**
  100559. * Gets the xyz component (output)
  100560. */
  100561. get xyzOut(): NodeMaterialConnectionPoint;
  100562. /**
  100563. * Gets the xy component (output)
  100564. */
  100565. get xyOut(): NodeMaterialConnectionPoint;
  100566. /**
  100567. * Gets the xy component (output)
  100568. * @deprecated Please use xyOut instead.
  100569. */
  100570. get xy(): NodeMaterialConnectionPoint;
  100571. /**
  100572. * Gets the xyz component (output)
  100573. * @deprecated Please use xyzOut instead.
  100574. */
  100575. get xyz(): NodeMaterialConnectionPoint;
  100576. protected _buildBlock(state: NodeMaterialBuildState): this;
  100577. }
  100578. }
  100579. declare module BABYLON {
  100580. /**
  100581. * Block used to remap a float from a range to a new one
  100582. */
  100583. export class RemapBlock extends NodeMaterialBlock {
  100584. /**
  100585. * Gets or sets the source range
  100586. */
  100587. sourceRange: Vector2;
  100588. /**
  100589. * Gets or sets the target range
  100590. */
  100591. targetRange: Vector2;
  100592. /**
  100593. * Creates a new RemapBlock
  100594. * @param name defines the block name
  100595. */
  100596. constructor(name: string);
  100597. /**
  100598. * Gets the current class name
  100599. * @returns the class name
  100600. */
  100601. getClassName(): string;
  100602. /**
  100603. * Gets the input component
  100604. */
  100605. get input(): NodeMaterialConnectionPoint;
  100606. /**
  100607. * Gets the source min input component
  100608. */
  100609. get sourceMin(): NodeMaterialConnectionPoint;
  100610. /**
  100611. * Gets the source max input component
  100612. */
  100613. get sourceMax(): NodeMaterialConnectionPoint;
  100614. /**
  100615. * Gets the target min input component
  100616. */
  100617. get targetMin(): NodeMaterialConnectionPoint;
  100618. /**
  100619. * Gets the target max input component
  100620. */
  100621. get targetMax(): NodeMaterialConnectionPoint;
  100622. /**
  100623. * Gets the output component
  100624. */
  100625. get output(): NodeMaterialConnectionPoint;
  100626. protected _buildBlock(state: NodeMaterialBuildState): this;
  100627. protected _dumpPropertiesCode(): string;
  100628. serialize(): any;
  100629. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100630. }
  100631. }
  100632. declare module BABYLON {
  100633. /**
  100634. * Block used to multiply 2 values
  100635. */
  100636. export class MultiplyBlock extends NodeMaterialBlock {
  100637. /**
  100638. * Creates a new MultiplyBlock
  100639. * @param name defines the block name
  100640. */
  100641. constructor(name: string);
  100642. /**
  100643. * Gets the current class name
  100644. * @returns the class name
  100645. */
  100646. getClassName(): string;
  100647. /**
  100648. * Gets the left operand input component
  100649. */
  100650. get left(): NodeMaterialConnectionPoint;
  100651. /**
  100652. * Gets the right operand input component
  100653. */
  100654. get right(): NodeMaterialConnectionPoint;
  100655. /**
  100656. * Gets the output component
  100657. */
  100658. get output(): NodeMaterialConnectionPoint;
  100659. protected _buildBlock(state: NodeMaterialBuildState): this;
  100660. }
  100661. }
  100662. declare module BABYLON {
  100663. /**
  100664. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  100665. */
  100666. export class ColorSplitterBlock extends NodeMaterialBlock {
  100667. /**
  100668. * Create a new ColorSplitterBlock
  100669. * @param name defines the block name
  100670. */
  100671. constructor(name: string);
  100672. /**
  100673. * Gets the current class name
  100674. * @returns the class name
  100675. */
  100676. getClassName(): string;
  100677. /**
  100678. * Gets the rgba component (input)
  100679. */
  100680. get rgba(): NodeMaterialConnectionPoint;
  100681. /**
  100682. * Gets the rgb component (input)
  100683. */
  100684. get rgbIn(): NodeMaterialConnectionPoint;
  100685. /**
  100686. * Gets the rgb component (output)
  100687. */
  100688. get rgbOut(): NodeMaterialConnectionPoint;
  100689. /**
  100690. * Gets the r component (output)
  100691. */
  100692. get r(): NodeMaterialConnectionPoint;
  100693. /**
  100694. * Gets the g component (output)
  100695. */
  100696. get g(): NodeMaterialConnectionPoint;
  100697. /**
  100698. * Gets the b component (output)
  100699. */
  100700. get b(): NodeMaterialConnectionPoint;
  100701. /**
  100702. * Gets the a component (output)
  100703. */
  100704. get a(): NodeMaterialConnectionPoint;
  100705. protected _inputRename(name: string): string;
  100706. protected _outputRename(name: string): string;
  100707. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100708. }
  100709. }
  100710. declare module BABYLON {
  100711. /**
  100712. * Interface used to configure the node material editor
  100713. */
  100714. export interface INodeMaterialEditorOptions {
  100715. /** Define the URl to load node editor script */
  100716. editorURL?: string;
  100717. }
  100718. /** @hidden */
  100719. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  100720. NORMAL: boolean;
  100721. TANGENT: boolean;
  100722. UV1: boolean;
  100723. /** BONES */
  100724. NUM_BONE_INFLUENCERS: number;
  100725. BonesPerMesh: number;
  100726. BONETEXTURE: boolean;
  100727. /** MORPH TARGETS */
  100728. MORPHTARGETS: boolean;
  100729. MORPHTARGETS_NORMAL: boolean;
  100730. MORPHTARGETS_TANGENT: boolean;
  100731. MORPHTARGETS_UV: boolean;
  100732. NUM_MORPH_INFLUENCERS: number;
  100733. /** IMAGE PROCESSING */
  100734. IMAGEPROCESSING: boolean;
  100735. VIGNETTE: boolean;
  100736. VIGNETTEBLENDMODEMULTIPLY: boolean;
  100737. VIGNETTEBLENDMODEOPAQUE: boolean;
  100738. TONEMAPPING: boolean;
  100739. TONEMAPPING_ACES: boolean;
  100740. CONTRAST: boolean;
  100741. EXPOSURE: boolean;
  100742. COLORCURVES: boolean;
  100743. COLORGRADING: boolean;
  100744. COLORGRADING3D: boolean;
  100745. SAMPLER3DGREENDEPTH: boolean;
  100746. SAMPLER3DBGRMAP: boolean;
  100747. IMAGEPROCESSINGPOSTPROCESS: boolean;
  100748. /** MISC. */
  100749. BUMPDIRECTUV: number;
  100750. constructor();
  100751. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  100752. }
  100753. /**
  100754. * Class used to configure NodeMaterial
  100755. */
  100756. export interface INodeMaterialOptions {
  100757. /**
  100758. * Defines if blocks should emit comments
  100759. */
  100760. emitComments: boolean;
  100761. }
  100762. /**
  100763. * Class used to create a node based material built by assembling shader blocks
  100764. */
  100765. export class NodeMaterial extends PushMaterial {
  100766. private static _BuildIdGenerator;
  100767. private _options;
  100768. private _vertexCompilationState;
  100769. private _fragmentCompilationState;
  100770. private _sharedData;
  100771. private _buildId;
  100772. private _buildWasSuccessful;
  100773. private _cachedWorldViewMatrix;
  100774. private _cachedWorldViewProjectionMatrix;
  100775. private _optimizers;
  100776. private _animationFrame;
  100777. /** Define the Url to load node editor script */
  100778. static EditorURL: string;
  100779. /** Define the Url to load snippets */
  100780. static SnippetUrl: string;
  100781. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  100782. static IgnoreTexturesAtLoadTime: boolean;
  100783. private BJSNODEMATERIALEDITOR;
  100784. /** Get the inspector from bundle or global */
  100785. private _getGlobalNodeMaterialEditor;
  100786. /**
  100787. * Snippet ID if the material was created from the snippet server
  100788. */
  100789. snippetId: string;
  100790. /**
  100791. * Gets or sets data used by visual editor
  100792. * @see https://nme.babylonjs.com
  100793. */
  100794. editorData: any;
  100795. /**
  100796. * 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)
  100797. */
  100798. ignoreAlpha: boolean;
  100799. /**
  100800. * Defines the maximum number of lights that can be used in the material
  100801. */
  100802. maxSimultaneousLights: number;
  100803. /**
  100804. * Observable raised when the material is built
  100805. */
  100806. onBuildObservable: Observable<NodeMaterial>;
  100807. /**
  100808. * Gets or sets the root nodes of the material vertex shader
  100809. */
  100810. _vertexOutputNodes: NodeMaterialBlock[];
  100811. /**
  100812. * Gets or sets the root nodes of the material fragment (pixel) shader
  100813. */
  100814. _fragmentOutputNodes: NodeMaterialBlock[];
  100815. /** Gets or sets options to control the node material overall behavior */
  100816. get options(): INodeMaterialOptions;
  100817. set options(options: INodeMaterialOptions);
  100818. /**
  100819. * Default configuration related to image processing available in the standard Material.
  100820. */
  100821. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  100822. /**
  100823. * Gets the image processing configuration used either in this material.
  100824. */
  100825. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  100826. /**
  100827. * Sets the Default image processing configuration used either in the this material.
  100828. *
  100829. * If sets to null, the scene one is in use.
  100830. */
  100831. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  100832. /**
  100833. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  100834. */
  100835. attachedBlocks: NodeMaterialBlock[];
  100836. /**
  100837. * Specifies the mode of the node material
  100838. * @hidden
  100839. */
  100840. _mode: NodeMaterialModes;
  100841. /**
  100842. * Gets the mode property
  100843. */
  100844. get mode(): NodeMaterialModes;
  100845. /**
  100846. * Create a new node based material
  100847. * @param name defines the material name
  100848. * @param scene defines the hosting scene
  100849. * @param options defines creation option
  100850. */
  100851. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  100852. /**
  100853. * Gets the current class name of the material e.g. "NodeMaterial"
  100854. * @returns the class name
  100855. */
  100856. getClassName(): string;
  100857. /**
  100858. * Keep track of the image processing observer to allow dispose and replace.
  100859. */
  100860. private _imageProcessingObserver;
  100861. /**
  100862. * Attaches a new image processing configuration to the Standard Material.
  100863. * @param configuration
  100864. */
  100865. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  100866. /**
  100867. * Get a block by its name
  100868. * @param name defines the name of the block to retrieve
  100869. * @returns the required block or null if not found
  100870. */
  100871. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  100872. /**
  100873. * Get a block by its name
  100874. * @param predicate defines the predicate used to find the good candidate
  100875. * @returns the required block or null if not found
  100876. */
  100877. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  100878. /**
  100879. * Get an input block by its name
  100880. * @param predicate defines the predicate used to find the good candidate
  100881. * @returns the required input block or null if not found
  100882. */
  100883. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  100884. /**
  100885. * Gets the list of input blocks attached to this material
  100886. * @returns an array of InputBlocks
  100887. */
  100888. getInputBlocks(): InputBlock[];
  100889. /**
  100890. * Adds a new optimizer to the list of optimizers
  100891. * @param optimizer defines the optimizers to add
  100892. * @returns the current material
  100893. */
  100894. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  100895. /**
  100896. * Remove an optimizer from the list of optimizers
  100897. * @param optimizer defines the optimizers to remove
  100898. * @returns the current material
  100899. */
  100900. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  100901. /**
  100902. * Add a new block to the list of output nodes
  100903. * @param node defines the node to add
  100904. * @returns the current material
  100905. */
  100906. addOutputNode(node: NodeMaterialBlock): this;
  100907. /**
  100908. * Remove a block from the list of root nodes
  100909. * @param node defines the node to remove
  100910. * @returns the current material
  100911. */
  100912. removeOutputNode(node: NodeMaterialBlock): this;
  100913. private _addVertexOutputNode;
  100914. private _removeVertexOutputNode;
  100915. private _addFragmentOutputNode;
  100916. private _removeFragmentOutputNode;
  100917. /**
  100918. * Specifies if the material will require alpha blending
  100919. * @returns a boolean specifying if alpha blending is needed
  100920. */
  100921. needAlphaBlending(): boolean;
  100922. /**
  100923. * Specifies if this material should be rendered in alpha test mode
  100924. * @returns a boolean specifying if an alpha test is needed.
  100925. */
  100926. needAlphaTesting(): boolean;
  100927. private _initializeBlock;
  100928. private _resetDualBlocks;
  100929. /**
  100930. * Remove a block from the current node material
  100931. * @param block defines the block to remove
  100932. */
  100933. removeBlock(block: NodeMaterialBlock): void;
  100934. /**
  100935. * Build the material and generates the inner effect
  100936. * @param verbose defines if the build should log activity
  100937. */
  100938. build(verbose?: boolean): void;
  100939. /**
  100940. * Runs an otpimization phase to try to improve the shader code
  100941. */
  100942. optimize(): void;
  100943. private _prepareDefinesForAttributes;
  100944. /**
  100945. * Create a post process from the material
  100946. * @param camera The camera to apply the render pass to.
  100947. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  100948. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  100949. * @param engine The engine which the post process will be applied. (default: current engine)
  100950. * @param reusable If the post process can be reused on the same frame. (default: false)
  100951. * @param textureType Type of textures used when performing the post process. (default: 0)
  100952. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  100953. * @returns the post process created
  100954. */
  100955. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  100956. /**
  100957. * Create the post process effect from the material
  100958. * @param postProcess The post process to create the effect for
  100959. */
  100960. createEffectForPostProcess(postProcess: PostProcess): void;
  100961. private _createEffectOrPostProcess;
  100962. private _createEffectForParticles;
  100963. /**
  100964. * Create the effect to be used as the custom effect for a particle system
  100965. * @param particleSystem Particle system to create the effect for
  100966. * @param onCompiled defines a function to call when the effect creation is successful
  100967. * @param onError defines a function to call when the effect creation has failed
  100968. */
  100969. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  100970. private _processDefines;
  100971. /**
  100972. * Get if the submesh is ready to be used and all its information available.
  100973. * Child classes can use it to update shaders
  100974. * @param mesh defines the mesh to check
  100975. * @param subMesh defines which submesh to check
  100976. * @param useInstances specifies that instances should be used
  100977. * @returns a boolean indicating that the submesh is ready or not
  100978. */
  100979. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  100980. /**
  100981. * Get a string representing the shaders built by the current node graph
  100982. */
  100983. get compiledShaders(): string;
  100984. /**
  100985. * Binds the world matrix to the material
  100986. * @param world defines the world transformation matrix
  100987. */
  100988. bindOnlyWorldMatrix(world: Matrix): void;
  100989. /**
  100990. * Binds the submesh to this material by preparing the effect and shader to draw
  100991. * @param world defines the world transformation matrix
  100992. * @param mesh defines the mesh containing the submesh
  100993. * @param subMesh defines the submesh to bind the material to
  100994. */
  100995. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  100996. /**
  100997. * Gets the active textures from the material
  100998. * @returns an array of textures
  100999. */
  101000. getActiveTextures(): BaseTexture[];
  101001. /**
  101002. * Gets the list of texture blocks
  101003. * @returns an array of texture blocks
  101004. */
  101005. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101006. /**
  101007. * Specifies if the material uses a texture
  101008. * @param texture defines the texture to check against the material
  101009. * @returns a boolean specifying if the material uses the texture
  101010. */
  101011. hasTexture(texture: BaseTexture): boolean;
  101012. /**
  101013. * Disposes the material
  101014. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  101015. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  101016. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  101017. */
  101018. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  101019. /** Creates the node editor window. */
  101020. private _createNodeEditor;
  101021. /**
  101022. * Launch the node material editor
  101023. * @param config Define the configuration of the editor
  101024. * @return a promise fulfilled when the node editor is visible
  101025. */
  101026. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  101027. /**
  101028. * Clear the current material
  101029. */
  101030. clear(): void;
  101031. /**
  101032. * Clear the current material and set it to a default state
  101033. */
  101034. setToDefault(): void;
  101035. /**
  101036. * Clear the current material and set it to a default state for post process
  101037. */
  101038. setToDefaultPostProcess(): void;
  101039. /**
  101040. * Clear the current material and set it to a default state for particle
  101041. */
  101042. setToDefaultParticle(): void;
  101043. /**
  101044. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  101045. * @param url defines the url to load from
  101046. * @returns a promise that will fullfil when the material is fully loaded
  101047. */
  101048. loadAsync(url: string): Promise<void>;
  101049. private _gatherBlocks;
  101050. /**
  101051. * Generate a string containing the code declaration required to create an equivalent of this material
  101052. * @returns a string
  101053. */
  101054. generateCode(): string;
  101055. /**
  101056. * Serializes this material in a JSON representation
  101057. * @returns the serialized material object
  101058. */
  101059. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  101060. private _restoreConnections;
  101061. /**
  101062. * Clear the current graph and load a new one from a serialization object
  101063. * @param source defines the JSON representation of the material
  101064. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101065. * @param merge defines whether or not the source must be merged or replace the current content
  101066. */
  101067. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  101068. /**
  101069. * Makes a duplicate of the current material.
  101070. * @param name - name to use for the new material.
  101071. */
  101072. clone(name: string): NodeMaterial;
  101073. /**
  101074. * Creates a node material from parsed material data
  101075. * @param source defines the JSON representation of the material
  101076. * @param scene defines the hosting scene
  101077. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101078. * @returns a new node material
  101079. */
  101080. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  101081. /**
  101082. * Creates a node material from a snippet saved in a remote file
  101083. * @param name defines the name of the material to create
  101084. * @param url defines the url to load from
  101085. * @param scene defines the hosting scene
  101086. * @returns a promise that will resolve to the new node material
  101087. */
  101088. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  101089. /**
  101090. * Creates a node material from a snippet saved by the node material editor
  101091. * @param snippetId defines the snippet to load
  101092. * @param scene defines the hosting scene
  101093. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101094. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  101095. * @returns a promise that will resolve to the new node material
  101096. */
  101097. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  101098. /**
  101099. * Creates a new node material set to default basic configuration
  101100. * @param name defines the name of the material
  101101. * @param scene defines the hosting scene
  101102. * @returns a new NodeMaterial
  101103. */
  101104. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  101105. }
  101106. }
  101107. declare module BABYLON {
  101108. /**
  101109. * Size options for a post process
  101110. */
  101111. export type PostProcessOptions = {
  101112. width: number;
  101113. height: number;
  101114. };
  101115. /**
  101116. * PostProcess can be used to apply a shader to a texture after it has been rendered
  101117. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  101118. */
  101119. export class PostProcess {
  101120. /** Name of the PostProcess. */
  101121. name: string;
  101122. /**
  101123. * Gets or sets the unique id of the post process
  101124. */
  101125. uniqueId: number;
  101126. /**
  101127. * Width of the texture to apply the post process on
  101128. */
  101129. width: number;
  101130. /**
  101131. * Height of the texture to apply the post process on
  101132. */
  101133. height: number;
  101134. /**
  101135. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  101136. */
  101137. nodeMaterialSource: Nullable<NodeMaterial>;
  101138. /**
  101139. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  101140. * @hidden
  101141. */
  101142. _outputTexture: Nullable<InternalTexture>;
  101143. /**
  101144. * Sampling mode used by the shader
  101145. * See https://doc.babylonjs.com/classes/3.1/texture
  101146. */
  101147. renderTargetSamplingMode: number;
  101148. /**
  101149. * Clear color to use when screen clearing
  101150. */
  101151. clearColor: Color4;
  101152. /**
  101153. * If the buffer needs to be cleared before applying the post process. (default: true)
  101154. * Should be set to false if shader will overwrite all previous pixels.
  101155. */
  101156. autoClear: boolean;
  101157. /**
  101158. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  101159. */
  101160. alphaMode: number;
  101161. /**
  101162. * Sets the setAlphaBlendConstants of the babylon engine
  101163. */
  101164. alphaConstants: Color4;
  101165. /**
  101166. * Animations to be used for the post processing
  101167. */
  101168. animations: Animation[];
  101169. /**
  101170. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  101171. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  101172. */
  101173. enablePixelPerfectMode: boolean;
  101174. /**
  101175. * Force the postprocess to be applied without taking in account viewport
  101176. */
  101177. forceFullscreenViewport: boolean;
  101178. /**
  101179. * List of inspectable custom properties (used by the Inspector)
  101180. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  101181. */
  101182. inspectableCustomProperties: IInspectable[];
  101183. /**
  101184. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  101185. *
  101186. * | Value | Type | Description |
  101187. * | ----- | ----------------------------------- | ----------- |
  101188. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  101189. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  101190. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  101191. *
  101192. */
  101193. scaleMode: number;
  101194. /**
  101195. * Force textures to be a power of two (default: false)
  101196. */
  101197. alwaysForcePOT: boolean;
  101198. private _samples;
  101199. /**
  101200. * Number of sample textures (default: 1)
  101201. */
  101202. get samples(): number;
  101203. set samples(n: number);
  101204. /**
  101205. * Modify the scale of the post process to be the same as the viewport (default: false)
  101206. */
  101207. adaptScaleToCurrentViewport: boolean;
  101208. private _camera;
  101209. protected _scene: Scene;
  101210. private _engine;
  101211. private _options;
  101212. private _reusable;
  101213. private _textureType;
  101214. private _textureFormat;
  101215. /**
  101216. * Smart array of input and output textures for the post process.
  101217. * @hidden
  101218. */
  101219. _textures: SmartArray<InternalTexture>;
  101220. /**
  101221. * The index in _textures that corresponds to the output texture.
  101222. * @hidden
  101223. */
  101224. _currentRenderTextureInd: number;
  101225. private _effect;
  101226. private _samplers;
  101227. private _fragmentUrl;
  101228. private _vertexUrl;
  101229. private _parameters;
  101230. private _scaleRatio;
  101231. protected _indexParameters: any;
  101232. private _shareOutputWithPostProcess;
  101233. private _texelSize;
  101234. private _forcedOutputTexture;
  101235. /**
  101236. * Returns the fragment url or shader name used in the post process.
  101237. * @returns the fragment url or name in the shader store.
  101238. */
  101239. getEffectName(): string;
  101240. /**
  101241. * An event triggered when the postprocess is activated.
  101242. */
  101243. onActivateObservable: Observable<Camera>;
  101244. private _onActivateObserver;
  101245. /**
  101246. * A function that is added to the onActivateObservable
  101247. */
  101248. set onActivate(callback: Nullable<(camera: Camera) => void>);
  101249. /**
  101250. * An event triggered when the postprocess changes its size.
  101251. */
  101252. onSizeChangedObservable: Observable<PostProcess>;
  101253. private _onSizeChangedObserver;
  101254. /**
  101255. * A function that is added to the onSizeChangedObservable
  101256. */
  101257. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  101258. /**
  101259. * An event triggered when the postprocess applies its effect.
  101260. */
  101261. onApplyObservable: Observable<Effect>;
  101262. private _onApplyObserver;
  101263. /**
  101264. * A function that is added to the onApplyObservable
  101265. */
  101266. set onApply(callback: (effect: Effect) => void);
  101267. /**
  101268. * An event triggered before rendering the postprocess
  101269. */
  101270. onBeforeRenderObservable: Observable<Effect>;
  101271. private _onBeforeRenderObserver;
  101272. /**
  101273. * A function that is added to the onBeforeRenderObservable
  101274. */
  101275. set onBeforeRender(callback: (effect: Effect) => void);
  101276. /**
  101277. * An event triggered after rendering the postprocess
  101278. */
  101279. onAfterRenderObservable: Observable<Effect>;
  101280. private _onAfterRenderObserver;
  101281. /**
  101282. * A function that is added to the onAfterRenderObservable
  101283. */
  101284. set onAfterRender(callback: (efect: Effect) => void);
  101285. /**
  101286. * 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
  101287. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  101288. */
  101289. get inputTexture(): InternalTexture;
  101290. set inputTexture(value: InternalTexture);
  101291. /**
  101292. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  101293. * the only way to unset it is to use this function to restore its internal state
  101294. */
  101295. restoreDefaultInputTexture(): void;
  101296. /**
  101297. * Gets the camera which post process is applied to.
  101298. * @returns The camera the post process is applied to.
  101299. */
  101300. getCamera(): Camera;
  101301. /**
  101302. * Gets the texel size of the postprocess.
  101303. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  101304. */
  101305. get texelSize(): Vector2;
  101306. /**
  101307. * Creates a new instance PostProcess
  101308. * @param name The name of the PostProcess.
  101309. * @param fragmentUrl The url of the fragment shader to be used.
  101310. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  101311. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  101312. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101313. * @param camera The camera to apply the render pass to.
  101314. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101315. * @param engine The engine which the post process will be applied. (default: current engine)
  101316. * @param reusable If the post process can be reused on the same frame. (default: false)
  101317. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  101318. * @param textureType Type of textures used when performing the post process. (default: 0)
  101319. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  101320. * @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
  101321. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  101322. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  101323. */
  101324. constructor(
  101325. /** Name of the PostProcess. */
  101326. 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);
  101327. /**
  101328. * Gets a string idenfifying the name of the class
  101329. * @returns "PostProcess" string
  101330. */
  101331. getClassName(): string;
  101332. /**
  101333. * Gets the engine which this post process belongs to.
  101334. * @returns The engine the post process was enabled with.
  101335. */
  101336. getEngine(): Engine;
  101337. /**
  101338. * The effect that is created when initializing the post process.
  101339. * @returns The created effect corresponding the the postprocess.
  101340. */
  101341. getEffect(): Effect;
  101342. /**
  101343. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  101344. * @param postProcess The post process to share the output with.
  101345. * @returns This post process.
  101346. */
  101347. shareOutputWith(postProcess: PostProcess): PostProcess;
  101348. /**
  101349. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  101350. * This should be called if the post process that shares output with this post process is disabled/disposed.
  101351. */
  101352. useOwnOutput(): void;
  101353. /**
  101354. * Updates the effect with the current post process compile time values and recompiles the shader.
  101355. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  101356. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  101357. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  101358. * @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
  101359. * @param onCompiled Called when the shader has been compiled.
  101360. * @param onError Called if there is an error when compiling a shader.
  101361. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  101362. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  101363. */
  101364. 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;
  101365. /**
  101366. * The post process is reusable if it can be used multiple times within one frame.
  101367. * @returns If the post process is reusable
  101368. */
  101369. isReusable(): boolean;
  101370. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  101371. markTextureDirty(): void;
  101372. /**
  101373. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  101374. * 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.
  101375. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  101376. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  101377. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  101378. * @returns The target texture that was bound to be written to.
  101379. */
  101380. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  101381. /**
  101382. * If the post process is supported.
  101383. */
  101384. get isSupported(): boolean;
  101385. /**
  101386. * The aspect ratio of the output texture.
  101387. */
  101388. get aspectRatio(): number;
  101389. /**
  101390. * Get a value indicating if the post-process is ready to be used
  101391. * @returns true if the post-process is ready (shader is compiled)
  101392. */
  101393. isReady(): boolean;
  101394. /**
  101395. * Binds all textures and uniforms to the shader, this will be run on every pass.
  101396. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  101397. */
  101398. apply(): Nullable<Effect>;
  101399. private _disposeTextures;
  101400. /**
  101401. * Disposes the post process.
  101402. * @param camera The camera to dispose the post process on.
  101403. */
  101404. dispose(camera?: Camera): void;
  101405. }
  101406. }
  101407. declare module BABYLON {
  101408. /** @hidden */
  101409. export var kernelBlurVaryingDeclaration: {
  101410. name: string;
  101411. shader: string;
  101412. };
  101413. }
  101414. declare module BABYLON {
  101415. /** @hidden */
  101416. export var kernelBlurFragment: {
  101417. name: string;
  101418. shader: string;
  101419. };
  101420. }
  101421. declare module BABYLON {
  101422. /** @hidden */
  101423. export var kernelBlurFragment2: {
  101424. name: string;
  101425. shader: string;
  101426. };
  101427. }
  101428. declare module BABYLON {
  101429. /** @hidden */
  101430. export var kernelBlurPixelShader: {
  101431. name: string;
  101432. shader: string;
  101433. };
  101434. }
  101435. declare module BABYLON {
  101436. /** @hidden */
  101437. export var kernelBlurVertex: {
  101438. name: string;
  101439. shader: string;
  101440. };
  101441. }
  101442. declare module BABYLON {
  101443. /** @hidden */
  101444. export var kernelBlurVertexShader: {
  101445. name: string;
  101446. shader: string;
  101447. };
  101448. }
  101449. declare module BABYLON {
  101450. /**
  101451. * The Blur Post Process which blurs an image based on a kernel and direction.
  101452. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  101453. */
  101454. export class BlurPostProcess extends PostProcess {
  101455. /** The direction in which to blur the image. */
  101456. direction: Vector2;
  101457. private blockCompilation;
  101458. protected _kernel: number;
  101459. protected _idealKernel: number;
  101460. protected _packedFloat: boolean;
  101461. private _staticDefines;
  101462. /**
  101463. * Sets the length in pixels of the blur sample region
  101464. */
  101465. set kernel(v: number);
  101466. /**
  101467. * Gets the length in pixels of the blur sample region
  101468. */
  101469. get kernel(): number;
  101470. /**
  101471. * Sets wether or not the blur needs to unpack/repack floats
  101472. */
  101473. set packedFloat(v: boolean);
  101474. /**
  101475. * Gets wether or not the blur is unpacking/repacking floats
  101476. */
  101477. get packedFloat(): boolean;
  101478. /**
  101479. * Creates a new instance BlurPostProcess
  101480. * @param name The name of the effect.
  101481. * @param direction The direction in which to blur the image.
  101482. * @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.
  101483. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101484. * @param camera The camera to apply the render pass to.
  101485. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101486. * @param engine The engine which the post process will be applied. (default: current engine)
  101487. * @param reusable If the post process can be reused on the same frame. (default: false)
  101488. * @param textureType Type of textures used when performing the post process. (default: 0)
  101489. * @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)
  101490. */
  101491. constructor(name: string,
  101492. /** The direction in which to blur the image. */
  101493. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  101494. /**
  101495. * Updates the effect with the current post process compile time values and recompiles the shader.
  101496. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  101497. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  101498. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  101499. * @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
  101500. * @param onCompiled Called when the shader has been compiled.
  101501. * @param onError Called if there is an error when compiling a shader.
  101502. */
  101503. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101504. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101505. /**
  101506. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  101507. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  101508. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  101509. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  101510. * The gaps between physical kernels are compensated for in the weighting of the samples
  101511. * @param idealKernel Ideal blur kernel.
  101512. * @return Nearest best kernel.
  101513. */
  101514. protected _nearestBestKernel(idealKernel: number): number;
  101515. /**
  101516. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  101517. * @param x The point on the Gaussian distribution to sample.
  101518. * @return the value of the Gaussian function at x.
  101519. */
  101520. protected _gaussianWeight(x: number): number;
  101521. /**
  101522. * Generates a string that can be used as a floating point number in GLSL.
  101523. * @param x Value to print.
  101524. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  101525. * @return GLSL float string.
  101526. */
  101527. protected _glslFloat(x: number, decimalFigures?: number): string;
  101528. }
  101529. }
  101530. declare module BABYLON {
  101531. /**
  101532. * Mirror texture can be used to simulate the view from a mirror in a scene.
  101533. * It will dynamically be rendered every frame to adapt to the camera point of view.
  101534. * You can then easily use it as a reflectionTexture on a flat surface.
  101535. * In case the surface is not a plane, please consider relying on reflection probes.
  101536. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101537. */
  101538. export class MirrorTexture extends RenderTargetTexture {
  101539. private scene;
  101540. /**
  101541. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  101542. * 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.
  101543. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101544. */
  101545. mirrorPlane: Plane;
  101546. /**
  101547. * Define the blur ratio used to blur the reflection if needed.
  101548. */
  101549. set blurRatio(value: number);
  101550. get blurRatio(): number;
  101551. /**
  101552. * Define the adaptive blur kernel used to blur the reflection if needed.
  101553. * This will autocompute the closest best match for the `blurKernel`
  101554. */
  101555. set adaptiveBlurKernel(value: number);
  101556. /**
  101557. * Define the blur kernel used to blur the reflection if needed.
  101558. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101559. */
  101560. set blurKernel(value: number);
  101561. /**
  101562. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  101563. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101564. */
  101565. set blurKernelX(value: number);
  101566. get blurKernelX(): number;
  101567. /**
  101568. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  101569. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101570. */
  101571. set blurKernelY(value: number);
  101572. get blurKernelY(): number;
  101573. private _autoComputeBlurKernel;
  101574. protected _onRatioRescale(): void;
  101575. private _updateGammaSpace;
  101576. private _imageProcessingConfigChangeObserver;
  101577. private _transformMatrix;
  101578. private _mirrorMatrix;
  101579. private _savedViewMatrix;
  101580. private _blurX;
  101581. private _blurY;
  101582. private _adaptiveBlurKernel;
  101583. private _blurKernelX;
  101584. private _blurKernelY;
  101585. private _blurRatio;
  101586. /**
  101587. * Instantiates a Mirror Texture.
  101588. * Mirror texture can be used to simulate the view from a mirror in a scene.
  101589. * It will dynamically be rendered every frame to adapt to the camera point of view.
  101590. * You can then easily use it as a reflectionTexture on a flat surface.
  101591. * In case the surface is not a plane, please consider relying on reflection probes.
  101592. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101593. * @param name
  101594. * @param size
  101595. * @param scene
  101596. * @param generateMipMaps
  101597. * @param type
  101598. * @param samplingMode
  101599. * @param generateDepthBuffer
  101600. */
  101601. constructor(name: string, size: number | {
  101602. width: number;
  101603. height: number;
  101604. } | {
  101605. ratio: number;
  101606. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  101607. private _preparePostProcesses;
  101608. /**
  101609. * Clone the mirror texture.
  101610. * @returns the cloned texture
  101611. */
  101612. clone(): MirrorTexture;
  101613. /**
  101614. * Serialize the texture to a JSON representation you could use in Parse later on
  101615. * @returns the serialized JSON representation
  101616. */
  101617. serialize(): any;
  101618. /**
  101619. * Dispose the texture and release its associated resources.
  101620. */
  101621. dispose(): void;
  101622. }
  101623. }
  101624. declare module BABYLON {
  101625. /**
  101626. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  101627. * @see https://doc.babylonjs.com/babylon101/materials#texture
  101628. */
  101629. export class Texture extends BaseTexture {
  101630. /**
  101631. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  101632. */
  101633. static SerializeBuffers: boolean;
  101634. /** @hidden */
  101635. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  101636. /** @hidden */
  101637. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  101638. /** @hidden */
  101639. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  101640. /** nearest is mag = nearest and min = nearest and mip = linear */
  101641. static readonly NEAREST_SAMPLINGMODE: number;
  101642. /** nearest is mag = nearest and min = nearest and mip = linear */
  101643. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  101644. /** Bilinear is mag = linear and min = linear and mip = nearest */
  101645. static readonly BILINEAR_SAMPLINGMODE: number;
  101646. /** Bilinear is mag = linear and min = linear and mip = nearest */
  101647. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  101648. /** Trilinear is mag = linear and min = linear and mip = linear */
  101649. static readonly TRILINEAR_SAMPLINGMODE: number;
  101650. /** Trilinear is mag = linear and min = linear and mip = linear */
  101651. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  101652. /** mag = nearest and min = nearest and mip = nearest */
  101653. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  101654. /** mag = nearest and min = linear and mip = nearest */
  101655. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  101656. /** mag = nearest and min = linear and mip = linear */
  101657. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  101658. /** mag = nearest and min = linear and mip = none */
  101659. static readonly NEAREST_LINEAR: number;
  101660. /** mag = nearest and min = nearest and mip = none */
  101661. static readonly NEAREST_NEAREST: number;
  101662. /** mag = linear and min = nearest and mip = nearest */
  101663. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  101664. /** mag = linear and min = nearest and mip = linear */
  101665. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  101666. /** mag = linear and min = linear and mip = none */
  101667. static readonly LINEAR_LINEAR: number;
  101668. /** mag = linear and min = nearest and mip = none */
  101669. static readonly LINEAR_NEAREST: number;
  101670. /** Explicit coordinates mode */
  101671. static readonly EXPLICIT_MODE: number;
  101672. /** Spherical coordinates mode */
  101673. static readonly SPHERICAL_MODE: number;
  101674. /** Planar coordinates mode */
  101675. static readonly PLANAR_MODE: number;
  101676. /** Cubic coordinates mode */
  101677. static readonly CUBIC_MODE: number;
  101678. /** Projection coordinates mode */
  101679. static readonly PROJECTION_MODE: number;
  101680. /** Inverse Cubic coordinates mode */
  101681. static readonly SKYBOX_MODE: number;
  101682. /** Inverse Cubic coordinates mode */
  101683. static readonly INVCUBIC_MODE: number;
  101684. /** Equirectangular coordinates mode */
  101685. static readonly EQUIRECTANGULAR_MODE: number;
  101686. /** Equirectangular Fixed coordinates mode */
  101687. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  101688. /** Equirectangular Fixed Mirrored coordinates mode */
  101689. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  101690. /** Texture is not repeating outside of 0..1 UVs */
  101691. static readonly CLAMP_ADDRESSMODE: number;
  101692. /** Texture is repeating outside of 0..1 UVs */
  101693. static readonly WRAP_ADDRESSMODE: number;
  101694. /** Texture is repeating and mirrored */
  101695. static readonly MIRROR_ADDRESSMODE: number;
  101696. /**
  101697. * 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
  101698. */
  101699. static UseSerializedUrlIfAny: boolean;
  101700. /**
  101701. * Define the url of the texture.
  101702. */
  101703. url: Nullable<string>;
  101704. /**
  101705. * Define an offset on the texture to offset the u coordinates of the UVs
  101706. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  101707. */
  101708. uOffset: number;
  101709. /**
  101710. * Define an offset on the texture to offset the v coordinates of the UVs
  101711. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  101712. */
  101713. vOffset: number;
  101714. /**
  101715. * Define an offset on the texture to scale the u coordinates of the UVs
  101716. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  101717. */
  101718. uScale: number;
  101719. /**
  101720. * Define an offset on the texture to scale the v coordinates of the UVs
  101721. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  101722. */
  101723. vScale: number;
  101724. /**
  101725. * Define an offset on the texture to rotate around the u coordinates of the UVs
  101726. * @see https://doc.babylonjs.com/how_to/more_materials
  101727. */
  101728. uAng: number;
  101729. /**
  101730. * Define an offset on the texture to rotate around the v coordinates of the UVs
  101731. * @see https://doc.babylonjs.com/how_to/more_materials
  101732. */
  101733. vAng: number;
  101734. /**
  101735. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  101736. * @see https://doc.babylonjs.com/how_to/more_materials
  101737. */
  101738. wAng: number;
  101739. /**
  101740. * Defines the center of rotation (U)
  101741. */
  101742. uRotationCenter: number;
  101743. /**
  101744. * Defines the center of rotation (V)
  101745. */
  101746. vRotationCenter: number;
  101747. /**
  101748. * Defines the center of rotation (W)
  101749. */
  101750. wRotationCenter: number;
  101751. /**
  101752. * Are mip maps generated for this texture or not.
  101753. */
  101754. get noMipmap(): boolean;
  101755. /**
  101756. * List of inspectable custom properties (used by the Inspector)
  101757. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  101758. */
  101759. inspectableCustomProperties: Nullable<IInspectable[]>;
  101760. private _noMipmap;
  101761. /** @hidden */
  101762. _invertY: boolean;
  101763. private _rowGenerationMatrix;
  101764. private _cachedTextureMatrix;
  101765. private _projectionModeMatrix;
  101766. private _t0;
  101767. private _t1;
  101768. private _t2;
  101769. private _cachedUOffset;
  101770. private _cachedVOffset;
  101771. private _cachedUScale;
  101772. private _cachedVScale;
  101773. private _cachedUAng;
  101774. private _cachedVAng;
  101775. private _cachedWAng;
  101776. private _cachedProjectionMatrixId;
  101777. private _cachedCoordinatesMode;
  101778. /** @hidden */
  101779. protected _initialSamplingMode: number;
  101780. /** @hidden */
  101781. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  101782. private _deleteBuffer;
  101783. protected _format: Nullable<number>;
  101784. private _delayedOnLoad;
  101785. private _delayedOnError;
  101786. private _mimeType?;
  101787. /**
  101788. * Observable triggered once the texture has been loaded.
  101789. */
  101790. onLoadObservable: Observable<Texture>;
  101791. protected _isBlocking: boolean;
  101792. /**
  101793. * Is the texture preventing material to render while loading.
  101794. * If false, a default texture will be used instead of the loading one during the preparation step.
  101795. */
  101796. set isBlocking(value: boolean);
  101797. get isBlocking(): boolean;
  101798. /**
  101799. * Get the current sampling mode associated with the texture.
  101800. */
  101801. get samplingMode(): number;
  101802. /**
  101803. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  101804. */
  101805. get invertY(): boolean;
  101806. /**
  101807. * Instantiates a new texture.
  101808. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  101809. * @see https://doc.babylonjs.com/babylon101/materials#texture
  101810. * @param url defines the url of the picture to load as a texture
  101811. * @param sceneOrEngine defines the scene or engine the texture will belong to
  101812. * @param noMipmap defines if the texture will require mip maps or not
  101813. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  101814. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101815. * @param onLoad defines a callback triggered when the texture has been loaded
  101816. * @param onError defines a callback triggered when an error occurred during the loading session
  101817. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  101818. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  101819. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101820. * @param mimeType defines an optional mime type information
  101821. */
  101822. 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);
  101823. /**
  101824. * Update the url (and optional buffer) of this texture if url was null during construction.
  101825. * @param url the url of the texture
  101826. * @param buffer the buffer of the texture (defaults to null)
  101827. * @param onLoad callback called when the texture is loaded (defaults to null)
  101828. */
  101829. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  101830. /**
  101831. * Finish the loading sequence of a texture flagged as delayed load.
  101832. * @hidden
  101833. */
  101834. delayLoad(): void;
  101835. private _prepareRowForTextureGeneration;
  101836. /**
  101837. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  101838. * @returns the transform matrix of the texture.
  101839. */
  101840. getTextureMatrix(uBase?: number): Matrix;
  101841. /**
  101842. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  101843. * @returns The reflection texture transform
  101844. */
  101845. getReflectionTextureMatrix(): Matrix;
  101846. /**
  101847. * Clones the texture.
  101848. * @returns the cloned texture
  101849. */
  101850. clone(): Texture;
  101851. /**
  101852. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  101853. * @returns The JSON representation of the texture
  101854. */
  101855. serialize(): any;
  101856. /**
  101857. * Get the current class name of the texture useful for serialization or dynamic coding.
  101858. * @returns "Texture"
  101859. */
  101860. getClassName(): string;
  101861. /**
  101862. * Dispose the texture and release its associated resources.
  101863. */
  101864. dispose(): void;
  101865. /**
  101866. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  101867. * @param parsedTexture Define the JSON representation of the texture
  101868. * @param scene Define the scene the parsed texture should be instantiated in
  101869. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  101870. * @returns The parsed texture if successful
  101871. */
  101872. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  101873. /**
  101874. * Creates a texture from its base 64 representation.
  101875. * @param data Define the base64 payload without the data: prefix
  101876. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  101877. * @param scene Define the scene the texture should belong to
  101878. * @param noMipmap Forces the texture to not create mip map information if true
  101879. * @param invertY define if the texture needs to be inverted on the y axis during loading
  101880. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101881. * @param onLoad define a callback triggered when the texture has been loaded
  101882. * @param onError define a callback triggered when an error occurred during the loading session
  101883. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101884. * @returns the created texture
  101885. */
  101886. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  101887. /**
  101888. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  101889. * @param data Define the base64 payload without the data: prefix
  101890. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  101891. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  101892. * @param scene Define the scene the texture should belong to
  101893. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  101894. * @param noMipmap Forces the texture to not create mip map information if true
  101895. * @param invertY define if the texture needs to be inverted on the y axis during loading
  101896. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101897. * @param onLoad define a callback triggered when the texture has been loaded
  101898. * @param onError define a callback triggered when an error occurred during the loading session
  101899. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101900. * @returns the created texture
  101901. */
  101902. 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;
  101903. }
  101904. }
  101905. declare module BABYLON {
  101906. /**
  101907. * PostProcessManager is used to manage one or more post processes or post process pipelines
  101908. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  101909. */
  101910. export class PostProcessManager {
  101911. private _scene;
  101912. private _indexBuffer;
  101913. private _vertexBuffers;
  101914. /**
  101915. * Creates a new instance PostProcess
  101916. * @param scene The scene that the post process is associated with.
  101917. */
  101918. constructor(scene: Scene);
  101919. private _prepareBuffers;
  101920. private _buildIndexBuffer;
  101921. /**
  101922. * Rebuilds the vertex buffers of the manager.
  101923. * @hidden
  101924. */
  101925. _rebuild(): void;
  101926. /**
  101927. * Prepares a frame to be run through a post process.
  101928. * @param sourceTexture The input texture to the post procesess. (default: null)
  101929. * @param postProcesses An array of post processes to be run. (default: null)
  101930. * @returns True if the post processes were able to be run.
  101931. * @hidden
  101932. */
  101933. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  101934. /**
  101935. * Manually render a set of post processes to a texture.
  101936. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  101937. * @param postProcesses An array of post processes to be run.
  101938. * @param targetTexture The target texture to render to.
  101939. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  101940. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  101941. * @param lodLevel defines which lod of the texture to render to
  101942. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  101943. */
  101944. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  101945. /**
  101946. * Finalize the result of the output of the postprocesses.
  101947. * @param doNotPresent If true the result will not be displayed to the screen.
  101948. * @param targetTexture The target texture to render to.
  101949. * @param faceIndex The index of the face to bind the target texture to.
  101950. * @param postProcesses The array of post processes to render.
  101951. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  101952. * @hidden
  101953. */
  101954. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  101955. /**
  101956. * Disposes of the post process manager.
  101957. */
  101958. dispose(): void;
  101959. }
  101960. }
  101961. declare module BABYLON {
  101962. /**
  101963. * This Helps creating a texture that will be created from a camera in your scene.
  101964. * It is basically a dynamic texture that could be used to create special effects for instance.
  101965. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  101966. */
  101967. export class RenderTargetTexture extends Texture {
  101968. isCube: boolean;
  101969. /**
  101970. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  101971. */
  101972. static readonly REFRESHRATE_RENDER_ONCE: number;
  101973. /**
  101974. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  101975. */
  101976. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  101977. /**
  101978. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  101979. * the central point of your effect and can save a lot of performances.
  101980. */
  101981. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  101982. /**
  101983. * Use this predicate to dynamically define the list of mesh you want to render.
  101984. * If set, the renderList property will be overwritten.
  101985. */
  101986. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  101987. private _renderList;
  101988. /**
  101989. * Use this list to define the list of mesh you want to render.
  101990. */
  101991. get renderList(): Nullable<Array<AbstractMesh>>;
  101992. set renderList(value: Nullable<Array<AbstractMesh>>);
  101993. /**
  101994. * Use this function to overload the renderList array at rendering time.
  101995. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  101996. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  101997. * the cube (if the RTT is a cube, else layerOrFace=0).
  101998. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  101999. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  102000. * hold dummy elements!
  102001. */
  102002. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  102003. private _hookArray;
  102004. /**
  102005. * Define if particles should be rendered in your texture.
  102006. */
  102007. renderParticles: boolean;
  102008. /**
  102009. * Define if sprites should be rendered in your texture.
  102010. */
  102011. renderSprites: boolean;
  102012. /**
  102013. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  102014. */
  102015. coordinatesMode: number;
  102016. /**
  102017. * Define the camera used to render the texture.
  102018. */
  102019. activeCamera: Nullable<Camera>;
  102020. /**
  102021. * Override the mesh isReady function with your own one.
  102022. */
  102023. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  102024. /**
  102025. * Override the render function of the texture with your own one.
  102026. */
  102027. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  102028. /**
  102029. * Define if camera post processes should be use while rendering the texture.
  102030. */
  102031. useCameraPostProcesses: boolean;
  102032. /**
  102033. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  102034. */
  102035. ignoreCameraViewport: boolean;
  102036. private _postProcessManager;
  102037. private _postProcesses;
  102038. private _resizeObserver;
  102039. /**
  102040. * An event triggered when the texture is unbind.
  102041. */
  102042. onBeforeBindObservable: Observable<RenderTargetTexture>;
  102043. /**
  102044. * An event triggered when the texture is unbind.
  102045. */
  102046. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  102047. private _onAfterUnbindObserver;
  102048. /**
  102049. * Set a after unbind callback in the texture.
  102050. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  102051. */
  102052. set onAfterUnbind(callback: () => void);
  102053. /**
  102054. * An event triggered before rendering the texture
  102055. */
  102056. onBeforeRenderObservable: Observable<number>;
  102057. private _onBeforeRenderObserver;
  102058. /**
  102059. * Set a before render callback in the texture.
  102060. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  102061. */
  102062. set onBeforeRender(callback: (faceIndex: number) => void);
  102063. /**
  102064. * An event triggered after rendering the texture
  102065. */
  102066. onAfterRenderObservable: Observable<number>;
  102067. private _onAfterRenderObserver;
  102068. /**
  102069. * Set a after render callback in the texture.
  102070. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  102071. */
  102072. set onAfterRender(callback: (faceIndex: number) => void);
  102073. /**
  102074. * An event triggered after the texture clear
  102075. */
  102076. onClearObservable: Observable<Engine>;
  102077. private _onClearObserver;
  102078. /**
  102079. * Set a clear callback in the texture.
  102080. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  102081. */
  102082. set onClear(callback: (Engine: Engine) => void);
  102083. /**
  102084. * An event triggered when the texture is resized.
  102085. */
  102086. onResizeObservable: Observable<RenderTargetTexture>;
  102087. /**
  102088. * Define the clear color of the Render Target if it should be different from the scene.
  102089. */
  102090. clearColor: Color4;
  102091. protected _size: number | {
  102092. width: number;
  102093. height: number;
  102094. layers?: number;
  102095. };
  102096. protected _initialSizeParameter: number | {
  102097. width: number;
  102098. height: number;
  102099. } | {
  102100. ratio: number;
  102101. };
  102102. protected _sizeRatio: Nullable<number>;
  102103. /** @hidden */
  102104. _generateMipMaps: boolean;
  102105. protected _renderingManager: RenderingManager;
  102106. /** @hidden */
  102107. _waitingRenderList: string[];
  102108. protected _doNotChangeAspectRatio: boolean;
  102109. protected _currentRefreshId: number;
  102110. protected _refreshRate: number;
  102111. protected _textureMatrix: Matrix;
  102112. protected _samples: number;
  102113. protected _renderTargetOptions: RenderTargetCreationOptions;
  102114. /**
  102115. * Gets render target creation options that were used.
  102116. */
  102117. get renderTargetOptions(): RenderTargetCreationOptions;
  102118. protected _onRatioRescale(): void;
  102119. /**
  102120. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  102121. * It must define where the camera used to render the texture is set
  102122. */
  102123. boundingBoxPosition: Vector3;
  102124. private _boundingBoxSize;
  102125. /**
  102126. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  102127. * When defined, the cubemap will switch to local mode
  102128. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  102129. * @example https://www.babylonjs-playground.com/#RNASML
  102130. */
  102131. set boundingBoxSize(value: Vector3);
  102132. get boundingBoxSize(): Vector3;
  102133. /**
  102134. * In case the RTT has been created with a depth texture, get the associated
  102135. * depth texture.
  102136. * Otherwise, return null.
  102137. */
  102138. get depthStencilTexture(): Nullable<InternalTexture>;
  102139. /**
  102140. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  102141. * or used a shadow, depth texture...
  102142. * @param name The friendly name of the texture
  102143. * @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)
  102144. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  102145. * @param generateMipMaps True if mip maps need to be generated after render.
  102146. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  102147. * @param type The type of the buffer in the RTT (int, half float, float...)
  102148. * @param isCube True if a cube texture needs to be created
  102149. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  102150. * @param generateDepthBuffer True to generate a depth buffer
  102151. * @param generateStencilBuffer True to generate a stencil buffer
  102152. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  102153. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  102154. * @param delayAllocation if the texture allocation should be delayed (default: false)
  102155. */
  102156. constructor(name: string, size: number | {
  102157. width: number;
  102158. height: number;
  102159. layers?: number;
  102160. } | {
  102161. ratio: number;
  102162. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  102163. /**
  102164. * Creates a depth stencil texture.
  102165. * This is only available in WebGL 2 or with the depth texture extension available.
  102166. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  102167. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  102168. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  102169. */
  102170. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  102171. private _processSizeParameter;
  102172. /**
  102173. * Define the number of samples to use in case of MSAA.
  102174. * It defaults to one meaning no MSAA has been enabled.
  102175. */
  102176. get samples(): number;
  102177. set samples(value: number);
  102178. /**
  102179. * Resets the refresh counter of the texture and start bak from scratch.
  102180. * Could be useful to regenerate the texture if it is setup to render only once.
  102181. */
  102182. resetRefreshCounter(): void;
  102183. /**
  102184. * Define the refresh rate of the texture or the rendering frequency.
  102185. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  102186. */
  102187. get refreshRate(): number;
  102188. set refreshRate(value: number);
  102189. /**
  102190. * Adds a post process to the render target rendering passes.
  102191. * @param postProcess define the post process to add
  102192. */
  102193. addPostProcess(postProcess: PostProcess): void;
  102194. /**
  102195. * Clear all the post processes attached to the render target
  102196. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  102197. */
  102198. clearPostProcesses(dispose?: boolean): void;
  102199. /**
  102200. * Remove one of the post process from the list of attached post processes to the texture
  102201. * @param postProcess define the post process to remove from the list
  102202. */
  102203. removePostProcess(postProcess: PostProcess): void;
  102204. /** @hidden */
  102205. _shouldRender(): boolean;
  102206. /**
  102207. * Gets the actual render size of the texture.
  102208. * @returns the width of the render size
  102209. */
  102210. getRenderSize(): number;
  102211. /**
  102212. * Gets the actual render width of the texture.
  102213. * @returns the width of the render size
  102214. */
  102215. getRenderWidth(): number;
  102216. /**
  102217. * Gets the actual render height of the texture.
  102218. * @returns the height of the render size
  102219. */
  102220. getRenderHeight(): number;
  102221. /**
  102222. * Gets the actual number of layers of the texture.
  102223. * @returns the number of layers
  102224. */
  102225. getRenderLayers(): number;
  102226. /**
  102227. * Get if the texture can be rescaled or not.
  102228. */
  102229. get canRescale(): boolean;
  102230. /**
  102231. * Resize the texture using a ratio.
  102232. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  102233. */
  102234. scale(ratio: number): void;
  102235. /**
  102236. * Get the texture reflection matrix used to rotate/transform the reflection.
  102237. * @returns the reflection matrix
  102238. */
  102239. getReflectionTextureMatrix(): Matrix;
  102240. /**
  102241. * Resize the texture to a new desired size.
  102242. * Be carrefull as it will recreate all the data in the new texture.
  102243. * @param size Define the new size. It can be:
  102244. * - a number for squared texture,
  102245. * - an object containing { width: number, height: number }
  102246. * - or an object containing a ratio { ratio: number }
  102247. */
  102248. resize(size: number | {
  102249. width: number;
  102250. height: number;
  102251. } | {
  102252. ratio: number;
  102253. }): void;
  102254. private _defaultRenderListPrepared;
  102255. /**
  102256. * Renders all the objects from the render list into the texture.
  102257. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  102258. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  102259. */
  102260. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  102261. private _bestReflectionRenderTargetDimension;
  102262. private _prepareRenderingManager;
  102263. /**
  102264. * @hidden
  102265. * @param faceIndex face index to bind to if this is a cubetexture
  102266. * @param layer defines the index of the texture to bind in the array
  102267. */
  102268. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  102269. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  102270. private renderToTarget;
  102271. /**
  102272. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  102273. * This allowed control for front to back rendering or reversly depending of the special needs.
  102274. *
  102275. * @param renderingGroupId The rendering group id corresponding to its index
  102276. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  102277. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  102278. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  102279. */
  102280. 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;
  102281. /**
  102282. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  102283. *
  102284. * @param renderingGroupId The rendering group id corresponding to its index
  102285. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  102286. */
  102287. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  102288. /**
  102289. * Clones the texture.
  102290. * @returns the cloned texture
  102291. */
  102292. clone(): RenderTargetTexture;
  102293. /**
  102294. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102295. * @returns The JSON representation of the texture
  102296. */
  102297. serialize(): any;
  102298. /**
  102299. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  102300. */
  102301. disposeFramebufferObjects(): void;
  102302. /**
  102303. * Dispose the texture and release its associated resources.
  102304. */
  102305. dispose(): void;
  102306. /** @hidden */
  102307. _rebuild(): void;
  102308. /**
  102309. * Clear the info related to rendering groups preventing retention point in material dispose.
  102310. */
  102311. freeRenderingGroups(): void;
  102312. /**
  102313. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  102314. * @returns the view count
  102315. */
  102316. getViewCount(): number;
  102317. }
  102318. }
  102319. declare module BABYLON {
  102320. /**
  102321. * Class used to manipulate GUIDs
  102322. */
  102323. export class GUID {
  102324. /**
  102325. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  102326. * Be aware Math.random() could cause collisions, but:
  102327. * "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"
  102328. * @returns a pseudo random id
  102329. */
  102330. static RandomId(): string;
  102331. }
  102332. }
  102333. declare module BABYLON {
  102334. /**
  102335. * Options to be used when creating a shadow depth material
  102336. */
  102337. export interface IIOptionShadowDepthMaterial {
  102338. /** Variables in the vertex shader code that need to have their names remapped.
  102339. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  102340. * "var_name" should be either: worldPos or vNormalW
  102341. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  102342. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  102343. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  102344. */
  102345. remappedVariables?: string[];
  102346. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  102347. standalone?: boolean;
  102348. }
  102349. /**
  102350. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  102351. */
  102352. export class ShadowDepthWrapper {
  102353. private _scene;
  102354. private _options?;
  102355. private _baseMaterial;
  102356. private _onEffectCreatedObserver;
  102357. private _subMeshToEffect;
  102358. private _subMeshToDepthEffect;
  102359. private _meshes;
  102360. /** @hidden */
  102361. _matriceNames: any;
  102362. /** Gets the standalone status of the wrapper */
  102363. get standalone(): boolean;
  102364. /** Gets the base material the wrapper is built upon */
  102365. get baseMaterial(): Material;
  102366. /**
  102367. * Instantiate a new shadow depth wrapper.
  102368. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  102369. * generate the shadow depth map. For more information, please refer to the documentation:
  102370. * https://doc.babylonjs.com/babylon101/shadows
  102371. * @param baseMaterial Material to wrap
  102372. * @param scene Define the scene the material belongs to
  102373. * @param options Options used to create the wrapper
  102374. */
  102375. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  102376. /**
  102377. * Gets the effect to use to generate the depth map
  102378. * @param subMesh subMesh to get the effect for
  102379. * @param shadowGenerator shadow generator to get the effect for
  102380. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  102381. */
  102382. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  102383. /**
  102384. * Specifies that the submesh is ready to be used for depth rendering
  102385. * @param subMesh submesh to check
  102386. * @param defines the list of defines to take into account when checking the effect
  102387. * @param shadowGenerator combined with subMesh, it defines the effect to check
  102388. * @param useInstances specifies that instances should be used
  102389. * @returns a boolean indicating that the submesh is ready or not
  102390. */
  102391. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  102392. /**
  102393. * Disposes the resources
  102394. */
  102395. dispose(): void;
  102396. private _makeEffect;
  102397. }
  102398. }
  102399. declare module BABYLON {
  102400. interface ThinEngine {
  102401. /**
  102402. * Unbind a list of render target textures from the webGL context
  102403. * This is used only when drawBuffer extension or webGL2 are active
  102404. * @param textures defines the render target textures to unbind
  102405. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  102406. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  102407. */
  102408. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  102409. /**
  102410. * Create a multi render target texture
  102411. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  102412. * @param size defines the size of the texture
  102413. * @param options defines the creation options
  102414. * @returns the cube texture as an InternalTexture
  102415. */
  102416. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  102417. /**
  102418. * Update the sample count for a given multiple render target texture
  102419. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  102420. * @param textures defines the textures to update
  102421. * @param samples defines the sample count to set
  102422. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  102423. */
  102424. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  102425. /**
  102426. * Select a subsets of attachments to draw to.
  102427. * @param attachments gl attachments
  102428. */
  102429. bindAttachments(attachments: number[]): void;
  102430. }
  102431. }
  102432. declare module BABYLON {
  102433. /**
  102434. * Creation options of the multi render target texture.
  102435. */
  102436. export interface IMultiRenderTargetOptions {
  102437. /**
  102438. * Define if the texture needs to create mip maps after render.
  102439. */
  102440. generateMipMaps?: boolean;
  102441. /**
  102442. * Define the types of all the draw buffers we want to create
  102443. */
  102444. types?: number[];
  102445. /**
  102446. * Define the sampling modes of all the draw buffers we want to create
  102447. */
  102448. samplingModes?: number[];
  102449. /**
  102450. * Define if a depth buffer is required
  102451. */
  102452. generateDepthBuffer?: boolean;
  102453. /**
  102454. * Define if a stencil buffer is required
  102455. */
  102456. generateStencilBuffer?: boolean;
  102457. /**
  102458. * Define if a depth texture is required instead of a depth buffer
  102459. */
  102460. generateDepthTexture?: boolean;
  102461. /**
  102462. * Define the number of desired draw buffers
  102463. */
  102464. textureCount?: number;
  102465. /**
  102466. * Define if aspect ratio should be adapted to the texture or stay the scene one
  102467. */
  102468. doNotChangeAspectRatio?: boolean;
  102469. /**
  102470. * Define the default type of the buffers we are creating
  102471. */
  102472. defaultType?: number;
  102473. }
  102474. /**
  102475. * A multi render target, like a render target provides the ability to render to a texture.
  102476. * Unlike the render target, it can render to several draw buffers in one draw.
  102477. * This is specially interesting in deferred rendering or for any effects requiring more than
  102478. * just one color from a single pass.
  102479. */
  102480. export class MultiRenderTarget extends RenderTargetTexture {
  102481. private _internalTextures;
  102482. private _textures;
  102483. private _multiRenderTargetOptions;
  102484. private _count;
  102485. /**
  102486. * Get if draw buffers are currently supported by the used hardware and browser.
  102487. */
  102488. get isSupported(): boolean;
  102489. /**
  102490. * Get the list of textures generated by the multi render target.
  102491. */
  102492. get textures(): Texture[];
  102493. /**
  102494. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  102495. */
  102496. get count(): number;
  102497. /**
  102498. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  102499. */
  102500. get depthTexture(): Texture;
  102501. /**
  102502. * Set the wrapping mode on U of all the textures we are rendering to.
  102503. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  102504. */
  102505. set wrapU(wrap: number);
  102506. /**
  102507. * Set the wrapping mode on V of all the textures we are rendering to.
  102508. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  102509. */
  102510. set wrapV(wrap: number);
  102511. /**
  102512. * Instantiate a new multi render target texture.
  102513. * A multi render target, like a render target provides the ability to render to a texture.
  102514. * Unlike the render target, it can render to several draw buffers in one draw.
  102515. * This is specially interesting in deferred rendering or for any effects requiring more than
  102516. * just one color from a single pass.
  102517. * @param name Define the name of the texture
  102518. * @param size Define the size of the buffers to render to
  102519. * @param count Define the number of target we are rendering into
  102520. * @param scene Define the scene the texture belongs to
  102521. * @param options Define the options used to create the multi render target
  102522. */
  102523. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  102524. /** @hidden */
  102525. _rebuild(): void;
  102526. private _createInternalTextures;
  102527. private _createTextures;
  102528. /**
  102529. * Define the number of samples used if MSAA is enabled.
  102530. */
  102531. get samples(): number;
  102532. set samples(value: number);
  102533. /**
  102534. * Resize all the textures in the multi render target.
  102535. * Be carrefull as it will recreate all the data in the new texture.
  102536. * @param size Define the new size
  102537. */
  102538. resize(size: any): void;
  102539. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  102540. /**
  102541. * Dispose the render targets and their associated resources
  102542. */
  102543. dispose(): void;
  102544. /**
  102545. * Release all the underlying texture used as draw buffers.
  102546. */
  102547. releaseInternalTextures(): void;
  102548. }
  102549. }
  102550. declare module BABYLON {
  102551. /** @hidden */
  102552. export var imageProcessingPixelShader: {
  102553. name: string;
  102554. shader: string;
  102555. };
  102556. }
  102557. declare module BABYLON {
  102558. /**
  102559. * ImageProcessingPostProcess
  102560. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  102561. */
  102562. export class ImageProcessingPostProcess extends PostProcess {
  102563. /**
  102564. * Default configuration related to image processing available in the PBR Material.
  102565. */
  102566. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102567. /**
  102568. * Gets the image processing configuration used either in this material.
  102569. */
  102570. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102571. /**
  102572. * Sets the Default image processing configuration used either in the this material.
  102573. *
  102574. * If sets to null, the scene one is in use.
  102575. */
  102576. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102577. /**
  102578. * Keep track of the image processing observer to allow dispose and replace.
  102579. */
  102580. private _imageProcessingObserver;
  102581. /**
  102582. * Attaches a new image processing configuration to the PBR Material.
  102583. * @param configuration
  102584. */
  102585. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  102586. /**
  102587. * If the post process is supported.
  102588. */
  102589. get isSupported(): boolean;
  102590. /**
  102591. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  102592. */
  102593. get colorCurves(): Nullable<ColorCurves>;
  102594. /**
  102595. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  102596. */
  102597. set colorCurves(value: Nullable<ColorCurves>);
  102598. /**
  102599. * Gets wether the color curves effect is enabled.
  102600. */
  102601. get colorCurvesEnabled(): boolean;
  102602. /**
  102603. * Sets wether the color curves effect is enabled.
  102604. */
  102605. set colorCurvesEnabled(value: boolean);
  102606. /**
  102607. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  102608. */
  102609. get colorGradingTexture(): Nullable<BaseTexture>;
  102610. /**
  102611. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  102612. */
  102613. set colorGradingTexture(value: Nullable<BaseTexture>);
  102614. /**
  102615. * Gets wether the color grading effect is enabled.
  102616. */
  102617. get colorGradingEnabled(): boolean;
  102618. /**
  102619. * Gets wether the color grading effect is enabled.
  102620. */
  102621. set colorGradingEnabled(value: boolean);
  102622. /**
  102623. * Gets exposure used in the effect.
  102624. */
  102625. get exposure(): number;
  102626. /**
  102627. * Sets exposure used in the effect.
  102628. */
  102629. set exposure(value: number);
  102630. /**
  102631. * Gets wether tonemapping is enabled or not.
  102632. */
  102633. get toneMappingEnabled(): boolean;
  102634. /**
  102635. * Sets wether tonemapping is enabled or not
  102636. */
  102637. set toneMappingEnabled(value: boolean);
  102638. /**
  102639. * Gets the type of tone mapping effect.
  102640. */
  102641. get toneMappingType(): number;
  102642. /**
  102643. * Sets the type of tone mapping effect.
  102644. */
  102645. set toneMappingType(value: number);
  102646. /**
  102647. * Gets contrast used in the effect.
  102648. */
  102649. get contrast(): number;
  102650. /**
  102651. * Sets contrast used in the effect.
  102652. */
  102653. set contrast(value: number);
  102654. /**
  102655. * Gets Vignette stretch size.
  102656. */
  102657. get vignetteStretch(): number;
  102658. /**
  102659. * Sets Vignette stretch size.
  102660. */
  102661. set vignetteStretch(value: number);
  102662. /**
  102663. * Gets Vignette centre X Offset.
  102664. */
  102665. get vignetteCentreX(): number;
  102666. /**
  102667. * Sets Vignette centre X Offset.
  102668. */
  102669. set vignetteCentreX(value: number);
  102670. /**
  102671. * Gets Vignette centre Y Offset.
  102672. */
  102673. get vignetteCentreY(): number;
  102674. /**
  102675. * Sets Vignette centre Y Offset.
  102676. */
  102677. set vignetteCentreY(value: number);
  102678. /**
  102679. * Gets Vignette weight or intensity of the vignette effect.
  102680. */
  102681. get vignetteWeight(): number;
  102682. /**
  102683. * Sets Vignette weight or intensity of the vignette effect.
  102684. */
  102685. set vignetteWeight(value: number);
  102686. /**
  102687. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  102688. * if vignetteEnabled is set to true.
  102689. */
  102690. get vignetteColor(): Color4;
  102691. /**
  102692. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  102693. * if vignetteEnabled is set to true.
  102694. */
  102695. set vignetteColor(value: Color4);
  102696. /**
  102697. * Gets Camera field of view used by the Vignette effect.
  102698. */
  102699. get vignetteCameraFov(): number;
  102700. /**
  102701. * Sets Camera field of view used by the Vignette effect.
  102702. */
  102703. set vignetteCameraFov(value: number);
  102704. /**
  102705. * Gets the vignette blend mode allowing different kind of effect.
  102706. */
  102707. get vignetteBlendMode(): number;
  102708. /**
  102709. * Sets the vignette blend mode allowing different kind of effect.
  102710. */
  102711. set vignetteBlendMode(value: number);
  102712. /**
  102713. * Gets wether the vignette effect is enabled.
  102714. */
  102715. get vignetteEnabled(): boolean;
  102716. /**
  102717. * Sets wether the vignette effect is enabled.
  102718. */
  102719. set vignetteEnabled(value: boolean);
  102720. private _fromLinearSpace;
  102721. /**
  102722. * Gets wether the input of the processing is in Gamma or Linear Space.
  102723. */
  102724. get fromLinearSpace(): boolean;
  102725. /**
  102726. * Sets wether the input of the processing is in Gamma or Linear Space.
  102727. */
  102728. set fromLinearSpace(value: boolean);
  102729. /**
  102730. * Defines cache preventing GC.
  102731. */
  102732. private _defines;
  102733. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  102734. /**
  102735. * "ImageProcessingPostProcess"
  102736. * @returns "ImageProcessingPostProcess"
  102737. */
  102738. getClassName(): string;
  102739. /**
  102740. * @hidden
  102741. */
  102742. _updateParameters(): void;
  102743. dispose(camera?: Camera): void;
  102744. }
  102745. }
  102746. declare module BABYLON {
  102747. /** @hidden */
  102748. export var fibonacci: {
  102749. name: string;
  102750. shader: string;
  102751. };
  102752. }
  102753. declare module BABYLON {
  102754. /** @hidden */
  102755. export var subSurfaceScatteringFunctions: {
  102756. name: string;
  102757. shader: string;
  102758. };
  102759. }
  102760. declare module BABYLON {
  102761. /** @hidden */
  102762. export var diffusionProfile: {
  102763. name: string;
  102764. shader: string;
  102765. };
  102766. }
  102767. declare module BABYLON {
  102768. /** @hidden */
  102769. export var subSurfaceScatteringPixelShader: {
  102770. name: string;
  102771. shader: string;
  102772. };
  102773. }
  102774. declare module BABYLON {
  102775. /**
  102776. * Sub surface scattering post process
  102777. */
  102778. export class SubSurfaceScatteringPostProcess extends PostProcess {
  102779. /** @hidden */
  102780. texelWidth: number;
  102781. /** @hidden */
  102782. texelHeight: number;
  102783. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  102784. }
  102785. }
  102786. declare module BABYLON {
  102787. /**
  102788. * Interface for defining prepass effects in the prepass post-process pipeline
  102789. */
  102790. export interface PrePassEffectConfiguration {
  102791. /**
  102792. * Post process to attach for this effect
  102793. */
  102794. postProcess: PostProcess;
  102795. /**
  102796. * Is the effect enabled
  102797. */
  102798. enabled: boolean;
  102799. /**
  102800. * Disposes the effect configuration
  102801. */
  102802. dispose(): void;
  102803. /**
  102804. * Disposes the effect configuration
  102805. */
  102806. createPostProcess: () => PostProcess;
  102807. }
  102808. }
  102809. declare module BABYLON {
  102810. /**
  102811. * Contains all parameters needed for the prepass to perform
  102812. * screen space subsurface scattering
  102813. */
  102814. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  102815. private _ssDiffusionS;
  102816. private _ssFilterRadii;
  102817. private _ssDiffusionD;
  102818. /**
  102819. * Post process to attach for screen space subsurface scattering
  102820. */
  102821. postProcess: SubSurfaceScatteringPostProcess;
  102822. /**
  102823. * Diffusion profile color for subsurface scattering
  102824. */
  102825. get ssDiffusionS(): number[];
  102826. /**
  102827. * Diffusion profile max color channel value for subsurface scattering
  102828. */
  102829. get ssDiffusionD(): number[];
  102830. /**
  102831. * Diffusion profile filter radius for subsurface scattering
  102832. */
  102833. get ssFilterRadii(): number[];
  102834. /**
  102835. * Is subsurface enabled
  102836. */
  102837. enabled: boolean;
  102838. /**
  102839. * Diffusion profile colors for subsurface scattering
  102840. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  102841. * See ...
  102842. * Note that you can only store up to 5 of them
  102843. */
  102844. ssDiffusionProfileColors: Color3[];
  102845. /**
  102846. * Defines the ratio real world => scene units.
  102847. * Used for subsurface scattering
  102848. */
  102849. metersPerUnit: number;
  102850. private _scene;
  102851. /**
  102852. * Builds a subsurface configuration object
  102853. * @param scene The scene
  102854. */
  102855. constructor(scene: Scene);
  102856. /**
  102857. * Adds a new diffusion profile.
  102858. * Useful for more realistic subsurface scattering on diverse materials.
  102859. * @param color The color of the diffusion profile. Should be the average color of the material.
  102860. * @return The index of the diffusion profile for the material subsurface configuration
  102861. */
  102862. addDiffusionProfile(color: Color3): number;
  102863. /**
  102864. * Creates the sss post process
  102865. * @return The created post process
  102866. */
  102867. createPostProcess(): SubSurfaceScatteringPostProcess;
  102868. /**
  102869. * Deletes all diffusion profiles.
  102870. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  102871. */
  102872. clearAllDiffusionProfiles(): void;
  102873. /**
  102874. * Disposes this object
  102875. */
  102876. dispose(): void;
  102877. /**
  102878. * @hidden
  102879. * https://zero-radiance.github.io/post/sampling-diffusion/
  102880. *
  102881. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  102882. * ------------------------------------------------------------------------------------
  102883. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  102884. * PDF[r, phi, s] = r * R[r, phi, s]
  102885. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  102886. * ------------------------------------------------------------------------------------
  102887. * We importance sample the color channel with the widest scattering distance.
  102888. */
  102889. getDiffusionProfileParameters(color: Color3): number;
  102890. /**
  102891. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  102892. * 'u' is the random number (the value of the CDF): [0, 1).
  102893. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  102894. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  102895. */
  102896. private _sampleBurleyDiffusionProfile;
  102897. }
  102898. }
  102899. declare module BABYLON {
  102900. /**
  102901. * Renders a pre pass of the scene
  102902. * This means every mesh in the scene will be rendered to a render target texture
  102903. * And then this texture will be composited to the rendering canvas with post processes
  102904. * It is necessary for effects like subsurface scattering or deferred shading
  102905. */
  102906. export class PrePassRenderer {
  102907. /** @hidden */
  102908. static _SceneComponentInitialization: (scene: Scene) => void;
  102909. private _scene;
  102910. private _engine;
  102911. private _isDirty;
  102912. /**
  102913. * Number of textures in the multi render target texture where the scene is directly rendered
  102914. */
  102915. readonly mrtCount: number;
  102916. /**
  102917. * The render target where the scene is directly rendered
  102918. */
  102919. prePassRT: MultiRenderTarget;
  102920. private _mrtTypes;
  102921. private _multiRenderAttachments;
  102922. private _defaultAttachments;
  102923. private _clearAttachments;
  102924. private _postProcesses;
  102925. private readonly _clearColor;
  102926. /**
  102927. * Image processing post process for composition
  102928. */
  102929. imageProcessingPostProcess: ImageProcessingPostProcess;
  102930. /**
  102931. * Configuration for sub surface scattering post process
  102932. */
  102933. subSurfaceConfiguration: SubSurfaceConfiguration;
  102934. /**
  102935. * Should materials render their geometry on the MRT
  102936. */
  102937. materialsShouldRenderGeometry: boolean;
  102938. /**
  102939. * Should materials render the irradiance information on the MRT
  102940. */
  102941. materialsShouldRenderIrradiance: boolean;
  102942. private _enabled;
  102943. /**
  102944. * Indicates if the prepass is enabled
  102945. */
  102946. get enabled(): boolean;
  102947. /**
  102948. * How many samples are used for MSAA of the scene render target
  102949. */
  102950. get samples(): number;
  102951. set samples(n: number);
  102952. /**
  102953. * Instanciates a prepass renderer
  102954. * @param scene The scene
  102955. */
  102956. constructor(scene: Scene);
  102957. private _initializeAttachments;
  102958. private _createCompositionEffect;
  102959. /**
  102960. * Indicates if rendering a prepass is supported
  102961. */
  102962. get isSupported(): boolean;
  102963. /**
  102964. * Sets the proper output textures to draw in the engine.
  102965. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  102966. */
  102967. bindAttachmentsForEffect(effect: Effect): void;
  102968. /**
  102969. * @hidden
  102970. */
  102971. _beforeCameraDraw(): void;
  102972. /**
  102973. * @hidden
  102974. */
  102975. _afterCameraDraw(): void;
  102976. private _checkRTSize;
  102977. private _bindFrameBuffer;
  102978. /**
  102979. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  102980. */
  102981. clear(): void;
  102982. private _setState;
  102983. private _enable;
  102984. private _disable;
  102985. private _resetPostProcessChain;
  102986. private _bindPostProcessChain;
  102987. /**
  102988. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  102989. */
  102990. markAsDirty(): void;
  102991. private _update;
  102992. /**
  102993. * Disposes the prepass renderer.
  102994. */
  102995. dispose(): void;
  102996. }
  102997. }
  102998. declare module BABYLON {
  102999. /**
  103000. * Options for compiling materials.
  103001. */
  103002. export interface IMaterialCompilationOptions {
  103003. /**
  103004. * Defines whether clip planes are enabled.
  103005. */
  103006. clipPlane: boolean;
  103007. /**
  103008. * Defines whether instances are enabled.
  103009. */
  103010. useInstances: boolean;
  103011. }
  103012. /**
  103013. * Options passed when calling customShaderNameResolve
  103014. */
  103015. export interface ICustomShaderNameResolveOptions {
  103016. /**
  103017. * 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
  103018. */
  103019. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  103020. }
  103021. /**
  103022. * Base class for the main features of a material in Babylon.js
  103023. */
  103024. export class Material implements IAnimatable {
  103025. /**
  103026. * Returns the triangle fill mode
  103027. */
  103028. static readonly TriangleFillMode: number;
  103029. /**
  103030. * Returns the wireframe mode
  103031. */
  103032. static readonly WireFrameFillMode: number;
  103033. /**
  103034. * Returns the point fill mode
  103035. */
  103036. static readonly PointFillMode: number;
  103037. /**
  103038. * Returns the point list draw mode
  103039. */
  103040. static readonly PointListDrawMode: number;
  103041. /**
  103042. * Returns the line list draw mode
  103043. */
  103044. static readonly LineListDrawMode: number;
  103045. /**
  103046. * Returns the line loop draw mode
  103047. */
  103048. static readonly LineLoopDrawMode: number;
  103049. /**
  103050. * Returns the line strip draw mode
  103051. */
  103052. static readonly LineStripDrawMode: number;
  103053. /**
  103054. * Returns the triangle strip draw mode
  103055. */
  103056. static readonly TriangleStripDrawMode: number;
  103057. /**
  103058. * Returns the triangle fan draw mode
  103059. */
  103060. static readonly TriangleFanDrawMode: number;
  103061. /**
  103062. * Stores the clock-wise side orientation
  103063. */
  103064. static readonly ClockWiseSideOrientation: number;
  103065. /**
  103066. * Stores the counter clock-wise side orientation
  103067. */
  103068. static readonly CounterClockWiseSideOrientation: number;
  103069. /**
  103070. * The dirty texture flag value
  103071. */
  103072. static readonly TextureDirtyFlag: number;
  103073. /**
  103074. * The dirty light flag value
  103075. */
  103076. static readonly LightDirtyFlag: number;
  103077. /**
  103078. * The dirty fresnel flag value
  103079. */
  103080. static readonly FresnelDirtyFlag: number;
  103081. /**
  103082. * The dirty attribute flag value
  103083. */
  103084. static readonly AttributesDirtyFlag: number;
  103085. /**
  103086. * The dirty misc flag value
  103087. */
  103088. static readonly MiscDirtyFlag: number;
  103089. /**
  103090. * The all dirty flag value
  103091. */
  103092. static readonly AllDirtyFlag: number;
  103093. /**
  103094. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  103095. */
  103096. static readonly MATERIAL_OPAQUE: number;
  103097. /**
  103098. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  103099. */
  103100. static readonly MATERIAL_ALPHATEST: number;
  103101. /**
  103102. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103103. */
  103104. static readonly MATERIAL_ALPHABLEND: number;
  103105. /**
  103106. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103107. * They are also discarded below the alpha cutoff threshold to improve performances.
  103108. */
  103109. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  103110. /**
  103111. * The Whiteout method is used to blend normals.
  103112. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  103113. */
  103114. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  103115. /**
  103116. * The Reoriented Normal Mapping method is used to blend normals.
  103117. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  103118. */
  103119. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  103120. /**
  103121. * Custom callback helping to override the default shader used in the material.
  103122. */
  103123. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  103124. /**
  103125. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  103126. */
  103127. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  103128. /**
  103129. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  103130. * This means that the material can keep using a previous shader while a new one is being compiled.
  103131. * This is mostly used when shader parallel compilation is supported (true by default)
  103132. */
  103133. allowShaderHotSwapping: boolean;
  103134. /**
  103135. * The ID of the material
  103136. */
  103137. id: string;
  103138. /**
  103139. * Gets or sets the unique id of the material
  103140. */
  103141. uniqueId: number;
  103142. /**
  103143. * The name of the material
  103144. */
  103145. name: string;
  103146. /**
  103147. * Gets or sets user defined metadata
  103148. */
  103149. metadata: any;
  103150. /**
  103151. * For internal use only. Please do not use.
  103152. */
  103153. reservedDataStore: any;
  103154. /**
  103155. * Specifies if the ready state should be checked on each call
  103156. */
  103157. checkReadyOnEveryCall: boolean;
  103158. /**
  103159. * Specifies if the ready state should be checked once
  103160. */
  103161. checkReadyOnlyOnce: boolean;
  103162. /**
  103163. * The state of the material
  103164. */
  103165. state: string;
  103166. /**
  103167. * If the material can be rendered to several textures with MRT extension
  103168. */
  103169. get canRenderToMRT(): boolean;
  103170. /**
  103171. * The alpha value of the material
  103172. */
  103173. protected _alpha: number;
  103174. /**
  103175. * List of inspectable custom properties (used by the Inspector)
  103176. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103177. */
  103178. inspectableCustomProperties: IInspectable[];
  103179. /**
  103180. * Sets the alpha value of the material
  103181. */
  103182. set alpha(value: number);
  103183. /**
  103184. * Gets the alpha value of the material
  103185. */
  103186. get alpha(): number;
  103187. /**
  103188. * Specifies if back face culling is enabled
  103189. */
  103190. protected _backFaceCulling: boolean;
  103191. /**
  103192. * Sets the back-face culling state
  103193. */
  103194. set backFaceCulling(value: boolean);
  103195. /**
  103196. * Gets the back-face culling state
  103197. */
  103198. get backFaceCulling(): boolean;
  103199. /**
  103200. * Stores the value for side orientation
  103201. */
  103202. sideOrientation: number;
  103203. /**
  103204. * Callback triggered when the material is compiled
  103205. */
  103206. onCompiled: Nullable<(effect: Effect) => void>;
  103207. /**
  103208. * Callback triggered when an error occurs
  103209. */
  103210. onError: Nullable<(effect: Effect, errors: string) => void>;
  103211. /**
  103212. * Callback triggered to get the render target textures
  103213. */
  103214. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  103215. /**
  103216. * Gets a boolean indicating that current material needs to register RTT
  103217. */
  103218. get hasRenderTargetTextures(): boolean;
  103219. /**
  103220. * Specifies if the material should be serialized
  103221. */
  103222. doNotSerialize: boolean;
  103223. /**
  103224. * @hidden
  103225. */
  103226. _storeEffectOnSubMeshes: boolean;
  103227. /**
  103228. * Stores the animations for the material
  103229. */
  103230. animations: Nullable<Array<Animation>>;
  103231. /**
  103232. * An event triggered when the material is disposed
  103233. */
  103234. onDisposeObservable: Observable<Material>;
  103235. /**
  103236. * An observer which watches for dispose events
  103237. */
  103238. private _onDisposeObserver;
  103239. private _onUnBindObservable;
  103240. /**
  103241. * Called during a dispose event
  103242. */
  103243. set onDispose(callback: () => void);
  103244. private _onBindObservable;
  103245. /**
  103246. * An event triggered when the material is bound
  103247. */
  103248. get onBindObservable(): Observable<AbstractMesh>;
  103249. /**
  103250. * An observer which watches for bind events
  103251. */
  103252. private _onBindObserver;
  103253. /**
  103254. * Called during a bind event
  103255. */
  103256. set onBind(callback: (Mesh: AbstractMesh) => void);
  103257. /**
  103258. * An event triggered when the material is unbound
  103259. */
  103260. get onUnBindObservable(): Observable<Material>;
  103261. protected _onEffectCreatedObservable: Nullable<Observable<{
  103262. effect: Effect;
  103263. subMesh: Nullable<SubMesh>;
  103264. }>>;
  103265. /**
  103266. * An event triggered when the effect is (re)created
  103267. */
  103268. get onEffectCreatedObservable(): Observable<{
  103269. effect: Effect;
  103270. subMesh: Nullable<SubMesh>;
  103271. }>;
  103272. /**
  103273. * Stores the value of the alpha mode
  103274. */
  103275. private _alphaMode;
  103276. /**
  103277. * Sets the value of the alpha mode.
  103278. *
  103279. * | Value | Type | Description |
  103280. * | --- | --- | --- |
  103281. * | 0 | ALPHA_DISABLE | |
  103282. * | 1 | ALPHA_ADD | |
  103283. * | 2 | ALPHA_COMBINE | |
  103284. * | 3 | ALPHA_SUBTRACT | |
  103285. * | 4 | ALPHA_MULTIPLY | |
  103286. * | 5 | ALPHA_MAXIMIZED | |
  103287. * | 6 | ALPHA_ONEONE | |
  103288. * | 7 | ALPHA_PREMULTIPLIED | |
  103289. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  103290. * | 9 | ALPHA_INTERPOLATE | |
  103291. * | 10 | ALPHA_SCREENMODE | |
  103292. *
  103293. */
  103294. set alphaMode(value: number);
  103295. /**
  103296. * Gets the value of the alpha mode
  103297. */
  103298. get alphaMode(): number;
  103299. /**
  103300. * Stores the state of the need depth pre-pass value
  103301. */
  103302. private _needDepthPrePass;
  103303. /**
  103304. * Sets the need depth pre-pass value
  103305. */
  103306. set needDepthPrePass(value: boolean);
  103307. /**
  103308. * Gets the depth pre-pass value
  103309. */
  103310. get needDepthPrePass(): boolean;
  103311. /**
  103312. * Specifies if depth writing should be disabled
  103313. */
  103314. disableDepthWrite: boolean;
  103315. /**
  103316. * Specifies if color writing should be disabled
  103317. */
  103318. disableColorWrite: boolean;
  103319. /**
  103320. * Specifies if depth writing should be forced
  103321. */
  103322. forceDepthWrite: boolean;
  103323. /**
  103324. * Specifies the depth function that should be used. 0 means the default engine function
  103325. */
  103326. depthFunction: number;
  103327. /**
  103328. * Specifies if there should be a separate pass for culling
  103329. */
  103330. separateCullingPass: boolean;
  103331. /**
  103332. * Stores the state specifing if fog should be enabled
  103333. */
  103334. private _fogEnabled;
  103335. /**
  103336. * Sets the state for enabling fog
  103337. */
  103338. set fogEnabled(value: boolean);
  103339. /**
  103340. * Gets the value of the fog enabled state
  103341. */
  103342. get fogEnabled(): boolean;
  103343. /**
  103344. * Stores the size of points
  103345. */
  103346. pointSize: number;
  103347. /**
  103348. * Stores the z offset value
  103349. */
  103350. zOffset: number;
  103351. get wireframe(): boolean;
  103352. /**
  103353. * Sets the state of wireframe mode
  103354. */
  103355. set wireframe(value: boolean);
  103356. /**
  103357. * Gets the value specifying if point clouds are enabled
  103358. */
  103359. get pointsCloud(): boolean;
  103360. /**
  103361. * Sets the state of point cloud mode
  103362. */
  103363. set pointsCloud(value: boolean);
  103364. /**
  103365. * Gets the material fill mode
  103366. */
  103367. get fillMode(): number;
  103368. /**
  103369. * Sets the material fill mode
  103370. */
  103371. set fillMode(value: number);
  103372. /**
  103373. * @hidden
  103374. * Stores the effects for the material
  103375. */
  103376. _effect: Nullable<Effect>;
  103377. /**
  103378. * Specifies if uniform buffers should be used
  103379. */
  103380. private _useUBO;
  103381. /**
  103382. * Stores a reference to the scene
  103383. */
  103384. private _scene;
  103385. /**
  103386. * Stores the fill mode state
  103387. */
  103388. private _fillMode;
  103389. /**
  103390. * Specifies if the depth write state should be cached
  103391. */
  103392. private _cachedDepthWriteState;
  103393. /**
  103394. * Specifies if the color write state should be cached
  103395. */
  103396. private _cachedColorWriteState;
  103397. /**
  103398. * Specifies if the depth function state should be cached
  103399. */
  103400. private _cachedDepthFunctionState;
  103401. /**
  103402. * Stores the uniform buffer
  103403. */
  103404. protected _uniformBuffer: UniformBuffer;
  103405. /** @hidden */
  103406. _indexInSceneMaterialArray: number;
  103407. /** @hidden */
  103408. meshMap: Nullable<{
  103409. [id: string]: AbstractMesh | undefined;
  103410. }>;
  103411. /**
  103412. * Creates a material instance
  103413. * @param name defines the name of the material
  103414. * @param scene defines the scene to reference
  103415. * @param doNotAdd specifies if the material should be added to the scene
  103416. */
  103417. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  103418. /**
  103419. * Returns a string representation of the current material
  103420. * @param fullDetails defines a boolean indicating which levels of logging is desired
  103421. * @returns a string with material information
  103422. */
  103423. toString(fullDetails?: boolean): string;
  103424. /**
  103425. * Gets the class name of the material
  103426. * @returns a string with the class name of the material
  103427. */
  103428. getClassName(): string;
  103429. /**
  103430. * Specifies if updates for the material been locked
  103431. */
  103432. get isFrozen(): boolean;
  103433. /**
  103434. * Locks updates for the material
  103435. */
  103436. freeze(): void;
  103437. /**
  103438. * Unlocks updates for the material
  103439. */
  103440. unfreeze(): void;
  103441. /**
  103442. * Specifies if the material is ready to be used
  103443. * @param mesh defines the mesh to check
  103444. * @param useInstances specifies if instances should be used
  103445. * @returns a boolean indicating if the material is ready to be used
  103446. */
  103447. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  103448. /**
  103449. * Specifies that the submesh is ready to be used
  103450. * @param mesh defines the mesh to check
  103451. * @param subMesh defines which submesh to check
  103452. * @param useInstances specifies that instances should be used
  103453. * @returns a boolean indicating that the submesh is ready or not
  103454. */
  103455. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  103456. /**
  103457. * Returns the material effect
  103458. * @returns the effect associated with the material
  103459. */
  103460. getEffect(): Nullable<Effect>;
  103461. /**
  103462. * Returns the current scene
  103463. * @returns a Scene
  103464. */
  103465. getScene(): Scene;
  103466. /**
  103467. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  103468. */
  103469. protected _forceAlphaTest: boolean;
  103470. /**
  103471. * The transparency mode of the material.
  103472. */
  103473. protected _transparencyMode: Nullable<number>;
  103474. /**
  103475. * Gets the current transparency mode.
  103476. */
  103477. get transparencyMode(): Nullable<number>;
  103478. /**
  103479. * Sets the transparency mode of the material.
  103480. *
  103481. * | Value | Type | Description |
  103482. * | ----- | ----------------------------------- | ----------- |
  103483. * | 0 | OPAQUE | |
  103484. * | 1 | ALPHATEST | |
  103485. * | 2 | ALPHABLEND | |
  103486. * | 3 | ALPHATESTANDBLEND | |
  103487. *
  103488. */
  103489. set transparencyMode(value: Nullable<number>);
  103490. /**
  103491. * Returns true if alpha blending should be disabled.
  103492. */
  103493. protected get _disableAlphaBlending(): boolean;
  103494. /**
  103495. * Specifies whether or not this material should be rendered in alpha blend mode.
  103496. * @returns a boolean specifying if alpha blending is needed
  103497. */
  103498. needAlphaBlending(): boolean;
  103499. /**
  103500. * Specifies if the mesh will require alpha blending
  103501. * @param mesh defines the mesh to check
  103502. * @returns a boolean specifying if alpha blending is needed for the mesh
  103503. */
  103504. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  103505. /**
  103506. * Specifies whether or not this material should be rendered in alpha test mode.
  103507. * @returns a boolean specifying if an alpha test is needed.
  103508. */
  103509. needAlphaTesting(): boolean;
  103510. /**
  103511. * Specifies if material alpha testing should be turned on for the mesh
  103512. * @param mesh defines the mesh to check
  103513. */
  103514. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  103515. /**
  103516. * Gets the texture used for the alpha test
  103517. * @returns the texture to use for alpha testing
  103518. */
  103519. getAlphaTestTexture(): Nullable<BaseTexture>;
  103520. /**
  103521. * Marks the material to indicate that it needs to be re-calculated
  103522. */
  103523. markDirty(): void;
  103524. /** @hidden */
  103525. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  103526. /**
  103527. * Binds the material to the mesh
  103528. * @param world defines the world transformation matrix
  103529. * @param mesh defines the mesh to bind the material to
  103530. */
  103531. bind(world: Matrix, mesh?: Mesh): void;
  103532. /**
  103533. * Binds the submesh to the material
  103534. * @param world defines the world transformation matrix
  103535. * @param mesh defines the mesh containing the submesh
  103536. * @param subMesh defines the submesh to bind the material to
  103537. */
  103538. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  103539. /**
  103540. * Binds the world matrix to the material
  103541. * @param world defines the world transformation matrix
  103542. */
  103543. bindOnlyWorldMatrix(world: Matrix): void;
  103544. /**
  103545. * Binds the scene's uniform buffer to the effect.
  103546. * @param effect defines the effect to bind to the scene uniform buffer
  103547. * @param sceneUbo defines the uniform buffer storing scene data
  103548. */
  103549. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  103550. /**
  103551. * Binds the view matrix to the effect
  103552. * @param effect defines the effect to bind the view matrix to
  103553. */
  103554. bindView(effect: Effect): void;
  103555. /**
  103556. * Binds the view projection matrix to the effect
  103557. * @param effect defines the effect to bind the view projection matrix to
  103558. */
  103559. bindViewProjection(effect: Effect): void;
  103560. /**
  103561. * Processes to execute after binding the material to a mesh
  103562. * @param mesh defines the rendered mesh
  103563. */
  103564. protected _afterBind(mesh?: Mesh): void;
  103565. /**
  103566. * Unbinds the material from the mesh
  103567. */
  103568. unbind(): void;
  103569. /**
  103570. * Gets the active textures from the material
  103571. * @returns an array of textures
  103572. */
  103573. getActiveTextures(): BaseTexture[];
  103574. /**
  103575. * Specifies if the material uses a texture
  103576. * @param texture defines the texture to check against the material
  103577. * @returns a boolean specifying if the material uses the texture
  103578. */
  103579. hasTexture(texture: BaseTexture): boolean;
  103580. /**
  103581. * Makes a duplicate of the material, and gives it a new name
  103582. * @param name defines the new name for the duplicated material
  103583. * @returns the cloned material
  103584. */
  103585. clone(name: string): Nullable<Material>;
  103586. /**
  103587. * Gets the meshes bound to the material
  103588. * @returns an array of meshes bound to the material
  103589. */
  103590. getBindedMeshes(): AbstractMesh[];
  103591. /**
  103592. * Force shader compilation
  103593. * @param mesh defines the mesh associated with this material
  103594. * @param onCompiled defines a function to execute once the material is compiled
  103595. * @param options defines the options to configure the compilation
  103596. * @param onError defines a function to execute if the material fails compiling
  103597. */
  103598. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  103599. /**
  103600. * Force shader compilation
  103601. * @param mesh defines the mesh that will use this material
  103602. * @param options defines additional options for compiling the shaders
  103603. * @returns a promise that resolves when the compilation completes
  103604. */
  103605. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  103606. private static readonly _AllDirtyCallBack;
  103607. private static readonly _ImageProcessingDirtyCallBack;
  103608. private static readonly _TextureDirtyCallBack;
  103609. private static readonly _FresnelDirtyCallBack;
  103610. private static readonly _MiscDirtyCallBack;
  103611. private static readonly _LightsDirtyCallBack;
  103612. private static readonly _AttributeDirtyCallBack;
  103613. private static _FresnelAndMiscDirtyCallBack;
  103614. private static _TextureAndMiscDirtyCallBack;
  103615. private static readonly _DirtyCallbackArray;
  103616. private static readonly _RunDirtyCallBacks;
  103617. /**
  103618. * Marks a define in the material to indicate that it needs to be re-computed
  103619. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  103620. */
  103621. markAsDirty(flag: number): void;
  103622. /**
  103623. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  103624. * @param func defines a function which checks material defines against the submeshes
  103625. */
  103626. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  103627. /**
  103628. * Indicates that the scene should check if the rendering now needs a prepass
  103629. */
  103630. protected _markScenePrePassDirty(): void;
  103631. /**
  103632. * Indicates that we need to re-calculated for all submeshes
  103633. */
  103634. protected _markAllSubMeshesAsAllDirty(): void;
  103635. /**
  103636. * Indicates that image processing needs to be re-calculated for all submeshes
  103637. */
  103638. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  103639. /**
  103640. * Indicates that textures need to be re-calculated for all submeshes
  103641. */
  103642. protected _markAllSubMeshesAsTexturesDirty(): void;
  103643. /**
  103644. * Indicates that fresnel needs to be re-calculated for all submeshes
  103645. */
  103646. protected _markAllSubMeshesAsFresnelDirty(): void;
  103647. /**
  103648. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  103649. */
  103650. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  103651. /**
  103652. * Indicates that lights need to be re-calculated for all submeshes
  103653. */
  103654. protected _markAllSubMeshesAsLightsDirty(): void;
  103655. /**
  103656. * Indicates that attributes need to be re-calculated for all submeshes
  103657. */
  103658. protected _markAllSubMeshesAsAttributesDirty(): void;
  103659. /**
  103660. * Indicates that misc needs to be re-calculated for all submeshes
  103661. */
  103662. protected _markAllSubMeshesAsMiscDirty(): void;
  103663. /**
  103664. * Indicates that textures and misc need to be re-calculated for all submeshes
  103665. */
  103666. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  103667. /**
  103668. * Sets the required values to the prepass renderer.
  103669. * @param prePassRenderer defines the prepass renderer to setup.
  103670. * @returns true if the pre pass is needed.
  103671. */
  103672. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  103673. /**
  103674. * Disposes the material
  103675. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  103676. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  103677. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  103678. */
  103679. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  103680. /** @hidden */
  103681. private releaseVertexArrayObject;
  103682. /**
  103683. * Serializes this material
  103684. * @returns the serialized material object
  103685. */
  103686. serialize(): any;
  103687. /**
  103688. * Creates a material from parsed material data
  103689. * @param parsedMaterial defines parsed material data
  103690. * @param scene defines the hosting scene
  103691. * @param rootUrl defines the root URL to use to load textures
  103692. * @returns a new material
  103693. */
  103694. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  103695. }
  103696. }
  103697. declare module BABYLON {
  103698. /**
  103699. * A multi-material is used to apply different materials to different parts of the same object without the need of
  103700. * separate meshes. This can be use to improve performances.
  103701. * @see https://doc.babylonjs.com/how_to/multi_materials
  103702. */
  103703. export class MultiMaterial extends Material {
  103704. private _subMaterials;
  103705. /**
  103706. * Gets or Sets the list of Materials used within the multi material.
  103707. * They need to be ordered according to the submeshes order in the associated mesh
  103708. */
  103709. get subMaterials(): Nullable<Material>[];
  103710. set subMaterials(value: Nullable<Material>[]);
  103711. /**
  103712. * Function used to align with Node.getChildren()
  103713. * @returns the list of Materials used within the multi material
  103714. */
  103715. getChildren(): Nullable<Material>[];
  103716. /**
  103717. * Instantiates a new Multi Material
  103718. * A multi-material is used to apply different materials to different parts of the same object without the need of
  103719. * separate meshes. This can be use to improve performances.
  103720. * @see https://doc.babylonjs.com/how_to/multi_materials
  103721. * @param name Define the name in the scene
  103722. * @param scene Define the scene the material belongs to
  103723. */
  103724. constructor(name: string, scene: Scene);
  103725. private _hookArray;
  103726. /**
  103727. * Get one of the submaterial by its index in the submaterials array
  103728. * @param index The index to look the sub material at
  103729. * @returns The Material if the index has been defined
  103730. */
  103731. getSubMaterial(index: number): Nullable<Material>;
  103732. /**
  103733. * Get the list of active textures for the whole sub materials list.
  103734. * @returns All the textures that will be used during the rendering
  103735. */
  103736. getActiveTextures(): BaseTexture[];
  103737. /**
  103738. * Gets the current class name of the material e.g. "MultiMaterial"
  103739. * Mainly use in serialization.
  103740. * @returns the class name
  103741. */
  103742. getClassName(): string;
  103743. /**
  103744. * Checks if the material is ready to render the requested sub mesh
  103745. * @param mesh Define the mesh the submesh belongs to
  103746. * @param subMesh Define the sub mesh to look readyness for
  103747. * @param useInstances Define whether or not the material is used with instances
  103748. * @returns true if ready, otherwise false
  103749. */
  103750. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  103751. /**
  103752. * Clones the current material and its related sub materials
  103753. * @param name Define the name of the newly cloned material
  103754. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  103755. * @returns the cloned material
  103756. */
  103757. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  103758. /**
  103759. * Serializes the materials into a JSON representation.
  103760. * @returns the JSON representation
  103761. */
  103762. serialize(): any;
  103763. /**
  103764. * Dispose the material and release its associated resources
  103765. * @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)
  103766. * @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)
  103767. * @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)
  103768. */
  103769. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  103770. /**
  103771. * Creates a MultiMaterial from parsed MultiMaterial data.
  103772. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  103773. * @param scene defines the hosting scene
  103774. * @returns a new MultiMaterial
  103775. */
  103776. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  103777. }
  103778. }
  103779. declare module BABYLON {
  103780. /**
  103781. * Defines a subdivision inside a mesh
  103782. */
  103783. export class SubMesh implements ICullable {
  103784. /** the material index to use */
  103785. materialIndex: number;
  103786. /** vertex index start */
  103787. verticesStart: number;
  103788. /** vertices count */
  103789. verticesCount: number;
  103790. /** index start */
  103791. indexStart: number;
  103792. /** indices count */
  103793. indexCount: number;
  103794. /** @hidden */
  103795. _materialDefines: Nullable<MaterialDefines>;
  103796. /** @hidden */
  103797. _materialEffect: Nullable<Effect>;
  103798. /** @hidden */
  103799. _effectOverride: Nullable<Effect>;
  103800. /**
  103801. * Gets material defines used by the effect associated to the sub mesh
  103802. */
  103803. get materialDefines(): Nullable<MaterialDefines>;
  103804. /**
  103805. * Sets material defines used by the effect associated to the sub mesh
  103806. */
  103807. set materialDefines(defines: Nullable<MaterialDefines>);
  103808. /**
  103809. * Gets associated effect
  103810. */
  103811. get effect(): Nullable<Effect>;
  103812. /**
  103813. * Sets associated effect (effect used to render this submesh)
  103814. * @param effect defines the effect to associate with
  103815. * @param defines defines the set of defines used to compile this effect
  103816. */
  103817. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  103818. /** @hidden */
  103819. _linesIndexCount: number;
  103820. private _mesh;
  103821. private _renderingMesh;
  103822. private _boundingInfo;
  103823. private _linesIndexBuffer;
  103824. /** @hidden */
  103825. _lastColliderWorldVertices: Nullable<Vector3[]>;
  103826. /** @hidden */
  103827. _trianglePlanes: Plane[];
  103828. /** @hidden */
  103829. _lastColliderTransformMatrix: Nullable<Matrix>;
  103830. /** @hidden */
  103831. _renderId: number;
  103832. /** @hidden */
  103833. _alphaIndex: number;
  103834. /** @hidden */
  103835. _distanceToCamera: number;
  103836. /** @hidden */
  103837. _id: number;
  103838. private _currentMaterial;
  103839. /**
  103840. * Add a new submesh to a mesh
  103841. * @param materialIndex defines the material index to use
  103842. * @param verticesStart defines vertex index start
  103843. * @param verticesCount defines vertices count
  103844. * @param indexStart defines index start
  103845. * @param indexCount defines indices count
  103846. * @param mesh defines the parent mesh
  103847. * @param renderingMesh defines an optional rendering mesh
  103848. * @param createBoundingBox defines if bounding box should be created for this submesh
  103849. * @returns the new submesh
  103850. */
  103851. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  103852. /**
  103853. * Creates a new submesh
  103854. * @param materialIndex defines the material index to use
  103855. * @param verticesStart defines vertex index start
  103856. * @param verticesCount defines vertices count
  103857. * @param indexStart defines index start
  103858. * @param indexCount defines indices count
  103859. * @param mesh defines the parent mesh
  103860. * @param renderingMesh defines an optional rendering mesh
  103861. * @param createBoundingBox defines if bounding box should be created for this submesh
  103862. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  103863. */
  103864. constructor(
  103865. /** the material index to use */
  103866. materialIndex: number,
  103867. /** vertex index start */
  103868. verticesStart: number,
  103869. /** vertices count */
  103870. verticesCount: number,
  103871. /** index start */
  103872. indexStart: number,
  103873. /** indices count */
  103874. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  103875. /**
  103876. * Returns true if this submesh covers the entire parent mesh
  103877. * @ignorenaming
  103878. */
  103879. get IsGlobal(): boolean;
  103880. /**
  103881. * Returns the submesh BoudingInfo object
  103882. * @returns current bounding info (or mesh's one if the submesh is global)
  103883. */
  103884. getBoundingInfo(): BoundingInfo;
  103885. /**
  103886. * Sets the submesh BoundingInfo
  103887. * @param boundingInfo defines the new bounding info to use
  103888. * @returns the SubMesh
  103889. */
  103890. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  103891. /**
  103892. * Returns the mesh of the current submesh
  103893. * @return the parent mesh
  103894. */
  103895. getMesh(): AbstractMesh;
  103896. /**
  103897. * Returns the rendering mesh of the submesh
  103898. * @returns the rendering mesh (could be different from parent mesh)
  103899. */
  103900. getRenderingMesh(): Mesh;
  103901. /**
  103902. * Returns the replacement mesh of the submesh
  103903. * @returns the replacement mesh (could be different from parent mesh)
  103904. */
  103905. getReplacementMesh(): Nullable<AbstractMesh>;
  103906. /**
  103907. * Returns the effective mesh of the submesh
  103908. * @returns the effective mesh (could be different from parent mesh)
  103909. */
  103910. getEffectiveMesh(): AbstractMesh;
  103911. /**
  103912. * Returns the submesh material
  103913. * @returns null or the current material
  103914. */
  103915. getMaterial(): Nullable<Material>;
  103916. private _IsMultiMaterial;
  103917. /**
  103918. * Sets a new updated BoundingInfo object to the submesh
  103919. * @param data defines an optional position array to use to determine the bounding info
  103920. * @returns the SubMesh
  103921. */
  103922. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  103923. /** @hidden */
  103924. _checkCollision(collider: Collider): boolean;
  103925. /**
  103926. * Updates the submesh BoundingInfo
  103927. * @param world defines the world matrix to use to update the bounding info
  103928. * @returns the submesh
  103929. */
  103930. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  103931. /**
  103932. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  103933. * @param frustumPlanes defines the frustum planes
  103934. * @returns true if the submesh is intersecting with the frustum
  103935. */
  103936. isInFrustum(frustumPlanes: Plane[]): boolean;
  103937. /**
  103938. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  103939. * @param frustumPlanes defines the frustum planes
  103940. * @returns true if the submesh is inside the frustum
  103941. */
  103942. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  103943. /**
  103944. * Renders the submesh
  103945. * @param enableAlphaMode defines if alpha needs to be used
  103946. * @returns the submesh
  103947. */
  103948. render(enableAlphaMode: boolean): SubMesh;
  103949. /**
  103950. * @hidden
  103951. */
  103952. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  103953. /**
  103954. * Checks if the submesh intersects with a ray
  103955. * @param ray defines the ray to test
  103956. * @returns true is the passed ray intersects the submesh bounding box
  103957. */
  103958. canIntersects(ray: Ray): boolean;
  103959. /**
  103960. * Intersects current submesh with a ray
  103961. * @param ray defines the ray to test
  103962. * @param positions defines mesh's positions array
  103963. * @param indices defines mesh's indices array
  103964. * @param fastCheck defines if the first intersection will be used (and not the closest)
  103965. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103966. * @returns intersection info or null if no intersection
  103967. */
  103968. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  103969. /** @hidden */
  103970. private _intersectLines;
  103971. /** @hidden */
  103972. private _intersectUnIndexedLines;
  103973. /** @hidden */
  103974. private _intersectTriangles;
  103975. /** @hidden */
  103976. private _intersectUnIndexedTriangles;
  103977. /** @hidden */
  103978. _rebuild(): void;
  103979. /**
  103980. * Creates a new submesh from the passed mesh
  103981. * @param newMesh defines the new hosting mesh
  103982. * @param newRenderingMesh defines an optional rendering mesh
  103983. * @returns the new submesh
  103984. */
  103985. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  103986. /**
  103987. * Release associated resources
  103988. */
  103989. dispose(): void;
  103990. /**
  103991. * Gets the class name
  103992. * @returns the string "SubMesh".
  103993. */
  103994. getClassName(): string;
  103995. /**
  103996. * Creates a new submesh from indices data
  103997. * @param materialIndex the index of the main mesh material
  103998. * @param startIndex the index where to start the copy in the mesh indices array
  103999. * @param indexCount the number of indices to copy then from the startIndex
  104000. * @param mesh the main mesh to create the submesh from
  104001. * @param renderingMesh the optional rendering mesh
  104002. * @returns a new submesh
  104003. */
  104004. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  104005. }
  104006. }
  104007. declare module BABYLON {
  104008. /**
  104009. * Class used to represent data loading progression
  104010. */
  104011. export class SceneLoaderFlags {
  104012. private static _ForceFullSceneLoadingForIncremental;
  104013. private static _ShowLoadingScreen;
  104014. private static _CleanBoneMatrixWeights;
  104015. private static _loggingLevel;
  104016. /**
  104017. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  104018. */
  104019. static get ForceFullSceneLoadingForIncremental(): boolean;
  104020. static set ForceFullSceneLoadingForIncremental(value: boolean);
  104021. /**
  104022. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  104023. */
  104024. static get ShowLoadingScreen(): boolean;
  104025. static set ShowLoadingScreen(value: boolean);
  104026. /**
  104027. * Defines the current logging level (while loading the scene)
  104028. * @ignorenaming
  104029. */
  104030. static get loggingLevel(): number;
  104031. static set loggingLevel(value: number);
  104032. /**
  104033. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  104034. */
  104035. static get CleanBoneMatrixWeights(): boolean;
  104036. static set CleanBoneMatrixWeights(value: boolean);
  104037. }
  104038. }
  104039. declare module BABYLON {
  104040. /**
  104041. * Class used to store geometry data (vertex buffers + index buffer)
  104042. */
  104043. export class Geometry implements IGetSetVerticesData {
  104044. /**
  104045. * Gets or sets the ID of the geometry
  104046. */
  104047. id: string;
  104048. /**
  104049. * Gets or sets the unique ID of the geometry
  104050. */
  104051. uniqueId: number;
  104052. /**
  104053. * Gets the delay loading state of the geometry (none by default which means not delayed)
  104054. */
  104055. delayLoadState: number;
  104056. /**
  104057. * Gets the file containing the data to load when running in delay load state
  104058. */
  104059. delayLoadingFile: Nullable<string>;
  104060. /**
  104061. * Callback called when the geometry is updated
  104062. */
  104063. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  104064. private _scene;
  104065. private _engine;
  104066. private _meshes;
  104067. private _totalVertices;
  104068. /** @hidden */
  104069. _indices: IndicesArray;
  104070. /** @hidden */
  104071. _vertexBuffers: {
  104072. [key: string]: VertexBuffer;
  104073. };
  104074. private _isDisposed;
  104075. private _extend;
  104076. private _boundingBias;
  104077. /** @hidden */
  104078. _delayInfo: Array<string>;
  104079. private _indexBuffer;
  104080. private _indexBufferIsUpdatable;
  104081. /** @hidden */
  104082. _boundingInfo: Nullable<BoundingInfo>;
  104083. /** @hidden */
  104084. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  104085. /** @hidden */
  104086. _softwareSkinningFrameId: number;
  104087. private _vertexArrayObjects;
  104088. private _updatable;
  104089. /** @hidden */
  104090. _positions: Nullable<Vector3[]>;
  104091. /**
  104092. * 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
  104093. */
  104094. get boundingBias(): Vector2;
  104095. /**
  104096. * 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
  104097. */
  104098. set boundingBias(value: Vector2);
  104099. /**
  104100. * Static function used to attach a new empty geometry to a mesh
  104101. * @param mesh defines the mesh to attach the geometry to
  104102. * @returns the new Geometry
  104103. */
  104104. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  104105. /** Get the list of meshes using this geometry */
  104106. get meshes(): Mesh[];
  104107. /**
  104108. * 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
  104109. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  104110. */
  104111. useBoundingInfoFromGeometry: boolean;
  104112. /**
  104113. * Creates a new geometry
  104114. * @param id defines the unique ID
  104115. * @param scene defines the hosting scene
  104116. * @param vertexData defines the VertexData used to get geometry data
  104117. * @param updatable defines if geometry must be updatable (false by default)
  104118. * @param mesh defines the mesh that will be associated with the geometry
  104119. */
  104120. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  104121. /**
  104122. * Gets the current extend of the geometry
  104123. */
  104124. get extend(): {
  104125. minimum: Vector3;
  104126. maximum: Vector3;
  104127. };
  104128. /**
  104129. * Gets the hosting scene
  104130. * @returns the hosting Scene
  104131. */
  104132. getScene(): Scene;
  104133. /**
  104134. * Gets the hosting engine
  104135. * @returns the hosting Engine
  104136. */
  104137. getEngine(): Engine;
  104138. /**
  104139. * Defines if the geometry is ready to use
  104140. * @returns true if the geometry is ready to be used
  104141. */
  104142. isReady(): boolean;
  104143. /**
  104144. * Gets a value indicating that the geometry should not be serialized
  104145. */
  104146. get doNotSerialize(): boolean;
  104147. /** @hidden */
  104148. _rebuild(): void;
  104149. /**
  104150. * Affects all geometry data in one call
  104151. * @param vertexData defines the geometry data
  104152. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  104153. */
  104154. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  104155. /**
  104156. * Set specific vertex data
  104157. * @param kind defines the data kind (Position, normal, etc...)
  104158. * @param data defines the vertex data to use
  104159. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  104160. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  104161. */
  104162. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  104163. /**
  104164. * Removes a specific vertex data
  104165. * @param kind defines the data kind (Position, normal, etc...)
  104166. */
  104167. removeVerticesData(kind: string): void;
  104168. /**
  104169. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  104170. * @param buffer defines the vertex buffer to use
  104171. * @param totalVertices defines the total number of vertices for position kind (could be null)
  104172. */
  104173. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  104174. /**
  104175. * Update a specific vertex buffer
  104176. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  104177. * It will do nothing if the buffer is not updatable
  104178. * @param kind defines the data kind (Position, normal, etc...)
  104179. * @param data defines the data to use
  104180. * @param offset defines the offset in the target buffer where to store the data
  104181. * @param useBytes set to true if the offset is in bytes
  104182. */
  104183. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  104184. /**
  104185. * Update a specific vertex buffer
  104186. * This function will create a new buffer if the current one is not updatable
  104187. * @param kind defines the data kind (Position, normal, etc...)
  104188. * @param data defines the data to use
  104189. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  104190. */
  104191. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  104192. private _updateBoundingInfo;
  104193. /** @hidden */
  104194. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  104195. /**
  104196. * Gets total number of vertices
  104197. * @returns the total number of vertices
  104198. */
  104199. getTotalVertices(): number;
  104200. /**
  104201. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  104202. * @param kind defines the data kind (Position, normal, etc...)
  104203. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104204. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104205. * @returns a float array containing vertex data
  104206. */
  104207. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  104208. /**
  104209. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  104210. * @param kind defines the data kind (Position, normal, etc...)
  104211. * @returns true if the vertex buffer with the specified kind is updatable
  104212. */
  104213. isVertexBufferUpdatable(kind: string): boolean;
  104214. /**
  104215. * Gets a specific vertex buffer
  104216. * @param kind defines the data kind (Position, normal, etc...)
  104217. * @returns a VertexBuffer
  104218. */
  104219. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  104220. /**
  104221. * Returns all vertex buffers
  104222. * @return an object holding all vertex buffers indexed by kind
  104223. */
  104224. getVertexBuffers(): Nullable<{
  104225. [key: string]: VertexBuffer;
  104226. }>;
  104227. /**
  104228. * Gets a boolean indicating if specific vertex buffer is present
  104229. * @param kind defines the data kind (Position, normal, etc...)
  104230. * @returns true if data is present
  104231. */
  104232. isVerticesDataPresent(kind: string): boolean;
  104233. /**
  104234. * Gets a list of all attached data kinds (Position, normal, etc...)
  104235. * @returns a list of string containing all kinds
  104236. */
  104237. getVerticesDataKinds(): string[];
  104238. /**
  104239. * Update index buffer
  104240. * @param indices defines the indices to store in the index buffer
  104241. * @param offset defines the offset in the target buffer where to store the data
  104242. * @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)
  104243. */
  104244. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  104245. /**
  104246. * Creates a new index buffer
  104247. * @param indices defines the indices to store in the index buffer
  104248. * @param totalVertices defines the total number of vertices (could be null)
  104249. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  104250. */
  104251. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  104252. /**
  104253. * Return the total number of indices
  104254. * @returns the total number of indices
  104255. */
  104256. getTotalIndices(): number;
  104257. /**
  104258. * Gets the index buffer array
  104259. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104260. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104261. * @returns the index buffer array
  104262. */
  104263. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  104264. /**
  104265. * Gets the index buffer
  104266. * @return the index buffer
  104267. */
  104268. getIndexBuffer(): Nullable<DataBuffer>;
  104269. /** @hidden */
  104270. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  104271. /**
  104272. * Release the associated resources for a specific mesh
  104273. * @param mesh defines the source mesh
  104274. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  104275. */
  104276. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  104277. /**
  104278. * Apply current geometry to a given mesh
  104279. * @param mesh defines the mesh to apply geometry to
  104280. */
  104281. applyToMesh(mesh: Mesh): void;
  104282. private _updateExtend;
  104283. private _applyToMesh;
  104284. private notifyUpdate;
  104285. /**
  104286. * Load the geometry if it was flagged as delay loaded
  104287. * @param scene defines the hosting scene
  104288. * @param onLoaded defines a callback called when the geometry is loaded
  104289. */
  104290. load(scene: Scene, onLoaded?: () => void): void;
  104291. private _queueLoad;
  104292. /**
  104293. * Invert the geometry to move from a right handed system to a left handed one.
  104294. */
  104295. toLeftHanded(): void;
  104296. /** @hidden */
  104297. _resetPointsArrayCache(): void;
  104298. /** @hidden */
  104299. _generatePointsArray(): boolean;
  104300. /**
  104301. * Gets a value indicating if the geometry is disposed
  104302. * @returns true if the geometry was disposed
  104303. */
  104304. isDisposed(): boolean;
  104305. private _disposeVertexArrayObjects;
  104306. /**
  104307. * Free all associated resources
  104308. */
  104309. dispose(): void;
  104310. /**
  104311. * Clone the current geometry into a new geometry
  104312. * @param id defines the unique ID of the new geometry
  104313. * @returns a new geometry object
  104314. */
  104315. copy(id: string): Geometry;
  104316. /**
  104317. * Serialize the current geometry info (and not the vertices data) into a JSON object
  104318. * @return a JSON representation of the current geometry data (without the vertices data)
  104319. */
  104320. serialize(): any;
  104321. private toNumberArray;
  104322. /**
  104323. * Serialize all vertices data into a JSON oject
  104324. * @returns a JSON representation of the current geometry data
  104325. */
  104326. serializeVerticeData(): any;
  104327. /**
  104328. * Extracts a clone of a mesh geometry
  104329. * @param mesh defines the source mesh
  104330. * @param id defines the unique ID of the new geometry object
  104331. * @returns the new geometry object
  104332. */
  104333. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  104334. /**
  104335. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  104336. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  104337. * Be aware Math.random() could cause collisions, but:
  104338. * "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"
  104339. * @returns a string containing a new GUID
  104340. */
  104341. static RandomId(): string;
  104342. /** @hidden */
  104343. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  104344. private static _CleanMatricesWeights;
  104345. /**
  104346. * Create a new geometry from persisted data (Using .babylon file format)
  104347. * @param parsedVertexData defines the persisted data
  104348. * @param scene defines the hosting scene
  104349. * @param rootUrl defines the root url to use to load assets (like delayed data)
  104350. * @returns the new geometry object
  104351. */
  104352. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  104353. }
  104354. }
  104355. declare module BABYLON {
  104356. /**
  104357. * Define an interface for all classes that will get and set the data on vertices
  104358. */
  104359. export interface IGetSetVerticesData {
  104360. /**
  104361. * Gets a boolean indicating if specific vertex data is present
  104362. * @param kind defines the vertex data kind to use
  104363. * @returns true is data kind is present
  104364. */
  104365. isVerticesDataPresent(kind: string): boolean;
  104366. /**
  104367. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  104368. * @param kind defines the data kind (Position, normal, etc...)
  104369. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104370. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104371. * @returns a float array containing vertex data
  104372. */
  104373. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  104374. /**
  104375. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  104376. * @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.
  104377. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104378. * @returns the indices array or an empty array if the mesh has no geometry
  104379. */
  104380. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  104381. /**
  104382. * Set specific vertex data
  104383. * @param kind defines the data kind (Position, normal, etc...)
  104384. * @param data defines the vertex data to use
  104385. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  104386. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  104387. */
  104388. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  104389. /**
  104390. * Update a specific associated vertex buffer
  104391. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  104392. * - VertexBuffer.PositionKind
  104393. * - VertexBuffer.UVKind
  104394. * - VertexBuffer.UV2Kind
  104395. * - VertexBuffer.UV3Kind
  104396. * - VertexBuffer.UV4Kind
  104397. * - VertexBuffer.UV5Kind
  104398. * - VertexBuffer.UV6Kind
  104399. * - VertexBuffer.ColorKind
  104400. * - VertexBuffer.MatricesIndicesKind
  104401. * - VertexBuffer.MatricesIndicesExtraKind
  104402. * - VertexBuffer.MatricesWeightsKind
  104403. * - VertexBuffer.MatricesWeightsExtraKind
  104404. * @param data defines the data source
  104405. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  104406. * @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)
  104407. */
  104408. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  104409. /**
  104410. * Creates a new index buffer
  104411. * @param indices defines the indices to store in the index buffer
  104412. * @param totalVertices defines the total number of vertices (could be null)
  104413. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  104414. */
  104415. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  104416. }
  104417. /**
  104418. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  104419. */
  104420. export class VertexData {
  104421. /**
  104422. * Mesh side orientation : usually the external or front surface
  104423. */
  104424. static readonly FRONTSIDE: number;
  104425. /**
  104426. * Mesh side orientation : usually the internal or back surface
  104427. */
  104428. static readonly BACKSIDE: number;
  104429. /**
  104430. * Mesh side orientation : both internal and external or front and back surfaces
  104431. */
  104432. static readonly DOUBLESIDE: number;
  104433. /**
  104434. * Mesh side orientation : by default, `FRONTSIDE`
  104435. */
  104436. static readonly DEFAULTSIDE: number;
  104437. /**
  104438. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  104439. */
  104440. positions: Nullable<FloatArray>;
  104441. /**
  104442. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  104443. */
  104444. normals: Nullable<FloatArray>;
  104445. /**
  104446. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  104447. */
  104448. tangents: Nullable<FloatArray>;
  104449. /**
  104450. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104451. */
  104452. uvs: Nullable<FloatArray>;
  104453. /**
  104454. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104455. */
  104456. uvs2: Nullable<FloatArray>;
  104457. /**
  104458. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104459. */
  104460. uvs3: Nullable<FloatArray>;
  104461. /**
  104462. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104463. */
  104464. uvs4: Nullable<FloatArray>;
  104465. /**
  104466. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104467. */
  104468. uvs5: Nullable<FloatArray>;
  104469. /**
  104470. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104471. */
  104472. uvs6: Nullable<FloatArray>;
  104473. /**
  104474. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  104475. */
  104476. colors: Nullable<FloatArray>;
  104477. /**
  104478. * 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).
  104479. */
  104480. matricesIndices: Nullable<FloatArray>;
  104481. /**
  104482. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  104483. */
  104484. matricesWeights: Nullable<FloatArray>;
  104485. /**
  104486. * An array extending the number of possible indices
  104487. */
  104488. matricesIndicesExtra: Nullable<FloatArray>;
  104489. /**
  104490. * An array extending the number of possible weights when the number of indices is extended
  104491. */
  104492. matricesWeightsExtra: Nullable<FloatArray>;
  104493. /**
  104494. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  104495. */
  104496. indices: Nullable<IndicesArray>;
  104497. /**
  104498. * Uses the passed data array to set the set the values for the specified kind of data
  104499. * @param data a linear array of floating numbers
  104500. * @param kind the type of data that is being set, eg positions, colors etc
  104501. */
  104502. set(data: FloatArray, kind: string): void;
  104503. /**
  104504. * Associates the vertexData to the passed Mesh.
  104505. * Sets it as updatable or not (default `false`)
  104506. * @param mesh the mesh the vertexData is applied to
  104507. * @param updatable when used and having the value true allows new data to update the vertexData
  104508. * @returns the VertexData
  104509. */
  104510. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  104511. /**
  104512. * Associates the vertexData to the passed Geometry.
  104513. * Sets it as updatable or not (default `false`)
  104514. * @param geometry the geometry the vertexData is applied to
  104515. * @param updatable when used and having the value true allows new data to update the vertexData
  104516. * @returns VertexData
  104517. */
  104518. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  104519. /**
  104520. * Updates the associated mesh
  104521. * @param mesh the mesh to be updated
  104522. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  104523. * @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
  104524. * @returns VertexData
  104525. */
  104526. updateMesh(mesh: Mesh): VertexData;
  104527. /**
  104528. * Updates the associated geometry
  104529. * @param geometry the geometry to be updated
  104530. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  104531. * @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
  104532. * @returns VertexData.
  104533. */
  104534. updateGeometry(geometry: Geometry): VertexData;
  104535. private _applyTo;
  104536. private _update;
  104537. /**
  104538. * Transforms each position and each normal of the vertexData according to the passed Matrix
  104539. * @param matrix the transforming matrix
  104540. * @returns the VertexData
  104541. */
  104542. transform(matrix: Matrix): VertexData;
  104543. /**
  104544. * Merges the passed VertexData into the current one
  104545. * @param other the VertexData to be merged into the current one
  104546. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  104547. * @returns the modified VertexData
  104548. */
  104549. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  104550. private _mergeElement;
  104551. private _validate;
  104552. /**
  104553. * Serializes the VertexData
  104554. * @returns a serialized object
  104555. */
  104556. serialize(): any;
  104557. /**
  104558. * Extracts the vertexData from a mesh
  104559. * @param mesh the mesh from which to extract the VertexData
  104560. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  104561. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  104562. * @returns the object VertexData associated to the passed mesh
  104563. */
  104564. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  104565. /**
  104566. * Extracts the vertexData from the geometry
  104567. * @param geometry the geometry from which to extract the VertexData
  104568. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  104569. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  104570. * @returns the object VertexData associated to the passed mesh
  104571. */
  104572. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  104573. private static _ExtractFrom;
  104574. /**
  104575. * Creates the VertexData for a Ribbon
  104576. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  104577. * * pathArray array of paths, each of which an array of successive Vector3
  104578. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  104579. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  104580. * * 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
  104581. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104582. * * 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)
  104583. * * 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)
  104584. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  104585. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  104586. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  104587. * @returns the VertexData of the ribbon
  104588. */
  104589. static CreateRibbon(options: {
  104590. pathArray: Vector3[][];
  104591. closeArray?: boolean;
  104592. closePath?: boolean;
  104593. offset?: number;
  104594. sideOrientation?: number;
  104595. frontUVs?: Vector4;
  104596. backUVs?: Vector4;
  104597. invertUV?: boolean;
  104598. uvs?: Vector2[];
  104599. colors?: Color4[];
  104600. }): VertexData;
  104601. /**
  104602. * Creates the VertexData for a box
  104603. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104604. * * size sets the width, height and depth of the box to the value of size, optional default 1
  104605. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  104606. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  104607. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  104608. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  104609. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  104610. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104611. * * 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)
  104612. * * 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)
  104613. * @returns the VertexData of the box
  104614. */
  104615. static CreateBox(options: {
  104616. size?: number;
  104617. width?: number;
  104618. height?: number;
  104619. depth?: number;
  104620. faceUV?: Vector4[];
  104621. faceColors?: Color4[];
  104622. sideOrientation?: number;
  104623. frontUVs?: Vector4;
  104624. backUVs?: Vector4;
  104625. }): VertexData;
  104626. /**
  104627. * Creates the VertexData for a tiled box
  104628. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104629. * * faceTiles sets the pattern, tile size and number of tiles for a face
  104630. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  104631. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  104632. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104633. * @returns the VertexData of the box
  104634. */
  104635. static CreateTiledBox(options: {
  104636. pattern?: number;
  104637. width?: number;
  104638. height?: number;
  104639. depth?: number;
  104640. tileSize?: number;
  104641. tileWidth?: number;
  104642. tileHeight?: number;
  104643. alignHorizontal?: number;
  104644. alignVertical?: number;
  104645. faceUV?: Vector4[];
  104646. faceColors?: Color4[];
  104647. sideOrientation?: number;
  104648. }): VertexData;
  104649. /**
  104650. * Creates the VertexData for a tiled plane
  104651. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104652. * * pattern a limited pattern arrangement depending on the number
  104653. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  104654. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  104655. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  104656. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104657. * * 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)
  104658. * * 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)
  104659. * @returns the VertexData of the tiled plane
  104660. */
  104661. static CreateTiledPlane(options: {
  104662. pattern?: number;
  104663. tileSize?: number;
  104664. tileWidth?: number;
  104665. tileHeight?: number;
  104666. size?: number;
  104667. width?: number;
  104668. height?: number;
  104669. alignHorizontal?: number;
  104670. alignVertical?: number;
  104671. sideOrientation?: number;
  104672. frontUVs?: Vector4;
  104673. backUVs?: Vector4;
  104674. }): VertexData;
  104675. /**
  104676. * Creates the VertexData for an ellipsoid, defaults to a sphere
  104677. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104678. * * segments sets the number of horizontal strips optional, default 32
  104679. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  104680. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  104681. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  104682. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  104683. * * 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
  104684. * * 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
  104685. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104686. * * 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)
  104687. * * 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)
  104688. * @returns the VertexData of the ellipsoid
  104689. */
  104690. static CreateSphere(options: {
  104691. segments?: number;
  104692. diameter?: number;
  104693. diameterX?: number;
  104694. diameterY?: number;
  104695. diameterZ?: number;
  104696. arc?: number;
  104697. slice?: number;
  104698. sideOrientation?: number;
  104699. frontUVs?: Vector4;
  104700. backUVs?: Vector4;
  104701. }): VertexData;
  104702. /**
  104703. * Creates the VertexData for a cylinder, cone or prism
  104704. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104705. * * height sets the height (y direction) of the cylinder, optional, default 2
  104706. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  104707. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  104708. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  104709. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  104710. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  104711. * * 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
  104712. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104713. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104714. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  104715. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  104716. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104717. * * 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)
  104718. * * 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)
  104719. * @returns the VertexData of the cylinder, cone or prism
  104720. */
  104721. static CreateCylinder(options: {
  104722. height?: number;
  104723. diameterTop?: number;
  104724. diameterBottom?: number;
  104725. diameter?: number;
  104726. tessellation?: number;
  104727. subdivisions?: number;
  104728. arc?: number;
  104729. faceColors?: Color4[];
  104730. faceUV?: Vector4[];
  104731. hasRings?: boolean;
  104732. enclose?: boolean;
  104733. sideOrientation?: number;
  104734. frontUVs?: Vector4;
  104735. backUVs?: Vector4;
  104736. }): VertexData;
  104737. /**
  104738. * Creates the VertexData for a torus
  104739. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104740. * * diameter the diameter of the torus, optional default 1
  104741. * * thickness the diameter of the tube forming the torus, optional default 0.5
  104742. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  104743. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104744. * * 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)
  104745. * * 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)
  104746. * @returns the VertexData of the torus
  104747. */
  104748. static CreateTorus(options: {
  104749. diameter?: number;
  104750. thickness?: number;
  104751. tessellation?: number;
  104752. sideOrientation?: number;
  104753. frontUVs?: Vector4;
  104754. backUVs?: Vector4;
  104755. }): VertexData;
  104756. /**
  104757. * Creates the VertexData of the LineSystem
  104758. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  104759. * - lines an array of lines, each line being an array of successive Vector3
  104760. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  104761. * @returns the VertexData of the LineSystem
  104762. */
  104763. static CreateLineSystem(options: {
  104764. lines: Vector3[][];
  104765. colors?: Nullable<Color4[][]>;
  104766. }): VertexData;
  104767. /**
  104768. * Create the VertexData for a DashedLines
  104769. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  104770. * - points an array successive Vector3
  104771. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  104772. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  104773. * - dashNb the intended total number of dashes, optional, default 200
  104774. * @returns the VertexData for the DashedLines
  104775. */
  104776. static CreateDashedLines(options: {
  104777. points: Vector3[];
  104778. dashSize?: number;
  104779. gapSize?: number;
  104780. dashNb?: number;
  104781. }): VertexData;
  104782. /**
  104783. * Creates the VertexData for a Ground
  104784. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  104785. * - width the width (x direction) of the ground, optional, default 1
  104786. * - height the height (z direction) of the ground, optional, default 1
  104787. * - subdivisions the number of subdivisions per side, optional, default 1
  104788. * @returns the VertexData of the Ground
  104789. */
  104790. static CreateGround(options: {
  104791. width?: number;
  104792. height?: number;
  104793. subdivisions?: number;
  104794. subdivisionsX?: number;
  104795. subdivisionsY?: number;
  104796. }): VertexData;
  104797. /**
  104798. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  104799. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  104800. * * xmin the ground minimum X coordinate, optional, default -1
  104801. * * zmin the ground minimum Z coordinate, optional, default -1
  104802. * * xmax the ground maximum X coordinate, optional, default 1
  104803. * * zmax the ground maximum Z coordinate, optional, default 1
  104804. * * 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}
  104805. * * 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}
  104806. * @returns the VertexData of the TiledGround
  104807. */
  104808. static CreateTiledGround(options: {
  104809. xmin: number;
  104810. zmin: number;
  104811. xmax: number;
  104812. zmax: number;
  104813. subdivisions?: {
  104814. w: number;
  104815. h: number;
  104816. };
  104817. precision?: {
  104818. w: number;
  104819. h: number;
  104820. };
  104821. }): VertexData;
  104822. /**
  104823. * Creates the VertexData of the Ground designed from a heightmap
  104824. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  104825. * * width the width (x direction) of the ground
  104826. * * height the height (z direction) of the ground
  104827. * * subdivisions the number of subdivisions per side
  104828. * * minHeight the minimum altitude on the ground, optional, default 0
  104829. * * maxHeight the maximum altitude on the ground, optional default 1
  104830. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  104831. * * buffer the array holding the image color data
  104832. * * bufferWidth the width of image
  104833. * * bufferHeight the height of image
  104834. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  104835. * @returns the VertexData of the Ground designed from a heightmap
  104836. */
  104837. static CreateGroundFromHeightMap(options: {
  104838. width: number;
  104839. height: number;
  104840. subdivisions: number;
  104841. minHeight: number;
  104842. maxHeight: number;
  104843. colorFilter: Color3;
  104844. buffer: Uint8Array;
  104845. bufferWidth: number;
  104846. bufferHeight: number;
  104847. alphaFilter: number;
  104848. }): VertexData;
  104849. /**
  104850. * Creates the VertexData for a Plane
  104851. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  104852. * * size sets the width and height of the plane to the value of size, optional default 1
  104853. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  104854. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  104855. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104856. * * 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)
  104857. * * 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)
  104858. * @returns the VertexData of the box
  104859. */
  104860. static CreatePlane(options: {
  104861. size?: number;
  104862. width?: number;
  104863. height?: number;
  104864. sideOrientation?: number;
  104865. frontUVs?: Vector4;
  104866. backUVs?: Vector4;
  104867. }): VertexData;
  104868. /**
  104869. * Creates the VertexData of the Disc or regular Polygon
  104870. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  104871. * * radius the radius of the disc, optional default 0.5
  104872. * * tessellation the number of polygon sides, optional, default 64
  104873. * * 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
  104874. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104875. * * 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)
  104876. * * 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)
  104877. * @returns the VertexData of the box
  104878. */
  104879. static CreateDisc(options: {
  104880. radius?: number;
  104881. tessellation?: number;
  104882. arc?: number;
  104883. sideOrientation?: number;
  104884. frontUVs?: Vector4;
  104885. backUVs?: Vector4;
  104886. }): VertexData;
  104887. /**
  104888. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  104889. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  104890. * @param polygon a mesh built from polygonTriangulation.build()
  104891. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104892. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104893. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104894. * @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)
  104895. * @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)
  104896. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  104897. * @returns the VertexData of the Polygon
  104898. */
  104899. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  104900. /**
  104901. * Creates the VertexData of the IcoSphere
  104902. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  104903. * * radius the radius of the IcoSphere, optional default 1
  104904. * * radiusX allows stretching in the x direction, optional, default radius
  104905. * * radiusY allows stretching in the y direction, optional, default radius
  104906. * * radiusZ allows stretching in the z direction, optional, default radius
  104907. * * flat when true creates a flat shaded mesh, optional, default true
  104908. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  104909. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104910. * * 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)
  104911. * * 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)
  104912. * @returns the VertexData of the IcoSphere
  104913. */
  104914. static CreateIcoSphere(options: {
  104915. radius?: number;
  104916. radiusX?: number;
  104917. radiusY?: number;
  104918. radiusZ?: number;
  104919. flat?: boolean;
  104920. subdivisions?: number;
  104921. sideOrientation?: number;
  104922. frontUVs?: Vector4;
  104923. backUVs?: Vector4;
  104924. }): VertexData;
  104925. /**
  104926. * Creates the VertexData for a Polyhedron
  104927. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  104928. * * type provided types are:
  104929. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  104930. * * 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)
  104931. * * size the size of the IcoSphere, optional default 1
  104932. * * sizeX allows stretching in the x direction, optional, default size
  104933. * * sizeY allows stretching in the y direction, optional, default size
  104934. * * sizeZ allows stretching in the z direction, optional, default size
  104935. * * 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
  104936. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104937. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104938. * * flat when true creates a flat shaded mesh, optional, default true
  104939. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  104940. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104941. * * 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)
  104942. * * 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)
  104943. * @returns the VertexData of the Polyhedron
  104944. */
  104945. static CreatePolyhedron(options: {
  104946. type?: number;
  104947. size?: number;
  104948. sizeX?: number;
  104949. sizeY?: number;
  104950. sizeZ?: number;
  104951. custom?: any;
  104952. faceUV?: Vector4[];
  104953. faceColors?: Color4[];
  104954. flat?: boolean;
  104955. sideOrientation?: number;
  104956. frontUVs?: Vector4;
  104957. backUVs?: Vector4;
  104958. }): VertexData;
  104959. /**
  104960. * Creates the VertexData for a TorusKnot
  104961. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  104962. * * radius the radius of the torus knot, optional, default 2
  104963. * * tube the thickness of the tube, optional, default 0.5
  104964. * * radialSegments the number of sides on each tube segments, optional, default 32
  104965. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  104966. * * p the number of windings around the z axis, optional, default 2
  104967. * * q the number of windings around the x axis, optional, default 3
  104968. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104969. * * 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)
  104970. * * 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)
  104971. * @returns the VertexData of the Torus Knot
  104972. */
  104973. static CreateTorusKnot(options: {
  104974. radius?: number;
  104975. tube?: number;
  104976. radialSegments?: number;
  104977. tubularSegments?: number;
  104978. p?: number;
  104979. q?: number;
  104980. sideOrientation?: number;
  104981. frontUVs?: Vector4;
  104982. backUVs?: Vector4;
  104983. }): VertexData;
  104984. /**
  104985. * Compute normals for given positions and indices
  104986. * @param positions an array of vertex positions, [...., x, y, z, ......]
  104987. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  104988. * @param normals an array of vertex normals, [...., x, y, z, ......]
  104989. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  104990. * * facetNormals : optional array of facet normals (vector3)
  104991. * * facetPositions : optional array of facet positions (vector3)
  104992. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  104993. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  104994. * * bInfo : optional bounding info, required for facetPartitioning computation
  104995. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  104996. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  104997. * * useRightHandedSystem: optional boolean to for right handed system computation
  104998. * * depthSort : optional boolean to enable the facet depth sort computation
  104999. * * distanceTo : optional Vector3 to compute the facet depth from this location
  105000. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  105001. */
  105002. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  105003. facetNormals?: any;
  105004. facetPositions?: any;
  105005. facetPartitioning?: any;
  105006. ratio?: number;
  105007. bInfo?: any;
  105008. bbSize?: Vector3;
  105009. subDiv?: any;
  105010. useRightHandedSystem?: boolean;
  105011. depthSort?: boolean;
  105012. distanceTo?: Vector3;
  105013. depthSortedFacets?: any;
  105014. }): void;
  105015. /** @hidden */
  105016. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  105017. /**
  105018. * Applies VertexData created from the imported parameters to the geometry
  105019. * @param parsedVertexData the parsed data from an imported file
  105020. * @param geometry the geometry to apply the VertexData to
  105021. */
  105022. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  105023. }
  105024. }
  105025. declare module BABYLON {
  105026. /**
  105027. * Defines a target to use with MorphTargetManager
  105028. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105029. */
  105030. export class MorphTarget implements IAnimatable {
  105031. /** defines the name of the target */
  105032. name: string;
  105033. /**
  105034. * Gets or sets the list of animations
  105035. */
  105036. animations: Animation[];
  105037. private _scene;
  105038. private _positions;
  105039. private _normals;
  105040. private _tangents;
  105041. private _uvs;
  105042. private _influence;
  105043. private _uniqueId;
  105044. /**
  105045. * Observable raised when the influence changes
  105046. */
  105047. onInfluenceChanged: Observable<boolean>;
  105048. /** @hidden */
  105049. _onDataLayoutChanged: Observable<void>;
  105050. /**
  105051. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  105052. */
  105053. get influence(): number;
  105054. set influence(influence: number);
  105055. /**
  105056. * Gets or sets the id of the morph Target
  105057. */
  105058. id: string;
  105059. private _animationPropertiesOverride;
  105060. /**
  105061. * Gets or sets the animation properties override
  105062. */
  105063. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  105064. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  105065. /**
  105066. * Creates a new MorphTarget
  105067. * @param name defines the name of the target
  105068. * @param influence defines the influence to use
  105069. * @param scene defines the scene the morphtarget belongs to
  105070. */
  105071. constructor(
  105072. /** defines the name of the target */
  105073. name: string, influence?: number, scene?: Nullable<Scene>);
  105074. /**
  105075. * Gets the unique ID of this manager
  105076. */
  105077. get uniqueId(): number;
  105078. /**
  105079. * Gets a boolean defining if the target contains position data
  105080. */
  105081. get hasPositions(): boolean;
  105082. /**
  105083. * Gets a boolean defining if the target contains normal data
  105084. */
  105085. get hasNormals(): boolean;
  105086. /**
  105087. * Gets a boolean defining if the target contains tangent data
  105088. */
  105089. get hasTangents(): boolean;
  105090. /**
  105091. * Gets a boolean defining if the target contains texture coordinates data
  105092. */
  105093. get hasUVs(): boolean;
  105094. /**
  105095. * Affects position data to this target
  105096. * @param data defines the position data to use
  105097. */
  105098. setPositions(data: Nullable<FloatArray>): void;
  105099. /**
  105100. * Gets the position data stored in this target
  105101. * @returns a FloatArray containing the position data (or null if not present)
  105102. */
  105103. getPositions(): Nullable<FloatArray>;
  105104. /**
  105105. * Affects normal data to this target
  105106. * @param data defines the normal data to use
  105107. */
  105108. setNormals(data: Nullable<FloatArray>): void;
  105109. /**
  105110. * Gets the normal data stored in this target
  105111. * @returns a FloatArray containing the normal data (or null if not present)
  105112. */
  105113. getNormals(): Nullable<FloatArray>;
  105114. /**
  105115. * Affects tangent data to this target
  105116. * @param data defines the tangent data to use
  105117. */
  105118. setTangents(data: Nullable<FloatArray>): void;
  105119. /**
  105120. * Gets the tangent data stored in this target
  105121. * @returns a FloatArray containing the tangent data (or null if not present)
  105122. */
  105123. getTangents(): Nullable<FloatArray>;
  105124. /**
  105125. * Affects texture coordinates data to this target
  105126. * @param data defines the texture coordinates data to use
  105127. */
  105128. setUVs(data: Nullable<FloatArray>): void;
  105129. /**
  105130. * Gets the texture coordinates data stored in this target
  105131. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  105132. */
  105133. getUVs(): Nullable<FloatArray>;
  105134. /**
  105135. * Clone the current target
  105136. * @returns a new MorphTarget
  105137. */
  105138. clone(): MorphTarget;
  105139. /**
  105140. * Serializes the current target into a Serialization object
  105141. * @returns the serialized object
  105142. */
  105143. serialize(): any;
  105144. /**
  105145. * Returns the string "MorphTarget"
  105146. * @returns "MorphTarget"
  105147. */
  105148. getClassName(): string;
  105149. /**
  105150. * Creates a new target from serialized data
  105151. * @param serializationObject defines the serialized data to use
  105152. * @returns a new MorphTarget
  105153. */
  105154. static Parse(serializationObject: any): MorphTarget;
  105155. /**
  105156. * Creates a MorphTarget from mesh data
  105157. * @param mesh defines the source mesh
  105158. * @param name defines the name to use for the new target
  105159. * @param influence defines the influence to attach to the target
  105160. * @returns a new MorphTarget
  105161. */
  105162. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  105163. }
  105164. }
  105165. declare module BABYLON {
  105166. /**
  105167. * This class is used to deform meshes using morphing between different targets
  105168. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105169. */
  105170. export class MorphTargetManager {
  105171. private _targets;
  105172. private _targetInfluenceChangedObservers;
  105173. private _targetDataLayoutChangedObservers;
  105174. private _activeTargets;
  105175. private _scene;
  105176. private _influences;
  105177. private _supportsNormals;
  105178. private _supportsTangents;
  105179. private _supportsUVs;
  105180. private _vertexCount;
  105181. private _uniqueId;
  105182. private _tempInfluences;
  105183. /**
  105184. * Gets or sets a boolean indicating if normals must be morphed
  105185. */
  105186. enableNormalMorphing: boolean;
  105187. /**
  105188. * Gets or sets a boolean indicating if tangents must be morphed
  105189. */
  105190. enableTangentMorphing: boolean;
  105191. /**
  105192. * Gets or sets a boolean indicating if UV must be morphed
  105193. */
  105194. enableUVMorphing: boolean;
  105195. /**
  105196. * Creates a new MorphTargetManager
  105197. * @param scene defines the current scene
  105198. */
  105199. constructor(scene?: Nullable<Scene>);
  105200. /**
  105201. * Gets the unique ID of this manager
  105202. */
  105203. get uniqueId(): number;
  105204. /**
  105205. * Gets the number of vertices handled by this manager
  105206. */
  105207. get vertexCount(): number;
  105208. /**
  105209. * Gets a boolean indicating if this manager supports morphing of normals
  105210. */
  105211. get supportsNormals(): boolean;
  105212. /**
  105213. * Gets a boolean indicating if this manager supports morphing of tangents
  105214. */
  105215. get supportsTangents(): boolean;
  105216. /**
  105217. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  105218. */
  105219. get supportsUVs(): boolean;
  105220. /**
  105221. * Gets the number of targets stored in this manager
  105222. */
  105223. get numTargets(): number;
  105224. /**
  105225. * Gets the number of influencers (ie. the number of targets with influences > 0)
  105226. */
  105227. get numInfluencers(): number;
  105228. /**
  105229. * Gets the list of influences (one per target)
  105230. */
  105231. get influences(): Float32Array;
  105232. /**
  105233. * Gets the active target at specified index. An active target is a target with an influence > 0
  105234. * @param index defines the index to check
  105235. * @returns the requested target
  105236. */
  105237. getActiveTarget(index: number): MorphTarget;
  105238. /**
  105239. * Gets the target at specified index
  105240. * @param index defines the index to check
  105241. * @returns the requested target
  105242. */
  105243. getTarget(index: number): MorphTarget;
  105244. /**
  105245. * Add a new target to this manager
  105246. * @param target defines the target to add
  105247. */
  105248. addTarget(target: MorphTarget): void;
  105249. /**
  105250. * Removes a target from the manager
  105251. * @param target defines the target to remove
  105252. */
  105253. removeTarget(target: MorphTarget): void;
  105254. /**
  105255. * Clone the current manager
  105256. * @returns a new MorphTargetManager
  105257. */
  105258. clone(): MorphTargetManager;
  105259. /**
  105260. * Serializes the current manager into a Serialization object
  105261. * @returns the serialized object
  105262. */
  105263. serialize(): any;
  105264. private _syncActiveTargets;
  105265. /**
  105266. * Syncrhonize the targets with all the meshes using this morph target manager
  105267. */
  105268. synchronize(): void;
  105269. /**
  105270. * Creates a new MorphTargetManager from serialized data
  105271. * @param serializationObject defines the serialized data
  105272. * @param scene defines the hosting scene
  105273. * @returns the new MorphTargetManager
  105274. */
  105275. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  105276. }
  105277. }
  105278. declare module BABYLON {
  105279. /**
  105280. * Class used to represent a specific level of detail of a mesh
  105281. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105282. */
  105283. export class MeshLODLevel {
  105284. /** Defines the distance where this level should start being displayed */
  105285. distance: number;
  105286. /** Defines the mesh to use to render this level */
  105287. mesh: Nullable<Mesh>;
  105288. /**
  105289. * Creates a new LOD level
  105290. * @param distance defines the distance where this level should star being displayed
  105291. * @param mesh defines the mesh to use to render this level
  105292. */
  105293. constructor(
  105294. /** Defines the distance where this level should start being displayed */
  105295. distance: number,
  105296. /** Defines the mesh to use to render this level */
  105297. mesh: Nullable<Mesh>);
  105298. }
  105299. }
  105300. declare module BABYLON {
  105301. /**
  105302. * Helper class used to generate a canvas to manipulate images
  105303. */
  105304. export class CanvasGenerator {
  105305. /**
  105306. * Create a new canvas (or offscreen canvas depending on the context)
  105307. * @param width defines the expected width
  105308. * @param height defines the expected height
  105309. * @return a new canvas or offscreen canvas
  105310. */
  105311. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  105312. }
  105313. }
  105314. declare module BABYLON {
  105315. /**
  105316. * Mesh representing the gorund
  105317. */
  105318. export class GroundMesh extends Mesh {
  105319. /** If octree should be generated */
  105320. generateOctree: boolean;
  105321. private _heightQuads;
  105322. /** @hidden */
  105323. _subdivisionsX: number;
  105324. /** @hidden */
  105325. _subdivisionsY: number;
  105326. /** @hidden */
  105327. _width: number;
  105328. /** @hidden */
  105329. _height: number;
  105330. /** @hidden */
  105331. _minX: number;
  105332. /** @hidden */
  105333. _maxX: number;
  105334. /** @hidden */
  105335. _minZ: number;
  105336. /** @hidden */
  105337. _maxZ: number;
  105338. constructor(name: string, scene: Scene);
  105339. /**
  105340. * "GroundMesh"
  105341. * @returns "GroundMesh"
  105342. */
  105343. getClassName(): string;
  105344. /**
  105345. * The minimum of x and y subdivisions
  105346. */
  105347. get subdivisions(): number;
  105348. /**
  105349. * X subdivisions
  105350. */
  105351. get subdivisionsX(): number;
  105352. /**
  105353. * Y subdivisions
  105354. */
  105355. get subdivisionsY(): number;
  105356. /**
  105357. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  105358. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  105359. * @param chunksCount the number of subdivisions for x and y
  105360. * @param octreeBlocksSize (Default: 32)
  105361. */
  105362. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  105363. /**
  105364. * Returns a height (y) value in the Worl system :
  105365. * the ground altitude at the coordinates (x, z) expressed in the World system.
  105366. * @param x x coordinate
  105367. * @param z z coordinate
  105368. * @returns the ground y position if (x, z) are outside the ground surface.
  105369. */
  105370. getHeightAtCoordinates(x: number, z: number): number;
  105371. /**
  105372. * Returns a normalized vector (Vector3) orthogonal to the ground
  105373. * at the ground coordinates (x, z) expressed in the World system.
  105374. * @param x x coordinate
  105375. * @param z z coordinate
  105376. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  105377. */
  105378. getNormalAtCoordinates(x: number, z: number): Vector3;
  105379. /**
  105380. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  105381. * at the ground coordinates (x, z) expressed in the World system.
  105382. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  105383. * @param x x coordinate
  105384. * @param z z coordinate
  105385. * @param ref vector to store the result
  105386. * @returns the GroundMesh.
  105387. */
  105388. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  105389. /**
  105390. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  105391. * if the ground has been updated.
  105392. * This can be used in the render loop.
  105393. * @returns the GroundMesh.
  105394. */
  105395. updateCoordinateHeights(): GroundMesh;
  105396. private _getFacetAt;
  105397. private _initHeightQuads;
  105398. private _computeHeightQuads;
  105399. /**
  105400. * Serializes this ground mesh
  105401. * @param serializationObject object to write serialization to
  105402. */
  105403. serialize(serializationObject: any): void;
  105404. /**
  105405. * Parses a serialized ground mesh
  105406. * @param parsedMesh the serialized mesh
  105407. * @param scene the scene to create the ground mesh in
  105408. * @returns the created ground mesh
  105409. */
  105410. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  105411. }
  105412. }
  105413. declare module BABYLON {
  105414. /**
  105415. * Interface for Physics-Joint data
  105416. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105417. */
  105418. export interface PhysicsJointData {
  105419. /**
  105420. * The main pivot of the joint
  105421. */
  105422. mainPivot?: Vector3;
  105423. /**
  105424. * The connected pivot of the joint
  105425. */
  105426. connectedPivot?: Vector3;
  105427. /**
  105428. * The main axis of the joint
  105429. */
  105430. mainAxis?: Vector3;
  105431. /**
  105432. * The connected axis of the joint
  105433. */
  105434. connectedAxis?: Vector3;
  105435. /**
  105436. * The collision of the joint
  105437. */
  105438. collision?: boolean;
  105439. /**
  105440. * Native Oimo/Cannon/Energy data
  105441. */
  105442. nativeParams?: any;
  105443. }
  105444. /**
  105445. * This is a holder class for the physics joint created by the physics plugin
  105446. * It holds a set of functions to control the underlying joint
  105447. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105448. */
  105449. export class PhysicsJoint {
  105450. /**
  105451. * The type of the physics joint
  105452. */
  105453. type: number;
  105454. /**
  105455. * The data for the physics joint
  105456. */
  105457. jointData: PhysicsJointData;
  105458. private _physicsJoint;
  105459. protected _physicsPlugin: IPhysicsEnginePlugin;
  105460. /**
  105461. * Initializes the physics joint
  105462. * @param type The type of the physics joint
  105463. * @param jointData The data for the physics joint
  105464. */
  105465. constructor(
  105466. /**
  105467. * The type of the physics joint
  105468. */
  105469. type: number,
  105470. /**
  105471. * The data for the physics joint
  105472. */
  105473. jointData: PhysicsJointData);
  105474. /**
  105475. * Gets the physics joint
  105476. */
  105477. get physicsJoint(): any;
  105478. /**
  105479. * Sets the physics joint
  105480. */
  105481. set physicsJoint(newJoint: any);
  105482. /**
  105483. * Sets the physics plugin
  105484. */
  105485. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  105486. /**
  105487. * Execute a function that is physics-plugin specific.
  105488. * @param {Function} func the function that will be executed.
  105489. * It accepts two parameters: the physics world and the physics joint
  105490. */
  105491. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  105492. /**
  105493. * Distance-Joint type
  105494. */
  105495. static DistanceJoint: number;
  105496. /**
  105497. * Hinge-Joint type
  105498. */
  105499. static HingeJoint: number;
  105500. /**
  105501. * Ball-and-Socket joint type
  105502. */
  105503. static BallAndSocketJoint: number;
  105504. /**
  105505. * Wheel-Joint type
  105506. */
  105507. static WheelJoint: number;
  105508. /**
  105509. * Slider-Joint type
  105510. */
  105511. static SliderJoint: number;
  105512. /**
  105513. * Prismatic-Joint type
  105514. */
  105515. static PrismaticJoint: number;
  105516. /**
  105517. * Universal-Joint type
  105518. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  105519. */
  105520. static UniversalJoint: number;
  105521. /**
  105522. * Hinge-Joint 2 type
  105523. */
  105524. static Hinge2Joint: number;
  105525. /**
  105526. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  105527. */
  105528. static PointToPointJoint: number;
  105529. /**
  105530. * Spring-Joint type
  105531. */
  105532. static SpringJoint: number;
  105533. /**
  105534. * Lock-Joint type
  105535. */
  105536. static LockJoint: number;
  105537. }
  105538. /**
  105539. * A class representing a physics distance joint
  105540. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105541. */
  105542. export class DistanceJoint extends PhysicsJoint {
  105543. /**
  105544. *
  105545. * @param jointData The data for the Distance-Joint
  105546. */
  105547. constructor(jointData: DistanceJointData);
  105548. /**
  105549. * Update the predefined distance.
  105550. * @param maxDistance The maximum preferred distance
  105551. * @param minDistance The minimum preferred distance
  105552. */
  105553. updateDistance(maxDistance: number, minDistance?: number): void;
  105554. }
  105555. /**
  105556. * Represents a Motor-Enabled Joint
  105557. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105558. */
  105559. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  105560. /**
  105561. * Initializes the Motor-Enabled Joint
  105562. * @param type The type of the joint
  105563. * @param jointData The physica joint data for the joint
  105564. */
  105565. constructor(type: number, jointData: PhysicsJointData);
  105566. /**
  105567. * Set the motor values.
  105568. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105569. * @param force the force to apply
  105570. * @param maxForce max force for this motor.
  105571. */
  105572. setMotor(force?: number, maxForce?: number): void;
  105573. /**
  105574. * Set the motor's limits.
  105575. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105576. * @param upperLimit The upper limit of the motor
  105577. * @param lowerLimit The lower limit of the motor
  105578. */
  105579. setLimit(upperLimit: number, lowerLimit?: number): void;
  105580. }
  105581. /**
  105582. * This class represents a single physics Hinge-Joint
  105583. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105584. */
  105585. export class HingeJoint extends MotorEnabledJoint {
  105586. /**
  105587. * Initializes the Hinge-Joint
  105588. * @param jointData The joint data for the Hinge-Joint
  105589. */
  105590. constructor(jointData: PhysicsJointData);
  105591. /**
  105592. * Set the motor values.
  105593. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105594. * @param {number} force the force to apply
  105595. * @param {number} maxForce max force for this motor.
  105596. */
  105597. setMotor(force?: number, maxForce?: number): void;
  105598. /**
  105599. * Set the motor's limits.
  105600. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105601. * @param upperLimit The upper limit of the motor
  105602. * @param lowerLimit The lower limit of the motor
  105603. */
  105604. setLimit(upperLimit: number, lowerLimit?: number): void;
  105605. }
  105606. /**
  105607. * This class represents a dual hinge physics joint (same as wheel joint)
  105608. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105609. */
  105610. export class Hinge2Joint extends MotorEnabledJoint {
  105611. /**
  105612. * Initializes the Hinge2-Joint
  105613. * @param jointData The joint data for the Hinge2-Joint
  105614. */
  105615. constructor(jointData: PhysicsJointData);
  105616. /**
  105617. * Set the motor values.
  105618. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105619. * @param {number} targetSpeed the speed the motor is to reach
  105620. * @param {number} maxForce max force for this motor.
  105621. * @param {motorIndex} the motor's index, 0 or 1.
  105622. */
  105623. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  105624. /**
  105625. * Set the motor limits.
  105626. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105627. * @param {number} upperLimit the upper limit
  105628. * @param {number} lowerLimit lower limit
  105629. * @param {motorIndex} the motor's index, 0 or 1.
  105630. */
  105631. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105632. }
  105633. /**
  105634. * Interface for a motor enabled joint
  105635. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105636. */
  105637. export interface IMotorEnabledJoint {
  105638. /**
  105639. * Physics joint
  105640. */
  105641. physicsJoint: any;
  105642. /**
  105643. * Sets the motor of the motor-enabled joint
  105644. * @param force The force of the motor
  105645. * @param maxForce The maximum force of the motor
  105646. * @param motorIndex The index of the motor
  105647. */
  105648. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  105649. /**
  105650. * Sets the limit of the motor
  105651. * @param upperLimit The upper limit of the motor
  105652. * @param lowerLimit The lower limit of the motor
  105653. * @param motorIndex The index of the motor
  105654. */
  105655. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105656. }
  105657. /**
  105658. * Joint data for a Distance-Joint
  105659. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105660. */
  105661. export interface DistanceJointData extends PhysicsJointData {
  105662. /**
  105663. * Max distance the 2 joint objects can be apart
  105664. */
  105665. maxDistance: number;
  105666. }
  105667. /**
  105668. * Joint data from a spring joint
  105669. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105670. */
  105671. export interface SpringJointData extends PhysicsJointData {
  105672. /**
  105673. * Length of the spring
  105674. */
  105675. length: number;
  105676. /**
  105677. * Stiffness of the spring
  105678. */
  105679. stiffness: number;
  105680. /**
  105681. * Damping of the spring
  105682. */
  105683. damping: number;
  105684. /** this callback will be called when applying the force to the impostors. */
  105685. forceApplicationCallback: () => void;
  105686. }
  105687. }
  105688. declare module BABYLON {
  105689. /**
  105690. * Holds the data for the raycast result
  105691. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105692. */
  105693. export class PhysicsRaycastResult {
  105694. private _hasHit;
  105695. private _hitDistance;
  105696. private _hitNormalWorld;
  105697. private _hitPointWorld;
  105698. private _rayFromWorld;
  105699. private _rayToWorld;
  105700. /**
  105701. * Gets if there was a hit
  105702. */
  105703. get hasHit(): boolean;
  105704. /**
  105705. * Gets the distance from the hit
  105706. */
  105707. get hitDistance(): number;
  105708. /**
  105709. * Gets the hit normal/direction in the world
  105710. */
  105711. get hitNormalWorld(): Vector3;
  105712. /**
  105713. * Gets the hit point in the world
  105714. */
  105715. get hitPointWorld(): Vector3;
  105716. /**
  105717. * Gets the ray "start point" of the ray in the world
  105718. */
  105719. get rayFromWorld(): Vector3;
  105720. /**
  105721. * Gets the ray "end point" of the ray in the world
  105722. */
  105723. get rayToWorld(): Vector3;
  105724. /**
  105725. * Sets the hit data (normal & point in world space)
  105726. * @param hitNormalWorld defines the normal in world space
  105727. * @param hitPointWorld defines the point in world space
  105728. */
  105729. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  105730. /**
  105731. * Sets the distance from the start point to the hit point
  105732. * @param distance
  105733. */
  105734. setHitDistance(distance: number): void;
  105735. /**
  105736. * Calculates the distance manually
  105737. */
  105738. calculateHitDistance(): void;
  105739. /**
  105740. * Resets all the values to default
  105741. * @param from The from point on world space
  105742. * @param to The to point on world space
  105743. */
  105744. reset(from?: Vector3, to?: Vector3): void;
  105745. }
  105746. /**
  105747. * Interface for the size containing width and height
  105748. */
  105749. interface IXYZ {
  105750. /**
  105751. * X
  105752. */
  105753. x: number;
  105754. /**
  105755. * Y
  105756. */
  105757. y: number;
  105758. /**
  105759. * Z
  105760. */
  105761. z: number;
  105762. }
  105763. }
  105764. declare module BABYLON {
  105765. /**
  105766. * Interface used to describe a physics joint
  105767. */
  105768. export interface PhysicsImpostorJoint {
  105769. /** Defines the main impostor to which the joint is linked */
  105770. mainImpostor: PhysicsImpostor;
  105771. /** Defines the impostor that is connected to the main impostor using this joint */
  105772. connectedImpostor: PhysicsImpostor;
  105773. /** Defines the joint itself */
  105774. joint: PhysicsJoint;
  105775. }
  105776. /** @hidden */
  105777. export interface IPhysicsEnginePlugin {
  105778. world: any;
  105779. name: string;
  105780. setGravity(gravity: Vector3): void;
  105781. setTimeStep(timeStep: number): void;
  105782. getTimeStep(): number;
  105783. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  105784. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  105785. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  105786. generatePhysicsBody(impostor: PhysicsImpostor): void;
  105787. removePhysicsBody(impostor: PhysicsImpostor): void;
  105788. generateJoint(joint: PhysicsImpostorJoint): void;
  105789. removeJoint(joint: PhysicsImpostorJoint): void;
  105790. isSupported(): boolean;
  105791. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  105792. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  105793. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  105794. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  105795. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  105796. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  105797. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  105798. getBodyMass(impostor: PhysicsImpostor): number;
  105799. getBodyFriction(impostor: PhysicsImpostor): number;
  105800. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  105801. getBodyRestitution(impostor: PhysicsImpostor): number;
  105802. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  105803. getBodyPressure?(impostor: PhysicsImpostor): number;
  105804. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  105805. getBodyStiffness?(impostor: PhysicsImpostor): number;
  105806. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  105807. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  105808. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  105809. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  105810. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  105811. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  105812. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  105813. sleepBody(impostor: PhysicsImpostor): void;
  105814. wakeUpBody(impostor: PhysicsImpostor): void;
  105815. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  105816. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  105817. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  105818. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105819. getRadius(impostor: PhysicsImpostor): number;
  105820. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  105821. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  105822. dispose(): void;
  105823. }
  105824. /**
  105825. * Interface used to define a physics engine
  105826. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105827. */
  105828. export interface IPhysicsEngine {
  105829. /**
  105830. * Gets the gravity vector used by the simulation
  105831. */
  105832. gravity: Vector3;
  105833. /**
  105834. * Sets the gravity vector used by the simulation
  105835. * @param gravity defines the gravity vector to use
  105836. */
  105837. setGravity(gravity: Vector3): void;
  105838. /**
  105839. * Set the time step of the physics engine.
  105840. * Default is 1/60.
  105841. * To slow it down, enter 1/600 for example.
  105842. * To speed it up, 1/30
  105843. * @param newTimeStep the new timestep to apply to this world.
  105844. */
  105845. setTimeStep(newTimeStep: number): void;
  105846. /**
  105847. * Get the time step of the physics engine.
  105848. * @returns the current time step
  105849. */
  105850. getTimeStep(): number;
  105851. /**
  105852. * Set the sub time step of the physics engine.
  105853. * Default is 0 meaning there is no sub steps
  105854. * To increase physics resolution precision, set a small value (like 1 ms)
  105855. * @param subTimeStep defines the new sub timestep used for physics resolution.
  105856. */
  105857. setSubTimeStep(subTimeStep: number): void;
  105858. /**
  105859. * Get the sub time step of the physics engine.
  105860. * @returns the current sub time step
  105861. */
  105862. getSubTimeStep(): number;
  105863. /**
  105864. * Release all resources
  105865. */
  105866. dispose(): void;
  105867. /**
  105868. * Gets the name of the current physics plugin
  105869. * @returns the name of the plugin
  105870. */
  105871. getPhysicsPluginName(): string;
  105872. /**
  105873. * Adding a new impostor for the impostor tracking.
  105874. * This will be done by the impostor itself.
  105875. * @param impostor the impostor to add
  105876. */
  105877. addImpostor(impostor: PhysicsImpostor): void;
  105878. /**
  105879. * Remove an impostor from the engine.
  105880. * This impostor and its mesh will not longer be updated by the physics engine.
  105881. * @param impostor the impostor to remove
  105882. */
  105883. removeImpostor(impostor: PhysicsImpostor): void;
  105884. /**
  105885. * Add a joint to the physics engine
  105886. * @param mainImpostor defines the main impostor to which the joint is added.
  105887. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  105888. * @param joint defines the joint that will connect both impostors.
  105889. */
  105890. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  105891. /**
  105892. * Removes a joint from the simulation
  105893. * @param mainImpostor defines the impostor used with the joint
  105894. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  105895. * @param joint defines the joint to remove
  105896. */
  105897. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  105898. /**
  105899. * Gets the current plugin used to run the simulation
  105900. * @returns current plugin
  105901. */
  105902. getPhysicsPlugin(): IPhysicsEnginePlugin;
  105903. /**
  105904. * Gets the list of physic impostors
  105905. * @returns an array of PhysicsImpostor
  105906. */
  105907. getImpostors(): Array<PhysicsImpostor>;
  105908. /**
  105909. * Gets the impostor for a physics enabled object
  105910. * @param object defines the object impersonated by the impostor
  105911. * @returns the PhysicsImpostor or null if not found
  105912. */
  105913. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  105914. /**
  105915. * Gets the impostor for a physics body object
  105916. * @param body defines physics body used by the impostor
  105917. * @returns the PhysicsImpostor or null if not found
  105918. */
  105919. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  105920. /**
  105921. * Does a raycast in the physics world
  105922. * @param from when should the ray start?
  105923. * @param to when should the ray end?
  105924. * @returns PhysicsRaycastResult
  105925. */
  105926. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  105927. /**
  105928. * Called by the scene. No need to call it.
  105929. * @param delta defines the timespam between frames
  105930. */
  105931. _step(delta: number): void;
  105932. }
  105933. }
  105934. declare module BABYLON {
  105935. /**
  105936. * The interface for the physics imposter parameters
  105937. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105938. */
  105939. export interface PhysicsImpostorParameters {
  105940. /**
  105941. * The mass of the physics imposter
  105942. */
  105943. mass: number;
  105944. /**
  105945. * The friction of the physics imposter
  105946. */
  105947. friction?: number;
  105948. /**
  105949. * The coefficient of restitution of the physics imposter
  105950. */
  105951. restitution?: number;
  105952. /**
  105953. * The native options of the physics imposter
  105954. */
  105955. nativeOptions?: any;
  105956. /**
  105957. * Specifies if the parent should be ignored
  105958. */
  105959. ignoreParent?: boolean;
  105960. /**
  105961. * Specifies if bi-directional transformations should be disabled
  105962. */
  105963. disableBidirectionalTransformation?: boolean;
  105964. /**
  105965. * The pressure inside the physics imposter, soft object only
  105966. */
  105967. pressure?: number;
  105968. /**
  105969. * The stiffness the physics imposter, soft object only
  105970. */
  105971. stiffness?: number;
  105972. /**
  105973. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  105974. */
  105975. velocityIterations?: number;
  105976. /**
  105977. * The number of iterations used in maintaining consistent vertex positions, soft object only
  105978. */
  105979. positionIterations?: number;
  105980. /**
  105981. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  105982. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  105983. * Add to fix multiple points
  105984. */
  105985. fixedPoints?: number;
  105986. /**
  105987. * The collision margin around a soft object
  105988. */
  105989. margin?: number;
  105990. /**
  105991. * The collision margin around a soft object
  105992. */
  105993. damping?: number;
  105994. /**
  105995. * The path for a rope based on an extrusion
  105996. */
  105997. path?: any;
  105998. /**
  105999. * The shape of an extrusion used for a rope based on an extrusion
  106000. */
  106001. shape?: any;
  106002. }
  106003. /**
  106004. * Interface for a physics-enabled object
  106005. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106006. */
  106007. export interface IPhysicsEnabledObject {
  106008. /**
  106009. * The position of the physics-enabled object
  106010. */
  106011. position: Vector3;
  106012. /**
  106013. * The rotation of the physics-enabled object
  106014. */
  106015. rotationQuaternion: Nullable<Quaternion>;
  106016. /**
  106017. * The scale of the physics-enabled object
  106018. */
  106019. scaling: Vector3;
  106020. /**
  106021. * The rotation of the physics-enabled object
  106022. */
  106023. rotation?: Vector3;
  106024. /**
  106025. * The parent of the physics-enabled object
  106026. */
  106027. parent?: any;
  106028. /**
  106029. * The bounding info of the physics-enabled object
  106030. * @returns The bounding info of the physics-enabled object
  106031. */
  106032. getBoundingInfo(): BoundingInfo;
  106033. /**
  106034. * Computes the world matrix
  106035. * @param force Specifies if the world matrix should be computed by force
  106036. * @returns A world matrix
  106037. */
  106038. computeWorldMatrix(force: boolean): Matrix;
  106039. /**
  106040. * Gets the world matrix
  106041. * @returns A world matrix
  106042. */
  106043. getWorldMatrix?(): Matrix;
  106044. /**
  106045. * Gets the child meshes
  106046. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  106047. * @returns An array of abstract meshes
  106048. */
  106049. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  106050. /**
  106051. * Gets the vertex data
  106052. * @param kind The type of vertex data
  106053. * @returns A nullable array of numbers, or a float32 array
  106054. */
  106055. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  106056. /**
  106057. * Gets the indices from the mesh
  106058. * @returns A nullable array of index arrays
  106059. */
  106060. getIndices?(): Nullable<IndicesArray>;
  106061. /**
  106062. * Gets the scene from the mesh
  106063. * @returns the indices array or null
  106064. */
  106065. getScene?(): Scene;
  106066. /**
  106067. * Gets the absolute position from the mesh
  106068. * @returns the absolute position
  106069. */
  106070. getAbsolutePosition(): Vector3;
  106071. /**
  106072. * Gets the absolute pivot point from the mesh
  106073. * @returns the absolute pivot point
  106074. */
  106075. getAbsolutePivotPoint(): Vector3;
  106076. /**
  106077. * Rotates the mesh
  106078. * @param axis The axis of rotation
  106079. * @param amount The amount of rotation
  106080. * @param space The space of the rotation
  106081. * @returns The rotation transform node
  106082. */
  106083. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  106084. /**
  106085. * Translates the mesh
  106086. * @param axis The axis of translation
  106087. * @param distance The distance of translation
  106088. * @param space The space of the translation
  106089. * @returns The transform node
  106090. */
  106091. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  106092. /**
  106093. * Sets the absolute position of the mesh
  106094. * @param absolutePosition The absolute position of the mesh
  106095. * @returns The transform node
  106096. */
  106097. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  106098. /**
  106099. * Gets the class name of the mesh
  106100. * @returns The class name
  106101. */
  106102. getClassName(): string;
  106103. }
  106104. /**
  106105. * Represents a physics imposter
  106106. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106107. */
  106108. export class PhysicsImpostor {
  106109. /**
  106110. * The physics-enabled object used as the physics imposter
  106111. */
  106112. object: IPhysicsEnabledObject;
  106113. /**
  106114. * The type of the physics imposter
  106115. */
  106116. type: number;
  106117. private _options;
  106118. private _scene?;
  106119. /**
  106120. * The default object size of the imposter
  106121. */
  106122. static DEFAULT_OBJECT_SIZE: Vector3;
  106123. /**
  106124. * The identity quaternion of the imposter
  106125. */
  106126. static IDENTITY_QUATERNION: Quaternion;
  106127. /** @hidden */
  106128. _pluginData: any;
  106129. private _physicsEngine;
  106130. private _physicsBody;
  106131. private _bodyUpdateRequired;
  106132. private _onBeforePhysicsStepCallbacks;
  106133. private _onAfterPhysicsStepCallbacks;
  106134. /** @hidden */
  106135. _onPhysicsCollideCallbacks: Array<{
  106136. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  106137. otherImpostors: Array<PhysicsImpostor>;
  106138. }>;
  106139. private _deltaPosition;
  106140. private _deltaRotation;
  106141. private _deltaRotationConjugated;
  106142. /** @hidden */
  106143. _isFromLine: boolean;
  106144. private _parent;
  106145. private _isDisposed;
  106146. private static _tmpVecs;
  106147. private static _tmpQuat;
  106148. /**
  106149. * Specifies if the physics imposter is disposed
  106150. */
  106151. get isDisposed(): boolean;
  106152. /**
  106153. * Gets the mass of the physics imposter
  106154. */
  106155. get mass(): number;
  106156. set mass(value: number);
  106157. /**
  106158. * Gets the coefficient of friction
  106159. */
  106160. get friction(): number;
  106161. /**
  106162. * Sets the coefficient of friction
  106163. */
  106164. set friction(value: number);
  106165. /**
  106166. * Gets the coefficient of restitution
  106167. */
  106168. get restitution(): number;
  106169. /**
  106170. * Sets the coefficient of restitution
  106171. */
  106172. set restitution(value: number);
  106173. /**
  106174. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  106175. */
  106176. get pressure(): number;
  106177. /**
  106178. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  106179. */
  106180. set pressure(value: number);
  106181. /**
  106182. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  106183. */
  106184. get stiffness(): number;
  106185. /**
  106186. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  106187. */
  106188. set stiffness(value: number);
  106189. /**
  106190. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  106191. */
  106192. get velocityIterations(): number;
  106193. /**
  106194. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  106195. */
  106196. set velocityIterations(value: number);
  106197. /**
  106198. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  106199. */
  106200. get positionIterations(): number;
  106201. /**
  106202. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  106203. */
  106204. set positionIterations(value: number);
  106205. /**
  106206. * The unique id of the physics imposter
  106207. * set by the physics engine when adding this impostor to the array
  106208. */
  106209. uniqueId: number;
  106210. /**
  106211. * @hidden
  106212. */
  106213. soft: boolean;
  106214. /**
  106215. * @hidden
  106216. */
  106217. segments: number;
  106218. private _joints;
  106219. /**
  106220. * Initializes the physics imposter
  106221. * @param object The physics-enabled object used as the physics imposter
  106222. * @param type The type of the physics imposter
  106223. * @param _options The options for the physics imposter
  106224. * @param _scene The Babylon scene
  106225. */
  106226. constructor(
  106227. /**
  106228. * The physics-enabled object used as the physics imposter
  106229. */
  106230. object: IPhysicsEnabledObject,
  106231. /**
  106232. * The type of the physics imposter
  106233. */
  106234. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  106235. /**
  106236. * This function will completly initialize this impostor.
  106237. * It will create a new body - but only if this mesh has no parent.
  106238. * If it has, this impostor will not be used other than to define the impostor
  106239. * of the child mesh.
  106240. * @hidden
  106241. */
  106242. _init(): void;
  106243. private _getPhysicsParent;
  106244. /**
  106245. * Should a new body be generated.
  106246. * @returns boolean specifying if body initialization is required
  106247. */
  106248. isBodyInitRequired(): boolean;
  106249. /**
  106250. * Sets the updated scaling
  106251. * @param updated Specifies if the scaling is updated
  106252. */
  106253. setScalingUpdated(): void;
  106254. /**
  106255. * Force a regeneration of this or the parent's impostor's body.
  106256. * Use under cautious - This will remove all joints already implemented.
  106257. */
  106258. forceUpdate(): void;
  106259. /**
  106260. * Gets the body that holds this impostor. Either its own, or its parent.
  106261. */
  106262. get physicsBody(): any;
  106263. /**
  106264. * Get the parent of the physics imposter
  106265. * @returns Physics imposter or null
  106266. */
  106267. get parent(): Nullable<PhysicsImpostor>;
  106268. /**
  106269. * Sets the parent of the physics imposter
  106270. */
  106271. set parent(value: Nullable<PhysicsImpostor>);
  106272. /**
  106273. * Set the physics body. Used mainly by the physics engine/plugin
  106274. */
  106275. set physicsBody(physicsBody: any);
  106276. /**
  106277. * Resets the update flags
  106278. */
  106279. resetUpdateFlags(): void;
  106280. /**
  106281. * Gets the object extend size
  106282. * @returns the object extend size
  106283. */
  106284. getObjectExtendSize(): Vector3;
  106285. /**
  106286. * Gets the object center
  106287. * @returns The object center
  106288. */
  106289. getObjectCenter(): Vector3;
  106290. /**
  106291. * Get a specific parameter from the options parameters
  106292. * @param paramName The object parameter name
  106293. * @returns The object parameter
  106294. */
  106295. getParam(paramName: string): any;
  106296. /**
  106297. * Sets a specific parameter in the options given to the physics plugin
  106298. * @param paramName The parameter name
  106299. * @param value The value of the parameter
  106300. */
  106301. setParam(paramName: string, value: number): void;
  106302. /**
  106303. * Specifically change the body's mass option. Won't recreate the physics body object
  106304. * @param mass The mass of the physics imposter
  106305. */
  106306. setMass(mass: number): void;
  106307. /**
  106308. * Gets the linear velocity
  106309. * @returns linear velocity or null
  106310. */
  106311. getLinearVelocity(): Nullable<Vector3>;
  106312. /**
  106313. * Sets the linear velocity
  106314. * @param velocity linear velocity or null
  106315. */
  106316. setLinearVelocity(velocity: Nullable<Vector3>): void;
  106317. /**
  106318. * Gets the angular velocity
  106319. * @returns angular velocity or null
  106320. */
  106321. getAngularVelocity(): Nullable<Vector3>;
  106322. /**
  106323. * Sets the angular velocity
  106324. * @param velocity The velocity or null
  106325. */
  106326. setAngularVelocity(velocity: Nullable<Vector3>): void;
  106327. /**
  106328. * Execute a function with the physics plugin native code
  106329. * Provide a function the will have two variables - the world object and the physics body object
  106330. * @param func The function to execute with the physics plugin native code
  106331. */
  106332. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  106333. /**
  106334. * Register a function that will be executed before the physics world is stepping forward
  106335. * @param func The function to execute before the physics world is stepped forward
  106336. */
  106337. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106338. /**
  106339. * Unregister a function that will be executed before the physics world is stepping forward
  106340. * @param func The function to execute before the physics world is stepped forward
  106341. */
  106342. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106343. /**
  106344. * Register a function that will be executed after the physics step
  106345. * @param func The function to execute after physics step
  106346. */
  106347. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106348. /**
  106349. * Unregisters a function that will be executed after the physics step
  106350. * @param func The function to execute after physics step
  106351. */
  106352. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106353. /**
  106354. * register a function that will be executed when this impostor collides against a different body
  106355. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  106356. * @param func Callback that is executed on collision
  106357. */
  106358. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  106359. /**
  106360. * Unregisters the physics imposter on contact
  106361. * @param collideAgainst The physics object to collide against
  106362. * @param func Callback to execute on collision
  106363. */
  106364. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  106365. private _tmpQuat;
  106366. private _tmpQuat2;
  106367. /**
  106368. * Get the parent rotation
  106369. * @returns The parent rotation
  106370. */
  106371. getParentsRotation(): Quaternion;
  106372. /**
  106373. * this function is executed by the physics engine.
  106374. */
  106375. beforeStep: () => void;
  106376. /**
  106377. * this function is executed by the physics engine
  106378. */
  106379. afterStep: () => void;
  106380. /**
  106381. * Legacy collision detection event support
  106382. */
  106383. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  106384. /**
  106385. * event and body object due to cannon's event-based architecture.
  106386. */
  106387. onCollide: (e: {
  106388. body: any;
  106389. }) => void;
  106390. /**
  106391. * Apply a force
  106392. * @param force The force to apply
  106393. * @param contactPoint The contact point for the force
  106394. * @returns The physics imposter
  106395. */
  106396. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  106397. /**
  106398. * Apply an impulse
  106399. * @param force The impulse force
  106400. * @param contactPoint The contact point for the impulse force
  106401. * @returns The physics imposter
  106402. */
  106403. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  106404. /**
  106405. * A help function to create a joint
  106406. * @param otherImpostor A physics imposter used to create a joint
  106407. * @param jointType The type of joint
  106408. * @param jointData The data for the joint
  106409. * @returns The physics imposter
  106410. */
  106411. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  106412. /**
  106413. * Add a joint to this impostor with a different impostor
  106414. * @param otherImpostor A physics imposter used to add a joint
  106415. * @param joint The joint to add
  106416. * @returns The physics imposter
  106417. */
  106418. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  106419. /**
  106420. * Add an anchor to a cloth impostor
  106421. * @param otherImpostor rigid impostor to anchor to
  106422. * @param width ratio across width from 0 to 1
  106423. * @param height ratio up height from 0 to 1
  106424. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  106425. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  106426. * @returns impostor the soft imposter
  106427. */
  106428. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  106429. /**
  106430. * Add a hook to a rope impostor
  106431. * @param otherImpostor rigid impostor to anchor to
  106432. * @param length ratio across rope from 0 to 1
  106433. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  106434. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  106435. * @returns impostor the rope imposter
  106436. */
  106437. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  106438. /**
  106439. * Will keep this body still, in a sleep mode.
  106440. * @returns the physics imposter
  106441. */
  106442. sleep(): PhysicsImpostor;
  106443. /**
  106444. * Wake the body up.
  106445. * @returns The physics imposter
  106446. */
  106447. wakeUp(): PhysicsImpostor;
  106448. /**
  106449. * Clones the physics imposter
  106450. * @param newObject The physics imposter clones to this physics-enabled object
  106451. * @returns A nullable physics imposter
  106452. */
  106453. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  106454. /**
  106455. * Disposes the physics imposter
  106456. */
  106457. dispose(): void;
  106458. /**
  106459. * Sets the delta position
  106460. * @param position The delta position amount
  106461. */
  106462. setDeltaPosition(position: Vector3): void;
  106463. /**
  106464. * Sets the delta rotation
  106465. * @param rotation The delta rotation amount
  106466. */
  106467. setDeltaRotation(rotation: Quaternion): void;
  106468. /**
  106469. * Gets the box size of the physics imposter and stores the result in the input parameter
  106470. * @param result Stores the box size
  106471. * @returns The physics imposter
  106472. */
  106473. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  106474. /**
  106475. * Gets the radius of the physics imposter
  106476. * @returns Radius of the physics imposter
  106477. */
  106478. getRadius(): number;
  106479. /**
  106480. * Sync a bone with this impostor
  106481. * @param bone The bone to sync to the impostor.
  106482. * @param boneMesh The mesh that the bone is influencing.
  106483. * @param jointPivot The pivot of the joint / bone in local space.
  106484. * @param distToJoint Optional distance from the impostor to the joint.
  106485. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  106486. */
  106487. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  106488. /**
  106489. * Sync impostor to a bone
  106490. * @param bone The bone that the impostor will be synced to.
  106491. * @param boneMesh The mesh that the bone is influencing.
  106492. * @param jointPivot The pivot of the joint / bone in local space.
  106493. * @param distToJoint Optional distance from the impostor to the joint.
  106494. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  106495. * @param boneAxis Optional vector3 axis the bone is aligned with
  106496. */
  106497. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  106498. /**
  106499. * No-Imposter type
  106500. */
  106501. static NoImpostor: number;
  106502. /**
  106503. * Sphere-Imposter type
  106504. */
  106505. static SphereImpostor: number;
  106506. /**
  106507. * Box-Imposter type
  106508. */
  106509. static BoxImpostor: number;
  106510. /**
  106511. * Plane-Imposter type
  106512. */
  106513. static PlaneImpostor: number;
  106514. /**
  106515. * Mesh-imposter type
  106516. */
  106517. static MeshImpostor: number;
  106518. /**
  106519. * Capsule-Impostor type (Ammo.js plugin only)
  106520. */
  106521. static CapsuleImpostor: number;
  106522. /**
  106523. * Cylinder-Imposter type
  106524. */
  106525. static CylinderImpostor: number;
  106526. /**
  106527. * Particle-Imposter type
  106528. */
  106529. static ParticleImpostor: number;
  106530. /**
  106531. * Heightmap-Imposter type
  106532. */
  106533. static HeightmapImpostor: number;
  106534. /**
  106535. * ConvexHull-Impostor type (Ammo.js plugin only)
  106536. */
  106537. static ConvexHullImpostor: number;
  106538. /**
  106539. * Custom-Imposter type (Ammo.js plugin only)
  106540. */
  106541. static CustomImpostor: number;
  106542. /**
  106543. * Rope-Imposter type
  106544. */
  106545. static RopeImpostor: number;
  106546. /**
  106547. * Cloth-Imposter type
  106548. */
  106549. static ClothImpostor: number;
  106550. /**
  106551. * Softbody-Imposter type
  106552. */
  106553. static SoftbodyImpostor: number;
  106554. }
  106555. }
  106556. declare module BABYLON {
  106557. /**
  106558. * @hidden
  106559. **/
  106560. export class _CreationDataStorage {
  106561. closePath?: boolean;
  106562. closeArray?: boolean;
  106563. idx: number[];
  106564. dashSize: number;
  106565. gapSize: number;
  106566. path3D: Path3D;
  106567. pathArray: Vector3[][];
  106568. arc: number;
  106569. radius: number;
  106570. cap: number;
  106571. tessellation: number;
  106572. }
  106573. /**
  106574. * @hidden
  106575. **/
  106576. class _InstanceDataStorage {
  106577. visibleInstances: any;
  106578. batchCache: _InstancesBatch;
  106579. instancesBufferSize: number;
  106580. instancesBuffer: Nullable<Buffer>;
  106581. instancesData: Float32Array;
  106582. overridenInstanceCount: number;
  106583. isFrozen: boolean;
  106584. previousBatch: Nullable<_InstancesBatch>;
  106585. hardwareInstancedRendering: boolean;
  106586. sideOrientation: number;
  106587. manualUpdate: boolean;
  106588. }
  106589. /**
  106590. * @hidden
  106591. **/
  106592. export class _InstancesBatch {
  106593. mustReturn: boolean;
  106594. visibleInstances: Nullable<InstancedMesh[]>[];
  106595. renderSelf: boolean[];
  106596. hardwareInstancedRendering: boolean[];
  106597. }
  106598. /**
  106599. * @hidden
  106600. **/
  106601. class _ThinInstanceDataStorage {
  106602. instancesCount: number;
  106603. matrixBuffer: Nullable<Buffer>;
  106604. matrixBufferSize: number;
  106605. matrixData: Nullable<Float32Array>;
  106606. boundingVectors: Array<Vector3>;
  106607. }
  106608. /**
  106609. * Class used to represent renderable models
  106610. */
  106611. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  106612. /**
  106613. * Mesh side orientation : usually the external or front surface
  106614. */
  106615. static readonly FRONTSIDE: number;
  106616. /**
  106617. * Mesh side orientation : usually the internal or back surface
  106618. */
  106619. static readonly BACKSIDE: number;
  106620. /**
  106621. * Mesh side orientation : both internal and external or front and back surfaces
  106622. */
  106623. static readonly DOUBLESIDE: number;
  106624. /**
  106625. * Mesh side orientation : by default, `FRONTSIDE`
  106626. */
  106627. static readonly DEFAULTSIDE: number;
  106628. /**
  106629. * Mesh cap setting : no cap
  106630. */
  106631. static readonly NO_CAP: number;
  106632. /**
  106633. * Mesh cap setting : one cap at the beginning of the mesh
  106634. */
  106635. static readonly CAP_START: number;
  106636. /**
  106637. * Mesh cap setting : one cap at the end of the mesh
  106638. */
  106639. static readonly CAP_END: number;
  106640. /**
  106641. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  106642. */
  106643. static readonly CAP_ALL: number;
  106644. /**
  106645. * Mesh pattern setting : no flip or rotate
  106646. */
  106647. static readonly NO_FLIP: number;
  106648. /**
  106649. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  106650. */
  106651. static readonly FLIP_TILE: number;
  106652. /**
  106653. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  106654. */
  106655. static readonly ROTATE_TILE: number;
  106656. /**
  106657. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  106658. */
  106659. static readonly FLIP_ROW: number;
  106660. /**
  106661. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  106662. */
  106663. static readonly ROTATE_ROW: number;
  106664. /**
  106665. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  106666. */
  106667. static readonly FLIP_N_ROTATE_TILE: number;
  106668. /**
  106669. * Mesh pattern setting : rotate pattern and rotate
  106670. */
  106671. static readonly FLIP_N_ROTATE_ROW: number;
  106672. /**
  106673. * Mesh tile positioning : part tiles same on left/right or top/bottom
  106674. */
  106675. static readonly CENTER: number;
  106676. /**
  106677. * Mesh tile positioning : part tiles on left
  106678. */
  106679. static readonly LEFT: number;
  106680. /**
  106681. * Mesh tile positioning : part tiles on right
  106682. */
  106683. static readonly RIGHT: number;
  106684. /**
  106685. * Mesh tile positioning : part tiles on top
  106686. */
  106687. static readonly TOP: number;
  106688. /**
  106689. * Mesh tile positioning : part tiles on bottom
  106690. */
  106691. static readonly BOTTOM: number;
  106692. /**
  106693. * Gets the default side orientation.
  106694. * @param orientation the orientation to value to attempt to get
  106695. * @returns the default orientation
  106696. * @hidden
  106697. */
  106698. static _GetDefaultSideOrientation(orientation?: number): number;
  106699. private _internalMeshDataInfo;
  106700. get computeBonesUsingShaders(): boolean;
  106701. set computeBonesUsingShaders(value: boolean);
  106702. /**
  106703. * An event triggered before rendering the mesh
  106704. */
  106705. get onBeforeRenderObservable(): Observable<Mesh>;
  106706. /**
  106707. * An event triggered before binding the mesh
  106708. */
  106709. get onBeforeBindObservable(): Observable<Mesh>;
  106710. /**
  106711. * An event triggered after rendering the mesh
  106712. */
  106713. get onAfterRenderObservable(): Observable<Mesh>;
  106714. /**
  106715. * An event triggered before drawing the mesh
  106716. */
  106717. get onBeforeDrawObservable(): Observable<Mesh>;
  106718. private _onBeforeDrawObserver;
  106719. /**
  106720. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  106721. */
  106722. set onBeforeDraw(callback: () => void);
  106723. get hasInstances(): boolean;
  106724. get hasThinInstances(): boolean;
  106725. /**
  106726. * Gets the delay loading state of the mesh (when delay loading is turned on)
  106727. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  106728. */
  106729. delayLoadState: number;
  106730. /**
  106731. * Gets the list of instances created from this mesh
  106732. * it is not supposed to be modified manually.
  106733. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  106734. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  106735. */
  106736. instances: InstancedMesh[];
  106737. /**
  106738. * Gets the file containing delay loading data for this mesh
  106739. */
  106740. delayLoadingFile: string;
  106741. /** @hidden */
  106742. _binaryInfo: any;
  106743. /**
  106744. * User defined function used to change how LOD level selection is done
  106745. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106746. */
  106747. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  106748. /**
  106749. * Gets or sets the morph target manager
  106750. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106751. */
  106752. get morphTargetManager(): Nullable<MorphTargetManager>;
  106753. set morphTargetManager(value: Nullable<MorphTargetManager>);
  106754. /** @hidden */
  106755. _creationDataStorage: Nullable<_CreationDataStorage>;
  106756. /** @hidden */
  106757. _geometry: Nullable<Geometry>;
  106758. /** @hidden */
  106759. _delayInfo: Array<string>;
  106760. /** @hidden */
  106761. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  106762. /** @hidden */
  106763. _instanceDataStorage: _InstanceDataStorage;
  106764. /** @hidden */
  106765. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  106766. private _effectiveMaterial;
  106767. /** @hidden */
  106768. _shouldGenerateFlatShading: boolean;
  106769. /** @hidden */
  106770. _originalBuilderSideOrientation: number;
  106771. /**
  106772. * Use this property to change the original side orientation defined at construction time
  106773. */
  106774. overrideMaterialSideOrientation: Nullable<number>;
  106775. /**
  106776. * Gets the source mesh (the one used to clone this one from)
  106777. */
  106778. get source(): Nullable<Mesh>;
  106779. /**
  106780. * Gets or sets a boolean indicating that this mesh does not use index buffer
  106781. */
  106782. get isUnIndexed(): boolean;
  106783. set isUnIndexed(value: boolean);
  106784. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  106785. get worldMatrixInstancedBuffer(): Float32Array;
  106786. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  106787. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  106788. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  106789. /**
  106790. * @constructor
  106791. * @param name The value used by scene.getMeshByName() to do a lookup.
  106792. * @param scene The scene to add this mesh to.
  106793. * @param parent The parent of this mesh, if it has one
  106794. * @param source An optional Mesh from which geometry is shared, cloned.
  106795. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  106796. * When false, achieved by calling a clone(), also passing False.
  106797. * This will make creation of children, recursive.
  106798. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  106799. */
  106800. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  106801. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  106802. doNotInstantiate: boolean;
  106803. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  106804. /**
  106805. * Gets the class name
  106806. * @returns the string "Mesh".
  106807. */
  106808. getClassName(): string;
  106809. /** @hidden */
  106810. get _isMesh(): boolean;
  106811. /**
  106812. * Returns a description of this mesh
  106813. * @param fullDetails define if full details about this mesh must be used
  106814. * @returns a descriptive string representing this mesh
  106815. */
  106816. toString(fullDetails?: boolean): string;
  106817. /** @hidden */
  106818. _unBindEffect(): void;
  106819. /**
  106820. * Gets a boolean indicating if this mesh has LOD
  106821. */
  106822. get hasLODLevels(): boolean;
  106823. /**
  106824. * Gets the list of MeshLODLevel associated with the current mesh
  106825. * @returns an array of MeshLODLevel
  106826. */
  106827. getLODLevels(): MeshLODLevel[];
  106828. private _sortLODLevels;
  106829. /**
  106830. * Add a mesh as LOD level triggered at the given distance.
  106831. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106832. * @param distance The distance from the center of the object to show this level
  106833. * @param mesh The mesh to be added as LOD level (can be null)
  106834. * @return This mesh (for chaining)
  106835. */
  106836. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  106837. /**
  106838. * Returns the LOD level mesh at the passed distance or null if not found.
  106839. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106840. * @param distance The distance from the center of the object to show this level
  106841. * @returns a Mesh or `null`
  106842. */
  106843. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  106844. /**
  106845. * Remove a mesh from the LOD array
  106846. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106847. * @param mesh defines the mesh to be removed
  106848. * @return This mesh (for chaining)
  106849. */
  106850. removeLODLevel(mesh: Mesh): Mesh;
  106851. /**
  106852. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  106853. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106854. * @param camera defines the camera to use to compute distance
  106855. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  106856. * @return This mesh (for chaining)
  106857. */
  106858. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  106859. /**
  106860. * Gets the mesh internal Geometry object
  106861. */
  106862. get geometry(): Nullable<Geometry>;
  106863. /**
  106864. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  106865. * @returns the total number of vertices
  106866. */
  106867. getTotalVertices(): number;
  106868. /**
  106869. * Returns the content of an associated vertex buffer
  106870. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106871. * - VertexBuffer.PositionKind
  106872. * - VertexBuffer.UVKind
  106873. * - VertexBuffer.UV2Kind
  106874. * - VertexBuffer.UV3Kind
  106875. * - VertexBuffer.UV4Kind
  106876. * - VertexBuffer.UV5Kind
  106877. * - VertexBuffer.UV6Kind
  106878. * - VertexBuffer.ColorKind
  106879. * - VertexBuffer.MatricesIndicesKind
  106880. * - VertexBuffer.MatricesIndicesExtraKind
  106881. * - VertexBuffer.MatricesWeightsKind
  106882. * - VertexBuffer.MatricesWeightsExtraKind
  106883. * @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
  106884. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  106885. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  106886. */
  106887. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106888. /**
  106889. * Returns the mesh VertexBuffer object from the requested `kind`
  106890. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106891. * - VertexBuffer.PositionKind
  106892. * - VertexBuffer.NormalKind
  106893. * - VertexBuffer.UVKind
  106894. * - VertexBuffer.UV2Kind
  106895. * - VertexBuffer.UV3Kind
  106896. * - VertexBuffer.UV4Kind
  106897. * - VertexBuffer.UV5Kind
  106898. * - VertexBuffer.UV6Kind
  106899. * - VertexBuffer.ColorKind
  106900. * - VertexBuffer.MatricesIndicesKind
  106901. * - VertexBuffer.MatricesIndicesExtraKind
  106902. * - VertexBuffer.MatricesWeightsKind
  106903. * - VertexBuffer.MatricesWeightsExtraKind
  106904. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  106905. */
  106906. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  106907. /**
  106908. * Tests if a specific vertex buffer is associated with this mesh
  106909. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  106910. * - VertexBuffer.PositionKind
  106911. * - VertexBuffer.NormalKind
  106912. * - VertexBuffer.UVKind
  106913. * - VertexBuffer.UV2Kind
  106914. * - VertexBuffer.UV3Kind
  106915. * - VertexBuffer.UV4Kind
  106916. * - VertexBuffer.UV5Kind
  106917. * - VertexBuffer.UV6Kind
  106918. * - VertexBuffer.ColorKind
  106919. * - VertexBuffer.MatricesIndicesKind
  106920. * - VertexBuffer.MatricesIndicesExtraKind
  106921. * - VertexBuffer.MatricesWeightsKind
  106922. * - VertexBuffer.MatricesWeightsExtraKind
  106923. * @returns a boolean
  106924. */
  106925. isVerticesDataPresent(kind: string): boolean;
  106926. /**
  106927. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  106928. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  106929. * - VertexBuffer.PositionKind
  106930. * - VertexBuffer.UVKind
  106931. * - VertexBuffer.UV2Kind
  106932. * - VertexBuffer.UV3Kind
  106933. * - VertexBuffer.UV4Kind
  106934. * - VertexBuffer.UV5Kind
  106935. * - VertexBuffer.UV6Kind
  106936. * - VertexBuffer.ColorKind
  106937. * - VertexBuffer.MatricesIndicesKind
  106938. * - VertexBuffer.MatricesIndicesExtraKind
  106939. * - VertexBuffer.MatricesWeightsKind
  106940. * - VertexBuffer.MatricesWeightsExtraKind
  106941. * @returns a boolean
  106942. */
  106943. isVertexBufferUpdatable(kind: string): boolean;
  106944. /**
  106945. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  106946. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106947. * - VertexBuffer.PositionKind
  106948. * - VertexBuffer.NormalKind
  106949. * - VertexBuffer.UVKind
  106950. * - VertexBuffer.UV2Kind
  106951. * - VertexBuffer.UV3Kind
  106952. * - VertexBuffer.UV4Kind
  106953. * - VertexBuffer.UV5Kind
  106954. * - VertexBuffer.UV6Kind
  106955. * - VertexBuffer.ColorKind
  106956. * - VertexBuffer.MatricesIndicesKind
  106957. * - VertexBuffer.MatricesIndicesExtraKind
  106958. * - VertexBuffer.MatricesWeightsKind
  106959. * - VertexBuffer.MatricesWeightsExtraKind
  106960. * @returns an array of strings
  106961. */
  106962. getVerticesDataKinds(): string[];
  106963. /**
  106964. * Returns a positive integer : the total number of indices in this mesh geometry.
  106965. * @returns the numner of indices or zero if the mesh has no geometry.
  106966. */
  106967. getTotalIndices(): number;
  106968. /**
  106969. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  106970. * @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.
  106971. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106972. * @returns the indices array or an empty array if the mesh has no geometry
  106973. */
  106974. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106975. get isBlocked(): boolean;
  106976. /**
  106977. * Determine if the current mesh is ready to be rendered
  106978. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  106979. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  106980. * @returns true if all associated assets are ready (material, textures, shaders)
  106981. */
  106982. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  106983. /**
  106984. * 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.
  106985. */
  106986. get areNormalsFrozen(): boolean;
  106987. /**
  106988. * 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.
  106989. * @returns the current mesh
  106990. */
  106991. freezeNormals(): Mesh;
  106992. /**
  106993. * 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
  106994. * @returns the current mesh
  106995. */
  106996. unfreezeNormals(): Mesh;
  106997. /**
  106998. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  106999. */
  107000. set overridenInstanceCount(count: number);
  107001. /** @hidden */
  107002. _preActivate(): Mesh;
  107003. /** @hidden */
  107004. _preActivateForIntermediateRendering(renderId: number): Mesh;
  107005. /** @hidden */
  107006. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  107007. protected _afterComputeWorldMatrix(): void;
  107008. /** @hidden */
  107009. _postActivate(): void;
  107010. /**
  107011. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  107012. * This means the mesh underlying bounding box and sphere are recomputed.
  107013. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  107014. * @returns the current mesh
  107015. */
  107016. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  107017. /** @hidden */
  107018. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  107019. /**
  107020. * This function will subdivide the mesh into multiple submeshes
  107021. * @param count defines the expected number of submeshes
  107022. */
  107023. subdivide(count: number): void;
  107024. /**
  107025. * Copy a FloatArray into a specific associated vertex buffer
  107026. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107027. * - VertexBuffer.PositionKind
  107028. * - VertexBuffer.UVKind
  107029. * - VertexBuffer.UV2Kind
  107030. * - VertexBuffer.UV3Kind
  107031. * - VertexBuffer.UV4Kind
  107032. * - VertexBuffer.UV5Kind
  107033. * - VertexBuffer.UV6Kind
  107034. * - VertexBuffer.ColorKind
  107035. * - VertexBuffer.MatricesIndicesKind
  107036. * - VertexBuffer.MatricesIndicesExtraKind
  107037. * - VertexBuffer.MatricesWeightsKind
  107038. * - VertexBuffer.MatricesWeightsExtraKind
  107039. * @param data defines the data source
  107040. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107041. * @param stride defines the data stride size (can be null)
  107042. * @returns the current mesh
  107043. */
  107044. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  107045. /**
  107046. * Delete a vertex buffer associated with this mesh
  107047. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  107048. * - VertexBuffer.PositionKind
  107049. * - VertexBuffer.UVKind
  107050. * - VertexBuffer.UV2Kind
  107051. * - VertexBuffer.UV3Kind
  107052. * - VertexBuffer.UV4Kind
  107053. * - VertexBuffer.UV5Kind
  107054. * - VertexBuffer.UV6Kind
  107055. * - VertexBuffer.ColorKind
  107056. * - VertexBuffer.MatricesIndicesKind
  107057. * - VertexBuffer.MatricesIndicesExtraKind
  107058. * - VertexBuffer.MatricesWeightsKind
  107059. * - VertexBuffer.MatricesWeightsExtraKind
  107060. */
  107061. removeVerticesData(kind: string): void;
  107062. /**
  107063. * Flags an associated vertex buffer as updatable
  107064. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  107065. * - VertexBuffer.PositionKind
  107066. * - VertexBuffer.UVKind
  107067. * - VertexBuffer.UV2Kind
  107068. * - VertexBuffer.UV3Kind
  107069. * - VertexBuffer.UV4Kind
  107070. * - VertexBuffer.UV5Kind
  107071. * - VertexBuffer.UV6Kind
  107072. * - VertexBuffer.ColorKind
  107073. * - VertexBuffer.MatricesIndicesKind
  107074. * - VertexBuffer.MatricesIndicesExtraKind
  107075. * - VertexBuffer.MatricesWeightsKind
  107076. * - VertexBuffer.MatricesWeightsExtraKind
  107077. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107078. */
  107079. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  107080. /**
  107081. * Sets the mesh global Vertex Buffer
  107082. * @param buffer defines the buffer to use
  107083. * @returns the current mesh
  107084. */
  107085. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  107086. /**
  107087. * Update a specific associated vertex buffer
  107088. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107089. * - VertexBuffer.PositionKind
  107090. * - VertexBuffer.UVKind
  107091. * - VertexBuffer.UV2Kind
  107092. * - VertexBuffer.UV3Kind
  107093. * - VertexBuffer.UV4Kind
  107094. * - VertexBuffer.UV5Kind
  107095. * - VertexBuffer.UV6Kind
  107096. * - VertexBuffer.ColorKind
  107097. * - VertexBuffer.MatricesIndicesKind
  107098. * - VertexBuffer.MatricesIndicesExtraKind
  107099. * - VertexBuffer.MatricesWeightsKind
  107100. * - VertexBuffer.MatricesWeightsExtraKind
  107101. * @param data defines the data source
  107102. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  107103. * @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)
  107104. * @returns the current mesh
  107105. */
  107106. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  107107. /**
  107108. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  107109. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  107110. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  107111. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  107112. * @returns the current mesh
  107113. */
  107114. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  107115. /**
  107116. * Creates a un-shared specific occurence of the geometry for the mesh.
  107117. * @returns the current mesh
  107118. */
  107119. makeGeometryUnique(): Mesh;
  107120. /**
  107121. * Set the index buffer of this mesh
  107122. * @param indices defines the source data
  107123. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  107124. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  107125. * @returns the current mesh
  107126. */
  107127. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  107128. /**
  107129. * Update the current index buffer
  107130. * @param indices defines the source data
  107131. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  107132. * @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)
  107133. * @returns the current mesh
  107134. */
  107135. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  107136. /**
  107137. * Invert the geometry to move from a right handed system to a left handed one.
  107138. * @returns the current mesh
  107139. */
  107140. toLeftHanded(): Mesh;
  107141. /** @hidden */
  107142. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  107143. /** @hidden */
  107144. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  107145. /**
  107146. * Registers for this mesh a javascript function called just before the rendering process
  107147. * @param func defines the function to call before rendering this mesh
  107148. * @returns the current mesh
  107149. */
  107150. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  107151. /**
  107152. * Disposes a previously registered javascript function called before the rendering
  107153. * @param func defines the function to remove
  107154. * @returns the current mesh
  107155. */
  107156. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  107157. /**
  107158. * Registers for this mesh a javascript function called just after the rendering is complete
  107159. * @param func defines the function to call after rendering this mesh
  107160. * @returns the current mesh
  107161. */
  107162. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  107163. /**
  107164. * Disposes a previously registered javascript function called after the rendering.
  107165. * @param func defines the function to remove
  107166. * @returns the current mesh
  107167. */
  107168. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  107169. /** @hidden */
  107170. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  107171. /** @hidden */
  107172. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  107173. /** @hidden */
  107174. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  107175. /** @hidden */
  107176. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  107177. /** @hidden */
  107178. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  107179. /** @hidden */
  107180. _rebuild(): void;
  107181. /** @hidden */
  107182. _freeze(): void;
  107183. /** @hidden */
  107184. _unFreeze(): void;
  107185. /**
  107186. * 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
  107187. * @param subMesh defines the subMesh to render
  107188. * @param enableAlphaMode defines if alpha mode can be changed
  107189. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  107190. * @returns the current mesh
  107191. */
  107192. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  107193. private _onBeforeDraw;
  107194. /**
  107195. * Renormalize the mesh and patch it up if there are no weights
  107196. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  107197. * However in the case of zero weights then we set just a single influence to 1.
  107198. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  107199. */
  107200. cleanMatrixWeights(): void;
  107201. private normalizeSkinFourWeights;
  107202. private normalizeSkinWeightsAndExtra;
  107203. /**
  107204. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  107205. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  107206. * the user know there was an issue with importing the mesh
  107207. * @returns a validation object with skinned, valid and report string
  107208. */
  107209. validateSkinning(): {
  107210. skinned: boolean;
  107211. valid: boolean;
  107212. report: string;
  107213. };
  107214. /** @hidden */
  107215. _checkDelayState(): Mesh;
  107216. private _queueLoad;
  107217. /**
  107218. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  107219. * A mesh is in the frustum if its bounding box intersects the frustum
  107220. * @param frustumPlanes defines the frustum to test
  107221. * @returns true if the mesh is in the frustum planes
  107222. */
  107223. isInFrustum(frustumPlanes: Plane[]): boolean;
  107224. /**
  107225. * Sets the mesh material by the material or multiMaterial `id` property
  107226. * @param id is a string identifying the material or the multiMaterial
  107227. * @returns the current mesh
  107228. */
  107229. setMaterialByID(id: string): Mesh;
  107230. /**
  107231. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  107232. * @returns an array of IAnimatable
  107233. */
  107234. getAnimatables(): IAnimatable[];
  107235. /**
  107236. * Modifies the mesh geometry according to the passed transformation matrix.
  107237. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  107238. * The mesh normals are modified using the same transformation.
  107239. * Note that, under the hood, this method sets a new VertexBuffer each call.
  107240. * @param transform defines the transform matrix to use
  107241. * @see https://doc.babylonjs.com/resources/baking_transformations
  107242. * @returns the current mesh
  107243. */
  107244. bakeTransformIntoVertices(transform: Matrix): Mesh;
  107245. /**
  107246. * Modifies the mesh geometry according to its own current World Matrix.
  107247. * The mesh World Matrix is then reset.
  107248. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  107249. * Note that, under the hood, this method sets a new VertexBuffer each call.
  107250. * @see https://doc.babylonjs.com/resources/baking_transformations
  107251. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  107252. * @returns the current mesh
  107253. */
  107254. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  107255. /** @hidden */
  107256. get _positions(): Nullable<Vector3[]>;
  107257. /** @hidden */
  107258. _resetPointsArrayCache(): Mesh;
  107259. /** @hidden */
  107260. _generatePointsArray(): boolean;
  107261. /**
  107262. * Returns a new Mesh object generated from the current mesh properties.
  107263. * This method must not get confused with createInstance()
  107264. * @param name is a string, the name given to the new mesh
  107265. * @param newParent can be any Node object (default `null`)
  107266. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  107267. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  107268. * @returns a new mesh
  107269. */
  107270. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  107271. /**
  107272. * Releases resources associated with this mesh.
  107273. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  107274. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  107275. */
  107276. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  107277. /** @hidden */
  107278. _disposeInstanceSpecificData(): void;
  107279. /** @hidden */
  107280. _disposeThinInstanceSpecificData(): void;
  107281. /**
  107282. * Modifies the mesh geometry according to a displacement map.
  107283. * 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.
  107284. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  107285. * @param url is a string, the URL from the image file is to be downloaded.
  107286. * @param minHeight is the lower limit of the displacement.
  107287. * @param maxHeight is the upper limit of the displacement.
  107288. * @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.
  107289. * @param uvOffset is an optional vector2 used to offset UV.
  107290. * @param uvScale is an optional vector2 used to scale UV.
  107291. * @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.
  107292. * @returns the Mesh.
  107293. */
  107294. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  107295. /**
  107296. * Modifies the mesh geometry according to a displacementMap buffer.
  107297. * 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.
  107298. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  107299. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  107300. * @param heightMapWidth is the width of the buffer image.
  107301. * @param heightMapHeight is the height of the buffer image.
  107302. * @param minHeight is the lower limit of the displacement.
  107303. * @param maxHeight is the upper limit of the displacement.
  107304. * @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.
  107305. * @param uvOffset is an optional vector2 used to offset UV.
  107306. * @param uvScale is an optional vector2 used to scale UV.
  107307. * @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.
  107308. * @returns the Mesh.
  107309. */
  107310. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  107311. /**
  107312. * Modify the mesh to get a flat shading rendering.
  107313. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  107314. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  107315. * @returns current mesh
  107316. */
  107317. convertToFlatShadedMesh(): Mesh;
  107318. /**
  107319. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  107320. * In other words, more vertices, no more indices and a single bigger VBO.
  107321. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  107322. * @returns current mesh
  107323. */
  107324. convertToUnIndexedMesh(): Mesh;
  107325. /**
  107326. * Inverses facet orientations.
  107327. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107328. * @param flipNormals will also inverts the normals
  107329. * @returns current mesh
  107330. */
  107331. flipFaces(flipNormals?: boolean): Mesh;
  107332. /**
  107333. * Increase the number of facets and hence vertices in a mesh
  107334. * Vertex normals are interpolated from existing vertex normals
  107335. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107336. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  107337. */
  107338. increaseVertices(numberPerEdge: number): void;
  107339. /**
  107340. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  107341. * This will undo any application of covertToFlatShadedMesh
  107342. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107343. */
  107344. forceSharedVertices(): void;
  107345. /** @hidden */
  107346. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  107347. /** @hidden */
  107348. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  107349. /**
  107350. * Creates a new InstancedMesh object from the mesh model.
  107351. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107352. * @param name defines the name of the new instance
  107353. * @returns a new InstancedMesh
  107354. */
  107355. createInstance(name: string): InstancedMesh;
  107356. /**
  107357. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  107358. * After this call, all the mesh instances have the same submeshes than the current mesh.
  107359. * @returns the current mesh
  107360. */
  107361. synchronizeInstances(): Mesh;
  107362. /**
  107363. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  107364. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  107365. * This should be used together with the simplification to avoid disappearing triangles.
  107366. * @param successCallback an optional success callback to be called after the optimization finished.
  107367. * @returns the current mesh
  107368. */
  107369. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  107370. /**
  107371. * Serialize current mesh
  107372. * @param serializationObject defines the object which will receive the serialization data
  107373. */
  107374. serialize(serializationObject: any): void;
  107375. /** @hidden */
  107376. _syncGeometryWithMorphTargetManager(): void;
  107377. /** @hidden */
  107378. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  107379. /**
  107380. * Returns a new Mesh object parsed from the source provided.
  107381. * @param parsedMesh is the source
  107382. * @param scene defines the hosting scene
  107383. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  107384. * @returns a new Mesh
  107385. */
  107386. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  107387. /**
  107388. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  107389. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107390. * @param name defines the name of the mesh to create
  107391. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  107392. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  107393. * @param closePath creates a seam between the first and the last points of each path of the path array
  107394. * @param offset is taken in account only if the `pathArray` is containing a single path
  107395. * @param scene defines the hosting scene
  107396. * @param updatable defines if the mesh must be flagged as updatable
  107397. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107398. * @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)
  107399. * @returns a new Mesh
  107400. */
  107401. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107402. /**
  107403. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  107404. * @param name defines the name of the mesh to create
  107405. * @param radius sets the radius size (float) of the polygon (default 0.5)
  107406. * @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
  107407. * @param scene defines the hosting scene
  107408. * @param updatable defines if the mesh must be flagged as updatable
  107409. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107410. * @returns a new Mesh
  107411. */
  107412. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  107413. /**
  107414. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  107415. * @param name defines the name of the mesh to create
  107416. * @param size sets the size (float) of each box side (default 1)
  107417. * @param scene defines the hosting scene
  107418. * @param updatable defines if the mesh must be flagged as updatable
  107419. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107420. * @returns a new Mesh
  107421. */
  107422. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  107423. /**
  107424. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  107425. * @param name defines the name of the mesh to create
  107426. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  107427. * @param diameter sets the diameter size (float) of the sphere (default 1)
  107428. * @param scene defines the hosting scene
  107429. * @param updatable defines if the mesh must be flagged as updatable
  107430. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107431. * @returns a new Mesh
  107432. */
  107433. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107434. /**
  107435. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  107436. * @param name defines the name of the mesh to create
  107437. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  107438. * @param diameter sets the diameter size (float) of the sphere (default 1)
  107439. * @param scene defines the hosting scene
  107440. * @returns a new Mesh
  107441. */
  107442. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  107443. /**
  107444. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  107445. * @param name defines the name of the mesh to create
  107446. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  107447. * @param diameterTop set the top cap diameter (floats, default 1)
  107448. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  107449. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  107450. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  107451. * @param scene defines the hosting scene
  107452. * @param updatable defines if the mesh must be flagged as updatable
  107453. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107454. * @returns a new Mesh
  107455. */
  107456. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  107457. /**
  107458. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  107459. * @param name defines the name of the mesh to create
  107460. * @param diameter sets the diameter size (float) of the torus (default 1)
  107461. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  107462. * @param tessellation sets the number of torus sides (postive integer, default 16)
  107463. * @param scene defines the hosting scene
  107464. * @param updatable defines if the mesh must be flagged as updatable
  107465. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107466. * @returns a new Mesh
  107467. */
  107468. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107469. /**
  107470. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  107471. * @param name defines the name of the mesh to create
  107472. * @param radius sets the global radius size (float) of the torus knot (default 2)
  107473. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  107474. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  107475. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  107476. * @param p the number of windings on X axis (positive integers, default 2)
  107477. * @param q the number of windings on Y axis (positive integers, default 3)
  107478. * @param scene defines the hosting scene
  107479. * @param updatable defines if the mesh must be flagged as updatable
  107480. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107481. * @returns a new Mesh
  107482. */
  107483. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107484. /**
  107485. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  107486. * @param name defines the name of the mesh to create
  107487. * @param points is an array successive Vector3
  107488. * @param scene defines the hosting scene
  107489. * @param updatable defines if the mesh must be flagged as updatable
  107490. * @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).
  107491. * @returns a new Mesh
  107492. */
  107493. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  107494. /**
  107495. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  107496. * @param name defines the name of the mesh to create
  107497. * @param points is an array successive Vector3
  107498. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  107499. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  107500. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  107501. * @param scene defines the hosting scene
  107502. * @param updatable defines if the mesh must be flagged as updatable
  107503. * @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)
  107504. * @returns a new Mesh
  107505. */
  107506. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  107507. /**
  107508. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  107509. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  107510. * 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.
  107511. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107512. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  107513. * Remember you can only change the shape positions, not their number when updating a polygon.
  107514. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  107515. * @param name defines the name of the mesh to create
  107516. * @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
  107517. * @param scene defines the hosting scene
  107518. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  107519. * @param updatable defines if the mesh must be flagged as updatable
  107520. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107521. * @param earcutInjection can be used to inject your own earcut reference
  107522. * @returns a new Mesh
  107523. */
  107524. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  107525. /**
  107526. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  107527. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  107528. * @param name defines the name of the mesh to create
  107529. * @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
  107530. * @param depth defines the height of extrusion
  107531. * @param scene defines the hosting scene
  107532. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  107533. * @param updatable defines if the mesh must be flagged as updatable
  107534. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107535. * @param earcutInjection can be used to inject your own earcut reference
  107536. * @returns a new Mesh
  107537. */
  107538. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  107539. /**
  107540. * Creates an extruded shape mesh.
  107541. * 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
  107542. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107543. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  107544. * @param name defines the name of the mesh to create
  107545. * @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
  107546. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  107547. * @param scale is the value to scale the shape
  107548. * @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
  107549. * @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
  107550. * @param scene defines the hosting scene
  107551. * @param updatable defines if the mesh must be flagged as updatable
  107552. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107553. * @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)
  107554. * @returns a new Mesh
  107555. */
  107556. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107557. /**
  107558. * Creates an custom extruded shape mesh.
  107559. * The custom extrusion is a parametric shape.
  107560. * It has no predefined shape. Its final shape will depend on the input parameters.
  107561. * Please consider using the same method from the MeshBuilder class instead
  107562. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  107563. * @param name defines the name of the mesh to create
  107564. * @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
  107565. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  107566. * @param scaleFunction is a custom Javascript function called on each path point
  107567. * @param rotationFunction is a custom Javascript function called on each path point
  107568. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  107569. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  107570. * @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
  107571. * @param scene defines the hosting scene
  107572. * @param updatable defines if the mesh must be flagged as updatable
  107573. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107574. * @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)
  107575. * @returns a new Mesh
  107576. */
  107577. 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;
  107578. /**
  107579. * Creates lathe mesh.
  107580. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  107581. * Please consider using the same method from the MeshBuilder class instead
  107582. * @param name defines the name of the mesh to create
  107583. * @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
  107584. * @param radius is the radius value of the lathe
  107585. * @param tessellation is the side number of the lathe.
  107586. * @param scene defines the hosting scene
  107587. * @param updatable defines if the mesh must be flagged as updatable
  107588. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107589. * @returns a new Mesh
  107590. */
  107591. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107592. /**
  107593. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  107594. * @param name defines the name of the mesh to create
  107595. * @param size sets the size (float) of both sides of the plane at once (default 1)
  107596. * @param scene defines the hosting scene
  107597. * @param updatable defines if the mesh must be flagged as updatable
  107598. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107599. * @returns a new Mesh
  107600. */
  107601. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107602. /**
  107603. * Creates a ground mesh.
  107604. * Please consider using the same method from the MeshBuilder class instead
  107605. * @param name defines the name of the mesh to create
  107606. * @param width set the width of the ground
  107607. * @param height set the height of the ground
  107608. * @param subdivisions sets the number of subdivisions per side
  107609. * @param scene defines the hosting scene
  107610. * @param updatable defines if the mesh must be flagged as updatable
  107611. * @returns a new Mesh
  107612. */
  107613. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  107614. /**
  107615. * Creates a tiled ground mesh.
  107616. * Please consider using the same method from the MeshBuilder class instead
  107617. * @param name defines the name of the mesh to create
  107618. * @param xmin set the ground minimum X coordinate
  107619. * @param zmin set the ground minimum Y coordinate
  107620. * @param xmax set the ground maximum X coordinate
  107621. * @param zmax set the ground maximum Z coordinate
  107622. * @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
  107623. * @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
  107624. * @param scene defines the hosting scene
  107625. * @param updatable defines if the mesh must be flagged as updatable
  107626. * @returns a new Mesh
  107627. */
  107628. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  107629. w: number;
  107630. h: number;
  107631. }, precision: {
  107632. w: number;
  107633. h: number;
  107634. }, scene: Scene, updatable?: boolean): Mesh;
  107635. /**
  107636. * Creates a ground mesh from a height map.
  107637. * Please consider using the same method from the MeshBuilder class instead
  107638. * @see https://doc.babylonjs.com/babylon101/height_map
  107639. * @param name defines the name of the mesh to create
  107640. * @param url sets the URL of the height map image resource
  107641. * @param width set the ground width size
  107642. * @param height set the ground height size
  107643. * @param subdivisions sets the number of subdivision per side
  107644. * @param minHeight is the minimum altitude on the ground
  107645. * @param maxHeight is the maximum altitude on the ground
  107646. * @param scene defines the hosting scene
  107647. * @param updatable defines if the mesh must be flagged as updatable
  107648. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  107649. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  107650. * @returns a new Mesh
  107651. */
  107652. 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;
  107653. /**
  107654. * Creates a tube mesh.
  107655. * The tube is a parametric shape.
  107656. * It has no predefined shape. Its final shape will depend on the input parameters.
  107657. * Please consider using the same method from the MeshBuilder class instead
  107658. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107659. * @param name defines the name of the mesh to create
  107660. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  107661. * @param radius sets the tube radius size
  107662. * @param tessellation is the number of sides on the tubular surface
  107663. * @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
  107664. * @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
  107665. * @param scene defines the hosting scene
  107666. * @param updatable defines if the mesh must be flagged as updatable
  107667. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107668. * @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)
  107669. * @returns a new Mesh
  107670. */
  107671. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  107672. (i: number, distance: number): number;
  107673. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107674. /**
  107675. * Creates a polyhedron mesh.
  107676. * Please consider using the same method from the MeshBuilder class instead.
  107677. * * 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
  107678. * * The parameter `size` (positive float, default 1) sets the polygon size
  107679. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  107680. * * 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`
  107681. * * 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
  107682. * * 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)`)
  107683. * * 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
  107684. * * 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
  107685. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107686. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107687. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107688. * @param name defines the name of the mesh to create
  107689. * @param options defines the options used to create the mesh
  107690. * @param scene defines the hosting scene
  107691. * @returns a new Mesh
  107692. */
  107693. static CreatePolyhedron(name: string, options: {
  107694. type?: number;
  107695. size?: number;
  107696. sizeX?: number;
  107697. sizeY?: number;
  107698. sizeZ?: number;
  107699. custom?: any;
  107700. faceUV?: Vector4[];
  107701. faceColors?: Color4[];
  107702. updatable?: boolean;
  107703. sideOrientation?: number;
  107704. }, scene: Scene): Mesh;
  107705. /**
  107706. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  107707. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  107708. * * 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`)
  107709. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  107710. * * 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
  107711. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107712. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107713. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107714. * @param name defines the name of the mesh
  107715. * @param options defines the options used to create the mesh
  107716. * @param scene defines the hosting scene
  107717. * @returns a new Mesh
  107718. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  107719. */
  107720. static CreateIcoSphere(name: string, options: {
  107721. radius?: number;
  107722. flat?: boolean;
  107723. subdivisions?: number;
  107724. sideOrientation?: number;
  107725. updatable?: boolean;
  107726. }, scene: Scene): Mesh;
  107727. /**
  107728. * Creates a decal mesh.
  107729. * Please consider using the same method from the MeshBuilder class instead.
  107730. * A decal is a mesh usually applied as a model onto the surface of another mesh
  107731. * @param name defines the name of the mesh
  107732. * @param sourceMesh defines the mesh receiving the decal
  107733. * @param position sets the position of the decal in world coordinates
  107734. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  107735. * @param size sets the decal scaling
  107736. * @param angle sets the angle to rotate the decal
  107737. * @returns a new Mesh
  107738. */
  107739. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  107740. /**
  107741. * Prepare internal position array for software CPU skinning
  107742. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  107743. */
  107744. setPositionsForCPUSkinning(): Float32Array;
  107745. /**
  107746. * Prepare internal normal array for software CPU skinning
  107747. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  107748. */
  107749. setNormalsForCPUSkinning(): Float32Array;
  107750. /**
  107751. * Updates the vertex buffer by applying transformation from the bones
  107752. * @param skeleton defines the skeleton to apply to current mesh
  107753. * @returns the current mesh
  107754. */
  107755. applySkeleton(skeleton: Skeleton): Mesh;
  107756. /**
  107757. * 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
  107758. * @param meshes defines the list of meshes to scan
  107759. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  107760. */
  107761. static MinMax(meshes: AbstractMesh[]): {
  107762. min: Vector3;
  107763. max: Vector3;
  107764. };
  107765. /**
  107766. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  107767. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  107768. * @returns a vector3
  107769. */
  107770. static Center(meshesOrMinMaxVector: {
  107771. min: Vector3;
  107772. max: Vector3;
  107773. } | AbstractMesh[]): Vector3;
  107774. /**
  107775. * Merge the array of meshes into a single mesh for performance reasons.
  107776. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  107777. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  107778. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  107779. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  107780. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  107781. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  107782. * @returns a new mesh
  107783. */
  107784. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  107785. /** @hidden */
  107786. addInstance(instance: InstancedMesh): void;
  107787. /** @hidden */
  107788. removeInstance(instance: InstancedMesh): void;
  107789. }
  107790. }
  107791. declare module BABYLON {
  107792. /**
  107793. * This is the base class of all the camera used in the application.
  107794. * @see https://doc.babylonjs.com/features/cameras
  107795. */
  107796. export class Camera extends Node {
  107797. /** @hidden */
  107798. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  107799. /**
  107800. * This is the default projection mode used by the cameras.
  107801. * It helps recreating a feeling of perspective and better appreciate depth.
  107802. * This is the best way to simulate real life cameras.
  107803. */
  107804. static readonly PERSPECTIVE_CAMERA: number;
  107805. /**
  107806. * This helps creating camera with an orthographic mode.
  107807. * 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.
  107808. */
  107809. static readonly ORTHOGRAPHIC_CAMERA: number;
  107810. /**
  107811. * This is the default FOV mode for perspective cameras.
  107812. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  107813. */
  107814. static readonly FOVMODE_VERTICAL_FIXED: number;
  107815. /**
  107816. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  107817. */
  107818. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  107819. /**
  107820. * This specifies ther is no need for a camera rig.
  107821. * Basically only one eye is rendered corresponding to the camera.
  107822. */
  107823. static readonly RIG_MODE_NONE: number;
  107824. /**
  107825. * Simulates a camera Rig with one blue eye and one red eye.
  107826. * This can be use with 3d blue and red glasses.
  107827. */
  107828. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  107829. /**
  107830. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  107831. */
  107832. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  107833. /**
  107834. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  107835. */
  107836. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  107837. /**
  107838. * Defines that both eyes of the camera will be rendered over under each other.
  107839. */
  107840. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  107841. /**
  107842. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  107843. */
  107844. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  107845. /**
  107846. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  107847. */
  107848. static readonly RIG_MODE_VR: number;
  107849. /**
  107850. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  107851. */
  107852. static readonly RIG_MODE_WEBVR: number;
  107853. /**
  107854. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  107855. */
  107856. static readonly RIG_MODE_CUSTOM: number;
  107857. /**
  107858. * Defines if by default attaching controls should prevent the default javascript event to continue.
  107859. */
  107860. static ForceAttachControlToAlwaysPreventDefault: boolean;
  107861. /**
  107862. * Define the input manager associated with the camera.
  107863. */
  107864. inputs: CameraInputsManager<Camera>;
  107865. /** @hidden */
  107866. _position: Vector3;
  107867. /**
  107868. * Define the current local position of the camera in the scene
  107869. */
  107870. get position(): Vector3;
  107871. set position(newPosition: Vector3);
  107872. /**
  107873. * The vector the camera should consider as up.
  107874. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  107875. */
  107876. upVector: Vector3;
  107877. /**
  107878. * Define the current limit on the left side for an orthographic camera
  107879. * In scene unit
  107880. */
  107881. orthoLeft: Nullable<number>;
  107882. /**
  107883. * Define the current limit on the right side for an orthographic camera
  107884. * In scene unit
  107885. */
  107886. orthoRight: Nullable<number>;
  107887. /**
  107888. * Define the current limit on the bottom side for an orthographic camera
  107889. * In scene unit
  107890. */
  107891. orthoBottom: Nullable<number>;
  107892. /**
  107893. * Define the current limit on the top side for an orthographic camera
  107894. * In scene unit
  107895. */
  107896. orthoTop: Nullable<number>;
  107897. /**
  107898. * Field Of View is set in Radians. (default is 0.8)
  107899. */
  107900. fov: number;
  107901. /**
  107902. * Define the minimum distance the camera can see from.
  107903. * This is important to note that the depth buffer are not infinite and the closer it starts
  107904. * the more your scene might encounter depth fighting issue.
  107905. */
  107906. minZ: number;
  107907. /**
  107908. * Define the maximum distance the camera can see to.
  107909. * This is important to note that the depth buffer are not infinite and the further it end
  107910. * the more your scene might encounter depth fighting issue.
  107911. */
  107912. maxZ: number;
  107913. /**
  107914. * Define the default inertia of the camera.
  107915. * This helps giving a smooth feeling to the camera movement.
  107916. */
  107917. inertia: number;
  107918. /**
  107919. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  107920. */
  107921. mode: number;
  107922. /**
  107923. * Define whether the camera is intermediate.
  107924. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  107925. */
  107926. isIntermediate: boolean;
  107927. /**
  107928. * Define the viewport of the camera.
  107929. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  107930. */
  107931. viewport: Viewport;
  107932. /**
  107933. * Restricts the camera to viewing objects with the same layerMask.
  107934. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  107935. */
  107936. layerMask: number;
  107937. /**
  107938. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  107939. */
  107940. fovMode: number;
  107941. /**
  107942. * Rig mode of the camera.
  107943. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  107944. * This is normally controlled byt the camera themselves as internal use.
  107945. */
  107946. cameraRigMode: number;
  107947. /**
  107948. * Defines the distance between both "eyes" in case of a RIG
  107949. */
  107950. interaxialDistance: number;
  107951. /**
  107952. * Defines if stereoscopic rendering is done side by side or over under.
  107953. */
  107954. isStereoscopicSideBySide: boolean;
  107955. /**
  107956. * 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
  107957. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  107958. * else in the scene. (Eg. security camera)
  107959. *
  107960. * 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)
  107961. */
  107962. customRenderTargets: RenderTargetTexture[];
  107963. /**
  107964. * When set, the camera will render to this render target instead of the default canvas
  107965. *
  107966. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  107967. */
  107968. outputRenderTarget: Nullable<RenderTargetTexture>;
  107969. /**
  107970. * Observable triggered when the camera view matrix has changed.
  107971. */
  107972. onViewMatrixChangedObservable: Observable<Camera>;
  107973. /**
  107974. * Observable triggered when the camera Projection matrix has changed.
  107975. */
  107976. onProjectionMatrixChangedObservable: Observable<Camera>;
  107977. /**
  107978. * Observable triggered when the inputs have been processed.
  107979. */
  107980. onAfterCheckInputsObservable: Observable<Camera>;
  107981. /**
  107982. * Observable triggered when reset has been called and applied to the camera.
  107983. */
  107984. onRestoreStateObservable: Observable<Camera>;
  107985. /**
  107986. * Is this camera a part of a rig system?
  107987. */
  107988. isRigCamera: boolean;
  107989. /**
  107990. * If isRigCamera set to true this will be set with the parent camera.
  107991. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  107992. */
  107993. rigParent?: Camera;
  107994. /** @hidden */
  107995. _cameraRigParams: any;
  107996. /** @hidden */
  107997. _rigCameras: Camera[];
  107998. /** @hidden */
  107999. _rigPostProcess: Nullable<PostProcess>;
  108000. protected _webvrViewMatrix: Matrix;
  108001. /** @hidden */
  108002. _skipRendering: boolean;
  108003. /** @hidden */
  108004. _projectionMatrix: Matrix;
  108005. /** @hidden */
  108006. _postProcesses: Nullable<PostProcess>[];
  108007. /** @hidden */
  108008. _activeMeshes: SmartArray<AbstractMesh>;
  108009. protected _globalPosition: Vector3;
  108010. /** @hidden */
  108011. _computedViewMatrix: Matrix;
  108012. private _doNotComputeProjectionMatrix;
  108013. private _transformMatrix;
  108014. private _frustumPlanes;
  108015. private _refreshFrustumPlanes;
  108016. private _storedFov;
  108017. private _stateStored;
  108018. /**
  108019. * Instantiates a new camera object.
  108020. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  108021. * @see https://doc.babylonjs.com/features/cameras
  108022. * @param name Defines the name of the camera in the scene
  108023. * @param position Defines the position of the camera
  108024. * @param scene Defines the scene the camera belongs too
  108025. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  108026. */
  108027. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  108028. /**
  108029. * Store current camera state (fov, position, etc..)
  108030. * @returns the camera
  108031. */
  108032. storeState(): Camera;
  108033. /**
  108034. * Restores the camera state values if it has been stored. You must call storeState() first
  108035. */
  108036. protected _restoreStateValues(): boolean;
  108037. /**
  108038. * Restored camera state. You must call storeState() first.
  108039. * @returns true if restored and false otherwise
  108040. */
  108041. restoreState(): boolean;
  108042. /**
  108043. * Gets the class name of the camera.
  108044. * @returns the class name
  108045. */
  108046. getClassName(): string;
  108047. /** @hidden */
  108048. readonly _isCamera: boolean;
  108049. /**
  108050. * Gets a string representation of the camera useful for debug purpose.
  108051. * @param fullDetails Defines that a more verboe level of logging is required
  108052. * @returns the string representation
  108053. */
  108054. toString(fullDetails?: boolean): string;
  108055. /**
  108056. * Gets the current world space position of the camera.
  108057. */
  108058. get globalPosition(): Vector3;
  108059. /**
  108060. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  108061. * @returns the active meshe list
  108062. */
  108063. getActiveMeshes(): SmartArray<AbstractMesh>;
  108064. /**
  108065. * Check whether a mesh is part of the current active mesh list of the camera
  108066. * @param mesh Defines the mesh to check
  108067. * @returns true if active, false otherwise
  108068. */
  108069. isActiveMesh(mesh: Mesh): boolean;
  108070. /**
  108071. * Is this camera ready to be used/rendered
  108072. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  108073. * @return true if the camera is ready
  108074. */
  108075. isReady(completeCheck?: boolean): boolean;
  108076. /** @hidden */
  108077. _initCache(): void;
  108078. /** @hidden */
  108079. _updateCache(ignoreParentClass?: boolean): void;
  108080. /** @hidden */
  108081. _isSynchronized(): boolean;
  108082. /** @hidden */
  108083. _isSynchronizedViewMatrix(): boolean;
  108084. /** @hidden */
  108085. _isSynchronizedProjectionMatrix(): boolean;
  108086. /**
  108087. * Attach the input controls to a specific dom element to get the input from.
  108088. * @param element Defines the element the controls should be listened from
  108089. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  108090. */
  108091. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  108092. /**
  108093. * Detach the current controls from the specified dom element.
  108094. * @param element Defines the element to stop listening the inputs from
  108095. */
  108096. detachControl(element: HTMLElement): void;
  108097. /**
  108098. * Update the camera state according to the different inputs gathered during the frame.
  108099. */
  108100. update(): void;
  108101. /** @hidden */
  108102. _checkInputs(): void;
  108103. /** @hidden */
  108104. get rigCameras(): Camera[];
  108105. /**
  108106. * Gets the post process used by the rig cameras
  108107. */
  108108. get rigPostProcess(): Nullable<PostProcess>;
  108109. /**
  108110. * Internal, gets the first post proces.
  108111. * @returns the first post process to be run on this camera.
  108112. */
  108113. _getFirstPostProcess(): Nullable<PostProcess>;
  108114. private _cascadePostProcessesToRigCams;
  108115. /**
  108116. * Attach a post process to the camera.
  108117. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  108118. * @param postProcess The post process to attach to the camera
  108119. * @param insertAt The position of the post process in case several of them are in use in the scene
  108120. * @returns the position the post process has been inserted at
  108121. */
  108122. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  108123. /**
  108124. * Detach a post process to the camera.
  108125. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  108126. * @param postProcess The post process to detach from the camera
  108127. */
  108128. detachPostProcess(postProcess: PostProcess): void;
  108129. /**
  108130. * Gets the current world matrix of the camera
  108131. */
  108132. getWorldMatrix(): Matrix;
  108133. /** @hidden */
  108134. _getViewMatrix(): Matrix;
  108135. /**
  108136. * Gets the current view matrix of the camera.
  108137. * @param force forces the camera to recompute the matrix without looking at the cached state
  108138. * @returns the view matrix
  108139. */
  108140. getViewMatrix(force?: boolean): Matrix;
  108141. /**
  108142. * Freeze the projection matrix.
  108143. * It will prevent the cache check of the camera projection compute and can speed up perf
  108144. * if no parameter of the camera are meant to change
  108145. * @param projection Defines manually a projection if necessary
  108146. */
  108147. freezeProjectionMatrix(projection?: Matrix): void;
  108148. /**
  108149. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  108150. */
  108151. unfreezeProjectionMatrix(): void;
  108152. /**
  108153. * Gets the current projection matrix of the camera.
  108154. * @param force forces the camera to recompute the matrix without looking at the cached state
  108155. * @returns the projection matrix
  108156. */
  108157. getProjectionMatrix(force?: boolean): Matrix;
  108158. /**
  108159. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  108160. * @returns a Matrix
  108161. */
  108162. getTransformationMatrix(): Matrix;
  108163. private _updateFrustumPlanes;
  108164. /**
  108165. * Checks if a cullable object (mesh...) is in the camera frustum
  108166. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  108167. * @param target The object to check
  108168. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  108169. * @returns true if the object is in frustum otherwise false
  108170. */
  108171. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  108172. /**
  108173. * Checks if a cullable object (mesh...) is in the camera frustum
  108174. * Unlike isInFrustum this cheks the full bounding box
  108175. * @param target The object to check
  108176. * @returns true if the object is in frustum otherwise false
  108177. */
  108178. isCompletelyInFrustum(target: ICullable): boolean;
  108179. /**
  108180. * Gets a ray in the forward direction from the camera.
  108181. * @param length Defines the length of the ray to create
  108182. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  108183. * @param origin Defines the start point of the ray which defaults to the camera position
  108184. * @returns the forward ray
  108185. */
  108186. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  108187. /**
  108188. * Gets a ray in the forward direction from the camera.
  108189. * @param refRay the ray to (re)use when setting the values
  108190. * @param length Defines the length of the ray to create
  108191. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  108192. * @param origin Defines the start point of the ray which defaults to the camera position
  108193. * @returns the forward ray
  108194. */
  108195. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  108196. /**
  108197. * Releases resources associated with this node.
  108198. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108199. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108200. */
  108201. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108202. /** @hidden */
  108203. _isLeftCamera: boolean;
  108204. /**
  108205. * Gets the left camera of a rig setup in case of Rigged Camera
  108206. */
  108207. get isLeftCamera(): boolean;
  108208. /** @hidden */
  108209. _isRightCamera: boolean;
  108210. /**
  108211. * Gets the right camera of a rig setup in case of Rigged Camera
  108212. */
  108213. get isRightCamera(): boolean;
  108214. /**
  108215. * Gets the left camera of a rig setup in case of Rigged Camera
  108216. */
  108217. get leftCamera(): Nullable<FreeCamera>;
  108218. /**
  108219. * Gets the right camera of a rig setup in case of Rigged Camera
  108220. */
  108221. get rightCamera(): Nullable<FreeCamera>;
  108222. /**
  108223. * Gets the left camera target of a rig setup in case of Rigged Camera
  108224. * @returns the target position
  108225. */
  108226. getLeftTarget(): Nullable<Vector3>;
  108227. /**
  108228. * Gets the right camera target of a rig setup in case of Rigged Camera
  108229. * @returns the target position
  108230. */
  108231. getRightTarget(): Nullable<Vector3>;
  108232. /**
  108233. * @hidden
  108234. */
  108235. setCameraRigMode(mode: number, rigParams: any): void;
  108236. /** @hidden */
  108237. static _setStereoscopicRigMode(camera: Camera): void;
  108238. /** @hidden */
  108239. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  108240. /** @hidden */
  108241. static _setVRRigMode(camera: Camera, rigParams: any): void;
  108242. /** @hidden */
  108243. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  108244. /** @hidden */
  108245. _getVRProjectionMatrix(): Matrix;
  108246. protected _updateCameraRotationMatrix(): void;
  108247. protected _updateWebVRCameraRotationMatrix(): void;
  108248. /**
  108249. * This function MUST be overwritten by the different WebVR cameras available.
  108250. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  108251. * @hidden
  108252. */
  108253. _getWebVRProjectionMatrix(): Matrix;
  108254. /**
  108255. * This function MUST be overwritten by the different WebVR cameras available.
  108256. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  108257. * @hidden
  108258. */
  108259. _getWebVRViewMatrix(): Matrix;
  108260. /** @hidden */
  108261. setCameraRigParameter(name: string, value: any): void;
  108262. /**
  108263. * needs to be overridden by children so sub has required properties to be copied
  108264. * @hidden
  108265. */
  108266. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  108267. /**
  108268. * May need to be overridden by children
  108269. * @hidden
  108270. */
  108271. _updateRigCameras(): void;
  108272. /** @hidden */
  108273. _setupInputs(): void;
  108274. /**
  108275. * Serialiaze the camera setup to a json represention
  108276. * @returns the JSON representation
  108277. */
  108278. serialize(): any;
  108279. /**
  108280. * Clones the current camera.
  108281. * @param name The cloned camera name
  108282. * @returns the cloned camera
  108283. */
  108284. clone(name: string): Camera;
  108285. /**
  108286. * Gets the direction of the camera relative to a given local axis.
  108287. * @param localAxis Defines the reference axis to provide a relative direction.
  108288. * @return the direction
  108289. */
  108290. getDirection(localAxis: Vector3): Vector3;
  108291. /**
  108292. * Returns the current camera absolute rotation
  108293. */
  108294. get absoluteRotation(): Quaternion;
  108295. /**
  108296. * Gets the direction of the camera relative to a given local axis into a passed vector.
  108297. * @param localAxis Defines the reference axis to provide a relative direction.
  108298. * @param result Defines the vector to store the result in
  108299. */
  108300. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  108301. /**
  108302. * Gets a camera constructor for a given camera type
  108303. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  108304. * @param name The name of the camera the result will be able to instantiate
  108305. * @param scene The scene the result will construct the camera in
  108306. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  108307. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  108308. * @returns a factory method to construc the camera
  108309. */
  108310. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  108311. /**
  108312. * Compute the world matrix of the camera.
  108313. * @returns the camera world matrix
  108314. */
  108315. computeWorldMatrix(): Matrix;
  108316. /**
  108317. * Parse a JSON and creates the camera from the parsed information
  108318. * @param parsedCamera The JSON to parse
  108319. * @param scene The scene to instantiate the camera in
  108320. * @returns the newly constructed camera
  108321. */
  108322. static Parse(parsedCamera: any, scene: Scene): Camera;
  108323. }
  108324. }
  108325. declare module BABYLON {
  108326. /**
  108327. * Class containing static functions to help procedurally build meshes
  108328. */
  108329. export class DiscBuilder {
  108330. /**
  108331. * Creates a plane polygonal mesh. By default, this is a disc
  108332. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  108333. * * 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
  108334. * * 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
  108335. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108336. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108337. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108338. * @param name defines the name of the mesh
  108339. * @param options defines the options used to create the mesh
  108340. * @param scene defines the hosting scene
  108341. * @returns the plane polygonal mesh
  108342. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  108343. */
  108344. static CreateDisc(name: string, options: {
  108345. radius?: number;
  108346. tessellation?: number;
  108347. arc?: number;
  108348. updatable?: boolean;
  108349. sideOrientation?: number;
  108350. frontUVs?: Vector4;
  108351. backUVs?: Vector4;
  108352. }, scene?: Nullable<Scene>): Mesh;
  108353. }
  108354. }
  108355. declare module BABYLON {
  108356. /**
  108357. * Options to be used when creating a FresnelParameters.
  108358. */
  108359. export type IFresnelParametersCreationOptions = {
  108360. /**
  108361. * Define the color used on edges (grazing angle)
  108362. */
  108363. leftColor?: Color3;
  108364. /**
  108365. * Define the color used on center
  108366. */
  108367. rightColor?: Color3;
  108368. /**
  108369. * Define bias applied to computed fresnel term
  108370. */
  108371. bias?: number;
  108372. /**
  108373. * Defined the power exponent applied to fresnel term
  108374. */
  108375. power?: number;
  108376. /**
  108377. * Define if the fresnel effect is enable or not.
  108378. */
  108379. isEnabled?: boolean;
  108380. };
  108381. /**
  108382. * Serialized format for FresnelParameters.
  108383. */
  108384. export type IFresnelParametersSerialized = {
  108385. /**
  108386. * Define the color used on edges (grazing angle) [as an array]
  108387. */
  108388. leftColor: number[];
  108389. /**
  108390. * Define the color used on center [as an array]
  108391. */
  108392. rightColor: number[];
  108393. /**
  108394. * Define bias applied to computed fresnel term
  108395. */
  108396. bias: number;
  108397. /**
  108398. * Defined the power exponent applied to fresnel term
  108399. */
  108400. power?: number;
  108401. /**
  108402. * Define if the fresnel effect is enable or not.
  108403. */
  108404. isEnabled: boolean;
  108405. };
  108406. /**
  108407. * This represents all the required information to add a fresnel effect on a material:
  108408. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108409. */
  108410. export class FresnelParameters {
  108411. private _isEnabled;
  108412. /**
  108413. * Define if the fresnel effect is enable or not.
  108414. */
  108415. get isEnabled(): boolean;
  108416. set isEnabled(value: boolean);
  108417. /**
  108418. * Define the color used on edges (grazing angle)
  108419. */
  108420. leftColor: Color3;
  108421. /**
  108422. * Define the color used on center
  108423. */
  108424. rightColor: Color3;
  108425. /**
  108426. * Define bias applied to computed fresnel term
  108427. */
  108428. bias: number;
  108429. /**
  108430. * Defined the power exponent applied to fresnel term
  108431. */
  108432. power: number;
  108433. /**
  108434. * Creates a new FresnelParameters object.
  108435. *
  108436. * @param options provide your own settings to optionally to override defaults
  108437. */
  108438. constructor(options?: IFresnelParametersCreationOptions);
  108439. /**
  108440. * Clones the current fresnel and its valuues
  108441. * @returns a clone fresnel configuration
  108442. */
  108443. clone(): FresnelParameters;
  108444. /**
  108445. * Determines equality between FresnelParameters objects
  108446. * @param otherFresnelParameters defines the second operand
  108447. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  108448. */
  108449. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  108450. /**
  108451. * Serializes the current fresnel parameters to a JSON representation.
  108452. * @return the JSON serialization
  108453. */
  108454. serialize(): IFresnelParametersSerialized;
  108455. /**
  108456. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  108457. * @param parsedFresnelParameters Define the JSON representation
  108458. * @returns the parsed parameters
  108459. */
  108460. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  108461. }
  108462. }
  108463. declare module BABYLON {
  108464. /**
  108465. * This groups all the flags used to control the materials channel.
  108466. */
  108467. export class MaterialFlags {
  108468. private static _DiffuseTextureEnabled;
  108469. /**
  108470. * Are diffuse textures enabled in the application.
  108471. */
  108472. static get DiffuseTextureEnabled(): boolean;
  108473. static set DiffuseTextureEnabled(value: boolean);
  108474. private static _DetailTextureEnabled;
  108475. /**
  108476. * Are detail textures enabled in the application.
  108477. */
  108478. static get DetailTextureEnabled(): boolean;
  108479. static set DetailTextureEnabled(value: boolean);
  108480. private static _AmbientTextureEnabled;
  108481. /**
  108482. * Are ambient textures enabled in the application.
  108483. */
  108484. static get AmbientTextureEnabled(): boolean;
  108485. static set AmbientTextureEnabled(value: boolean);
  108486. private static _OpacityTextureEnabled;
  108487. /**
  108488. * Are opacity textures enabled in the application.
  108489. */
  108490. static get OpacityTextureEnabled(): boolean;
  108491. static set OpacityTextureEnabled(value: boolean);
  108492. private static _ReflectionTextureEnabled;
  108493. /**
  108494. * Are reflection textures enabled in the application.
  108495. */
  108496. static get ReflectionTextureEnabled(): boolean;
  108497. static set ReflectionTextureEnabled(value: boolean);
  108498. private static _EmissiveTextureEnabled;
  108499. /**
  108500. * Are emissive textures enabled in the application.
  108501. */
  108502. static get EmissiveTextureEnabled(): boolean;
  108503. static set EmissiveTextureEnabled(value: boolean);
  108504. private static _SpecularTextureEnabled;
  108505. /**
  108506. * Are specular textures enabled in the application.
  108507. */
  108508. static get SpecularTextureEnabled(): boolean;
  108509. static set SpecularTextureEnabled(value: boolean);
  108510. private static _BumpTextureEnabled;
  108511. /**
  108512. * Are bump textures enabled in the application.
  108513. */
  108514. static get BumpTextureEnabled(): boolean;
  108515. static set BumpTextureEnabled(value: boolean);
  108516. private static _LightmapTextureEnabled;
  108517. /**
  108518. * Are lightmap textures enabled in the application.
  108519. */
  108520. static get LightmapTextureEnabled(): boolean;
  108521. static set LightmapTextureEnabled(value: boolean);
  108522. private static _RefractionTextureEnabled;
  108523. /**
  108524. * Are refraction textures enabled in the application.
  108525. */
  108526. static get RefractionTextureEnabled(): boolean;
  108527. static set RefractionTextureEnabled(value: boolean);
  108528. private static _ColorGradingTextureEnabled;
  108529. /**
  108530. * Are color grading textures enabled in the application.
  108531. */
  108532. static get ColorGradingTextureEnabled(): boolean;
  108533. static set ColorGradingTextureEnabled(value: boolean);
  108534. private static _FresnelEnabled;
  108535. /**
  108536. * Are fresnels enabled in the application.
  108537. */
  108538. static get FresnelEnabled(): boolean;
  108539. static set FresnelEnabled(value: boolean);
  108540. private static _ClearCoatTextureEnabled;
  108541. /**
  108542. * Are clear coat textures enabled in the application.
  108543. */
  108544. static get ClearCoatTextureEnabled(): boolean;
  108545. static set ClearCoatTextureEnabled(value: boolean);
  108546. private static _ClearCoatBumpTextureEnabled;
  108547. /**
  108548. * Are clear coat bump textures enabled in the application.
  108549. */
  108550. static get ClearCoatBumpTextureEnabled(): boolean;
  108551. static set ClearCoatBumpTextureEnabled(value: boolean);
  108552. private static _ClearCoatTintTextureEnabled;
  108553. /**
  108554. * Are clear coat tint textures enabled in the application.
  108555. */
  108556. static get ClearCoatTintTextureEnabled(): boolean;
  108557. static set ClearCoatTintTextureEnabled(value: boolean);
  108558. private static _SheenTextureEnabled;
  108559. /**
  108560. * Are sheen textures enabled in the application.
  108561. */
  108562. static get SheenTextureEnabled(): boolean;
  108563. static set SheenTextureEnabled(value: boolean);
  108564. private static _AnisotropicTextureEnabled;
  108565. /**
  108566. * Are anisotropic textures enabled in the application.
  108567. */
  108568. static get AnisotropicTextureEnabled(): boolean;
  108569. static set AnisotropicTextureEnabled(value: boolean);
  108570. private static _ThicknessTextureEnabled;
  108571. /**
  108572. * Are thickness textures enabled in the application.
  108573. */
  108574. static get ThicknessTextureEnabled(): boolean;
  108575. static set ThicknessTextureEnabled(value: boolean);
  108576. }
  108577. }
  108578. declare module BABYLON {
  108579. /** @hidden */
  108580. export var defaultFragmentDeclaration: {
  108581. name: string;
  108582. shader: string;
  108583. };
  108584. }
  108585. declare module BABYLON {
  108586. /** @hidden */
  108587. export var defaultUboDeclaration: {
  108588. name: string;
  108589. shader: string;
  108590. };
  108591. }
  108592. declare module BABYLON {
  108593. /** @hidden */
  108594. export var prePassDeclaration: {
  108595. name: string;
  108596. shader: string;
  108597. };
  108598. }
  108599. declare module BABYLON {
  108600. /** @hidden */
  108601. export var lightFragmentDeclaration: {
  108602. name: string;
  108603. shader: string;
  108604. };
  108605. }
  108606. declare module BABYLON {
  108607. /** @hidden */
  108608. export var lightUboDeclaration: {
  108609. name: string;
  108610. shader: string;
  108611. };
  108612. }
  108613. declare module BABYLON {
  108614. /** @hidden */
  108615. export var lightsFragmentFunctions: {
  108616. name: string;
  108617. shader: string;
  108618. };
  108619. }
  108620. declare module BABYLON {
  108621. /** @hidden */
  108622. export var shadowsFragmentFunctions: {
  108623. name: string;
  108624. shader: string;
  108625. };
  108626. }
  108627. declare module BABYLON {
  108628. /** @hidden */
  108629. export var fresnelFunction: {
  108630. name: string;
  108631. shader: string;
  108632. };
  108633. }
  108634. declare module BABYLON {
  108635. /** @hidden */
  108636. export var bumpFragmentMainFunctions: {
  108637. name: string;
  108638. shader: string;
  108639. };
  108640. }
  108641. declare module BABYLON {
  108642. /** @hidden */
  108643. export var bumpFragmentFunctions: {
  108644. name: string;
  108645. shader: string;
  108646. };
  108647. }
  108648. declare module BABYLON {
  108649. /** @hidden */
  108650. export var logDepthDeclaration: {
  108651. name: string;
  108652. shader: string;
  108653. };
  108654. }
  108655. declare module BABYLON {
  108656. /** @hidden */
  108657. export var bumpFragment: {
  108658. name: string;
  108659. shader: string;
  108660. };
  108661. }
  108662. declare module BABYLON {
  108663. /** @hidden */
  108664. export var depthPrePass: {
  108665. name: string;
  108666. shader: string;
  108667. };
  108668. }
  108669. declare module BABYLON {
  108670. /** @hidden */
  108671. export var lightFragment: {
  108672. name: string;
  108673. shader: string;
  108674. };
  108675. }
  108676. declare module BABYLON {
  108677. /** @hidden */
  108678. export var logDepthFragment: {
  108679. name: string;
  108680. shader: string;
  108681. };
  108682. }
  108683. declare module BABYLON {
  108684. /** @hidden */
  108685. export var defaultPixelShader: {
  108686. name: string;
  108687. shader: string;
  108688. };
  108689. }
  108690. declare module BABYLON {
  108691. /** @hidden */
  108692. export var defaultVertexDeclaration: {
  108693. name: string;
  108694. shader: string;
  108695. };
  108696. }
  108697. declare module BABYLON {
  108698. /** @hidden */
  108699. export var bumpVertexDeclaration: {
  108700. name: string;
  108701. shader: string;
  108702. };
  108703. }
  108704. declare module BABYLON {
  108705. /** @hidden */
  108706. export var bumpVertex: {
  108707. name: string;
  108708. shader: string;
  108709. };
  108710. }
  108711. declare module BABYLON {
  108712. /** @hidden */
  108713. export var fogVertex: {
  108714. name: string;
  108715. shader: string;
  108716. };
  108717. }
  108718. declare module BABYLON {
  108719. /** @hidden */
  108720. export var shadowsVertex: {
  108721. name: string;
  108722. shader: string;
  108723. };
  108724. }
  108725. declare module BABYLON {
  108726. /** @hidden */
  108727. export var pointCloudVertex: {
  108728. name: string;
  108729. shader: string;
  108730. };
  108731. }
  108732. declare module BABYLON {
  108733. /** @hidden */
  108734. export var logDepthVertex: {
  108735. name: string;
  108736. shader: string;
  108737. };
  108738. }
  108739. declare module BABYLON {
  108740. /** @hidden */
  108741. export var defaultVertexShader: {
  108742. name: string;
  108743. shader: string;
  108744. };
  108745. }
  108746. declare module BABYLON {
  108747. /**
  108748. * @hidden
  108749. */
  108750. export interface IMaterialDetailMapDefines {
  108751. DETAIL: boolean;
  108752. DETAILDIRECTUV: number;
  108753. DETAIL_NORMALBLENDMETHOD: number;
  108754. /** @hidden */
  108755. _areTexturesDirty: boolean;
  108756. }
  108757. /**
  108758. * Define the code related to the detail map parameters of a material
  108759. *
  108760. * Inspired from:
  108761. * 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
  108762. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  108763. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  108764. */
  108765. export class DetailMapConfiguration {
  108766. private _texture;
  108767. /**
  108768. * The detail texture of the material.
  108769. */
  108770. texture: Nullable<BaseTexture>;
  108771. /**
  108772. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  108773. * Bigger values mean stronger blending
  108774. */
  108775. diffuseBlendLevel: number;
  108776. /**
  108777. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  108778. * Bigger values mean stronger blending. Only used with PBR materials
  108779. */
  108780. roughnessBlendLevel: number;
  108781. /**
  108782. * Defines how strong the bump effect from the detail map is
  108783. * Bigger values mean stronger effect
  108784. */
  108785. bumpLevel: number;
  108786. private _normalBlendMethod;
  108787. /**
  108788. * The method used to blend the bump and detail normals together
  108789. */
  108790. normalBlendMethod: number;
  108791. private _isEnabled;
  108792. /**
  108793. * Enable or disable the detail map on this material
  108794. */
  108795. isEnabled: boolean;
  108796. /** @hidden */
  108797. private _internalMarkAllSubMeshesAsTexturesDirty;
  108798. /** @hidden */
  108799. _markAllSubMeshesAsTexturesDirty(): void;
  108800. /**
  108801. * Instantiate a new detail map
  108802. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  108803. */
  108804. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  108805. /**
  108806. * Gets whether the submesh is ready to be used or not.
  108807. * @param defines the list of "defines" to update.
  108808. * @param scene defines the scene the material belongs to.
  108809. * @returns - boolean indicating that the submesh is ready or not.
  108810. */
  108811. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  108812. /**
  108813. * Update the defines for detail map usage
  108814. * @param defines the list of "defines" to update.
  108815. * @param scene defines the scene the material belongs to.
  108816. */
  108817. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  108818. /**
  108819. * Binds the material data.
  108820. * @param uniformBuffer defines the Uniform buffer to fill in.
  108821. * @param scene defines the scene the material belongs to.
  108822. * @param isFrozen defines whether the material is frozen or not.
  108823. */
  108824. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  108825. /**
  108826. * Checks to see if a texture is used in the material.
  108827. * @param texture - Base texture to use.
  108828. * @returns - Boolean specifying if a texture is used in the material.
  108829. */
  108830. hasTexture(texture: BaseTexture): boolean;
  108831. /**
  108832. * Returns an array of the actively used textures.
  108833. * @param activeTextures Array of BaseTextures
  108834. */
  108835. getActiveTextures(activeTextures: BaseTexture[]): void;
  108836. /**
  108837. * Returns the animatable textures.
  108838. * @param animatables Array of animatable textures.
  108839. */
  108840. getAnimatables(animatables: IAnimatable[]): void;
  108841. /**
  108842. * Disposes the resources of the material.
  108843. * @param forceDisposeTextures - Forces the disposal of all textures.
  108844. */
  108845. dispose(forceDisposeTextures?: boolean): void;
  108846. /**
  108847. * Get the current class name useful for serialization or dynamic coding.
  108848. * @returns "DetailMap"
  108849. */
  108850. getClassName(): string;
  108851. /**
  108852. * Add the required uniforms to the current list.
  108853. * @param uniforms defines the current uniform list.
  108854. */
  108855. static AddUniforms(uniforms: string[]): void;
  108856. /**
  108857. * Add the required samplers to the current list.
  108858. * @param samplers defines the current sampler list.
  108859. */
  108860. static AddSamplers(samplers: string[]): void;
  108861. /**
  108862. * Add the required uniforms to the current buffer.
  108863. * @param uniformBuffer defines the current uniform buffer.
  108864. */
  108865. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  108866. /**
  108867. * Makes a duplicate of the current instance into another one.
  108868. * @param detailMap define the instance where to copy the info
  108869. */
  108870. copyTo(detailMap: DetailMapConfiguration): void;
  108871. /**
  108872. * Serializes this detail map instance
  108873. * @returns - An object with the serialized instance.
  108874. */
  108875. serialize(): any;
  108876. /**
  108877. * Parses a detail map setting from a serialized object.
  108878. * @param source - Serialized object.
  108879. * @param scene Defines the scene we are parsing for
  108880. * @param rootUrl Defines the rootUrl to load from
  108881. */
  108882. parse(source: any, scene: Scene, rootUrl: string): void;
  108883. }
  108884. }
  108885. declare module BABYLON {
  108886. /** @hidden */
  108887. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  108888. MAINUV1: boolean;
  108889. MAINUV2: boolean;
  108890. DIFFUSE: boolean;
  108891. DIFFUSEDIRECTUV: number;
  108892. DETAIL: boolean;
  108893. DETAILDIRECTUV: number;
  108894. DETAIL_NORMALBLENDMETHOD: number;
  108895. AMBIENT: boolean;
  108896. AMBIENTDIRECTUV: number;
  108897. OPACITY: boolean;
  108898. OPACITYDIRECTUV: number;
  108899. OPACITYRGB: boolean;
  108900. REFLECTION: boolean;
  108901. EMISSIVE: boolean;
  108902. EMISSIVEDIRECTUV: number;
  108903. SPECULAR: boolean;
  108904. SPECULARDIRECTUV: number;
  108905. BUMP: boolean;
  108906. BUMPDIRECTUV: number;
  108907. PARALLAX: boolean;
  108908. PARALLAXOCCLUSION: boolean;
  108909. SPECULAROVERALPHA: boolean;
  108910. CLIPPLANE: boolean;
  108911. CLIPPLANE2: boolean;
  108912. CLIPPLANE3: boolean;
  108913. CLIPPLANE4: boolean;
  108914. CLIPPLANE5: boolean;
  108915. CLIPPLANE6: boolean;
  108916. ALPHATEST: boolean;
  108917. DEPTHPREPASS: boolean;
  108918. ALPHAFROMDIFFUSE: boolean;
  108919. POINTSIZE: boolean;
  108920. FOG: boolean;
  108921. SPECULARTERM: boolean;
  108922. DIFFUSEFRESNEL: boolean;
  108923. OPACITYFRESNEL: boolean;
  108924. REFLECTIONFRESNEL: boolean;
  108925. REFRACTIONFRESNEL: boolean;
  108926. EMISSIVEFRESNEL: boolean;
  108927. FRESNEL: boolean;
  108928. NORMAL: boolean;
  108929. UV1: boolean;
  108930. UV2: boolean;
  108931. VERTEXCOLOR: boolean;
  108932. VERTEXALPHA: boolean;
  108933. NUM_BONE_INFLUENCERS: number;
  108934. BonesPerMesh: number;
  108935. BONETEXTURE: boolean;
  108936. INSTANCES: boolean;
  108937. THIN_INSTANCES: boolean;
  108938. GLOSSINESS: boolean;
  108939. ROUGHNESS: boolean;
  108940. EMISSIVEASILLUMINATION: boolean;
  108941. LINKEMISSIVEWITHDIFFUSE: boolean;
  108942. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108943. LIGHTMAP: boolean;
  108944. LIGHTMAPDIRECTUV: number;
  108945. OBJECTSPACE_NORMALMAP: boolean;
  108946. USELIGHTMAPASSHADOWMAP: boolean;
  108947. REFLECTIONMAP_3D: boolean;
  108948. REFLECTIONMAP_SPHERICAL: boolean;
  108949. REFLECTIONMAP_PLANAR: boolean;
  108950. REFLECTIONMAP_CUBIC: boolean;
  108951. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108952. REFLECTIONMAP_PROJECTION: boolean;
  108953. REFLECTIONMAP_SKYBOX: boolean;
  108954. REFLECTIONMAP_EXPLICIT: boolean;
  108955. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108956. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108957. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108958. INVERTCUBICMAP: boolean;
  108959. LOGARITHMICDEPTH: boolean;
  108960. REFRACTION: boolean;
  108961. REFRACTIONMAP_3D: boolean;
  108962. REFLECTIONOVERALPHA: boolean;
  108963. TWOSIDEDLIGHTING: boolean;
  108964. SHADOWFLOAT: boolean;
  108965. MORPHTARGETS: boolean;
  108966. MORPHTARGETS_NORMAL: boolean;
  108967. MORPHTARGETS_TANGENT: boolean;
  108968. MORPHTARGETS_UV: boolean;
  108969. NUM_MORPH_INFLUENCERS: number;
  108970. NONUNIFORMSCALING: boolean;
  108971. PREMULTIPLYALPHA: boolean;
  108972. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  108973. ALPHABLEND: boolean;
  108974. PREPASS: boolean;
  108975. SCENE_MRT_COUNT: number;
  108976. RGBDLIGHTMAP: boolean;
  108977. RGBDREFLECTION: boolean;
  108978. RGBDREFRACTION: boolean;
  108979. IMAGEPROCESSING: boolean;
  108980. VIGNETTE: boolean;
  108981. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108982. VIGNETTEBLENDMODEOPAQUE: boolean;
  108983. TONEMAPPING: boolean;
  108984. TONEMAPPING_ACES: boolean;
  108985. CONTRAST: boolean;
  108986. COLORCURVES: boolean;
  108987. COLORGRADING: boolean;
  108988. COLORGRADING3D: boolean;
  108989. SAMPLER3DGREENDEPTH: boolean;
  108990. SAMPLER3DBGRMAP: boolean;
  108991. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108992. MULTIVIEW: boolean;
  108993. /**
  108994. * If the reflection texture on this material is in linear color space
  108995. * @hidden
  108996. */
  108997. IS_REFLECTION_LINEAR: boolean;
  108998. /**
  108999. * If the refraction texture on this material is in linear color space
  109000. * @hidden
  109001. */
  109002. IS_REFRACTION_LINEAR: boolean;
  109003. EXPOSURE: boolean;
  109004. constructor();
  109005. setReflectionMode(modeToEnable: string): void;
  109006. }
  109007. /**
  109008. * This is the default material used in Babylon. It is the best trade off between quality
  109009. * and performances.
  109010. * @see https://doc.babylonjs.com/babylon101/materials
  109011. */
  109012. export class StandardMaterial extends PushMaterial {
  109013. private _diffuseTexture;
  109014. /**
  109015. * The basic texture of the material as viewed under a light.
  109016. */
  109017. diffuseTexture: Nullable<BaseTexture>;
  109018. private _ambientTexture;
  109019. /**
  109020. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  109021. */
  109022. ambientTexture: Nullable<BaseTexture>;
  109023. private _opacityTexture;
  109024. /**
  109025. * Define the transparency of the material from a texture.
  109026. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  109027. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  109028. */
  109029. opacityTexture: Nullable<BaseTexture>;
  109030. private _reflectionTexture;
  109031. /**
  109032. * Define the texture used to display the reflection.
  109033. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109034. */
  109035. reflectionTexture: Nullable<BaseTexture>;
  109036. private _emissiveTexture;
  109037. /**
  109038. * Define texture of the material as if self lit.
  109039. * This will be mixed in the final result even in the absence of light.
  109040. */
  109041. emissiveTexture: Nullable<BaseTexture>;
  109042. private _specularTexture;
  109043. /**
  109044. * Define how the color and intensity of the highlight given by the light in the material.
  109045. */
  109046. specularTexture: Nullable<BaseTexture>;
  109047. private _bumpTexture;
  109048. /**
  109049. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  109050. * 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.
  109051. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  109052. */
  109053. bumpTexture: Nullable<BaseTexture>;
  109054. private _lightmapTexture;
  109055. /**
  109056. * Complex lighting can be computationally expensive to compute at runtime.
  109057. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  109058. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  109059. */
  109060. lightmapTexture: Nullable<BaseTexture>;
  109061. private _refractionTexture;
  109062. /**
  109063. * Define the texture used to display the refraction.
  109064. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109065. */
  109066. refractionTexture: Nullable<BaseTexture>;
  109067. /**
  109068. * The color of the material lit by the environmental background lighting.
  109069. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  109070. */
  109071. ambientColor: Color3;
  109072. /**
  109073. * The basic color of the material as viewed under a light.
  109074. */
  109075. diffuseColor: Color3;
  109076. /**
  109077. * Define how the color and intensity of the highlight given by the light in the material.
  109078. */
  109079. specularColor: Color3;
  109080. /**
  109081. * Define the color of the material as if self lit.
  109082. * This will be mixed in the final result even in the absence of light.
  109083. */
  109084. emissiveColor: Color3;
  109085. /**
  109086. * Defines how sharp are the highlights in the material.
  109087. * The bigger the value the sharper giving a more glossy feeling to the result.
  109088. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  109089. */
  109090. specularPower: number;
  109091. private _useAlphaFromDiffuseTexture;
  109092. /**
  109093. * Does the transparency come from the diffuse texture alpha channel.
  109094. */
  109095. useAlphaFromDiffuseTexture: boolean;
  109096. private _useEmissiveAsIllumination;
  109097. /**
  109098. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  109099. */
  109100. useEmissiveAsIllumination: boolean;
  109101. private _linkEmissiveWithDiffuse;
  109102. /**
  109103. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  109104. * the emissive level when the final color is close to one.
  109105. */
  109106. linkEmissiveWithDiffuse: boolean;
  109107. private _useSpecularOverAlpha;
  109108. /**
  109109. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  109110. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  109111. */
  109112. useSpecularOverAlpha: boolean;
  109113. private _useReflectionOverAlpha;
  109114. /**
  109115. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  109116. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  109117. */
  109118. useReflectionOverAlpha: boolean;
  109119. private _disableLighting;
  109120. /**
  109121. * Does lights from the scene impacts this material.
  109122. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  109123. */
  109124. disableLighting: boolean;
  109125. private _useObjectSpaceNormalMap;
  109126. /**
  109127. * Allows using an object space normal map (instead of tangent space).
  109128. */
  109129. useObjectSpaceNormalMap: boolean;
  109130. private _useParallax;
  109131. /**
  109132. * Is parallax enabled or not.
  109133. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  109134. */
  109135. useParallax: boolean;
  109136. private _useParallaxOcclusion;
  109137. /**
  109138. * Is parallax occlusion enabled or not.
  109139. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  109140. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  109141. */
  109142. useParallaxOcclusion: boolean;
  109143. /**
  109144. * 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.
  109145. */
  109146. parallaxScaleBias: number;
  109147. private _roughness;
  109148. /**
  109149. * Helps to define how blurry the reflections should appears in the material.
  109150. */
  109151. roughness: number;
  109152. /**
  109153. * In case of refraction, define the value of the index of refraction.
  109154. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109155. */
  109156. indexOfRefraction: number;
  109157. /**
  109158. * Invert the refraction texture alongside the y axis.
  109159. * It can be useful with procedural textures or probe for instance.
  109160. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109161. */
  109162. invertRefractionY: boolean;
  109163. /**
  109164. * Defines the alpha limits in alpha test mode.
  109165. */
  109166. alphaCutOff: number;
  109167. private _useLightmapAsShadowmap;
  109168. /**
  109169. * In case of light mapping, define whether the map contains light or shadow informations.
  109170. */
  109171. useLightmapAsShadowmap: boolean;
  109172. private _diffuseFresnelParameters;
  109173. /**
  109174. * Define the diffuse fresnel parameters of the material.
  109175. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109176. */
  109177. diffuseFresnelParameters: FresnelParameters;
  109178. private _opacityFresnelParameters;
  109179. /**
  109180. * Define the opacity fresnel parameters of the material.
  109181. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109182. */
  109183. opacityFresnelParameters: FresnelParameters;
  109184. private _reflectionFresnelParameters;
  109185. /**
  109186. * Define the reflection fresnel parameters of the material.
  109187. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109188. */
  109189. reflectionFresnelParameters: FresnelParameters;
  109190. private _refractionFresnelParameters;
  109191. /**
  109192. * Define the refraction fresnel parameters of the material.
  109193. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109194. */
  109195. refractionFresnelParameters: FresnelParameters;
  109196. private _emissiveFresnelParameters;
  109197. /**
  109198. * Define the emissive fresnel parameters of the material.
  109199. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109200. */
  109201. emissiveFresnelParameters: FresnelParameters;
  109202. private _useReflectionFresnelFromSpecular;
  109203. /**
  109204. * If true automatically deducts the fresnels values from the material specularity.
  109205. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109206. */
  109207. useReflectionFresnelFromSpecular: boolean;
  109208. private _useGlossinessFromSpecularMapAlpha;
  109209. /**
  109210. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  109211. */
  109212. useGlossinessFromSpecularMapAlpha: boolean;
  109213. private _maxSimultaneousLights;
  109214. /**
  109215. * Defines the maximum number of lights that can be used in the material
  109216. */
  109217. maxSimultaneousLights: number;
  109218. private _invertNormalMapX;
  109219. /**
  109220. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  109221. */
  109222. invertNormalMapX: boolean;
  109223. private _invertNormalMapY;
  109224. /**
  109225. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  109226. */
  109227. invertNormalMapY: boolean;
  109228. private _twoSidedLighting;
  109229. /**
  109230. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  109231. */
  109232. twoSidedLighting: boolean;
  109233. /**
  109234. * Default configuration related to image processing available in the standard Material.
  109235. */
  109236. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109237. /**
  109238. * Gets the image processing configuration used either in this material.
  109239. */
  109240. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  109241. /**
  109242. * Sets the Default image processing configuration used either in the this material.
  109243. *
  109244. * If sets to null, the scene one is in use.
  109245. */
  109246. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  109247. /**
  109248. * Keep track of the image processing observer to allow dispose and replace.
  109249. */
  109250. private _imageProcessingObserver;
  109251. /**
  109252. * Attaches a new image processing configuration to the Standard Material.
  109253. * @param configuration
  109254. */
  109255. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  109256. /**
  109257. * Gets wether the color curves effect is enabled.
  109258. */
  109259. get cameraColorCurvesEnabled(): boolean;
  109260. /**
  109261. * Sets wether the color curves effect is enabled.
  109262. */
  109263. set cameraColorCurvesEnabled(value: boolean);
  109264. /**
  109265. * Gets wether the color grading effect is enabled.
  109266. */
  109267. get cameraColorGradingEnabled(): boolean;
  109268. /**
  109269. * Gets wether the color grading effect is enabled.
  109270. */
  109271. set cameraColorGradingEnabled(value: boolean);
  109272. /**
  109273. * Gets wether tonemapping is enabled or not.
  109274. */
  109275. get cameraToneMappingEnabled(): boolean;
  109276. /**
  109277. * Sets wether tonemapping is enabled or not
  109278. */
  109279. set cameraToneMappingEnabled(value: boolean);
  109280. /**
  109281. * The camera exposure used on this material.
  109282. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109283. * This corresponds to a photographic exposure.
  109284. */
  109285. get cameraExposure(): number;
  109286. /**
  109287. * The camera exposure used on this material.
  109288. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109289. * This corresponds to a photographic exposure.
  109290. */
  109291. set cameraExposure(value: number);
  109292. /**
  109293. * Gets The camera contrast used on this material.
  109294. */
  109295. get cameraContrast(): number;
  109296. /**
  109297. * Sets The camera contrast used on this material.
  109298. */
  109299. set cameraContrast(value: number);
  109300. /**
  109301. * Gets the Color Grading 2D Lookup Texture.
  109302. */
  109303. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  109304. /**
  109305. * Sets the Color Grading 2D Lookup Texture.
  109306. */
  109307. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  109308. /**
  109309. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109310. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109311. * 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;
  109312. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109313. */
  109314. get cameraColorCurves(): Nullable<ColorCurves>;
  109315. /**
  109316. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109317. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109318. * 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;
  109319. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109320. */
  109321. set cameraColorCurves(value: Nullable<ColorCurves>);
  109322. /**
  109323. * Can this material render to several textures at once
  109324. */
  109325. get canRenderToMRT(): boolean;
  109326. /**
  109327. * Defines the detail map parameters for the material.
  109328. */
  109329. readonly detailMap: DetailMapConfiguration;
  109330. protected _renderTargets: SmartArray<RenderTargetTexture>;
  109331. protected _worldViewProjectionMatrix: Matrix;
  109332. protected _globalAmbientColor: Color3;
  109333. protected _useLogarithmicDepth: boolean;
  109334. protected _rebuildInParallel: boolean;
  109335. /**
  109336. * Instantiates a new standard material.
  109337. * This is the default material used in Babylon. It is the best trade off between quality
  109338. * and performances.
  109339. * @see https://doc.babylonjs.com/babylon101/materials
  109340. * @param name Define the name of the material in the scene
  109341. * @param scene Define the scene the material belong to
  109342. */
  109343. constructor(name: string, scene: Scene);
  109344. /**
  109345. * Gets a boolean indicating that current material needs to register RTT
  109346. */
  109347. get hasRenderTargetTextures(): boolean;
  109348. /**
  109349. * Gets the current class name of the material e.g. "StandardMaterial"
  109350. * Mainly use in serialization.
  109351. * @returns the class name
  109352. */
  109353. getClassName(): string;
  109354. /**
  109355. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  109356. * You can try switching to logarithmic depth.
  109357. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  109358. */
  109359. get useLogarithmicDepth(): boolean;
  109360. set useLogarithmicDepth(value: boolean);
  109361. /**
  109362. * Specifies if the material will require alpha blending
  109363. * @returns a boolean specifying if alpha blending is needed
  109364. */
  109365. needAlphaBlending(): boolean;
  109366. /**
  109367. * Specifies if this material should be rendered in alpha test mode
  109368. * @returns a boolean specifying if an alpha test is needed.
  109369. */
  109370. needAlphaTesting(): boolean;
  109371. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  109372. /**
  109373. * Get the texture used for alpha test purpose.
  109374. * @returns the diffuse texture in case of the standard material.
  109375. */
  109376. getAlphaTestTexture(): Nullable<BaseTexture>;
  109377. /**
  109378. * Get if the submesh is ready to be used and all its information available.
  109379. * Child classes can use it to update shaders
  109380. * @param mesh defines the mesh to check
  109381. * @param subMesh defines which submesh to check
  109382. * @param useInstances specifies that instances should be used
  109383. * @returns a boolean indicating that the submesh is ready or not
  109384. */
  109385. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  109386. /**
  109387. * Builds the material UBO layouts.
  109388. * Used internally during the effect preparation.
  109389. */
  109390. buildUniformLayout(): void;
  109391. /**
  109392. * Unbinds the material from the mesh
  109393. */
  109394. unbind(): void;
  109395. /**
  109396. * Binds the submesh to this material by preparing the effect and shader to draw
  109397. * @param world defines the world transformation matrix
  109398. * @param mesh defines the mesh containing the submesh
  109399. * @param subMesh defines the submesh to bind the material to
  109400. */
  109401. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109402. /**
  109403. * Get the list of animatables in the material.
  109404. * @returns the list of animatables object used in the material
  109405. */
  109406. getAnimatables(): IAnimatable[];
  109407. /**
  109408. * Gets the active textures from the material
  109409. * @returns an array of textures
  109410. */
  109411. getActiveTextures(): BaseTexture[];
  109412. /**
  109413. * Specifies if the material uses a texture
  109414. * @param texture defines the texture to check against the material
  109415. * @returns a boolean specifying if the material uses the texture
  109416. */
  109417. hasTexture(texture: BaseTexture): boolean;
  109418. /**
  109419. * Disposes the material
  109420. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  109421. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  109422. */
  109423. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109424. /**
  109425. * Makes a duplicate of the material, and gives it a new name
  109426. * @param name defines the new name for the duplicated material
  109427. * @returns the cloned material
  109428. */
  109429. clone(name: string): StandardMaterial;
  109430. /**
  109431. * Serializes this material in a JSON representation
  109432. * @returns the serialized material object
  109433. */
  109434. serialize(): any;
  109435. /**
  109436. * Creates a standard material from parsed material data
  109437. * @param source defines the JSON representation of the material
  109438. * @param scene defines the hosting scene
  109439. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  109440. * @returns a new standard material
  109441. */
  109442. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  109443. /**
  109444. * Are diffuse textures enabled in the application.
  109445. */
  109446. static get DiffuseTextureEnabled(): boolean;
  109447. static set DiffuseTextureEnabled(value: boolean);
  109448. /**
  109449. * Are detail textures enabled in the application.
  109450. */
  109451. static get DetailTextureEnabled(): boolean;
  109452. static set DetailTextureEnabled(value: boolean);
  109453. /**
  109454. * Are ambient textures enabled in the application.
  109455. */
  109456. static get AmbientTextureEnabled(): boolean;
  109457. static set AmbientTextureEnabled(value: boolean);
  109458. /**
  109459. * Are opacity textures enabled in the application.
  109460. */
  109461. static get OpacityTextureEnabled(): boolean;
  109462. static set OpacityTextureEnabled(value: boolean);
  109463. /**
  109464. * Are reflection textures enabled in the application.
  109465. */
  109466. static get ReflectionTextureEnabled(): boolean;
  109467. static set ReflectionTextureEnabled(value: boolean);
  109468. /**
  109469. * Are emissive textures enabled in the application.
  109470. */
  109471. static get EmissiveTextureEnabled(): boolean;
  109472. static set EmissiveTextureEnabled(value: boolean);
  109473. /**
  109474. * Are specular textures enabled in the application.
  109475. */
  109476. static get SpecularTextureEnabled(): boolean;
  109477. static set SpecularTextureEnabled(value: boolean);
  109478. /**
  109479. * Are bump textures enabled in the application.
  109480. */
  109481. static get BumpTextureEnabled(): boolean;
  109482. static set BumpTextureEnabled(value: boolean);
  109483. /**
  109484. * Are lightmap textures enabled in the application.
  109485. */
  109486. static get LightmapTextureEnabled(): boolean;
  109487. static set LightmapTextureEnabled(value: boolean);
  109488. /**
  109489. * Are refraction textures enabled in the application.
  109490. */
  109491. static get RefractionTextureEnabled(): boolean;
  109492. static set RefractionTextureEnabled(value: boolean);
  109493. /**
  109494. * Are color grading textures enabled in the application.
  109495. */
  109496. static get ColorGradingTextureEnabled(): boolean;
  109497. static set ColorGradingTextureEnabled(value: boolean);
  109498. /**
  109499. * Are fresnels enabled in the application.
  109500. */
  109501. static get FresnelEnabled(): boolean;
  109502. static set FresnelEnabled(value: boolean);
  109503. }
  109504. }
  109505. declare module BABYLON {
  109506. /**
  109507. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  109508. *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.
  109509. * The SPS is also a particle system. It provides some methods to manage the particles.
  109510. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  109511. *
  109512. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  109513. */
  109514. export class SolidParticleSystem implements IDisposable {
  109515. /**
  109516. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  109517. * Example : var p = SPS.particles[i];
  109518. */
  109519. particles: SolidParticle[];
  109520. /**
  109521. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  109522. */
  109523. nbParticles: number;
  109524. /**
  109525. * If the particles must ever face the camera (default false). Useful for planar particles.
  109526. */
  109527. billboard: boolean;
  109528. /**
  109529. * Recompute normals when adding a shape
  109530. */
  109531. recomputeNormals: boolean;
  109532. /**
  109533. * This a counter ofr your own usage. It's not set by any SPS functions.
  109534. */
  109535. counter: number;
  109536. /**
  109537. * The SPS name. This name is also given to the underlying mesh.
  109538. */
  109539. name: string;
  109540. /**
  109541. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  109542. */
  109543. mesh: Mesh;
  109544. /**
  109545. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  109546. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  109547. */
  109548. vars: any;
  109549. /**
  109550. * This array is populated when the SPS is set as 'pickable'.
  109551. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  109552. * Each element of this array is an object `{idx: int, faceId: int}`.
  109553. * `idx` is the picked particle index in the `SPS.particles` array
  109554. * `faceId` is the picked face index counted within this particle.
  109555. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  109556. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  109557. * Use the method SPS.pickedParticle(pickingInfo) instead.
  109558. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  109559. */
  109560. pickedParticles: {
  109561. idx: number;
  109562. faceId: number;
  109563. }[];
  109564. /**
  109565. * This array is populated when the SPS is set as 'pickable'
  109566. * Each key of this array is a submesh index.
  109567. * Each element of this array is a second array defined like this :
  109568. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  109569. * Each element of this second array is an object `{idx: int, faceId: int}`.
  109570. * `idx` is the picked particle index in the `SPS.particles` array
  109571. * `faceId` is the picked face index counted within this particle.
  109572. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  109573. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  109574. */
  109575. pickedBySubMesh: {
  109576. idx: number;
  109577. faceId: number;
  109578. }[][];
  109579. /**
  109580. * This array is populated when `enableDepthSort` is set to true.
  109581. * Each element of this array is an instance of the class DepthSortedParticle.
  109582. */
  109583. depthSortedParticles: DepthSortedParticle[];
  109584. /**
  109585. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  109586. * @hidden
  109587. */
  109588. _bSphereOnly: boolean;
  109589. /**
  109590. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  109591. * @hidden
  109592. */
  109593. _bSphereRadiusFactor: number;
  109594. private _scene;
  109595. private _positions;
  109596. private _indices;
  109597. private _normals;
  109598. private _colors;
  109599. private _uvs;
  109600. private _indices32;
  109601. private _positions32;
  109602. private _normals32;
  109603. private _fixedNormal32;
  109604. private _colors32;
  109605. private _uvs32;
  109606. private _index;
  109607. private _updatable;
  109608. private _pickable;
  109609. private _isVisibilityBoxLocked;
  109610. private _alwaysVisible;
  109611. private _depthSort;
  109612. private _expandable;
  109613. private _shapeCounter;
  109614. private _copy;
  109615. private _color;
  109616. private _computeParticleColor;
  109617. private _computeParticleTexture;
  109618. private _computeParticleRotation;
  109619. private _computeParticleVertex;
  109620. private _computeBoundingBox;
  109621. private _depthSortParticles;
  109622. private _camera;
  109623. private _mustUnrotateFixedNormals;
  109624. private _particlesIntersect;
  109625. private _needs32Bits;
  109626. private _isNotBuilt;
  109627. private _lastParticleId;
  109628. private _idxOfId;
  109629. private _multimaterialEnabled;
  109630. private _useModelMaterial;
  109631. private _indicesByMaterial;
  109632. private _materialIndexes;
  109633. private _depthSortFunction;
  109634. private _materialSortFunction;
  109635. private _materials;
  109636. private _multimaterial;
  109637. private _materialIndexesById;
  109638. private _defaultMaterial;
  109639. private _autoUpdateSubMeshes;
  109640. private _tmpVertex;
  109641. /**
  109642. * Creates a SPS (Solid Particle System) object.
  109643. * @param name (String) is the SPS name, this will be the underlying mesh name.
  109644. * @param scene (Scene) is the scene in which the SPS is added.
  109645. * @param options defines the options of the sps e.g.
  109646. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  109647. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  109648. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  109649. * * 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.
  109650. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  109651. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  109652. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  109653. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  109654. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  109655. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  109656. */
  109657. constructor(name: string, scene: Scene, options?: {
  109658. updatable?: boolean;
  109659. isPickable?: boolean;
  109660. enableDepthSort?: boolean;
  109661. particleIntersection?: boolean;
  109662. boundingSphereOnly?: boolean;
  109663. bSphereRadiusFactor?: number;
  109664. expandable?: boolean;
  109665. useModelMaterial?: boolean;
  109666. enableMultiMaterial?: boolean;
  109667. });
  109668. /**
  109669. * Builds the SPS underlying mesh. Returns a standard Mesh.
  109670. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  109671. * @returns the created mesh
  109672. */
  109673. buildMesh(): Mesh;
  109674. /**
  109675. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  109676. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  109677. * Thus the particles generated from `digest()` have their property `position` set yet.
  109678. * @param mesh ( Mesh ) is the mesh to be digested
  109679. * @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
  109680. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  109681. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  109682. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  109683. * @returns the current SPS
  109684. */
  109685. digest(mesh: Mesh, options?: {
  109686. facetNb?: number;
  109687. number?: number;
  109688. delta?: number;
  109689. storage?: [];
  109690. }): SolidParticleSystem;
  109691. /**
  109692. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  109693. * @hidden
  109694. */
  109695. private _unrotateFixedNormals;
  109696. /**
  109697. * Resets the temporary working copy particle
  109698. * @hidden
  109699. */
  109700. private _resetCopy;
  109701. /**
  109702. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  109703. * @param p the current index in the positions array to be updated
  109704. * @param ind the current index in the indices array
  109705. * @param shape a Vector3 array, the shape geometry
  109706. * @param positions the positions array to be updated
  109707. * @param meshInd the shape indices array
  109708. * @param indices the indices array to be updated
  109709. * @param meshUV the shape uv array
  109710. * @param uvs the uv array to be updated
  109711. * @param meshCol the shape color array
  109712. * @param colors the color array to be updated
  109713. * @param meshNor the shape normals array
  109714. * @param normals the normals array to be updated
  109715. * @param idx the particle index
  109716. * @param idxInShape the particle index in its shape
  109717. * @param options the addShape() method passed options
  109718. * @model the particle model
  109719. * @hidden
  109720. */
  109721. private _meshBuilder;
  109722. /**
  109723. * Returns a shape Vector3 array from positions float array
  109724. * @param positions float array
  109725. * @returns a vector3 array
  109726. * @hidden
  109727. */
  109728. private _posToShape;
  109729. /**
  109730. * Returns a shapeUV array from a float uvs (array deep copy)
  109731. * @param uvs as a float array
  109732. * @returns a shapeUV array
  109733. * @hidden
  109734. */
  109735. private _uvsToShapeUV;
  109736. /**
  109737. * Adds a new particle object in the particles array
  109738. * @param idx particle index in particles array
  109739. * @param id particle id
  109740. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  109741. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  109742. * @param model particle ModelShape object
  109743. * @param shapeId model shape identifier
  109744. * @param idxInShape index of the particle in the current model
  109745. * @param bInfo model bounding info object
  109746. * @param storage target storage array, if any
  109747. * @hidden
  109748. */
  109749. private _addParticle;
  109750. /**
  109751. * Adds some particles to the SPS from the model shape. Returns the shape id.
  109752. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  109753. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  109754. * @param nb (positive integer) the number of particles to be created from this model
  109755. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  109756. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  109757. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  109758. * @returns the number of shapes in the system
  109759. */
  109760. addShape(mesh: Mesh, nb: number, options?: {
  109761. positionFunction?: any;
  109762. vertexFunction?: any;
  109763. storage?: [];
  109764. }): number;
  109765. /**
  109766. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  109767. * @hidden
  109768. */
  109769. private _rebuildParticle;
  109770. /**
  109771. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  109772. * @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.
  109773. * @returns the SPS.
  109774. */
  109775. rebuildMesh(reset?: boolean): SolidParticleSystem;
  109776. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  109777. * Returns an array with the removed particles.
  109778. * 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.
  109779. * The SPS can't be empty so at least one particle needs to remain in place.
  109780. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  109781. * @param start index of the first particle to remove
  109782. * @param end index of the last particle to remove (included)
  109783. * @returns an array populated with the removed particles
  109784. */
  109785. removeParticles(start: number, end: number): SolidParticle[];
  109786. /**
  109787. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  109788. * @param solidParticleArray an array populated with Solid Particles objects
  109789. * @returns the SPS
  109790. */
  109791. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  109792. /**
  109793. * Creates a new particle and modifies the SPS mesh geometry :
  109794. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  109795. * - calls _addParticle() to populate the particle array
  109796. * factorized code from addShape() and insertParticlesFromArray()
  109797. * @param idx particle index in the particles array
  109798. * @param i particle index in its shape
  109799. * @param modelShape particle ModelShape object
  109800. * @param shape shape vertex array
  109801. * @param meshInd shape indices array
  109802. * @param meshUV shape uv array
  109803. * @param meshCol shape color array
  109804. * @param meshNor shape normals array
  109805. * @param bbInfo shape bounding info
  109806. * @param storage target particle storage
  109807. * @options addShape() passed options
  109808. * @hidden
  109809. */
  109810. private _insertNewParticle;
  109811. /**
  109812. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  109813. * This method calls `updateParticle()` for each particle of the SPS.
  109814. * For an animated SPS, it is usually called within the render loop.
  109815. * 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.
  109816. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  109817. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  109818. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  109819. * @returns the SPS.
  109820. */
  109821. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  109822. /**
  109823. * Disposes the SPS.
  109824. */
  109825. dispose(): void;
  109826. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  109827. * idx is the particle index in the SPS
  109828. * faceId is the picked face index counted within this particle.
  109829. * Returns null if the pickInfo can't identify a picked particle.
  109830. * @param pickingInfo (PickingInfo object)
  109831. * @returns {idx: number, faceId: number} or null
  109832. */
  109833. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  109834. idx: number;
  109835. faceId: number;
  109836. }>;
  109837. /**
  109838. * Returns a SolidParticle object from its identifier : particle.id
  109839. * @param id (integer) the particle Id
  109840. * @returns the searched particle or null if not found in the SPS.
  109841. */
  109842. getParticleById(id: number): Nullable<SolidParticle>;
  109843. /**
  109844. * Returns a new array populated with the particles having the passed shapeId.
  109845. * @param shapeId (integer) the shape identifier
  109846. * @returns a new solid particle array
  109847. */
  109848. getParticlesByShapeId(shapeId: number): SolidParticle[];
  109849. /**
  109850. * Populates the passed array "ref" with the particles having the passed shapeId.
  109851. * @param shapeId the shape identifier
  109852. * @returns the SPS
  109853. * @param ref
  109854. */
  109855. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  109856. /**
  109857. * Computes the required SubMeshes according the materials assigned to the particles.
  109858. * @returns the solid particle system.
  109859. * Does nothing if called before the SPS mesh is built.
  109860. */
  109861. computeSubMeshes(): SolidParticleSystem;
  109862. /**
  109863. * Sorts the solid particles by material when MultiMaterial is enabled.
  109864. * Updates the indices32 array.
  109865. * Updates the indicesByMaterial array.
  109866. * Updates the mesh indices array.
  109867. * @returns the SPS
  109868. * @hidden
  109869. */
  109870. private _sortParticlesByMaterial;
  109871. /**
  109872. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  109873. * @hidden
  109874. */
  109875. private _setMaterialIndexesById;
  109876. /**
  109877. * Returns an array with unique values of Materials from the passed array
  109878. * @param array the material array to be checked and filtered
  109879. * @hidden
  109880. */
  109881. private _filterUniqueMaterialId;
  109882. /**
  109883. * Sets a new Standard Material as _defaultMaterial if not already set.
  109884. * @hidden
  109885. */
  109886. private _setDefaultMaterial;
  109887. /**
  109888. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  109889. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109890. * @returns the SPS.
  109891. */
  109892. refreshVisibleSize(): SolidParticleSystem;
  109893. /**
  109894. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  109895. * @param size the size (float) of the visibility box
  109896. * note : this doesn't lock the SPS mesh bounding box.
  109897. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109898. */
  109899. setVisibilityBox(size: number): void;
  109900. /**
  109901. * Gets whether the SPS as always visible or not
  109902. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109903. */
  109904. get isAlwaysVisible(): boolean;
  109905. /**
  109906. * Sets the SPS as always visible or not
  109907. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109908. */
  109909. set isAlwaysVisible(val: boolean);
  109910. /**
  109911. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  109912. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109913. */
  109914. set isVisibilityBoxLocked(val: boolean);
  109915. /**
  109916. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  109917. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109918. */
  109919. get isVisibilityBoxLocked(): boolean;
  109920. /**
  109921. * Tells to `setParticles()` to compute the particle rotations or not.
  109922. * Default value : true. The SPS is faster when it's set to false.
  109923. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  109924. */
  109925. set computeParticleRotation(val: boolean);
  109926. /**
  109927. * Tells to `setParticles()` to compute the particle colors or not.
  109928. * Default value : true. The SPS is faster when it's set to false.
  109929. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  109930. */
  109931. set computeParticleColor(val: boolean);
  109932. set computeParticleTexture(val: boolean);
  109933. /**
  109934. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  109935. * Default value : false. The SPS is faster when it's set to false.
  109936. * Note : the particle custom vertex positions aren't stored values.
  109937. */
  109938. set computeParticleVertex(val: boolean);
  109939. /**
  109940. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  109941. */
  109942. set computeBoundingBox(val: boolean);
  109943. /**
  109944. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  109945. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  109946. * Default : `true`
  109947. */
  109948. set depthSortParticles(val: boolean);
  109949. /**
  109950. * Gets if `setParticles()` computes the particle rotations or not.
  109951. * Default value : true. The SPS is faster when it's set to false.
  109952. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  109953. */
  109954. get computeParticleRotation(): boolean;
  109955. /**
  109956. * Gets if `setParticles()` computes the particle colors or not.
  109957. * Default value : true. The SPS is faster when it's set to false.
  109958. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  109959. */
  109960. get computeParticleColor(): boolean;
  109961. /**
  109962. * Gets if `setParticles()` computes the particle textures or not.
  109963. * Default value : true. The SPS is faster when it's set to false.
  109964. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  109965. */
  109966. get computeParticleTexture(): boolean;
  109967. /**
  109968. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  109969. * Default value : false. The SPS is faster when it's set to false.
  109970. * Note : the particle custom vertex positions aren't stored values.
  109971. */
  109972. get computeParticleVertex(): boolean;
  109973. /**
  109974. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  109975. */
  109976. get computeBoundingBox(): boolean;
  109977. /**
  109978. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  109979. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  109980. * Default : `true`
  109981. */
  109982. get depthSortParticles(): boolean;
  109983. /**
  109984. * Gets if the SPS is created as expandable at construction time.
  109985. * Default : `false`
  109986. */
  109987. get expandable(): boolean;
  109988. /**
  109989. * Gets if the SPS supports the Multi Materials
  109990. */
  109991. get multimaterialEnabled(): boolean;
  109992. /**
  109993. * Gets if the SPS uses the model materials for its own multimaterial.
  109994. */
  109995. get useModelMaterial(): boolean;
  109996. /**
  109997. * The SPS used material array.
  109998. */
  109999. get materials(): Material[];
  110000. /**
  110001. * Sets the SPS MultiMaterial from the passed materials.
  110002. * Note : the passed array is internally copied and not used then by reference.
  110003. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  110004. */
  110005. setMultiMaterial(materials: Material[]): void;
  110006. /**
  110007. * The SPS computed multimaterial object
  110008. */
  110009. get multimaterial(): MultiMaterial;
  110010. set multimaterial(mm: MultiMaterial);
  110011. /**
  110012. * If the subMeshes must be updated on the next call to setParticles()
  110013. */
  110014. get autoUpdateSubMeshes(): boolean;
  110015. set autoUpdateSubMeshes(val: boolean);
  110016. /**
  110017. * This function does nothing. It may be overwritten to set all the particle first values.
  110018. * The SPS doesn't call this function, you may have to call it by your own.
  110019. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110020. */
  110021. initParticles(): void;
  110022. /**
  110023. * This function does nothing. It may be overwritten to recycle a particle.
  110024. * The SPS doesn't call this function, you may have to call it by your own.
  110025. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110026. * @param particle The particle to recycle
  110027. * @returns the recycled particle
  110028. */
  110029. recycleParticle(particle: SolidParticle): SolidParticle;
  110030. /**
  110031. * Updates a particle : this function should be overwritten by the user.
  110032. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  110033. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110034. * @example : just set a particle position or velocity and recycle conditions
  110035. * @param particle The particle to update
  110036. * @returns the updated particle
  110037. */
  110038. updateParticle(particle: SolidParticle): SolidParticle;
  110039. /**
  110040. * Updates a vertex of a particle : it can be overwritten by the user.
  110041. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  110042. * @param particle the current particle
  110043. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  110044. * @param pt the index of the current vertex in the particle shape
  110045. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  110046. * @example : just set a vertex particle position or color
  110047. * @returns the sps
  110048. */
  110049. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  110050. /**
  110051. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  110052. * This does nothing and may be overwritten by the user.
  110053. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110054. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110055. * @param update the boolean update value actually passed to setParticles()
  110056. */
  110057. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110058. /**
  110059. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  110060. * This will be passed three parameters.
  110061. * This does nothing and may be overwritten by the user.
  110062. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110063. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110064. * @param update the boolean update value actually passed to setParticles()
  110065. */
  110066. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110067. }
  110068. }
  110069. declare module BABYLON {
  110070. /**
  110071. * Represents one particle of a solid particle system.
  110072. */
  110073. export class SolidParticle {
  110074. /**
  110075. * particle global index
  110076. */
  110077. idx: number;
  110078. /**
  110079. * particle identifier
  110080. */
  110081. id: number;
  110082. /**
  110083. * The color of the particle
  110084. */
  110085. color: Nullable<Color4>;
  110086. /**
  110087. * The world space position of the particle.
  110088. */
  110089. position: Vector3;
  110090. /**
  110091. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  110092. */
  110093. rotation: Vector3;
  110094. /**
  110095. * The world space rotation quaternion of the particle.
  110096. */
  110097. rotationQuaternion: Nullable<Quaternion>;
  110098. /**
  110099. * The scaling of the particle.
  110100. */
  110101. scaling: Vector3;
  110102. /**
  110103. * The uvs of the particle.
  110104. */
  110105. uvs: Vector4;
  110106. /**
  110107. * The current speed of the particle.
  110108. */
  110109. velocity: Vector3;
  110110. /**
  110111. * The pivot point in the particle local space.
  110112. */
  110113. pivot: Vector3;
  110114. /**
  110115. * Must the particle be translated from its pivot point in its local space ?
  110116. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  110117. * Default : false
  110118. */
  110119. translateFromPivot: boolean;
  110120. /**
  110121. * Is the particle active or not ?
  110122. */
  110123. alive: boolean;
  110124. /**
  110125. * Is the particle visible or not ?
  110126. */
  110127. isVisible: boolean;
  110128. /**
  110129. * Index of this particle in the global "positions" array (Internal use)
  110130. * @hidden
  110131. */
  110132. _pos: number;
  110133. /**
  110134. * @hidden Index of this particle in the global "indices" array (Internal use)
  110135. */
  110136. _ind: number;
  110137. /**
  110138. * @hidden ModelShape of this particle (Internal use)
  110139. */
  110140. _model: ModelShape;
  110141. /**
  110142. * ModelShape id of this particle
  110143. */
  110144. shapeId: number;
  110145. /**
  110146. * Index of the particle in its shape id
  110147. */
  110148. idxInShape: number;
  110149. /**
  110150. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  110151. */
  110152. _modelBoundingInfo: BoundingInfo;
  110153. /**
  110154. * @hidden Particle BoundingInfo object (Internal use)
  110155. */
  110156. _boundingInfo: BoundingInfo;
  110157. /**
  110158. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  110159. */
  110160. _sps: SolidParticleSystem;
  110161. /**
  110162. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  110163. */
  110164. _stillInvisible: boolean;
  110165. /**
  110166. * @hidden Last computed particle rotation matrix
  110167. */
  110168. _rotationMatrix: number[];
  110169. /**
  110170. * Parent particle Id, if any.
  110171. * Default null.
  110172. */
  110173. parentId: Nullable<number>;
  110174. /**
  110175. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  110176. */
  110177. materialIndex: Nullable<number>;
  110178. /**
  110179. * Custom object or properties.
  110180. */
  110181. props: Nullable<any>;
  110182. /**
  110183. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  110184. * The possible values are :
  110185. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  110186. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110187. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  110188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  110189. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110190. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  110191. * */
  110192. cullingStrategy: number;
  110193. /**
  110194. * @hidden Internal global position in the SPS.
  110195. */
  110196. _globalPosition: Vector3;
  110197. /**
  110198. * Creates a Solid Particle object.
  110199. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  110200. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  110201. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  110202. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  110203. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  110204. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  110205. * @param shapeId (integer) is the model shape identifier in the SPS.
  110206. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  110207. * @param sps defines the sps it is associated to
  110208. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  110209. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  110210. */
  110211. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  110212. /**
  110213. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  110214. * @param target the particle target
  110215. * @returns the current particle
  110216. */
  110217. copyToRef(target: SolidParticle): SolidParticle;
  110218. /**
  110219. * Legacy support, changed scale to scaling
  110220. */
  110221. get scale(): Vector3;
  110222. /**
  110223. * Legacy support, changed scale to scaling
  110224. */
  110225. set scale(scale: Vector3);
  110226. /**
  110227. * Legacy support, changed quaternion to rotationQuaternion
  110228. */
  110229. get quaternion(): Nullable<Quaternion>;
  110230. /**
  110231. * Legacy support, changed quaternion to rotationQuaternion
  110232. */
  110233. set quaternion(q: Nullable<Quaternion>);
  110234. /**
  110235. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  110236. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  110237. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  110238. * @returns true if it intersects
  110239. */
  110240. intersectsMesh(target: Mesh | SolidParticle): boolean;
  110241. /**
  110242. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  110243. * A particle is in the frustum if its bounding box intersects the frustum
  110244. * @param frustumPlanes defines the frustum to test
  110245. * @returns true if the particle is in the frustum planes
  110246. */
  110247. isInFrustum(frustumPlanes: Plane[]): boolean;
  110248. /**
  110249. * get the rotation matrix of the particle
  110250. * @hidden
  110251. */
  110252. getRotationMatrix(m: Matrix): void;
  110253. }
  110254. /**
  110255. * Represents the shape of the model used by one particle of a solid particle system.
  110256. * SPS internal tool, don't use it manually.
  110257. */
  110258. export class ModelShape {
  110259. /**
  110260. * The shape id
  110261. * @hidden
  110262. */
  110263. shapeID: number;
  110264. /**
  110265. * flat array of model positions (internal use)
  110266. * @hidden
  110267. */
  110268. _shape: Vector3[];
  110269. /**
  110270. * flat array of model UVs (internal use)
  110271. * @hidden
  110272. */
  110273. _shapeUV: number[];
  110274. /**
  110275. * color array of the model
  110276. * @hidden
  110277. */
  110278. _shapeColors: number[];
  110279. /**
  110280. * indices array of the model
  110281. * @hidden
  110282. */
  110283. _indices: number[];
  110284. /**
  110285. * normals array of the model
  110286. * @hidden
  110287. */
  110288. _normals: number[];
  110289. /**
  110290. * length of the shape in the model indices array (internal use)
  110291. * @hidden
  110292. */
  110293. _indicesLength: number;
  110294. /**
  110295. * Custom position function (internal use)
  110296. * @hidden
  110297. */
  110298. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  110299. /**
  110300. * Custom vertex function (internal use)
  110301. * @hidden
  110302. */
  110303. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  110304. /**
  110305. * Model material (internal use)
  110306. * @hidden
  110307. */
  110308. _material: Nullable<Material>;
  110309. /**
  110310. * 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.
  110311. * SPS internal tool, don't use it manually.
  110312. * @hidden
  110313. */
  110314. 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>);
  110315. }
  110316. /**
  110317. * Represents a Depth Sorted Particle in the solid particle system.
  110318. * @hidden
  110319. */
  110320. export class DepthSortedParticle {
  110321. /**
  110322. * Particle index
  110323. */
  110324. idx: number;
  110325. /**
  110326. * Index of the particle in the "indices" array
  110327. */
  110328. ind: number;
  110329. /**
  110330. * Length of the particle shape in the "indices" array
  110331. */
  110332. indicesLength: number;
  110333. /**
  110334. * Squared distance from the particle to the camera
  110335. */
  110336. sqDistance: number;
  110337. /**
  110338. * Material index when used with MultiMaterials
  110339. */
  110340. materialIndex: number;
  110341. /**
  110342. * Creates a new sorted particle
  110343. * @param materialIndex
  110344. */
  110345. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  110346. }
  110347. /**
  110348. * Represents a solid particle vertex
  110349. */
  110350. export class SolidParticleVertex {
  110351. /**
  110352. * Vertex position
  110353. */
  110354. position: Vector3;
  110355. /**
  110356. * Vertex color
  110357. */
  110358. color: Color4;
  110359. /**
  110360. * Vertex UV
  110361. */
  110362. uv: Vector2;
  110363. /**
  110364. * Creates a new solid particle vertex
  110365. */
  110366. constructor();
  110367. /** Vertex x coordinate */
  110368. get x(): number;
  110369. set x(val: number);
  110370. /** Vertex y coordinate */
  110371. get y(): number;
  110372. set y(val: number);
  110373. /** Vertex z coordinate */
  110374. get z(): number;
  110375. set z(val: number);
  110376. }
  110377. }
  110378. declare module BABYLON {
  110379. /**
  110380. * @hidden
  110381. */
  110382. export class _MeshCollisionData {
  110383. _checkCollisions: boolean;
  110384. _collisionMask: number;
  110385. _collisionGroup: number;
  110386. _surroundingMeshes: Nullable<AbstractMesh[]>;
  110387. _collider: Nullable<Collider>;
  110388. _oldPositionForCollisions: Vector3;
  110389. _diffPositionForCollisions: Vector3;
  110390. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  110391. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  110392. }
  110393. }
  110394. declare module BABYLON {
  110395. /** @hidden */
  110396. class _FacetDataStorage {
  110397. facetPositions: Vector3[];
  110398. facetNormals: Vector3[];
  110399. facetPartitioning: number[][];
  110400. facetNb: number;
  110401. partitioningSubdivisions: number;
  110402. partitioningBBoxRatio: number;
  110403. facetDataEnabled: boolean;
  110404. facetParameters: any;
  110405. bbSize: Vector3;
  110406. subDiv: {
  110407. max: number;
  110408. X: number;
  110409. Y: number;
  110410. Z: number;
  110411. };
  110412. facetDepthSort: boolean;
  110413. facetDepthSortEnabled: boolean;
  110414. depthSortedIndices: IndicesArray;
  110415. depthSortedFacets: {
  110416. ind: number;
  110417. sqDistance: number;
  110418. }[];
  110419. facetDepthSortFunction: (f1: {
  110420. ind: number;
  110421. sqDistance: number;
  110422. }, f2: {
  110423. ind: number;
  110424. sqDistance: number;
  110425. }) => number;
  110426. facetDepthSortFrom: Vector3;
  110427. facetDepthSortOrigin: Vector3;
  110428. invertedMatrix: Matrix;
  110429. }
  110430. /**
  110431. * @hidden
  110432. **/
  110433. class _InternalAbstractMeshDataInfo {
  110434. _hasVertexAlpha: boolean;
  110435. _useVertexColors: boolean;
  110436. _numBoneInfluencers: number;
  110437. _applyFog: boolean;
  110438. _receiveShadows: boolean;
  110439. _facetData: _FacetDataStorage;
  110440. _visibility: number;
  110441. _skeleton: Nullable<Skeleton>;
  110442. _layerMask: number;
  110443. _computeBonesUsingShaders: boolean;
  110444. _isActive: boolean;
  110445. _onlyForInstances: boolean;
  110446. _isActiveIntermediate: boolean;
  110447. _onlyForInstancesIntermediate: boolean;
  110448. _actAsRegularMesh: boolean;
  110449. }
  110450. /**
  110451. * Class used to store all common mesh properties
  110452. */
  110453. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  110454. /** No occlusion */
  110455. static OCCLUSION_TYPE_NONE: number;
  110456. /** Occlusion set to optimisitic */
  110457. static OCCLUSION_TYPE_OPTIMISTIC: number;
  110458. /** Occlusion set to strict */
  110459. static OCCLUSION_TYPE_STRICT: number;
  110460. /** Use an accurante occlusion algorithm */
  110461. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  110462. /** Use a conservative occlusion algorithm */
  110463. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  110464. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  110465. * Test order :
  110466. * Is the bounding sphere outside the frustum ?
  110467. * If not, are the bounding box vertices outside the frustum ?
  110468. * It not, then the cullable object is in the frustum.
  110469. */
  110470. static readonly CULLINGSTRATEGY_STANDARD: number;
  110471. /** Culling strategy : Bounding Sphere Only.
  110472. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  110473. * It's also less accurate than the standard because some not visible objects can still be selected.
  110474. * Test : is the bounding sphere outside the frustum ?
  110475. * If not, then the cullable object is in the frustum.
  110476. */
  110477. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  110478. /** Culling strategy : Optimistic Inclusion.
  110479. * This in an inclusion test first, then the standard exclusion test.
  110480. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  110481. * 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.
  110482. * Anyway, it's as accurate as the standard strategy.
  110483. * Test :
  110484. * Is the cullable object bounding sphere center in the frustum ?
  110485. * If not, apply the default culling strategy.
  110486. */
  110487. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  110488. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  110489. * This in an inclusion test first, then the bounding sphere only exclusion test.
  110490. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  110491. * 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.
  110492. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  110493. * Test :
  110494. * Is the cullable object bounding sphere center in the frustum ?
  110495. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  110496. */
  110497. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  110498. /**
  110499. * No billboard
  110500. */
  110501. static get BILLBOARDMODE_NONE(): number;
  110502. /** Billboard on X axis */
  110503. static get BILLBOARDMODE_X(): number;
  110504. /** Billboard on Y axis */
  110505. static get BILLBOARDMODE_Y(): number;
  110506. /** Billboard on Z axis */
  110507. static get BILLBOARDMODE_Z(): number;
  110508. /** Billboard on all axes */
  110509. static get BILLBOARDMODE_ALL(): number;
  110510. /** Billboard on using position instead of orientation */
  110511. static get BILLBOARDMODE_USE_POSITION(): number;
  110512. /** @hidden */
  110513. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  110514. /**
  110515. * The culling strategy to use to check whether the mesh must be rendered or not.
  110516. * This value can be changed at any time and will be used on the next render mesh selection.
  110517. * The possible values are :
  110518. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  110519. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110520. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  110521. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  110522. * Please read each static variable documentation to get details about the culling process.
  110523. * */
  110524. cullingStrategy: number;
  110525. /**
  110526. * Gets the number of facets in the mesh
  110527. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  110528. */
  110529. get facetNb(): number;
  110530. /**
  110531. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  110532. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  110533. */
  110534. get partitioningSubdivisions(): number;
  110535. set partitioningSubdivisions(nb: number);
  110536. /**
  110537. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  110538. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  110539. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  110540. */
  110541. get partitioningBBoxRatio(): number;
  110542. set partitioningBBoxRatio(ratio: number);
  110543. /**
  110544. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  110545. * Works only for updatable meshes.
  110546. * Doesn't work with multi-materials
  110547. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  110548. */
  110549. get mustDepthSortFacets(): boolean;
  110550. set mustDepthSortFacets(sort: boolean);
  110551. /**
  110552. * The location (Vector3) where the facet depth sort must be computed from.
  110553. * By default, the active camera position.
  110554. * Used only when facet depth sort is enabled
  110555. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  110556. */
  110557. get facetDepthSortFrom(): Vector3;
  110558. set facetDepthSortFrom(location: Vector3);
  110559. /**
  110560. * gets a boolean indicating if facetData is enabled
  110561. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  110562. */
  110563. get isFacetDataEnabled(): boolean;
  110564. /** @hidden */
  110565. _updateNonUniformScalingState(value: boolean): boolean;
  110566. /**
  110567. * An event triggered when this mesh collides with another one
  110568. */
  110569. onCollideObservable: Observable<AbstractMesh>;
  110570. /** Set a function to call when this mesh collides with another one */
  110571. set onCollide(callback: () => void);
  110572. /**
  110573. * An event triggered when the collision's position changes
  110574. */
  110575. onCollisionPositionChangeObservable: Observable<Vector3>;
  110576. /** Set a function to call when the collision's position changes */
  110577. set onCollisionPositionChange(callback: () => void);
  110578. /**
  110579. * An event triggered when material is changed
  110580. */
  110581. onMaterialChangedObservable: Observable<AbstractMesh>;
  110582. /**
  110583. * Gets or sets the orientation for POV movement & rotation
  110584. */
  110585. definedFacingForward: boolean;
  110586. /** @hidden */
  110587. _occlusionQuery: Nullable<WebGLQuery>;
  110588. /** @hidden */
  110589. _renderingGroup: Nullable<RenderingGroup>;
  110590. /**
  110591. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  110592. */
  110593. get visibility(): number;
  110594. /**
  110595. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  110596. */
  110597. set visibility(value: number);
  110598. /** Gets or sets the alpha index used to sort transparent meshes
  110599. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  110600. */
  110601. alphaIndex: number;
  110602. /**
  110603. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  110604. */
  110605. isVisible: boolean;
  110606. /**
  110607. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  110608. */
  110609. isPickable: boolean;
  110610. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  110611. showSubMeshesBoundingBox: boolean;
  110612. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  110613. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  110614. */
  110615. isBlocker: boolean;
  110616. /**
  110617. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  110618. */
  110619. enablePointerMoveEvents: boolean;
  110620. /**
  110621. * Specifies the rendering group id for this mesh (0 by default)
  110622. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  110623. */
  110624. renderingGroupId: number;
  110625. private _material;
  110626. /** Gets or sets current material */
  110627. get material(): Nullable<Material>;
  110628. set material(value: Nullable<Material>);
  110629. /**
  110630. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  110631. * @see https://doc.babylonjs.com/babylon101/shadows
  110632. */
  110633. get receiveShadows(): boolean;
  110634. set receiveShadows(value: boolean);
  110635. /** Defines color to use when rendering outline */
  110636. outlineColor: Color3;
  110637. /** Define width to use when rendering outline */
  110638. outlineWidth: number;
  110639. /** Defines color to use when rendering overlay */
  110640. overlayColor: Color3;
  110641. /** Defines alpha to use when rendering overlay */
  110642. overlayAlpha: number;
  110643. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  110644. get hasVertexAlpha(): boolean;
  110645. set hasVertexAlpha(value: boolean);
  110646. /** 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) */
  110647. get useVertexColors(): boolean;
  110648. set useVertexColors(value: boolean);
  110649. /**
  110650. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  110651. */
  110652. get computeBonesUsingShaders(): boolean;
  110653. set computeBonesUsingShaders(value: boolean);
  110654. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  110655. get numBoneInfluencers(): number;
  110656. set numBoneInfluencers(value: number);
  110657. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  110658. get applyFog(): boolean;
  110659. set applyFog(value: boolean);
  110660. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  110661. useOctreeForRenderingSelection: boolean;
  110662. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  110663. useOctreeForPicking: boolean;
  110664. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  110665. useOctreeForCollisions: boolean;
  110666. /**
  110667. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  110668. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  110669. */
  110670. get layerMask(): number;
  110671. set layerMask(value: number);
  110672. /**
  110673. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  110674. */
  110675. alwaysSelectAsActiveMesh: boolean;
  110676. /**
  110677. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  110678. */
  110679. doNotSyncBoundingInfo: boolean;
  110680. /**
  110681. * Gets or sets the current action manager
  110682. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  110683. */
  110684. actionManager: Nullable<AbstractActionManager>;
  110685. private _meshCollisionData;
  110686. /**
  110687. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  110688. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110689. */
  110690. ellipsoid: Vector3;
  110691. /**
  110692. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  110693. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110694. */
  110695. ellipsoidOffset: Vector3;
  110696. /**
  110697. * Gets or sets a collision mask used to mask collisions (default is -1).
  110698. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  110699. */
  110700. get collisionMask(): number;
  110701. set collisionMask(mask: number);
  110702. /**
  110703. * Gets or sets the current collision group mask (-1 by default).
  110704. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  110705. */
  110706. get collisionGroup(): number;
  110707. set collisionGroup(mask: number);
  110708. /**
  110709. * Gets or sets current surrounding meshes (null by default).
  110710. *
  110711. * By default collision detection is tested against every mesh in the scene.
  110712. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  110713. * meshes will be tested for the collision.
  110714. *
  110715. * Note: if set to an empty array no collision will happen when this mesh is moved.
  110716. */
  110717. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  110718. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  110719. /**
  110720. * Defines edge width used when edgesRenderer is enabled
  110721. * @see https://www.babylonjs-playground.com/#10OJSG#13
  110722. */
  110723. edgesWidth: number;
  110724. /**
  110725. * Defines edge color used when edgesRenderer is enabled
  110726. * @see https://www.babylonjs-playground.com/#10OJSG#13
  110727. */
  110728. edgesColor: Color4;
  110729. /** @hidden */
  110730. _edgesRenderer: Nullable<IEdgesRenderer>;
  110731. /** @hidden */
  110732. _masterMesh: Nullable<AbstractMesh>;
  110733. /** @hidden */
  110734. _boundingInfo: Nullable<BoundingInfo>;
  110735. /** @hidden */
  110736. _renderId: number;
  110737. /**
  110738. * Gets or sets the list of subMeshes
  110739. * @see https://doc.babylonjs.com/how_to/multi_materials
  110740. */
  110741. subMeshes: SubMesh[];
  110742. /** @hidden */
  110743. _intersectionsInProgress: AbstractMesh[];
  110744. /** @hidden */
  110745. _unIndexed: boolean;
  110746. /** @hidden */
  110747. _lightSources: Light[];
  110748. /** Gets the list of lights affecting that mesh */
  110749. get lightSources(): Light[];
  110750. /** @hidden */
  110751. get _positions(): Nullable<Vector3[]>;
  110752. /** @hidden */
  110753. _waitingData: {
  110754. lods: Nullable<any>;
  110755. actions: Nullable<any>;
  110756. freezeWorldMatrix: Nullable<boolean>;
  110757. };
  110758. /** @hidden */
  110759. _bonesTransformMatrices: Nullable<Float32Array>;
  110760. /** @hidden */
  110761. _transformMatrixTexture: Nullable<RawTexture>;
  110762. /**
  110763. * Gets or sets a skeleton to apply skining transformations
  110764. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  110765. */
  110766. set skeleton(value: Nullable<Skeleton>);
  110767. get skeleton(): Nullable<Skeleton>;
  110768. /**
  110769. * An event triggered when the mesh is rebuilt.
  110770. */
  110771. onRebuildObservable: Observable<AbstractMesh>;
  110772. /**
  110773. * Creates a new AbstractMesh
  110774. * @param name defines the name of the mesh
  110775. * @param scene defines the hosting scene
  110776. */
  110777. constructor(name: string, scene?: Nullable<Scene>);
  110778. /**
  110779. * Returns the string "AbstractMesh"
  110780. * @returns "AbstractMesh"
  110781. */
  110782. getClassName(): string;
  110783. /**
  110784. * Gets a string representation of the current mesh
  110785. * @param fullDetails defines a boolean indicating if full details must be included
  110786. * @returns a string representation of the current mesh
  110787. */
  110788. toString(fullDetails?: boolean): string;
  110789. /**
  110790. * @hidden
  110791. */
  110792. protected _getEffectiveParent(): Nullable<Node>;
  110793. /** @hidden */
  110794. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  110795. /** @hidden */
  110796. _rebuild(): void;
  110797. /** @hidden */
  110798. _resyncLightSources(): void;
  110799. /** @hidden */
  110800. _resyncLightSource(light: Light): void;
  110801. /** @hidden */
  110802. _unBindEffect(): void;
  110803. /** @hidden */
  110804. _removeLightSource(light: Light, dispose: boolean): void;
  110805. private _markSubMeshesAsDirty;
  110806. /** @hidden */
  110807. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  110808. /** @hidden */
  110809. _markSubMeshesAsAttributesDirty(): void;
  110810. /** @hidden */
  110811. _markSubMeshesAsMiscDirty(): void;
  110812. /**
  110813. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  110814. */
  110815. get scaling(): Vector3;
  110816. set scaling(newScaling: Vector3);
  110817. /**
  110818. * Returns true if the mesh is blocked. Implemented by child classes
  110819. */
  110820. get isBlocked(): boolean;
  110821. /**
  110822. * Returns the mesh itself by default. Implemented by child classes
  110823. * @param camera defines the camera to use to pick the right LOD level
  110824. * @returns the currentAbstractMesh
  110825. */
  110826. getLOD(camera: Camera): Nullable<AbstractMesh>;
  110827. /**
  110828. * Returns 0 by default. Implemented by child classes
  110829. * @returns an integer
  110830. */
  110831. getTotalVertices(): number;
  110832. /**
  110833. * Returns a positive integer : the total number of indices in this mesh geometry.
  110834. * @returns the numner of indices or zero if the mesh has no geometry.
  110835. */
  110836. getTotalIndices(): number;
  110837. /**
  110838. * Returns null by default. Implemented by child classes
  110839. * @returns null
  110840. */
  110841. getIndices(): Nullable<IndicesArray>;
  110842. /**
  110843. * Returns the array of the requested vertex data kind. Implemented by child classes
  110844. * @param kind defines the vertex data kind to use
  110845. * @returns null
  110846. */
  110847. getVerticesData(kind: string): Nullable<FloatArray>;
  110848. /**
  110849. * Sets the vertex data of the mesh geometry for the requested `kind`.
  110850. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  110851. * Note that a new underlying VertexBuffer object is created each call.
  110852. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  110853. * @param kind defines vertex data kind:
  110854. * * VertexBuffer.PositionKind
  110855. * * VertexBuffer.UVKind
  110856. * * VertexBuffer.UV2Kind
  110857. * * VertexBuffer.UV3Kind
  110858. * * VertexBuffer.UV4Kind
  110859. * * VertexBuffer.UV5Kind
  110860. * * VertexBuffer.UV6Kind
  110861. * * VertexBuffer.ColorKind
  110862. * * VertexBuffer.MatricesIndicesKind
  110863. * * VertexBuffer.MatricesIndicesExtraKind
  110864. * * VertexBuffer.MatricesWeightsKind
  110865. * * VertexBuffer.MatricesWeightsExtraKind
  110866. * @param data defines the data source
  110867. * @param updatable defines if the data must be flagged as updatable (or static)
  110868. * @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
  110869. * @returns the current mesh
  110870. */
  110871. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  110872. /**
  110873. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  110874. * If the mesh has no geometry, it is simply returned as it is.
  110875. * @param kind defines vertex data kind:
  110876. * * VertexBuffer.PositionKind
  110877. * * VertexBuffer.UVKind
  110878. * * VertexBuffer.UV2Kind
  110879. * * VertexBuffer.UV3Kind
  110880. * * VertexBuffer.UV4Kind
  110881. * * VertexBuffer.UV5Kind
  110882. * * VertexBuffer.UV6Kind
  110883. * * VertexBuffer.ColorKind
  110884. * * VertexBuffer.MatricesIndicesKind
  110885. * * VertexBuffer.MatricesIndicesExtraKind
  110886. * * VertexBuffer.MatricesWeightsKind
  110887. * * VertexBuffer.MatricesWeightsExtraKind
  110888. * @param data defines the data source
  110889. * @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
  110890. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  110891. * @returns the current mesh
  110892. */
  110893. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  110894. /**
  110895. * Sets the mesh indices,
  110896. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  110897. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  110898. * @param totalVertices Defines the total number of vertices
  110899. * @returns the current mesh
  110900. */
  110901. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  110902. /**
  110903. * Gets a boolean indicating if specific vertex data is present
  110904. * @param kind defines the vertex data kind to use
  110905. * @returns true is data kind is present
  110906. */
  110907. isVerticesDataPresent(kind: string): boolean;
  110908. /**
  110909. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  110910. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  110911. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  110912. * @returns a BoundingInfo
  110913. */
  110914. getBoundingInfo(): BoundingInfo;
  110915. /**
  110916. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  110917. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  110918. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  110919. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  110920. * @returns the current mesh
  110921. */
  110922. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  110923. /**
  110924. * Overwrite the current bounding info
  110925. * @param boundingInfo defines the new bounding info
  110926. * @returns the current mesh
  110927. */
  110928. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  110929. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  110930. get useBones(): boolean;
  110931. /** @hidden */
  110932. _preActivate(): void;
  110933. /** @hidden */
  110934. _preActivateForIntermediateRendering(renderId: number): void;
  110935. /** @hidden */
  110936. _activate(renderId: number, intermediateRendering: boolean): boolean;
  110937. /** @hidden */
  110938. _postActivate(): void;
  110939. /** @hidden */
  110940. _freeze(): void;
  110941. /** @hidden */
  110942. _unFreeze(): void;
  110943. /**
  110944. * Gets the current world matrix
  110945. * @returns a Matrix
  110946. */
  110947. getWorldMatrix(): Matrix;
  110948. /** @hidden */
  110949. _getWorldMatrixDeterminant(): number;
  110950. /**
  110951. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  110952. */
  110953. get isAnInstance(): boolean;
  110954. /**
  110955. * Gets a boolean indicating if this mesh has instances
  110956. */
  110957. get hasInstances(): boolean;
  110958. /**
  110959. * Gets a boolean indicating if this mesh has thin instances
  110960. */
  110961. get hasThinInstances(): boolean;
  110962. /**
  110963. * Perform relative position change from the point of view of behind the front of the mesh.
  110964. * This is performed taking into account the meshes current rotation, so you do not have to care.
  110965. * Supports definition of mesh facing forward or backward
  110966. * @param amountRight defines the distance on the right axis
  110967. * @param amountUp defines the distance on the up axis
  110968. * @param amountForward defines the distance on the forward axis
  110969. * @returns the current mesh
  110970. */
  110971. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  110972. /**
  110973. * Calculate relative position change from the point of view of behind the front of the mesh.
  110974. * This is performed taking into account the meshes current rotation, so you do not have to care.
  110975. * Supports definition of mesh facing forward or backward
  110976. * @param amountRight defines the distance on the right axis
  110977. * @param amountUp defines the distance on the up axis
  110978. * @param amountForward defines the distance on the forward axis
  110979. * @returns the new displacement vector
  110980. */
  110981. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  110982. /**
  110983. * Perform relative rotation change from the point of view of behind the front of the mesh.
  110984. * Supports definition of mesh facing forward or backward
  110985. * @param flipBack defines the flip
  110986. * @param twirlClockwise defines the twirl
  110987. * @param tiltRight defines the tilt
  110988. * @returns the current mesh
  110989. */
  110990. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  110991. /**
  110992. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  110993. * Supports definition of mesh facing forward or backward.
  110994. * @param flipBack defines the flip
  110995. * @param twirlClockwise defines the twirl
  110996. * @param tiltRight defines the tilt
  110997. * @returns the new rotation vector
  110998. */
  110999. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  111000. /**
  111001. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  111002. * This means the mesh underlying bounding box and sphere are recomputed.
  111003. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  111004. * @returns the current mesh
  111005. */
  111006. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  111007. /** @hidden */
  111008. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  111009. /** @hidden */
  111010. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  111011. /** @hidden */
  111012. _updateBoundingInfo(): AbstractMesh;
  111013. /** @hidden */
  111014. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  111015. /** @hidden */
  111016. protected _afterComputeWorldMatrix(): void;
  111017. /** @hidden */
  111018. get _effectiveMesh(): AbstractMesh;
  111019. /**
  111020. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  111021. * A mesh is in the frustum if its bounding box intersects the frustum
  111022. * @param frustumPlanes defines the frustum to test
  111023. * @returns true if the mesh is in the frustum planes
  111024. */
  111025. isInFrustum(frustumPlanes: Plane[]): boolean;
  111026. /**
  111027. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  111028. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  111029. * @param frustumPlanes defines the frustum to test
  111030. * @returns true if the mesh is completely in the frustum planes
  111031. */
  111032. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  111033. /**
  111034. * True if the mesh intersects another mesh or a SolidParticle object
  111035. * @param mesh defines a target mesh or SolidParticle to test
  111036. * @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)
  111037. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  111038. * @returns true if there is an intersection
  111039. */
  111040. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  111041. /**
  111042. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  111043. * @param point defines the point to test
  111044. * @returns true if there is an intersection
  111045. */
  111046. intersectsPoint(point: Vector3): boolean;
  111047. /**
  111048. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  111049. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111050. */
  111051. get checkCollisions(): boolean;
  111052. set checkCollisions(collisionEnabled: boolean);
  111053. /**
  111054. * Gets Collider object used to compute collisions (not physics)
  111055. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111056. */
  111057. get collider(): Nullable<Collider>;
  111058. /**
  111059. * Move the mesh using collision engine
  111060. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111061. * @param displacement defines the requested displacement vector
  111062. * @returns the current mesh
  111063. */
  111064. moveWithCollisions(displacement: Vector3): AbstractMesh;
  111065. private _onCollisionPositionChange;
  111066. /** @hidden */
  111067. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  111068. /** @hidden */
  111069. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  111070. /** @hidden */
  111071. _checkCollision(collider: Collider): AbstractMesh;
  111072. /** @hidden */
  111073. _generatePointsArray(): boolean;
  111074. /**
  111075. * Checks if the passed Ray intersects with the mesh
  111076. * @param ray defines the ray to use
  111077. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  111078. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  111079. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  111080. * @returns the picking info
  111081. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  111082. */
  111083. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  111084. /**
  111085. * Clones the current mesh
  111086. * @param name defines the mesh name
  111087. * @param newParent defines the new mesh parent
  111088. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  111089. * @returns the new mesh
  111090. */
  111091. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  111092. /**
  111093. * Disposes all the submeshes of the current meshnp
  111094. * @returns the current mesh
  111095. */
  111096. releaseSubMeshes(): AbstractMesh;
  111097. /**
  111098. * Releases resources associated with this abstract mesh.
  111099. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111100. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111101. */
  111102. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111103. /**
  111104. * Adds the passed mesh as a child to the current mesh
  111105. * @param mesh defines the child mesh
  111106. * @returns the current mesh
  111107. */
  111108. addChild(mesh: AbstractMesh): AbstractMesh;
  111109. /**
  111110. * Removes the passed mesh from the current mesh children list
  111111. * @param mesh defines the child mesh
  111112. * @returns the current mesh
  111113. */
  111114. removeChild(mesh: AbstractMesh): AbstractMesh;
  111115. /** @hidden */
  111116. private _initFacetData;
  111117. /**
  111118. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  111119. * This method can be called within the render loop.
  111120. * 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
  111121. * @returns the current mesh
  111122. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111123. */
  111124. updateFacetData(): AbstractMesh;
  111125. /**
  111126. * Returns the facetLocalNormals array.
  111127. * The normals are expressed in the mesh local spac
  111128. * @returns an array of Vector3
  111129. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111130. */
  111131. getFacetLocalNormals(): Vector3[];
  111132. /**
  111133. * Returns the facetLocalPositions array.
  111134. * The facet positions are expressed in the mesh local space
  111135. * @returns an array of Vector3
  111136. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111137. */
  111138. getFacetLocalPositions(): Vector3[];
  111139. /**
  111140. * Returns the facetLocalPartioning array
  111141. * @returns an array of array of numbers
  111142. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111143. */
  111144. getFacetLocalPartitioning(): number[][];
  111145. /**
  111146. * Returns the i-th facet position in the world system.
  111147. * This method allocates a new Vector3 per call
  111148. * @param i defines the facet index
  111149. * @returns a new Vector3
  111150. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111151. */
  111152. getFacetPosition(i: number): Vector3;
  111153. /**
  111154. * Sets the reference Vector3 with the i-th facet position in the world system
  111155. * @param i defines the facet index
  111156. * @param ref defines the target vector
  111157. * @returns the current mesh
  111158. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111159. */
  111160. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  111161. /**
  111162. * Returns the i-th facet normal in the world system.
  111163. * This method allocates a new Vector3 per call
  111164. * @param i defines the facet index
  111165. * @returns a new Vector3
  111166. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111167. */
  111168. getFacetNormal(i: number): Vector3;
  111169. /**
  111170. * Sets the reference Vector3 with the i-th facet normal in the world system
  111171. * @param i defines the facet index
  111172. * @param ref defines the target vector
  111173. * @returns the current mesh
  111174. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111175. */
  111176. getFacetNormalToRef(i: number, ref: Vector3): this;
  111177. /**
  111178. * 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)
  111179. * @param x defines x coordinate
  111180. * @param y defines y coordinate
  111181. * @param z defines z coordinate
  111182. * @returns the array of facet indexes
  111183. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111184. */
  111185. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  111186. /**
  111187. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  111188. * @param projected sets as the (x,y,z) world projection on the facet
  111189. * @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
  111190. * @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
  111191. * @param x defines x coordinate
  111192. * @param y defines y coordinate
  111193. * @param z defines z coordinate
  111194. * @returns the face index if found (or null instead)
  111195. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111196. */
  111197. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  111198. /**
  111199. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  111200. * @param projected sets as the (x,y,z) local projection on the facet
  111201. * @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
  111202. * @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
  111203. * @param x defines x coordinate
  111204. * @param y defines y coordinate
  111205. * @param z defines z coordinate
  111206. * @returns the face index if found (or null instead)
  111207. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111208. */
  111209. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  111210. /**
  111211. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  111212. * @returns the parameters
  111213. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111214. */
  111215. getFacetDataParameters(): any;
  111216. /**
  111217. * Disables the feature FacetData and frees the related memory
  111218. * @returns the current mesh
  111219. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111220. */
  111221. disableFacetData(): AbstractMesh;
  111222. /**
  111223. * Updates the AbstractMesh indices array
  111224. * @param indices defines the data source
  111225. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  111226. * @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)
  111227. * @returns the current mesh
  111228. */
  111229. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  111230. /**
  111231. * Creates new normals data for the mesh
  111232. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  111233. * @returns the current mesh
  111234. */
  111235. createNormals(updatable: boolean): AbstractMesh;
  111236. /**
  111237. * Align the mesh with a normal
  111238. * @param normal defines the normal to use
  111239. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  111240. * @returns the current mesh
  111241. */
  111242. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  111243. /** @hidden */
  111244. _checkOcclusionQuery(): boolean;
  111245. /**
  111246. * Disables the mesh edge rendering mode
  111247. * @returns the currentAbstractMesh
  111248. */
  111249. disableEdgesRendering(): AbstractMesh;
  111250. /**
  111251. * Enables the edge rendering mode on the mesh.
  111252. * This mode makes the mesh edges visible
  111253. * @param epsilon defines the maximal distance between two angles to detect a face
  111254. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  111255. * @returns the currentAbstractMesh
  111256. * @see https://www.babylonjs-playground.com/#19O9TU#0
  111257. */
  111258. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  111259. /**
  111260. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  111261. * @returns an array of particle systems in the scene that use the mesh as an emitter
  111262. */
  111263. getConnectedParticleSystems(): IParticleSystem[];
  111264. }
  111265. }
  111266. declare module BABYLON {
  111267. /**
  111268. * Interface used to define ActionEvent
  111269. */
  111270. export interface IActionEvent {
  111271. /** The mesh or sprite that triggered the action */
  111272. source: any;
  111273. /** The X mouse cursor position at the time of the event */
  111274. pointerX: number;
  111275. /** The Y mouse cursor position at the time of the event */
  111276. pointerY: number;
  111277. /** The mesh that is currently pointed at (can be null) */
  111278. meshUnderPointer: Nullable<AbstractMesh>;
  111279. /** the original (browser) event that triggered the ActionEvent */
  111280. sourceEvent?: any;
  111281. /** additional data for the event */
  111282. additionalData?: any;
  111283. }
  111284. /**
  111285. * ActionEvent is the event being sent when an action is triggered.
  111286. */
  111287. export class ActionEvent implements IActionEvent {
  111288. /** The mesh or sprite that triggered the action */
  111289. source: any;
  111290. /** The X mouse cursor position at the time of the event */
  111291. pointerX: number;
  111292. /** The Y mouse cursor position at the time of the event */
  111293. pointerY: number;
  111294. /** The mesh that is currently pointed at (can be null) */
  111295. meshUnderPointer: Nullable<AbstractMesh>;
  111296. /** the original (browser) event that triggered the ActionEvent */
  111297. sourceEvent?: any;
  111298. /** additional data for the event */
  111299. additionalData?: any;
  111300. /**
  111301. * Creates a new ActionEvent
  111302. * @param source The mesh or sprite that triggered the action
  111303. * @param pointerX The X mouse cursor position at the time of the event
  111304. * @param pointerY The Y mouse cursor position at the time of the event
  111305. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  111306. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  111307. * @param additionalData additional data for the event
  111308. */
  111309. constructor(
  111310. /** The mesh or sprite that triggered the action */
  111311. source: any,
  111312. /** The X mouse cursor position at the time of the event */
  111313. pointerX: number,
  111314. /** The Y mouse cursor position at the time of the event */
  111315. pointerY: number,
  111316. /** The mesh that is currently pointed at (can be null) */
  111317. meshUnderPointer: Nullable<AbstractMesh>,
  111318. /** the original (browser) event that triggered the ActionEvent */
  111319. sourceEvent?: any,
  111320. /** additional data for the event */
  111321. additionalData?: any);
  111322. /**
  111323. * Helper function to auto-create an ActionEvent from a source mesh.
  111324. * @param source The source mesh that triggered the event
  111325. * @param evt The original (browser) event
  111326. * @param additionalData additional data for the event
  111327. * @returns the new ActionEvent
  111328. */
  111329. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  111330. /**
  111331. * Helper function to auto-create an ActionEvent from a source sprite
  111332. * @param source The source sprite that triggered the event
  111333. * @param scene Scene associated with the sprite
  111334. * @param evt The original (browser) event
  111335. * @param additionalData additional data for the event
  111336. * @returns the new ActionEvent
  111337. */
  111338. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  111339. /**
  111340. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  111341. * @param scene the scene where the event occurred
  111342. * @param evt The original (browser) event
  111343. * @returns the new ActionEvent
  111344. */
  111345. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  111346. /**
  111347. * Helper function to auto-create an ActionEvent from a primitive
  111348. * @param prim defines the target primitive
  111349. * @param pointerPos defines the pointer position
  111350. * @param evt The original (browser) event
  111351. * @param additionalData additional data for the event
  111352. * @returns the new ActionEvent
  111353. */
  111354. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  111355. }
  111356. }
  111357. declare module BABYLON {
  111358. /**
  111359. * Abstract class used to decouple action Manager from scene and meshes.
  111360. * Do not instantiate.
  111361. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111362. */
  111363. export abstract class AbstractActionManager implements IDisposable {
  111364. /** Gets the list of active triggers */
  111365. static Triggers: {
  111366. [key: string]: number;
  111367. };
  111368. /** Gets the cursor to use when hovering items */
  111369. hoverCursor: string;
  111370. /** Gets the list of actions */
  111371. actions: IAction[];
  111372. /**
  111373. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  111374. */
  111375. isRecursive: boolean;
  111376. /**
  111377. * Releases all associated resources
  111378. */
  111379. abstract dispose(): void;
  111380. /**
  111381. * Does this action manager has pointer triggers
  111382. */
  111383. abstract get hasPointerTriggers(): boolean;
  111384. /**
  111385. * Does this action manager has pick triggers
  111386. */
  111387. abstract get hasPickTriggers(): boolean;
  111388. /**
  111389. * Process a specific trigger
  111390. * @param trigger defines the trigger to process
  111391. * @param evt defines the event details to be processed
  111392. */
  111393. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  111394. /**
  111395. * Does this action manager handles actions of any of the given triggers
  111396. * @param triggers defines the triggers to be tested
  111397. * @return a boolean indicating whether one (or more) of the triggers is handled
  111398. */
  111399. abstract hasSpecificTriggers(triggers: number[]): boolean;
  111400. /**
  111401. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  111402. * speed.
  111403. * @param triggerA defines the trigger to be tested
  111404. * @param triggerB defines the trigger to be tested
  111405. * @return a boolean indicating whether one (or more) of the triggers is handled
  111406. */
  111407. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  111408. /**
  111409. * Does this action manager handles actions of a given trigger
  111410. * @param trigger defines the trigger to be tested
  111411. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  111412. * @return whether the trigger is handled
  111413. */
  111414. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  111415. /**
  111416. * Serialize this manager to a JSON object
  111417. * @param name defines the property name to store this manager
  111418. * @returns a JSON representation of this manager
  111419. */
  111420. abstract serialize(name: string): any;
  111421. /**
  111422. * Registers an action to this action manager
  111423. * @param action defines the action to be registered
  111424. * @return the action amended (prepared) after registration
  111425. */
  111426. abstract registerAction(action: IAction): Nullable<IAction>;
  111427. /**
  111428. * Unregisters an action to this action manager
  111429. * @param action defines the action to be unregistered
  111430. * @return a boolean indicating whether the action has been unregistered
  111431. */
  111432. abstract unregisterAction(action: IAction): Boolean;
  111433. /**
  111434. * Does exist one action manager with at least one trigger
  111435. **/
  111436. static get HasTriggers(): boolean;
  111437. /**
  111438. * Does exist one action manager with at least one pick trigger
  111439. **/
  111440. static get HasPickTriggers(): boolean;
  111441. /**
  111442. * Does exist one action manager that handles actions of a given trigger
  111443. * @param trigger defines the trigger to be tested
  111444. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  111445. **/
  111446. static HasSpecificTrigger(trigger: number): boolean;
  111447. }
  111448. }
  111449. declare module BABYLON {
  111450. /**
  111451. * Defines how a node can be built from a string name.
  111452. */
  111453. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  111454. /**
  111455. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  111456. */
  111457. export class Node implements IBehaviorAware<Node> {
  111458. /** @hidden */
  111459. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  111460. private static _NodeConstructors;
  111461. /**
  111462. * Add a new node constructor
  111463. * @param type defines the type name of the node to construct
  111464. * @param constructorFunc defines the constructor function
  111465. */
  111466. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  111467. /**
  111468. * Returns a node constructor based on type name
  111469. * @param type defines the type name
  111470. * @param name defines the new node name
  111471. * @param scene defines the hosting scene
  111472. * @param options defines optional options to transmit to constructors
  111473. * @returns the new constructor or null
  111474. */
  111475. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  111476. /**
  111477. * Gets or sets the name of the node
  111478. */
  111479. name: string;
  111480. /**
  111481. * Gets or sets the id of the node
  111482. */
  111483. id: string;
  111484. /**
  111485. * Gets or sets the unique id of the node
  111486. */
  111487. uniqueId: number;
  111488. /**
  111489. * Gets or sets a string used to store user defined state for the node
  111490. */
  111491. state: string;
  111492. /**
  111493. * Gets or sets an object used to store user defined information for the node
  111494. */
  111495. metadata: any;
  111496. /**
  111497. * For internal use only. Please do not use.
  111498. */
  111499. reservedDataStore: any;
  111500. /**
  111501. * List of inspectable custom properties (used by the Inspector)
  111502. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  111503. */
  111504. inspectableCustomProperties: IInspectable[];
  111505. private _doNotSerialize;
  111506. /**
  111507. * Gets or sets a boolean used to define if the node must be serialized
  111508. */
  111509. get doNotSerialize(): boolean;
  111510. set doNotSerialize(value: boolean);
  111511. /** @hidden */
  111512. _isDisposed: boolean;
  111513. /**
  111514. * Gets a list of Animations associated with the node
  111515. */
  111516. animations: Animation[];
  111517. protected _ranges: {
  111518. [name: string]: Nullable<AnimationRange>;
  111519. };
  111520. /**
  111521. * Callback raised when the node is ready to be used
  111522. */
  111523. onReady: Nullable<(node: Node) => void>;
  111524. private _isEnabled;
  111525. private _isParentEnabled;
  111526. private _isReady;
  111527. /** @hidden */
  111528. _currentRenderId: number;
  111529. private _parentUpdateId;
  111530. /** @hidden */
  111531. _childUpdateId: number;
  111532. /** @hidden */
  111533. _waitingParentId: Nullable<string>;
  111534. /** @hidden */
  111535. _scene: Scene;
  111536. /** @hidden */
  111537. _cache: any;
  111538. private _parentNode;
  111539. private _children;
  111540. /** @hidden */
  111541. _worldMatrix: Matrix;
  111542. /** @hidden */
  111543. _worldMatrixDeterminant: number;
  111544. /** @hidden */
  111545. _worldMatrixDeterminantIsDirty: boolean;
  111546. /** @hidden */
  111547. private _sceneRootNodesIndex;
  111548. /**
  111549. * Gets a boolean indicating if the node has been disposed
  111550. * @returns true if the node was disposed
  111551. */
  111552. isDisposed(): boolean;
  111553. /**
  111554. * Gets or sets the parent of the node (without keeping the current position in the scene)
  111555. * @see https://doc.babylonjs.com/how_to/parenting
  111556. */
  111557. set parent(parent: Nullable<Node>);
  111558. get parent(): Nullable<Node>;
  111559. /** @hidden */
  111560. _addToSceneRootNodes(): void;
  111561. /** @hidden */
  111562. _removeFromSceneRootNodes(): void;
  111563. private _animationPropertiesOverride;
  111564. /**
  111565. * Gets or sets the animation properties override
  111566. */
  111567. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  111568. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  111569. /**
  111570. * Gets a string idenfifying the name of the class
  111571. * @returns "Node" string
  111572. */
  111573. getClassName(): string;
  111574. /** @hidden */
  111575. readonly _isNode: boolean;
  111576. /**
  111577. * An event triggered when the mesh is disposed
  111578. */
  111579. onDisposeObservable: Observable<Node>;
  111580. private _onDisposeObserver;
  111581. /**
  111582. * Sets a callback that will be raised when the node will be disposed
  111583. */
  111584. set onDispose(callback: () => void);
  111585. /**
  111586. * Creates a new Node
  111587. * @param name the name and id to be given to this node
  111588. * @param scene the scene this node will be added to
  111589. */
  111590. constructor(name: string, scene?: Nullable<Scene>);
  111591. /**
  111592. * Gets the scene of the node
  111593. * @returns a scene
  111594. */
  111595. getScene(): Scene;
  111596. /**
  111597. * Gets the engine of the node
  111598. * @returns a Engine
  111599. */
  111600. getEngine(): Engine;
  111601. private _behaviors;
  111602. /**
  111603. * Attach a behavior to the node
  111604. * @see https://doc.babylonjs.com/features/behaviour
  111605. * @param behavior defines the behavior to attach
  111606. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  111607. * @returns the current Node
  111608. */
  111609. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  111610. /**
  111611. * Remove an attached behavior
  111612. * @see https://doc.babylonjs.com/features/behaviour
  111613. * @param behavior defines the behavior to attach
  111614. * @returns the current Node
  111615. */
  111616. removeBehavior(behavior: Behavior<Node>): Node;
  111617. /**
  111618. * Gets the list of attached behaviors
  111619. * @see https://doc.babylonjs.com/features/behaviour
  111620. */
  111621. get behaviors(): Behavior<Node>[];
  111622. /**
  111623. * Gets an attached behavior by name
  111624. * @param name defines the name of the behavior to look for
  111625. * @see https://doc.babylonjs.com/features/behaviour
  111626. * @returns null if behavior was not found else the requested behavior
  111627. */
  111628. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  111629. /**
  111630. * Returns the latest update of the World matrix
  111631. * @returns a Matrix
  111632. */
  111633. getWorldMatrix(): Matrix;
  111634. /** @hidden */
  111635. _getWorldMatrixDeterminant(): number;
  111636. /**
  111637. * Returns directly the latest state of the mesh World matrix.
  111638. * A Matrix is returned.
  111639. */
  111640. get worldMatrixFromCache(): Matrix;
  111641. /** @hidden */
  111642. _initCache(): void;
  111643. /** @hidden */
  111644. updateCache(force?: boolean): void;
  111645. /** @hidden */
  111646. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111647. /** @hidden */
  111648. _updateCache(ignoreParentClass?: boolean): void;
  111649. /** @hidden */
  111650. _isSynchronized(): boolean;
  111651. /** @hidden */
  111652. _markSyncedWithParent(): void;
  111653. /** @hidden */
  111654. isSynchronizedWithParent(): boolean;
  111655. /** @hidden */
  111656. isSynchronized(): boolean;
  111657. /**
  111658. * Is this node ready to be used/rendered
  111659. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  111660. * @return true if the node is ready
  111661. */
  111662. isReady(completeCheck?: boolean): boolean;
  111663. /**
  111664. * Is this node enabled?
  111665. * 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
  111666. * @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
  111667. * @return whether this node (and its parent) is enabled
  111668. */
  111669. isEnabled(checkAncestors?: boolean): boolean;
  111670. /** @hidden */
  111671. protected _syncParentEnabledState(): void;
  111672. /**
  111673. * Set the enabled state of this node
  111674. * @param value defines the new enabled state
  111675. */
  111676. setEnabled(value: boolean): void;
  111677. /**
  111678. * Is this node a descendant of the given node?
  111679. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  111680. * @param ancestor defines the parent node to inspect
  111681. * @returns a boolean indicating if this node is a descendant of the given node
  111682. */
  111683. isDescendantOf(ancestor: Node): boolean;
  111684. /** @hidden */
  111685. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  111686. /**
  111687. * Will return all nodes that have this node as ascendant
  111688. * @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
  111689. * @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
  111690. * @return all children nodes of all types
  111691. */
  111692. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  111693. /**
  111694. * Get all child-meshes of this node
  111695. * @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)
  111696. * @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
  111697. * @returns an array of AbstractMesh
  111698. */
  111699. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  111700. /**
  111701. * Get all direct children of this node
  111702. * @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
  111703. * @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)
  111704. * @returns an array of Node
  111705. */
  111706. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  111707. /** @hidden */
  111708. _setReady(state: boolean): void;
  111709. /**
  111710. * Get an animation by name
  111711. * @param name defines the name of the animation to look for
  111712. * @returns null if not found else the requested animation
  111713. */
  111714. getAnimationByName(name: string): Nullable<Animation>;
  111715. /**
  111716. * Creates an animation range for this node
  111717. * @param name defines the name of the range
  111718. * @param from defines the starting key
  111719. * @param to defines the end key
  111720. */
  111721. createAnimationRange(name: string, from: number, to: number): void;
  111722. /**
  111723. * Delete a specific animation range
  111724. * @param name defines the name of the range to delete
  111725. * @param deleteFrames defines if animation frames from the range must be deleted as well
  111726. */
  111727. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  111728. /**
  111729. * Get an animation range by name
  111730. * @param name defines the name of the animation range to look for
  111731. * @returns null if not found else the requested animation range
  111732. */
  111733. getAnimationRange(name: string): Nullable<AnimationRange>;
  111734. /**
  111735. * Gets the list of all animation ranges defined on this node
  111736. * @returns an array
  111737. */
  111738. getAnimationRanges(): Nullable<AnimationRange>[];
  111739. /**
  111740. * Will start the animation sequence
  111741. * @param name defines the range frames for animation sequence
  111742. * @param loop defines if the animation should loop (false by default)
  111743. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  111744. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  111745. * @returns the object created for this animation. If range does not exist, it will return null
  111746. */
  111747. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  111748. /**
  111749. * Serialize animation ranges into a JSON compatible object
  111750. * @returns serialization object
  111751. */
  111752. serializeAnimationRanges(): any;
  111753. /**
  111754. * Computes the world matrix of the node
  111755. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  111756. * @returns the world matrix
  111757. */
  111758. computeWorldMatrix(force?: boolean): Matrix;
  111759. /**
  111760. * Releases resources associated with this node.
  111761. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111762. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111763. */
  111764. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111765. /**
  111766. * Parse animation range data from a serialization object and store them into a given node
  111767. * @param node defines where to store the animation ranges
  111768. * @param parsedNode defines the serialization object to read data from
  111769. * @param scene defines the hosting scene
  111770. */
  111771. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  111772. /**
  111773. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  111774. * @param includeDescendants Include bounding info from descendants as well (true by default)
  111775. * @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
  111776. * @returns the new bounding vectors
  111777. */
  111778. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  111779. min: Vector3;
  111780. max: Vector3;
  111781. };
  111782. }
  111783. }
  111784. declare module BABYLON {
  111785. /**
  111786. * @hidden
  111787. */
  111788. export class _IAnimationState {
  111789. key: number;
  111790. repeatCount: number;
  111791. workValue?: any;
  111792. loopMode?: number;
  111793. offsetValue?: any;
  111794. highLimitValue?: any;
  111795. }
  111796. /**
  111797. * Class used to store any kind of animation
  111798. */
  111799. export class Animation {
  111800. /**Name of the animation */
  111801. name: string;
  111802. /**Property to animate */
  111803. targetProperty: string;
  111804. /**The frames per second of the animation */
  111805. framePerSecond: number;
  111806. /**The data type of the animation */
  111807. dataType: number;
  111808. /**The loop mode of the animation */
  111809. loopMode?: number | undefined;
  111810. /**Specifies if blending should be enabled */
  111811. enableBlending?: boolean | undefined;
  111812. /**
  111813. * Use matrix interpolation instead of using direct key value when animating matrices
  111814. */
  111815. static AllowMatricesInterpolation: boolean;
  111816. /**
  111817. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  111818. */
  111819. static AllowMatrixDecomposeForInterpolation: boolean;
  111820. /** Define the Url to load snippets */
  111821. static SnippetUrl: string;
  111822. /** Snippet ID if the animation was created from the snippet server */
  111823. snippetId: string;
  111824. /**
  111825. * Stores the key frames of the animation
  111826. */
  111827. private _keys;
  111828. /**
  111829. * Stores the easing function of the animation
  111830. */
  111831. private _easingFunction;
  111832. /**
  111833. * @hidden Internal use only
  111834. */
  111835. _runtimeAnimations: RuntimeAnimation[];
  111836. /**
  111837. * The set of event that will be linked to this animation
  111838. */
  111839. private _events;
  111840. /**
  111841. * Stores an array of target property paths
  111842. */
  111843. targetPropertyPath: string[];
  111844. /**
  111845. * Stores the blending speed of the animation
  111846. */
  111847. blendingSpeed: number;
  111848. /**
  111849. * Stores the animation ranges for the animation
  111850. */
  111851. private _ranges;
  111852. /**
  111853. * @hidden Internal use
  111854. */
  111855. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  111856. /**
  111857. * Sets up an animation
  111858. * @param property The property to animate
  111859. * @param animationType The animation type to apply
  111860. * @param framePerSecond The frames per second of the animation
  111861. * @param easingFunction The easing function used in the animation
  111862. * @returns The created animation
  111863. */
  111864. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  111865. /**
  111866. * Create and start an animation on a node
  111867. * @param name defines the name of the global animation that will be run on all nodes
  111868. * @param node defines the root node where the animation will take place
  111869. * @param targetProperty defines property to animate
  111870. * @param framePerSecond defines the number of frame per second yo use
  111871. * @param totalFrame defines the number of frames in total
  111872. * @param from defines the initial value
  111873. * @param to defines the final value
  111874. * @param loopMode defines which loop mode you want to use (off by default)
  111875. * @param easingFunction defines the easing function to use (linear by default)
  111876. * @param onAnimationEnd defines the callback to call when animation end
  111877. * @returns the animatable created for this animation
  111878. */
  111879. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  111880. /**
  111881. * Create and start an animation on a node and its descendants
  111882. * @param name defines the name of the global animation that will be run on all nodes
  111883. * @param node defines the root node where the animation will take place
  111884. * @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
  111885. * @param targetProperty defines property to animate
  111886. * @param framePerSecond defines the number of frame per second to use
  111887. * @param totalFrame defines the number of frames in total
  111888. * @param from defines the initial value
  111889. * @param to defines the final value
  111890. * @param loopMode defines which loop mode you want to use (off by default)
  111891. * @param easingFunction defines the easing function to use (linear by default)
  111892. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  111893. * @returns the list of animatables created for all nodes
  111894. * @example https://www.babylonjs-playground.com/#MH0VLI
  111895. */
  111896. 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[]>;
  111897. /**
  111898. * Creates a new animation, merges it with the existing animations and starts it
  111899. * @param name Name of the animation
  111900. * @param node Node which contains the scene that begins the animations
  111901. * @param targetProperty Specifies which property to animate
  111902. * @param framePerSecond The frames per second of the animation
  111903. * @param totalFrame The total number of frames
  111904. * @param from The frame at the beginning of the animation
  111905. * @param to The frame at the end of the animation
  111906. * @param loopMode Specifies the loop mode of the animation
  111907. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  111908. * @param onAnimationEnd Callback to run once the animation is complete
  111909. * @returns Nullable animation
  111910. */
  111911. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  111912. /**
  111913. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  111914. * @param sourceAnimation defines the Animation containing keyframes to convert
  111915. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  111916. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  111917. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  111918. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  111919. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  111920. */
  111921. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  111922. /**
  111923. * Transition property of an host to the target Value
  111924. * @param property The property to transition
  111925. * @param targetValue The target Value of the property
  111926. * @param host The object where the property to animate belongs
  111927. * @param scene Scene used to run the animation
  111928. * @param frameRate Framerate (in frame/s) to use
  111929. * @param transition The transition type we want to use
  111930. * @param duration The duration of the animation, in milliseconds
  111931. * @param onAnimationEnd Callback trigger at the end of the animation
  111932. * @returns Nullable animation
  111933. */
  111934. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  111935. /**
  111936. * Return the array of runtime animations currently using this animation
  111937. */
  111938. get runtimeAnimations(): RuntimeAnimation[];
  111939. /**
  111940. * Specifies if any of the runtime animations are currently running
  111941. */
  111942. get hasRunningRuntimeAnimations(): boolean;
  111943. /**
  111944. * Initializes the animation
  111945. * @param name Name of the animation
  111946. * @param targetProperty Property to animate
  111947. * @param framePerSecond The frames per second of the animation
  111948. * @param dataType The data type of the animation
  111949. * @param loopMode The loop mode of the animation
  111950. * @param enableBlending Specifies if blending should be enabled
  111951. */
  111952. constructor(
  111953. /**Name of the animation */
  111954. name: string,
  111955. /**Property to animate */
  111956. targetProperty: string,
  111957. /**The frames per second of the animation */
  111958. framePerSecond: number,
  111959. /**The data type of the animation */
  111960. dataType: number,
  111961. /**The loop mode of the animation */
  111962. loopMode?: number | undefined,
  111963. /**Specifies if blending should be enabled */
  111964. enableBlending?: boolean | undefined);
  111965. /**
  111966. * Converts the animation to a string
  111967. * @param fullDetails support for multiple levels of logging within scene loading
  111968. * @returns String form of the animation
  111969. */
  111970. toString(fullDetails?: boolean): string;
  111971. /**
  111972. * Add an event to this animation
  111973. * @param event Event to add
  111974. */
  111975. addEvent(event: AnimationEvent): void;
  111976. /**
  111977. * Remove all events found at the given frame
  111978. * @param frame The frame to remove events from
  111979. */
  111980. removeEvents(frame: number): void;
  111981. /**
  111982. * Retrieves all the events from the animation
  111983. * @returns Events from the animation
  111984. */
  111985. getEvents(): AnimationEvent[];
  111986. /**
  111987. * Creates an animation range
  111988. * @param name Name of the animation range
  111989. * @param from Starting frame of the animation range
  111990. * @param to Ending frame of the animation
  111991. */
  111992. createRange(name: string, from: number, to: number): void;
  111993. /**
  111994. * Deletes an animation range by name
  111995. * @param name Name of the animation range to delete
  111996. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  111997. */
  111998. deleteRange(name: string, deleteFrames?: boolean): void;
  111999. /**
  112000. * Gets the animation range by name, or null if not defined
  112001. * @param name Name of the animation range
  112002. * @returns Nullable animation range
  112003. */
  112004. getRange(name: string): Nullable<AnimationRange>;
  112005. /**
  112006. * Gets the key frames from the animation
  112007. * @returns The key frames of the animation
  112008. */
  112009. getKeys(): Array<IAnimationKey>;
  112010. /**
  112011. * Gets the highest frame rate of the animation
  112012. * @returns Highest frame rate of the animation
  112013. */
  112014. getHighestFrame(): number;
  112015. /**
  112016. * Gets the easing function of the animation
  112017. * @returns Easing function of the animation
  112018. */
  112019. getEasingFunction(): IEasingFunction;
  112020. /**
  112021. * Sets the easing function of the animation
  112022. * @param easingFunction A custom mathematical formula for animation
  112023. */
  112024. setEasingFunction(easingFunction: EasingFunction): void;
  112025. /**
  112026. * Interpolates a scalar linearly
  112027. * @param startValue Start value of the animation curve
  112028. * @param endValue End value of the animation curve
  112029. * @param gradient Scalar amount to interpolate
  112030. * @returns Interpolated scalar value
  112031. */
  112032. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  112033. /**
  112034. * Interpolates a scalar cubically
  112035. * @param startValue Start value of the animation curve
  112036. * @param outTangent End tangent of the animation
  112037. * @param endValue End value of the animation curve
  112038. * @param inTangent Start tangent of the animation curve
  112039. * @param gradient Scalar amount to interpolate
  112040. * @returns Interpolated scalar value
  112041. */
  112042. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  112043. /**
  112044. * Interpolates a quaternion using a spherical linear interpolation
  112045. * @param startValue Start value of the animation curve
  112046. * @param endValue End value of the animation curve
  112047. * @param gradient Scalar amount to interpolate
  112048. * @returns Interpolated quaternion value
  112049. */
  112050. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  112051. /**
  112052. * Interpolates a quaternion cubically
  112053. * @param startValue Start value of the animation curve
  112054. * @param outTangent End tangent of the animation curve
  112055. * @param endValue End value of the animation curve
  112056. * @param inTangent Start tangent of the animation curve
  112057. * @param gradient Scalar amount to interpolate
  112058. * @returns Interpolated quaternion value
  112059. */
  112060. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  112061. /**
  112062. * Interpolates a Vector3 linearl
  112063. * @param startValue Start value of the animation curve
  112064. * @param endValue End value of the animation curve
  112065. * @param gradient Scalar amount to interpolate
  112066. * @returns Interpolated scalar value
  112067. */
  112068. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  112069. /**
  112070. * Interpolates a Vector3 cubically
  112071. * @param startValue Start value of the animation curve
  112072. * @param outTangent End tangent of the animation
  112073. * @param endValue End value of the animation curve
  112074. * @param inTangent Start tangent of the animation curve
  112075. * @param gradient Scalar amount to interpolate
  112076. * @returns InterpolatedVector3 value
  112077. */
  112078. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  112079. /**
  112080. * Interpolates a Vector2 linearly
  112081. * @param startValue Start value of the animation curve
  112082. * @param endValue End value of the animation curve
  112083. * @param gradient Scalar amount to interpolate
  112084. * @returns Interpolated Vector2 value
  112085. */
  112086. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  112087. /**
  112088. * Interpolates a Vector2 cubically
  112089. * @param startValue Start value of the animation curve
  112090. * @param outTangent End tangent of the animation
  112091. * @param endValue End value of the animation curve
  112092. * @param inTangent Start tangent of the animation curve
  112093. * @param gradient Scalar amount to interpolate
  112094. * @returns Interpolated Vector2 value
  112095. */
  112096. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  112097. /**
  112098. * Interpolates a size linearly
  112099. * @param startValue Start value of the animation curve
  112100. * @param endValue End value of the animation curve
  112101. * @param gradient Scalar amount to interpolate
  112102. * @returns Interpolated Size value
  112103. */
  112104. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  112105. /**
  112106. * Interpolates a Color3 linearly
  112107. * @param startValue Start value of the animation curve
  112108. * @param endValue End value of the animation curve
  112109. * @param gradient Scalar amount to interpolate
  112110. * @returns Interpolated Color3 value
  112111. */
  112112. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  112113. /**
  112114. * Interpolates a Color4 linearly
  112115. * @param startValue Start value of the animation curve
  112116. * @param endValue End value of the animation curve
  112117. * @param gradient Scalar amount to interpolate
  112118. * @returns Interpolated Color3 value
  112119. */
  112120. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  112121. /**
  112122. * @hidden Internal use only
  112123. */
  112124. _getKeyValue(value: any): any;
  112125. /**
  112126. * @hidden Internal use only
  112127. */
  112128. _interpolate(currentFrame: number, state: _IAnimationState): any;
  112129. /**
  112130. * Defines the function to use to interpolate matrices
  112131. * @param startValue defines the start matrix
  112132. * @param endValue defines the end matrix
  112133. * @param gradient defines the gradient between both matrices
  112134. * @param result defines an optional target matrix where to store the interpolation
  112135. * @returns the interpolated matrix
  112136. */
  112137. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  112138. /**
  112139. * Makes a copy of the animation
  112140. * @returns Cloned animation
  112141. */
  112142. clone(): Animation;
  112143. /**
  112144. * Sets the key frames of the animation
  112145. * @param values The animation key frames to set
  112146. */
  112147. setKeys(values: Array<IAnimationKey>): void;
  112148. /**
  112149. * Serializes the animation to an object
  112150. * @returns Serialized object
  112151. */
  112152. serialize(): any;
  112153. /**
  112154. * Float animation type
  112155. */
  112156. static readonly ANIMATIONTYPE_FLOAT: number;
  112157. /**
  112158. * Vector3 animation type
  112159. */
  112160. static readonly ANIMATIONTYPE_VECTOR3: number;
  112161. /**
  112162. * Quaternion animation type
  112163. */
  112164. static readonly ANIMATIONTYPE_QUATERNION: number;
  112165. /**
  112166. * Matrix animation type
  112167. */
  112168. static readonly ANIMATIONTYPE_MATRIX: number;
  112169. /**
  112170. * Color3 animation type
  112171. */
  112172. static readonly ANIMATIONTYPE_COLOR3: number;
  112173. /**
  112174. * Color3 animation type
  112175. */
  112176. static readonly ANIMATIONTYPE_COLOR4: number;
  112177. /**
  112178. * Vector2 animation type
  112179. */
  112180. static readonly ANIMATIONTYPE_VECTOR2: number;
  112181. /**
  112182. * Size animation type
  112183. */
  112184. static readonly ANIMATIONTYPE_SIZE: number;
  112185. /**
  112186. * Relative Loop Mode
  112187. */
  112188. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  112189. /**
  112190. * Cycle Loop Mode
  112191. */
  112192. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  112193. /**
  112194. * Constant Loop Mode
  112195. */
  112196. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  112197. /** @hidden */
  112198. static _UniversalLerp(left: any, right: any, amount: number): any;
  112199. /**
  112200. * Parses an animation object and creates an animation
  112201. * @param parsedAnimation Parsed animation object
  112202. * @returns Animation object
  112203. */
  112204. static Parse(parsedAnimation: any): Animation;
  112205. /**
  112206. * Appends the serialized animations from the source animations
  112207. * @param source Source containing the animations
  112208. * @param destination Target to store the animations
  112209. */
  112210. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  112211. /**
  112212. * Creates a new animation or an array of animations from a snippet saved in a remote file
  112213. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  112214. * @param url defines the url to load from
  112215. * @returns a promise that will resolve to the new animation or an array of animations
  112216. */
  112217. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  112218. /**
  112219. * Creates an animation or an array of animations from a snippet saved by the Inspector
  112220. * @param snippetId defines the snippet to load
  112221. * @returns a promise that will resolve to the new animation or a new array of animations
  112222. */
  112223. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  112224. }
  112225. }
  112226. declare module BABYLON {
  112227. /**
  112228. * Interface containing an array of animations
  112229. */
  112230. export interface IAnimatable {
  112231. /**
  112232. * Array of animations
  112233. */
  112234. animations: Nullable<Array<Animation>>;
  112235. }
  112236. }
  112237. declare module BABYLON {
  112238. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  112239. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112240. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112241. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112242. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112243. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112244. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112245. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112246. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112247. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112248. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112249. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112250. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112251. /**
  112252. * Decorator used to define property that can be serialized as reference to a camera
  112253. * @param sourceName defines the name of the property to decorate
  112254. */
  112255. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112256. /**
  112257. * Class used to help serialization objects
  112258. */
  112259. export class SerializationHelper {
  112260. /** @hidden */
  112261. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  112262. /** @hidden */
  112263. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  112264. /** @hidden */
  112265. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  112266. /** @hidden */
  112267. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  112268. /**
  112269. * Appends the serialized animations from the source animations
  112270. * @param source Source containing the animations
  112271. * @param destination Target to store the animations
  112272. */
  112273. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  112274. /**
  112275. * Static function used to serialized a specific entity
  112276. * @param entity defines the entity to serialize
  112277. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  112278. * @returns a JSON compatible object representing the serialization of the entity
  112279. */
  112280. static Serialize<T>(entity: T, serializationObject?: any): any;
  112281. /**
  112282. * Creates a new entity from a serialization data object
  112283. * @param creationFunction defines a function used to instanciated the new entity
  112284. * @param source defines the source serialization data
  112285. * @param scene defines the hosting scene
  112286. * @param rootUrl defines the root url for resources
  112287. * @returns a new entity
  112288. */
  112289. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  112290. /**
  112291. * Clones an object
  112292. * @param creationFunction defines the function used to instanciate the new object
  112293. * @param source defines the source object
  112294. * @returns the cloned object
  112295. */
  112296. static Clone<T>(creationFunction: () => T, source: T): T;
  112297. /**
  112298. * Instanciates a new object based on a source one (some data will be shared between both object)
  112299. * @param creationFunction defines the function used to instanciate the new object
  112300. * @param source defines the source object
  112301. * @returns the new object
  112302. */
  112303. static Instanciate<T>(creationFunction: () => T, source: T): T;
  112304. }
  112305. }
  112306. declare module BABYLON {
  112307. /**
  112308. * Base class of all the textures in babylon.
  112309. * It groups all the common properties the materials, post process, lights... might need
  112310. * in order to make a correct use of the texture.
  112311. */
  112312. export class BaseTexture implements IAnimatable {
  112313. /**
  112314. * Default anisotropic filtering level for the application.
  112315. * It is set to 4 as a good tradeoff between perf and quality.
  112316. */
  112317. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  112318. /**
  112319. * Gets or sets the unique id of the texture
  112320. */
  112321. uniqueId: number;
  112322. /**
  112323. * Define the name of the texture.
  112324. */
  112325. name: string;
  112326. /**
  112327. * Gets or sets an object used to store user defined information.
  112328. */
  112329. metadata: any;
  112330. /**
  112331. * For internal use only. Please do not use.
  112332. */
  112333. reservedDataStore: any;
  112334. private _hasAlpha;
  112335. /**
  112336. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  112337. */
  112338. set hasAlpha(value: boolean);
  112339. get hasAlpha(): boolean;
  112340. /**
  112341. * Defines if the alpha value should be determined via the rgb values.
  112342. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  112343. */
  112344. getAlphaFromRGB: boolean;
  112345. /**
  112346. * Intensity or strength of the texture.
  112347. * It is commonly used by materials to fine tune the intensity of the texture
  112348. */
  112349. level: number;
  112350. /**
  112351. * Define the UV chanel to use starting from 0 and defaulting to 0.
  112352. * This is part of the texture as textures usually maps to one uv set.
  112353. */
  112354. coordinatesIndex: number;
  112355. private _coordinatesMode;
  112356. /**
  112357. * How a texture is mapped.
  112358. *
  112359. * | Value | Type | Description |
  112360. * | ----- | ----------------------------------- | ----------- |
  112361. * | 0 | EXPLICIT_MODE | |
  112362. * | 1 | SPHERICAL_MODE | |
  112363. * | 2 | PLANAR_MODE | |
  112364. * | 3 | CUBIC_MODE | |
  112365. * | 4 | PROJECTION_MODE | |
  112366. * | 5 | SKYBOX_MODE | |
  112367. * | 6 | INVCUBIC_MODE | |
  112368. * | 7 | EQUIRECTANGULAR_MODE | |
  112369. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  112370. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  112371. */
  112372. set coordinatesMode(value: number);
  112373. get coordinatesMode(): number;
  112374. /**
  112375. * | Value | Type | Description |
  112376. * | ----- | ------------------ | ----------- |
  112377. * | 0 | CLAMP_ADDRESSMODE | |
  112378. * | 1 | WRAP_ADDRESSMODE | |
  112379. * | 2 | MIRROR_ADDRESSMODE | |
  112380. */
  112381. wrapU: number;
  112382. /**
  112383. * | Value | Type | Description |
  112384. * | ----- | ------------------ | ----------- |
  112385. * | 0 | CLAMP_ADDRESSMODE | |
  112386. * | 1 | WRAP_ADDRESSMODE | |
  112387. * | 2 | MIRROR_ADDRESSMODE | |
  112388. */
  112389. wrapV: number;
  112390. /**
  112391. * | Value | Type | Description |
  112392. * | ----- | ------------------ | ----------- |
  112393. * | 0 | CLAMP_ADDRESSMODE | |
  112394. * | 1 | WRAP_ADDRESSMODE | |
  112395. * | 2 | MIRROR_ADDRESSMODE | |
  112396. */
  112397. wrapR: number;
  112398. /**
  112399. * With compliant hardware and browser (supporting anisotropic filtering)
  112400. * this defines the level of anisotropic filtering in the texture.
  112401. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  112402. */
  112403. anisotropicFilteringLevel: number;
  112404. /**
  112405. * Define if the texture is a cube texture or if false a 2d texture.
  112406. */
  112407. get isCube(): boolean;
  112408. set isCube(value: boolean);
  112409. /**
  112410. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  112411. */
  112412. get is3D(): boolean;
  112413. set is3D(value: boolean);
  112414. /**
  112415. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  112416. */
  112417. get is2DArray(): boolean;
  112418. set is2DArray(value: boolean);
  112419. /**
  112420. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  112421. * HDR texture are usually stored in linear space.
  112422. * This only impacts the PBR and Background materials
  112423. */
  112424. gammaSpace: boolean;
  112425. /**
  112426. * Gets or sets whether or not the texture contains RGBD data.
  112427. */
  112428. get isRGBD(): boolean;
  112429. set isRGBD(value: boolean);
  112430. /**
  112431. * Is Z inverted in the texture (useful in a cube texture).
  112432. */
  112433. invertZ: boolean;
  112434. /**
  112435. * Are mip maps generated for this texture or not.
  112436. */
  112437. get noMipmap(): boolean;
  112438. /**
  112439. * @hidden
  112440. */
  112441. lodLevelInAlpha: boolean;
  112442. /**
  112443. * With prefiltered texture, defined the offset used during the prefiltering steps.
  112444. */
  112445. get lodGenerationOffset(): number;
  112446. set lodGenerationOffset(value: number);
  112447. /**
  112448. * With prefiltered texture, defined the scale used during the prefiltering steps.
  112449. */
  112450. get lodGenerationScale(): number;
  112451. set lodGenerationScale(value: number);
  112452. /**
  112453. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  112454. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  112455. * average roughness values.
  112456. */
  112457. get linearSpecularLOD(): boolean;
  112458. set linearSpecularLOD(value: boolean);
  112459. /**
  112460. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  112461. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  112462. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  112463. */
  112464. get irradianceTexture(): Nullable<BaseTexture>;
  112465. set irradianceTexture(value: Nullable<BaseTexture>);
  112466. /**
  112467. * Define if the texture is a render target.
  112468. */
  112469. isRenderTarget: boolean;
  112470. /**
  112471. * Define the unique id of the texture in the scene.
  112472. */
  112473. get uid(): string;
  112474. /** @hidden */
  112475. _prefiltered: boolean;
  112476. /**
  112477. * Return a string representation of the texture.
  112478. * @returns the texture as a string
  112479. */
  112480. toString(): string;
  112481. /**
  112482. * Get the class name of the texture.
  112483. * @returns "BaseTexture"
  112484. */
  112485. getClassName(): string;
  112486. /**
  112487. * Define the list of animation attached to the texture.
  112488. */
  112489. animations: Animation[];
  112490. /**
  112491. * An event triggered when the texture is disposed.
  112492. */
  112493. onDisposeObservable: Observable<BaseTexture>;
  112494. private _onDisposeObserver;
  112495. /**
  112496. * Callback triggered when the texture has been disposed.
  112497. * Kept for back compatibility, you can use the onDisposeObservable instead.
  112498. */
  112499. set onDispose(callback: () => void);
  112500. /**
  112501. * Define the current state of the loading sequence when in delayed load mode.
  112502. */
  112503. delayLoadState: number;
  112504. private _scene;
  112505. private _engine;
  112506. /** @hidden */
  112507. _texture: Nullable<InternalTexture>;
  112508. private _uid;
  112509. /**
  112510. * Define if the texture is preventinga material to render or not.
  112511. * If not and the texture is not ready, the engine will use a default black texture instead.
  112512. */
  112513. get isBlocking(): boolean;
  112514. /**
  112515. * Instantiates a new BaseTexture.
  112516. * Base class of all the textures in babylon.
  112517. * It groups all the common properties the materials, post process, lights... might need
  112518. * in order to make a correct use of the texture.
  112519. * @param sceneOrEngine Define the scene or engine the texture blongs to
  112520. */
  112521. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  112522. /**
  112523. * Get the scene the texture belongs to.
  112524. * @returns the scene or null if undefined
  112525. */
  112526. getScene(): Nullable<Scene>;
  112527. /** @hidden */
  112528. protected _getEngine(): Nullable<ThinEngine>;
  112529. /**
  112530. * Get the texture transform matrix used to offset tile the texture for istance.
  112531. * @returns the transformation matrix
  112532. */
  112533. getTextureMatrix(): Matrix;
  112534. /**
  112535. * Get the texture reflection matrix used to rotate/transform the reflection.
  112536. * @returns the reflection matrix
  112537. */
  112538. getReflectionTextureMatrix(): Matrix;
  112539. /**
  112540. * Get the underlying lower level texture from Babylon.
  112541. * @returns the insternal texture
  112542. */
  112543. getInternalTexture(): Nullable<InternalTexture>;
  112544. /**
  112545. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  112546. * @returns true if ready or not blocking
  112547. */
  112548. isReadyOrNotBlocking(): boolean;
  112549. /**
  112550. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  112551. * @returns true if fully ready
  112552. */
  112553. isReady(): boolean;
  112554. private _cachedSize;
  112555. /**
  112556. * Get the size of the texture.
  112557. * @returns the texture size.
  112558. */
  112559. getSize(): ISize;
  112560. /**
  112561. * Get the base size of the texture.
  112562. * It can be different from the size if the texture has been resized for POT for instance
  112563. * @returns the base size
  112564. */
  112565. getBaseSize(): ISize;
  112566. /**
  112567. * Update the sampling mode of the texture.
  112568. * Default is Trilinear mode.
  112569. *
  112570. * | Value | Type | Description |
  112571. * | ----- | ------------------ | ----------- |
  112572. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  112573. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  112574. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  112575. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  112576. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  112577. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  112578. * | 7 | NEAREST_LINEAR | |
  112579. * | 8 | NEAREST_NEAREST | |
  112580. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  112581. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  112582. * | 11 | LINEAR_LINEAR | |
  112583. * | 12 | LINEAR_NEAREST | |
  112584. *
  112585. * > _mag_: magnification filter (close to the viewer)
  112586. * > _min_: minification filter (far from the viewer)
  112587. * > _mip_: filter used between mip map levels
  112588. *@param samplingMode Define the new sampling mode of the texture
  112589. */
  112590. updateSamplingMode(samplingMode: number): void;
  112591. /**
  112592. * Scales the texture if is `canRescale()`
  112593. * @param ratio the resize factor we want to use to rescale
  112594. */
  112595. scale(ratio: number): void;
  112596. /**
  112597. * Get if the texture can rescale.
  112598. */
  112599. get canRescale(): boolean;
  112600. /** @hidden */
  112601. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  112602. /** @hidden */
  112603. _rebuild(): void;
  112604. /**
  112605. * Triggers the load sequence in delayed load mode.
  112606. */
  112607. delayLoad(): void;
  112608. /**
  112609. * Clones the texture.
  112610. * @returns the cloned texture
  112611. */
  112612. clone(): Nullable<BaseTexture>;
  112613. /**
  112614. * Get the texture underlying type (INT, FLOAT...)
  112615. */
  112616. get textureType(): number;
  112617. /**
  112618. * Get the texture underlying format (RGB, RGBA...)
  112619. */
  112620. get textureFormat(): number;
  112621. /**
  112622. * Indicates that textures need to be re-calculated for all materials
  112623. */
  112624. protected _markAllSubMeshesAsTexturesDirty(): void;
  112625. /**
  112626. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  112627. * This will returns an RGBA array buffer containing either in values (0-255) or
  112628. * float values (0-1) depending of the underlying buffer type.
  112629. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  112630. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  112631. * @param buffer defines a user defined buffer to fill with data (can be null)
  112632. * @returns The Array buffer containing the pixels data.
  112633. */
  112634. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  112635. /**
  112636. * Release and destroy the underlying lower level texture aka internalTexture.
  112637. */
  112638. releaseInternalTexture(): void;
  112639. /** @hidden */
  112640. get _lodTextureHigh(): Nullable<BaseTexture>;
  112641. /** @hidden */
  112642. get _lodTextureMid(): Nullable<BaseTexture>;
  112643. /** @hidden */
  112644. get _lodTextureLow(): Nullable<BaseTexture>;
  112645. /**
  112646. * Dispose the texture and release its associated resources.
  112647. */
  112648. dispose(): void;
  112649. /**
  112650. * Serialize the texture into a JSON representation that can be parsed later on.
  112651. * @returns the JSON representation of the texture
  112652. */
  112653. serialize(): any;
  112654. /**
  112655. * Helper function to be called back once a list of texture contains only ready textures.
  112656. * @param textures Define the list of textures to wait for
  112657. * @param callback Define the callback triggered once the entire list will be ready
  112658. */
  112659. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  112660. private static _isScene;
  112661. }
  112662. }
  112663. declare module BABYLON {
  112664. /**
  112665. * Options to be used when creating an effect.
  112666. */
  112667. export interface IEffectCreationOptions {
  112668. /**
  112669. * Atrributes that will be used in the shader.
  112670. */
  112671. attributes: string[];
  112672. /**
  112673. * Uniform varible names that will be set in the shader.
  112674. */
  112675. uniformsNames: string[];
  112676. /**
  112677. * Uniform buffer variable names that will be set in the shader.
  112678. */
  112679. uniformBuffersNames: string[];
  112680. /**
  112681. * Sampler texture variable names that will be set in the shader.
  112682. */
  112683. samplers: string[];
  112684. /**
  112685. * Define statements that will be set in the shader.
  112686. */
  112687. defines: any;
  112688. /**
  112689. * Possible fallbacks for this effect to improve performance when needed.
  112690. */
  112691. fallbacks: Nullable<IEffectFallbacks>;
  112692. /**
  112693. * Callback that will be called when the shader is compiled.
  112694. */
  112695. onCompiled: Nullable<(effect: Effect) => void>;
  112696. /**
  112697. * Callback that will be called if an error occurs during shader compilation.
  112698. */
  112699. onError: Nullable<(effect: Effect, errors: string) => void>;
  112700. /**
  112701. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  112702. */
  112703. indexParameters?: any;
  112704. /**
  112705. * Max number of lights that can be used in the shader.
  112706. */
  112707. maxSimultaneousLights?: number;
  112708. /**
  112709. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  112710. */
  112711. transformFeedbackVaryings?: Nullable<string[]>;
  112712. /**
  112713. * 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
  112714. */
  112715. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  112716. /**
  112717. * Is this effect rendering to several color attachments ?
  112718. */
  112719. multiTarget?: boolean;
  112720. }
  112721. /**
  112722. * Effect containing vertex and fragment shader that can be executed on an object.
  112723. */
  112724. export class Effect implements IDisposable {
  112725. /**
  112726. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  112727. */
  112728. static ShadersRepository: string;
  112729. /**
  112730. * Enable logging of the shader code when a compilation error occurs
  112731. */
  112732. static LogShaderCodeOnCompilationError: boolean;
  112733. /**
  112734. * Name of the effect.
  112735. */
  112736. name: any;
  112737. /**
  112738. * String container all the define statements that should be set on the shader.
  112739. */
  112740. defines: string;
  112741. /**
  112742. * Callback that will be called when the shader is compiled.
  112743. */
  112744. onCompiled: Nullable<(effect: Effect) => void>;
  112745. /**
  112746. * Callback that will be called if an error occurs during shader compilation.
  112747. */
  112748. onError: Nullable<(effect: Effect, errors: string) => void>;
  112749. /**
  112750. * Callback that will be called when effect is bound.
  112751. */
  112752. onBind: Nullable<(effect: Effect) => void>;
  112753. /**
  112754. * Unique ID of the effect.
  112755. */
  112756. uniqueId: number;
  112757. /**
  112758. * Observable that will be called when the shader is compiled.
  112759. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  112760. */
  112761. onCompileObservable: Observable<Effect>;
  112762. /**
  112763. * Observable that will be called if an error occurs during shader compilation.
  112764. */
  112765. onErrorObservable: Observable<Effect>;
  112766. /** @hidden */
  112767. _onBindObservable: Nullable<Observable<Effect>>;
  112768. /**
  112769. * @hidden
  112770. * Specifies if the effect was previously ready
  112771. */
  112772. _wasPreviouslyReady: boolean;
  112773. /**
  112774. * Observable that will be called when effect is bound.
  112775. */
  112776. get onBindObservable(): Observable<Effect>;
  112777. /** @hidden */
  112778. _bonesComputationForcedToCPU: boolean;
  112779. /** @hidden */
  112780. _multiTarget: boolean;
  112781. private static _uniqueIdSeed;
  112782. private _engine;
  112783. private _uniformBuffersNames;
  112784. private _uniformBuffersNamesList;
  112785. private _uniformsNames;
  112786. private _samplerList;
  112787. private _samplers;
  112788. private _isReady;
  112789. private _compilationError;
  112790. private _allFallbacksProcessed;
  112791. private _attributesNames;
  112792. private _attributes;
  112793. private _attributeLocationByName;
  112794. private _uniforms;
  112795. /**
  112796. * Key for the effect.
  112797. * @hidden
  112798. */
  112799. _key: string;
  112800. private _indexParameters;
  112801. private _fallbacks;
  112802. private _vertexSourceCode;
  112803. private _fragmentSourceCode;
  112804. private _vertexSourceCodeOverride;
  112805. private _fragmentSourceCodeOverride;
  112806. private _transformFeedbackVaryings;
  112807. /**
  112808. * Compiled shader to webGL program.
  112809. * @hidden
  112810. */
  112811. _pipelineContext: Nullable<IPipelineContext>;
  112812. private _valueCache;
  112813. private static _baseCache;
  112814. /**
  112815. * Instantiates an effect.
  112816. * An effect can be used to create/manage/execute vertex and fragment shaders.
  112817. * @param baseName Name of the effect.
  112818. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  112819. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  112820. * @param samplers List of sampler variables that will be passed to the shader.
  112821. * @param engine Engine to be used to render the effect
  112822. * @param defines Define statements to be added to the shader.
  112823. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  112824. * @param onCompiled Callback that will be called when the shader is compiled.
  112825. * @param onError Callback that will be called if an error occurs during shader compilation.
  112826. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  112827. */
  112828. 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);
  112829. private _useFinalCode;
  112830. /**
  112831. * Unique key for this effect
  112832. */
  112833. get key(): string;
  112834. /**
  112835. * If the effect has been compiled and prepared.
  112836. * @returns if the effect is compiled and prepared.
  112837. */
  112838. isReady(): boolean;
  112839. private _isReadyInternal;
  112840. /**
  112841. * The engine the effect was initialized with.
  112842. * @returns the engine.
  112843. */
  112844. getEngine(): Engine;
  112845. /**
  112846. * The pipeline context for this effect
  112847. * @returns the associated pipeline context
  112848. */
  112849. getPipelineContext(): Nullable<IPipelineContext>;
  112850. /**
  112851. * The set of names of attribute variables for the shader.
  112852. * @returns An array of attribute names.
  112853. */
  112854. getAttributesNames(): string[];
  112855. /**
  112856. * Returns the attribute at the given index.
  112857. * @param index The index of the attribute.
  112858. * @returns The location of the attribute.
  112859. */
  112860. getAttributeLocation(index: number): number;
  112861. /**
  112862. * Returns the attribute based on the name of the variable.
  112863. * @param name of the attribute to look up.
  112864. * @returns the attribute location.
  112865. */
  112866. getAttributeLocationByName(name: string): number;
  112867. /**
  112868. * The number of attributes.
  112869. * @returns the numnber of attributes.
  112870. */
  112871. getAttributesCount(): number;
  112872. /**
  112873. * Gets the index of a uniform variable.
  112874. * @param uniformName of the uniform to look up.
  112875. * @returns the index.
  112876. */
  112877. getUniformIndex(uniformName: string): number;
  112878. /**
  112879. * Returns the attribute based on the name of the variable.
  112880. * @param uniformName of the uniform to look up.
  112881. * @returns the location of the uniform.
  112882. */
  112883. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  112884. /**
  112885. * Returns an array of sampler variable names
  112886. * @returns The array of sampler variable names.
  112887. */
  112888. getSamplers(): string[];
  112889. /**
  112890. * Returns an array of uniform variable names
  112891. * @returns The array of uniform variable names.
  112892. */
  112893. getUniformNames(): string[];
  112894. /**
  112895. * Returns an array of uniform buffer variable names
  112896. * @returns The array of uniform buffer variable names.
  112897. */
  112898. getUniformBuffersNames(): string[];
  112899. /**
  112900. * Returns the index parameters used to create the effect
  112901. * @returns The index parameters object
  112902. */
  112903. getIndexParameters(): any;
  112904. /**
  112905. * The error from the last compilation.
  112906. * @returns the error string.
  112907. */
  112908. getCompilationError(): string;
  112909. /**
  112910. * Gets a boolean indicating that all fallbacks were used during compilation
  112911. * @returns true if all fallbacks were used
  112912. */
  112913. allFallbacksProcessed(): boolean;
  112914. /**
  112915. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  112916. * @param func The callback to be used.
  112917. */
  112918. executeWhenCompiled(func: (effect: Effect) => void): void;
  112919. private _checkIsReady;
  112920. private _loadShader;
  112921. /**
  112922. * Gets the vertex shader source code of this effect
  112923. */
  112924. get vertexSourceCode(): string;
  112925. /**
  112926. * Gets the fragment shader source code of this effect
  112927. */
  112928. get fragmentSourceCode(): string;
  112929. /**
  112930. * Recompiles the webGL program
  112931. * @param vertexSourceCode The source code for the vertex shader.
  112932. * @param fragmentSourceCode The source code for the fragment shader.
  112933. * @param onCompiled Callback called when completed.
  112934. * @param onError Callback called on error.
  112935. * @hidden
  112936. */
  112937. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  112938. /**
  112939. * Prepares the effect
  112940. * @hidden
  112941. */
  112942. _prepareEffect(): void;
  112943. private _getShaderCodeAndErrorLine;
  112944. private _processCompilationErrors;
  112945. /**
  112946. * Checks if the effect is supported. (Must be called after compilation)
  112947. */
  112948. get isSupported(): boolean;
  112949. /**
  112950. * Binds a texture to the engine to be used as output of the shader.
  112951. * @param channel Name of the output variable.
  112952. * @param texture Texture to bind.
  112953. * @hidden
  112954. */
  112955. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  112956. /**
  112957. * Sets a texture on the engine to be used in the shader.
  112958. * @param channel Name of the sampler variable.
  112959. * @param texture Texture to set.
  112960. */
  112961. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  112962. /**
  112963. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  112964. * @param channel Name of the sampler variable.
  112965. * @param texture Texture to set.
  112966. */
  112967. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  112968. /**
  112969. * Sets an array of textures on the engine to be used in the shader.
  112970. * @param channel Name of the variable.
  112971. * @param textures Textures to set.
  112972. */
  112973. setTextureArray(channel: string, textures: BaseTexture[]): void;
  112974. /**
  112975. * 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)
  112976. * @param channel Name of the sampler variable.
  112977. * @param postProcess Post process to get the input texture from.
  112978. */
  112979. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  112980. /**
  112981. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  112982. * 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)
  112983. * @param channel Name of the sampler variable.
  112984. * @param postProcess Post process to get the output texture from.
  112985. */
  112986. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  112987. /** @hidden */
  112988. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  112989. /** @hidden */
  112990. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  112991. /** @hidden */
  112992. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  112993. /** @hidden */
  112994. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  112995. /**
  112996. * Binds a buffer to a uniform.
  112997. * @param buffer Buffer to bind.
  112998. * @param name Name of the uniform variable to bind to.
  112999. */
  113000. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  113001. /**
  113002. * Binds block to a uniform.
  113003. * @param blockName Name of the block to bind.
  113004. * @param index Index to bind.
  113005. */
  113006. bindUniformBlock(blockName: string, index: number): void;
  113007. /**
  113008. * Sets an interger value on a uniform variable.
  113009. * @param uniformName Name of the variable.
  113010. * @param value Value to be set.
  113011. * @returns this effect.
  113012. */
  113013. setInt(uniformName: string, value: number): Effect;
  113014. /**
  113015. * Sets an int array on a uniform variable.
  113016. * @param uniformName Name of the variable.
  113017. * @param array array to be set.
  113018. * @returns this effect.
  113019. */
  113020. setIntArray(uniformName: string, array: Int32Array): Effect;
  113021. /**
  113022. * 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)
  113023. * @param uniformName Name of the variable.
  113024. * @param array array to be set.
  113025. * @returns this effect.
  113026. */
  113027. setIntArray2(uniformName: string, array: Int32Array): Effect;
  113028. /**
  113029. * 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)
  113030. * @param uniformName Name of the variable.
  113031. * @param array array to be set.
  113032. * @returns this effect.
  113033. */
  113034. setIntArray3(uniformName: string, array: Int32Array): Effect;
  113035. /**
  113036. * 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)
  113037. * @param uniformName Name of the variable.
  113038. * @param array array to be set.
  113039. * @returns this effect.
  113040. */
  113041. setIntArray4(uniformName: string, array: Int32Array): Effect;
  113042. /**
  113043. * Sets an float array on a uniform variable.
  113044. * @param uniformName Name of the variable.
  113045. * @param array array to be set.
  113046. * @returns this effect.
  113047. */
  113048. setFloatArray(uniformName: string, array: Float32Array): Effect;
  113049. /**
  113050. * 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)
  113051. * @param uniformName Name of the variable.
  113052. * @param array array to be set.
  113053. * @returns this effect.
  113054. */
  113055. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  113056. /**
  113057. * 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)
  113058. * @param uniformName Name of the variable.
  113059. * @param array array to be set.
  113060. * @returns this effect.
  113061. */
  113062. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  113063. /**
  113064. * 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)
  113065. * @param uniformName Name of the variable.
  113066. * @param array array to be set.
  113067. * @returns this effect.
  113068. */
  113069. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  113070. /**
  113071. * Sets an array on a uniform variable.
  113072. * @param uniformName Name of the variable.
  113073. * @param array array to be set.
  113074. * @returns this effect.
  113075. */
  113076. setArray(uniformName: string, array: number[]): Effect;
  113077. /**
  113078. * 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)
  113079. * @param uniformName Name of the variable.
  113080. * @param array array to be set.
  113081. * @returns this effect.
  113082. */
  113083. setArray2(uniformName: string, array: number[]): Effect;
  113084. /**
  113085. * 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)
  113086. * @param uniformName Name of the variable.
  113087. * @param array array to be set.
  113088. * @returns this effect.
  113089. */
  113090. setArray3(uniformName: string, array: number[]): Effect;
  113091. /**
  113092. * 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)
  113093. * @param uniformName Name of the variable.
  113094. * @param array array to be set.
  113095. * @returns this effect.
  113096. */
  113097. setArray4(uniformName: string, array: number[]): Effect;
  113098. /**
  113099. * Sets matrices on a uniform variable.
  113100. * @param uniformName Name of the variable.
  113101. * @param matrices matrices to be set.
  113102. * @returns this effect.
  113103. */
  113104. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  113105. /**
  113106. * Sets matrix on a uniform variable.
  113107. * @param uniformName Name of the variable.
  113108. * @param matrix matrix to be set.
  113109. * @returns this effect.
  113110. */
  113111. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  113112. /**
  113113. * 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)
  113114. * @param uniformName Name of the variable.
  113115. * @param matrix matrix to be set.
  113116. * @returns this effect.
  113117. */
  113118. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  113119. /**
  113120. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  113121. * @param uniformName Name of the variable.
  113122. * @param matrix matrix to be set.
  113123. * @returns this effect.
  113124. */
  113125. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  113126. /**
  113127. * Sets a float on a uniform variable.
  113128. * @param uniformName Name of the variable.
  113129. * @param value value to be set.
  113130. * @returns this effect.
  113131. */
  113132. setFloat(uniformName: string, value: number): Effect;
  113133. /**
  113134. * Sets a boolean on a uniform variable.
  113135. * @param uniformName Name of the variable.
  113136. * @param bool value to be set.
  113137. * @returns this effect.
  113138. */
  113139. setBool(uniformName: string, bool: boolean): Effect;
  113140. /**
  113141. * Sets a Vector2 on a uniform variable.
  113142. * @param uniformName Name of the variable.
  113143. * @param vector2 vector2 to be set.
  113144. * @returns this effect.
  113145. */
  113146. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  113147. /**
  113148. * Sets a float2 on a uniform variable.
  113149. * @param uniformName Name of the variable.
  113150. * @param x First float in float2.
  113151. * @param y Second float in float2.
  113152. * @returns this effect.
  113153. */
  113154. setFloat2(uniformName: string, x: number, y: number): Effect;
  113155. /**
  113156. * Sets a Vector3 on a uniform variable.
  113157. * @param uniformName Name of the variable.
  113158. * @param vector3 Value to be set.
  113159. * @returns this effect.
  113160. */
  113161. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  113162. /**
  113163. * Sets a float3 on a uniform variable.
  113164. * @param uniformName Name of the variable.
  113165. * @param x First float in float3.
  113166. * @param y Second float in float3.
  113167. * @param z Third float in float3.
  113168. * @returns this effect.
  113169. */
  113170. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  113171. /**
  113172. * Sets a Vector4 on a uniform variable.
  113173. * @param uniformName Name of the variable.
  113174. * @param vector4 Value to be set.
  113175. * @returns this effect.
  113176. */
  113177. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  113178. /**
  113179. * Sets a float4 on a uniform variable.
  113180. * @param uniformName Name of the variable.
  113181. * @param x First float in float4.
  113182. * @param y Second float in float4.
  113183. * @param z Third float in float4.
  113184. * @param w Fourth float in float4.
  113185. * @returns this effect.
  113186. */
  113187. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  113188. /**
  113189. * Sets a Color3 on a uniform variable.
  113190. * @param uniformName Name of the variable.
  113191. * @param color3 Value to be set.
  113192. * @returns this effect.
  113193. */
  113194. setColor3(uniformName: string, color3: IColor3Like): Effect;
  113195. /**
  113196. * Sets a Color4 on a uniform variable.
  113197. * @param uniformName Name of the variable.
  113198. * @param color3 Value to be set.
  113199. * @param alpha Alpha value to be set.
  113200. * @returns this effect.
  113201. */
  113202. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  113203. /**
  113204. * Sets a Color4 on a uniform variable
  113205. * @param uniformName defines the name of the variable
  113206. * @param color4 defines the value to be set
  113207. * @returns this effect.
  113208. */
  113209. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  113210. /** Release all associated resources */
  113211. dispose(): void;
  113212. /**
  113213. * This function will add a new shader to the shader store
  113214. * @param name the name of the shader
  113215. * @param pixelShader optional pixel shader content
  113216. * @param vertexShader optional vertex shader content
  113217. */
  113218. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  113219. /**
  113220. * Store of each shader (The can be looked up using effect.key)
  113221. */
  113222. static ShadersStore: {
  113223. [key: string]: string;
  113224. };
  113225. /**
  113226. * Store of each included file for a shader (The can be looked up using effect.key)
  113227. */
  113228. static IncludesShadersStore: {
  113229. [key: string]: string;
  113230. };
  113231. /**
  113232. * Resets the cache of effects.
  113233. */
  113234. static ResetCache(): void;
  113235. }
  113236. }
  113237. declare module BABYLON {
  113238. /**
  113239. * Interface used to describe the capabilities of the engine relatively to the current browser
  113240. */
  113241. export interface EngineCapabilities {
  113242. /** Maximum textures units per fragment shader */
  113243. maxTexturesImageUnits: number;
  113244. /** Maximum texture units per vertex shader */
  113245. maxVertexTextureImageUnits: number;
  113246. /** Maximum textures units in the entire pipeline */
  113247. maxCombinedTexturesImageUnits: number;
  113248. /** Maximum texture size */
  113249. maxTextureSize: number;
  113250. /** Maximum texture samples */
  113251. maxSamples?: number;
  113252. /** Maximum cube texture size */
  113253. maxCubemapTextureSize: number;
  113254. /** Maximum render texture size */
  113255. maxRenderTextureSize: number;
  113256. /** Maximum number of vertex attributes */
  113257. maxVertexAttribs: number;
  113258. /** Maximum number of varyings */
  113259. maxVaryingVectors: number;
  113260. /** Maximum number of uniforms per vertex shader */
  113261. maxVertexUniformVectors: number;
  113262. /** Maximum number of uniforms per fragment shader */
  113263. maxFragmentUniformVectors: number;
  113264. /** Defines if standard derivates (dx/dy) are supported */
  113265. standardDerivatives: boolean;
  113266. /** Defines if s3tc texture compression is supported */
  113267. s3tc?: WEBGL_compressed_texture_s3tc;
  113268. /** Defines if pvrtc texture compression is supported */
  113269. pvrtc: any;
  113270. /** Defines if etc1 texture compression is supported */
  113271. etc1: any;
  113272. /** Defines if etc2 texture compression is supported */
  113273. etc2: any;
  113274. /** Defines if astc texture compression is supported */
  113275. astc: any;
  113276. /** Defines if float textures are supported */
  113277. textureFloat: boolean;
  113278. /** Defines if vertex array objects are supported */
  113279. vertexArrayObject: boolean;
  113280. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  113281. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  113282. /** Gets the maximum level of anisotropy supported */
  113283. maxAnisotropy: number;
  113284. /** Defines if instancing is supported */
  113285. instancedArrays: boolean;
  113286. /** Defines if 32 bits indices are supported */
  113287. uintIndices: boolean;
  113288. /** Defines if high precision shaders are supported */
  113289. highPrecisionShaderSupported: boolean;
  113290. /** Defines if depth reading in the fragment shader is supported */
  113291. fragmentDepthSupported: boolean;
  113292. /** Defines if float texture linear filtering is supported*/
  113293. textureFloatLinearFiltering: boolean;
  113294. /** Defines if rendering to float textures is supported */
  113295. textureFloatRender: boolean;
  113296. /** Defines if half float textures are supported*/
  113297. textureHalfFloat: boolean;
  113298. /** Defines if half float texture linear filtering is supported*/
  113299. textureHalfFloatLinearFiltering: boolean;
  113300. /** Defines if rendering to half float textures is supported */
  113301. textureHalfFloatRender: boolean;
  113302. /** Defines if textureLOD shader command is supported */
  113303. textureLOD: boolean;
  113304. /** Defines if draw buffers extension is supported */
  113305. drawBuffersExtension: boolean;
  113306. /** Defines if depth textures are supported */
  113307. depthTextureExtension: boolean;
  113308. /** Defines if float color buffer are supported */
  113309. colorBufferFloat: boolean;
  113310. /** Gets disjoint timer query extension (null if not supported) */
  113311. timerQuery?: EXT_disjoint_timer_query;
  113312. /** Defines if timestamp can be used with timer query */
  113313. canUseTimestampForTimerQuery: boolean;
  113314. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  113315. multiview?: any;
  113316. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  113317. oculusMultiview?: any;
  113318. /** Function used to let the system compiles shaders in background */
  113319. parallelShaderCompile?: {
  113320. COMPLETION_STATUS_KHR: number;
  113321. };
  113322. /** Max number of texture samples for MSAA */
  113323. maxMSAASamples: number;
  113324. /** Defines if the blend min max extension is supported */
  113325. blendMinMax: boolean;
  113326. }
  113327. }
  113328. declare module BABYLON {
  113329. /**
  113330. * @hidden
  113331. **/
  113332. export class DepthCullingState {
  113333. private _isDepthTestDirty;
  113334. private _isDepthMaskDirty;
  113335. private _isDepthFuncDirty;
  113336. private _isCullFaceDirty;
  113337. private _isCullDirty;
  113338. private _isZOffsetDirty;
  113339. private _isFrontFaceDirty;
  113340. private _depthTest;
  113341. private _depthMask;
  113342. private _depthFunc;
  113343. private _cull;
  113344. private _cullFace;
  113345. private _zOffset;
  113346. private _frontFace;
  113347. /**
  113348. * Initializes the state.
  113349. */
  113350. constructor();
  113351. get isDirty(): boolean;
  113352. get zOffset(): number;
  113353. set zOffset(value: number);
  113354. get cullFace(): Nullable<number>;
  113355. set cullFace(value: Nullable<number>);
  113356. get cull(): Nullable<boolean>;
  113357. set cull(value: Nullable<boolean>);
  113358. get depthFunc(): Nullable<number>;
  113359. set depthFunc(value: Nullable<number>);
  113360. get depthMask(): boolean;
  113361. set depthMask(value: boolean);
  113362. get depthTest(): boolean;
  113363. set depthTest(value: boolean);
  113364. get frontFace(): Nullable<number>;
  113365. set frontFace(value: Nullable<number>);
  113366. reset(): void;
  113367. apply(gl: WebGLRenderingContext): void;
  113368. }
  113369. }
  113370. declare module BABYLON {
  113371. /**
  113372. * @hidden
  113373. **/
  113374. export class StencilState {
  113375. /** 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 */
  113376. static readonly ALWAYS: number;
  113377. /** Passed to stencilOperation to specify that stencil value must be kept */
  113378. static readonly KEEP: number;
  113379. /** Passed to stencilOperation to specify that stencil value must be replaced */
  113380. static readonly REPLACE: number;
  113381. private _isStencilTestDirty;
  113382. private _isStencilMaskDirty;
  113383. private _isStencilFuncDirty;
  113384. private _isStencilOpDirty;
  113385. private _stencilTest;
  113386. private _stencilMask;
  113387. private _stencilFunc;
  113388. private _stencilFuncRef;
  113389. private _stencilFuncMask;
  113390. private _stencilOpStencilFail;
  113391. private _stencilOpDepthFail;
  113392. private _stencilOpStencilDepthPass;
  113393. get isDirty(): boolean;
  113394. get stencilFunc(): number;
  113395. set stencilFunc(value: number);
  113396. get stencilFuncRef(): number;
  113397. set stencilFuncRef(value: number);
  113398. get stencilFuncMask(): number;
  113399. set stencilFuncMask(value: number);
  113400. get stencilOpStencilFail(): number;
  113401. set stencilOpStencilFail(value: number);
  113402. get stencilOpDepthFail(): number;
  113403. set stencilOpDepthFail(value: number);
  113404. get stencilOpStencilDepthPass(): number;
  113405. set stencilOpStencilDepthPass(value: number);
  113406. get stencilMask(): number;
  113407. set stencilMask(value: number);
  113408. get stencilTest(): boolean;
  113409. set stencilTest(value: boolean);
  113410. constructor();
  113411. reset(): void;
  113412. apply(gl: WebGLRenderingContext): void;
  113413. }
  113414. }
  113415. declare module BABYLON {
  113416. /**
  113417. * @hidden
  113418. **/
  113419. export class AlphaState {
  113420. private _isAlphaBlendDirty;
  113421. private _isBlendFunctionParametersDirty;
  113422. private _isBlendEquationParametersDirty;
  113423. private _isBlendConstantsDirty;
  113424. private _alphaBlend;
  113425. private _blendFunctionParameters;
  113426. private _blendEquationParameters;
  113427. private _blendConstants;
  113428. /**
  113429. * Initializes the state.
  113430. */
  113431. constructor();
  113432. get isDirty(): boolean;
  113433. get alphaBlend(): boolean;
  113434. set alphaBlend(value: boolean);
  113435. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  113436. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  113437. setAlphaEquationParameters(rgb: number, alpha: number): void;
  113438. reset(): void;
  113439. apply(gl: WebGLRenderingContext): void;
  113440. }
  113441. }
  113442. declare module BABYLON {
  113443. /** @hidden */
  113444. export class WebGL2ShaderProcessor implements IShaderProcessor {
  113445. attributeProcessor(attribute: string): string;
  113446. varyingProcessor(varying: string, isFragment: boolean): string;
  113447. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  113448. }
  113449. }
  113450. declare module BABYLON {
  113451. /**
  113452. * Interface for attribute information associated with buffer instanciation
  113453. */
  113454. export interface InstancingAttributeInfo {
  113455. /**
  113456. * Name of the GLSL attribute
  113457. * if attribute index is not specified, this is used to retrieve the index from the effect
  113458. */
  113459. attributeName: string;
  113460. /**
  113461. * Index/offset of the attribute in the vertex shader
  113462. * if not specified, this will be computes from the name.
  113463. */
  113464. index?: number;
  113465. /**
  113466. * size of the attribute, 1, 2, 3 or 4
  113467. */
  113468. attributeSize: number;
  113469. /**
  113470. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  113471. */
  113472. offset: number;
  113473. /**
  113474. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  113475. * default to 1
  113476. */
  113477. divisor?: number;
  113478. /**
  113479. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  113480. * default is FLOAT
  113481. */
  113482. attributeType?: number;
  113483. /**
  113484. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  113485. */
  113486. normalized?: boolean;
  113487. }
  113488. }
  113489. declare module BABYLON {
  113490. interface ThinEngine {
  113491. /**
  113492. * Update a video texture
  113493. * @param texture defines the texture to update
  113494. * @param video defines the video element to use
  113495. * @param invertY defines if data must be stored with Y axis inverted
  113496. */
  113497. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  113498. }
  113499. }
  113500. declare module BABYLON {
  113501. interface ThinEngine {
  113502. /**
  113503. * Creates a dynamic texture
  113504. * @param width defines the width of the texture
  113505. * @param height defines the height of the texture
  113506. * @param generateMipMaps defines if the engine should generate the mip levels
  113507. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  113508. * @returns the dynamic texture inside an InternalTexture
  113509. */
  113510. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  113511. /**
  113512. * Update the content of a dynamic texture
  113513. * @param texture defines the texture to update
  113514. * @param canvas defines the canvas containing the source
  113515. * @param invertY defines if data must be stored with Y axis inverted
  113516. * @param premulAlpha defines if alpha is stored as premultiplied
  113517. * @param format defines the format of the data
  113518. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  113519. */
  113520. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  113521. }
  113522. }
  113523. declare module BABYLON {
  113524. /**
  113525. * Settings for finer control over video usage
  113526. */
  113527. export interface VideoTextureSettings {
  113528. /**
  113529. * Applies `autoplay` to video, if specified
  113530. */
  113531. autoPlay?: boolean;
  113532. /**
  113533. * Applies `loop` to video, if specified
  113534. */
  113535. loop?: boolean;
  113536. /**
  113537. * Automatically updates internal texture from video at every frame in the render loop
  113538. */
  113539. autoUpdateTexture: boolean;
  113540. /**
  113541. * Image src displayed during the video loading or until the user interacts with the video.
  113542. */
  113543. poster?: string;
  113544. }
  113545. /**
  113546. * If you want to display a video in your scene, this is the special texture for that.
  113547. * This special texture works similar to other textures, with the exception of a few parameters.
  113548. * @see https://doc.babylonjs.com/how_to/video_texture
  113549. */
  113550. export class VideoTexture extends Texture {
  113551. /**
  113552. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  113553. */
  113554. readonly autoUpdateTexture: boolean;
  113555. /**
  113556. * The video instance used by the texture internally
  113557. */
  113558. readonly video: HTMLVideoElement;
  113559. private _onUserActionRequestedObservable;
  113560. /**
  113561. * Event triggerd when a dom action is required by the user to play the video.
  113562. * This happens due to recent changes in browser policies preventing video to auto start.
  113563. */
  113564. get onUserActionRequestedObservable(): Observable<Texture>;
  113565. private _generateMipMaps;
  113566. private _stillImageCaptured;
  113567. private _displayingPosterTexture;
  113568. private _settings;
  113569. private _createInternalTextureOnEvent;
  113570. private _frameId;
  113571. private _currentSrc;
  113572. /**
  113573. * Creates a video texture.
  113574. * If you want to display a video in your scene, this is the special texture for that.
  113575. * This special texture works similar to other textures, with the exception of a few parameters.
  113576. * @see https://doc.babylonjs.com/how_to/video_texture
  113577. * @param name optional name, will detect from video source, if not defined
  113578. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  113579. * @param scene is obviously the current scene.
  113580. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  113581. * @param invertY is false by default but can be used to invert video on Y axis
  113582. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  113583. * @param settings allows finer control over video usage
  113584. */
  113585. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  113586. private _getName;
  113587. private _getVideo;
  113588. private _createInternalTexture;
  113589. private reset;
  113590. /**
  113591. * @hidden Internal method to initiate `update`.
  113592. */
  113593. _rebuild(): void;
  113594. /**
  113595. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  113596. */
  113597. update(): void;
  113598. /**
  113599. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  113600. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  113601. */
  113602. updateTexture(isVisible: boolean): void;
  113603. protected _updateInternalTexture: () => void;
  113604. /**
  113605. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  113606. * @param url New url.
  113607. */
  113608. updateURL(url: string): void;
  113609. /**
  113610. * Clones the texture.
  113611. * @returns the cloned texture
  113612. */
  113613. clone(): VideoTexture;
  113614. /**
  113615. * Dispose the texture and release its associated resources.
  113616. */
  113617. dispose(): void;
  113618. /**
  113619. * Creates a video texture straight from a stream.
  113620. * @param scene Define the scene the texture should be created in
  113621. * @param stream Define the stream the texture should be created from
  113622. * @returns The created video texture as a promise
  113623. */
  113624. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  113625. /**
  113626. * Creates a video texture straight from your WebCam video feed.
  113627. * @param scene Define the scene the texture should be created in
  113628. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  113629. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  113630. * @returns The created video texture as a promise
  113631. */
  113632. static CreateFromWebCamAsync(scene: Scene, constraints: {
  113633. minWidth: number;
  113634. maxWidth: number;
  113635. minHeight: number;
  113636. maxHeight: number;
  113637. deviceId: string;
  113638. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  113639. /**
  113640. * Creates a video texture straight from your WebCam video feed.
  113641. * @param scene Define the scene the texture should be created in
  113642. * @param onReady Define a callback to triggered once the texture will be ready
  113643. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  113644. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  113645. */
  113646. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  113647. minWidth: number;
  113648. maxWidth: number;
  113649. minHeight: number;
  113650. maxHeight: number;
  113651. deviceId: string;
  113652. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  113653. }
  113654. }
  113655. declare module BABYLON {
  113656. /**
  113657. * Defines the interface used by objects working like Scene
  113658. * @hidden
  113659. */
  113660. export interface ISceneLike {
  113661. _addPendingData(data: any): void;
  113662. _removePendingData(data: any): void;
  113663. offlineProvider: IOfflineProvider;
  113664. }
  113665. /** Interface defining initialization parameters for Engine class */
  113666. export interface EngineOptions extends WebGLContextAttributes {
  113667. /**
  113668. * Defines if the engine should no exceed a specified device ratio
  113669. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  113670. */
  113671. limitDeviceRatio?: number;
  113672. /**
  113673. * Defines if webvr should be enabled automatically
  113674. * @see https://doc.babylonjs.com/how_to/webvr_camera
  113675. */
  113676. autoEnableWebVR?: boolean;
  113677. /**
  113678. * Defines if webgl2 should be turned off even if supported
  113679. * @see https://doc.babylonjs.com/features/webgl2
  113680. */
  113681. disableWebGL2Support?: boolean;
  113682. /**
  113683. * Defines if webaudio should be initialized as well
  113684. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  113685. */
  113686. audioEngine?: boolean;
  113687. /**
  113688. * Defines if animations should run using a deterministic lock step
  113689. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  113690. */
  113691. deterministicLockstep?: boolean;
  113692. /** Defines the maximum steps to use with deterministic lock step mode */
  113693. lockstepMaxSteps?: number;
  113694. /** Defines the seconds between each deterministic lock step */
  113695. timeStep?: number;
  113696. /**
  113697. * Defines that engine should ignore context lost events
  113698. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  113699. */
  113700. doNotHandleContextLost?: boolean;
  113701. /**
  113702. * Defines that engine should ignore modifying touch action attribute and style
  113703. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  113704. */
  113705. doNotHandleTouchAction?: boolean;
  113706. /**
  113707. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  113708. */
  113709. useHighPrecisionFloats?: boolean;
  113710. /**
  113711. * Make the canvas XR Compatible for XR sessions
  113712. */
  113713. xrCompatible?: boolean;
  113714. /**
  113715. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  113716. */
  113717. useHighPrecisionMatrix?: boolean;
  113718. }
  113719. /**
  113720. * The base engine class (root of all engines)
  113721. */
  113722. export class ThinEngine {
  113723. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  113724. static ExceptionList: ({
  113725. key: string;
  113726. capture: string;
  113727. captureConstraint: number;
  113728. targets: string[];
  113729. } | {
  113730. key: string;
  113731. capture: null;
  113732. captureConstraint: null;
  113733. targets: string[];
  113734. })[];
  113735. /** @hidden */
  113736. static _TextureLoaders: IInternalTextureLoader[];
  113737. /**
  113738. * Returns the current npm package of the sdk
  113739. */
  113740. static get NpmPackage(): string;
  113741. /**
  113742. * Returns the current version of the framework
  113743. */
  113744. static get Version(): string;
  113745. /**
  113746. * Returns a string describing the current engine
  113747. */
  113748. get description(): string;
  113749. /**
  113750. * Gets or sets the epsilon value used by collision engine
  113751. */
  113752. static CollisionsEpsilon: number;
  113753. /**
  113754. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113755. */
  113756. static get ShadersRepository(): string;
  113757. static set ShadersRepository(value: string);
  113758. /** @hidden */
  113759. _shaderProcessor: IShaderProcessor;
  113760. /**
  113761. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  113762. */
  113763. forcePOTTextures: boolean;
  113764. /**
  113765. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  113766. */
  113767. isFullscreen: boolean;
  113768. /**
  113769. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  113770. */
  113771. cullBackFaces: boolean;
  113772. /**
  113773. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  113774. */
  113775. renderEvenInBackground: boolean;
  113776. /**
  113777. * Gets or sets a boolean indicating that cache can be kept between frames
  113778. */
  113779. preventCacheWipeBetweenFrames: boolean;
  113780. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  113781. validateShaderPrograms: boolean;
  113782. /**
  113783. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  113784. * This can provide greater z depth for distant objects.
  113785. */
  113786. useReverseDepthBuffer: boolean;
  113787. /**
  113788. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  113789. */
  113790. disableUniformBuffers: boolean;
  113791. /** @hidden */
  113792. _uniformBuffers: UniformBuffer[];
  113793. /**
  113794. * Gets a boolean indicating that the engine supports uniform buffers
  113795. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  113796. */
  113797. get supportsUniformBuffers(): boolean;
  113798. /** @hidden */
  113799. _gl: WebGLRenderingContext;
  113800. /** @hidden */
  113801. _webGLVersion: number;
  113802. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  113803. protected _windowIsBackground: boolean;
  113804. protected _creationOptions: EngineOptions;
  113805. protected _highPrecisionShadersAllowed: boolean;
  113806. /** @hidden */
  113807. get _shouldUseHighPrecisionShader(): boolean;
  113808. /**
  113809. * Gets a boolean indicating that only power of 2 textures are supported
  113810. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  113811. */
  113812. get needPOTTextures(): boolean;
  113813. /** @hidden */
  113814. _badOS: boolean;
  113815. /** @hidden */
  113816. _badDesktopOS: boolean;
  113817. private _hardwareScalingLevel;
  113818. /** @hidden */
  113819. _caps: EngineCapabilities;
  113820. private _isStencilEnable;
  113821. private _glVersion;
  113822. private _glRenderer;
  113823. private _glVendor;
  113824. /** @hidden */
  113825. _videoTextureSupported: boolean;
  113826. protected _renderingQueueLaunched: boolean;
  113827. protected _activeRenderLoops: (() => void)[];
  113828. /**
  113829. * Observable signaled when a context lost event is raised
  113830. */
  113831. onContextLostObservable: Observable<ThinEngine>;
  113832. /**
  113833. * Observable signaled when a context restored event is raised
  113834. */
  113835. onContextRestoredObservable: Observable<ThinEngine>;
  113836. private _onContextLost;
  113837. private _onContextRestored;
  113838. protected _contextWasLost: boolean;
  113839. /** @hidden */
  113840. _doNotHandleContextLost: boolean;
  113841. /**
  113842. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  113843. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  113844. */
  113845. get doNotHandleContextLost(): boolean;
  113846. set doNotHandleContextLost(value: boolean);
  113847. /**
  113848. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  113849. */
  113850. disableVertexArrayObjects: boolean;
  113851. /** @hidden */
  113852. protected _colorWrite: boolean;
  113853. /** @hidden */
  113854. protected _colorWriteChanged: boolean;
  113855. /** @hidden */
  113856. protected _depthCullingState: DepthCullingState;
  113857. /** @hidden */
  113858. protected _stencilState: StencilState;
  113859. /** @hidden */
  113860. _alphaState: AlphaState;
  113861. /** @hidden */
  113862. _alphaMode: number;
  113863. /** @hidden */
  113864. _alphaEquation: number;
  113865. /** @hidden */
  113866. _internalTexturesCache: InternalTexture[];
  113867. /** @hidden */
  113868. protected _activeChannel: number;
  113869. private _currentTextureChannel;
  113870. /** @hidden */
  113871. protected _boundTexturesCache: {
  113872. [key: string]: Nullable<InternalTexture>;
  113873. };
  113874. /** @hidden */
  113875. protected _currentEffect: Nullable<Effect>;
  113876. /** @hidden */
  113877. protected _currentProgram: Nullable<WebGLProgram>;
  113878. private _compiledEffects;
  113879. private _vertexAttribArraysEnabled;
  113880. /** @hidden */
  113881. protected _cachedViewport: Nullable<IViewportLike>;
  113882. private _cachedVertexArrayObject;
  113883. /** @hidden */
  113884. protected _cachedVertexBuffers: any;
  113885. /** @hidden */
  113886. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  113887. /** @hidden */
  113888. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  113889. /** @hidden */
  113890. _currentRenderTarget: Nullable<InternalTexture>;
  113891. private _uintIndicesCurrentlySet;
  113892. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  113893. /** @hidden */
  113894. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  113895. /** @hidden */
  113896. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  113897. private _currentBufferPointers;
  113898. private _currentInstanceLocations;
  113899. private _currentInstanceBuffers;
  113900. private _textureUnits;
  113901. /** @hidden */
  113902. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  113903. /** @hidden */
  113904. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  113905. /** @hidden */
  113906. _boundRenderFunction: any;
  113907. private _vaoRecordInProgress;
  113908. private _mustWipeVertexAttributes;
  113909. private _emptyTexture;
  113910. private _emptyCubeTexture;
  113911. private _emptyTexture3D;
  113912. private _emptyTexture2DArray;
  113913. /** @hidden */
  113914. _frameHandler: number;
  113915. private _nextFreeTextureSlots;
  113916. private _maxSimultaneousTextures;
  113917. private _activeRequests;
  113918. /** @hidden */
  113919. _transformTextureUrl: Nullable<(url: string) => string>;
  113920. protected get _supportsHardwareTextureRescaling(): boolean;
  113921. private _framebufferDimensionsObject;
  113922. /**
  113923. * sets the object from which width and height will be taken from when getting render width and height
  113924. * Will fallback to the gl object
  113925. * @param dimensions the framebuffer width and height that will be used.
  113926. */
  113927. set framebufferDimensionsObject(dimensions: Nullable<{
  113928. framebufferWidth: number;
  113929. framebufferHeight: number;
  113930. }>);
  113931. /**
  113932. * Gets the current viewport
  113933. */
  113934. get currentViewport(): Nullable<IViewportLike>;
  113935. /**
  113936. * Gets the default empty texture
  113937. */
  113938. get emptyTexture(): InternalTexture;
  113939. /**
  113940. * Gets the default empty 3D texture
  113941. */
  113942. get emptyTexture3D(): InternalTexture;
  113943. /**
  113944. * Gets the default empty 2D array texture
  113945. */
  113946. get emptyTexture2DArray(): InternalTexture;
  113947. /**
  113948. * Gets the default empty cube texture
  113949. */
  113950. get emptyCubeTexture(): InternalTexture;
  113951. /**
  113952. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  113953. */
  113954. readonly premultipliedAlpha: boolean;
  113955. /**
  113956. * Observable event triggered before each texture is initialized
  113957. */
  113958. onBeforeTextureInitObservable: Observable<Texture>;
  113959. /**
  113960. * Creates a new engine
  113961. * @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
  113962. * @param antialias defines enable antialiasing (default: false)
  113963. * @param options defines further options to be sent to the getContext() function
  113964. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  113965. */
  113966. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  113967. private _rebuildInternalTextures;
  113968. private _rebuildEffects;
  113969. /**
  113970. * Gets a boolean indicating if all created effects are ready
  113971. * @returns true if all effects are ready
  113972. */
  113973. areAllEffectsReady(): boolean;
  113974. protected _rebuildBuffers(): void;
  113975. protected _initGLContext(): void;
  113976. /**
  113977. * Gets version of the current webGL context
  113978. */
  113979. get webGLVersion(): number;
  113980. /**
  113981. * Gets a string idenfifying the name of the class
  113982. * @returns "Engine" string
  113983. */
  113984. getClassName(): string;
  113985. /**
  113986. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  113987. */
  113988. get isStencilEnable(): boolean;
  113989. /** @hidden */
  113990. _prepareWorkingCanvas(): void;
  113991. /**
  113992. * Reset the texture cache to empty state
  113993. */
  113994. resetTextureCache(): void;
  113995. /**
  113996. * Gets an object containing information about the current webGL context
  113997. * @returns an object containing the vender, the renderer and the version of the current webGL context
  113998. */
  113999. getGlInfo(): {
  114000. vendor: string;
  114001. renderer: string;
  114002. version: string;
  114003. };
  114004. /**
  114005. * Defines the hardware scaling level.
  114006. * By default the hardware scaling level is computed from the window device ratio.
  114007. * 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.
  114008. * @param level defines the level to use
  114009. */
  114010. setHardwareScalingLevel(level: number): void;
  114011. /**
  114012. * Gets the current hardware scaling level.
  114013. * By default the hardware scaling level is computed from the window device ratio.
  114014. * 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.
  114015. * @returns a number indicating the current hardware scaling level
  114016. */
  114017. getHardwareScalingLevel(): number;
  114018. /**
  114019. * Gets the list of loaded textures
  114020. * @returns an array containing all loaded textures
  114021. */
  114022. getLoadedTexturesCache(): InternalTexture[];
  114023. /**
  114024. * Gets the object containing all engine capabilities
  114025. * @returns the EngineCapabilities object
  114026. */
  114027. getCaps(): EngineCapabilities;
  114028. /**
  114029. * stop executing a render loop function and remove it from the execution array
  114030. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  114031. */
  114032. stopRenderLoop(renderFunction?: () => void): void;
  114033. /** @hidden */
  114034. _renderLoop(): void;
  114035. /**
  114036. * Gets the HTML canvas attached with the current webGL context
  114037. * @returns a HTML canvas
  114038. */
  114039. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  114040. /**
  114041. * Gets host window
  114042. * @returns the host window object
  114043. */
  114044. getHostWindow(): Nullable<Window>;
  114045. /**
  114046. * Gets the current render width
  114047. * @param useScreen defines if screen size must be used (or the current render target if any)
  114048. * @returns a number defining the current render width
  114049. */
  114050. getRenderWidth(useScreen?: boolean): number;
  114051. /**
  114052. * Gets the current render height
  114053. * @param useScreen defines if screen size must be used (or the current render target if any)
  114054. * @returns a number defining the current render height
  114055. */
  114056. getRenderHeight(useScreen?: boolean): number;
  114057. /**
  114058. * Can be used to override the current requestAnimationFrame requester.
  114059. * @hidden
  114060. */
  114061. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  114062. /**
  114063. * Register and execute a render loop. The engine can have more than one render function
  114064. * @param renderFunction defines the function to continuously execute
  114065. */
  114066. runRenderLoop(renderFunction: () => void): void;
  114067. /**
  114068. * Clear the current render buffer or the current render target (if any is set up)
  114069. * @param color defines the color to use
  114070. * @param backBuffer defines if the back buffer must be cleared
  114071. * @param depth defines if the depth buffer must be cleared
  114072. * @param stencil defines if the stencil buffer must be cleared
  114073. */
  114074. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  114075. private _viewportCached;
  114076. /** @hidden */
  114077. _viewport(x: number, y: number, width: number, height: number): void;
  114078. /**
  114079. * Set the WebGL's viewport
  114080. * @param viewport defines the viewport element to be used
  114081. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  114082. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  114083. */
  114084. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  114085. /**
  114086. * Begin a new frame
  114087. */
  114088. beginFrame(): void;
  114089. /**
  114090. * Enf the current frame
  114091. */
  114092. endFrame(): void;
  114093. /**
  114094. * Resize the view according to the canvas' size
  114095. */
  114096. resize(): void;
  114097. /**
  114098. * Force a specific size of the canvas
  114099. * @param width defines the new canvas' width
  114100. * @param height defines the new canvas' height
  114101. * @returns true if the size was changed
  114102. */
  114103. setSize(width: number, height: number): boolean;
  114104. /**
  114105. * Binds the frame buffer to the specified texture.
  114106. * @param texture The texture to render to or null for the default canvas
  114107. * @param faceIndex The face of the texture to render to in case of cube texture
  114108. * @param requiredWidth The width of the target to render to
  114109. * @param requiredHeight The height of the target to render to
  114110. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  114111. * @param lodLevel defines the lod level to bind to the frame buffer
  114112. * @param layer defines the 2d array index to bind to frame buffer to
  114113. */
  114114. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  114115. /** @hidden */
  114116. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  114117. /**
  114118. * Unbind the current render target texture from the webGL context
  114119. * @param texture defines the render target texture to unbind
  114120. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  114121. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  114122. */
  114123. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  114124. /**
  114125. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  114126. */
  114127. flushFramebuffer(): void;
  114128. /**
  114129. * Unbind the current render target and bind the default framebuffer
  114130. */
  114131. restoreDefaultFramebuffer(): void;
  114132. /** @hidden */
  114133. protected _resetVertexBufferBinding(): void;
  114134. /**
  114135. * Creates a vertex buffer
  114136. * @param data the data for the vertex buffer
  114137. * @returns the new WebGL static buffer
  114138. */
  114139. createVertexBuffer(data: DataArray): DataBuffer;
  114140. private _createVertexBuffer;
  114141. /**
  114142. * Creates a dynamic vertex buffer
  114143. * @param data the data for the dynamic vertex buffer
  114144. * @returns the new WebGL dynamic buffer
  114145. */
  114146. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  114147. protected _resetIndexBufferBinding(): void;
  114148. /**
  114149. * Creates a new index buffer
  114150. * @param indices defines the content of the index buffer
  114151. * @param updatable defines if the index buffer must be updatable
  114152. * @returns a new webGL buffer
  114153. */
  114154. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  114155. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  114156. /**
  114157. * Bind a webGL buffer to the webGL context
  114158. * @param buffer defines the buffer to bind
  114159. */
  114160. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  114161. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  114162. private bindBuffer;
  114163. /**
  114164. * update the bound buffer with the given data
  114165. * @param data defines the data to update
  114166. */
  114167. updateArrayBuffer(data: Float32Array): void;
  114168. private _vertexAttribPointer;
  114169. /** @hidden */
  114170. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  114171. private _bindVertexBuffersAttributes;
  114172. /**
  114173. * Records a vertex array object
  114174. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  114175. * @param vertexBuffers defines the list of vertex buffers to store
  114176. * @param indexBuffer defines the index buffer to store
  114177. * @param effect defines the effect to store
  114178. * @returns the new vertex array object
  114179. */
  114180. recordVertexArrayObject(vertexBuffers: {
  114181. [key: string]: VertexBuffer;
  114182. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  114183. /**
  114184. * Bind a specific vertex array object
  114185. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  114186. * @param vertexArrayObject defines the vertex array object to bind
  114187. * @param indexBuffer defines the index buffer to bind
  114188. */
  114189. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  114190. /**
  114191. * Bind webGl buffers directly to the webGL context
  114192. * @param vertexBuffer defines the vertex buffer to bind
  114193. * @param indexBuffer defines the index buffer to bind
  114194. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  114195. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  114196. * @param effect defines the effect associated with the vertex buffer
  114197. */
  114198. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  114199. private _unbindVertexArrayObject;
  114200. /**
  114201. * Bind a list of vertex buffers to the webGL context
  114202. * @param vertexBuffers defines the list of vertex buffers to bind
  114203. * @param indexBuffer defines the index buffer to bind
  114204. * @param effect defines the effect associated with the vertex buffers
  114205. */
  114206. bindBuffers(vertexBuffers: {
  114207. [key: string]: Nullable<VertexBuffer>;
  114208. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  114209. /**
  114210. * Unbind all instance attributes
  114211. */
  114212. unbindInstanceAttributes(): void;
  114213. /**
  114214. * Release and free the memory of a vertex array object
  114215. * @param vao defines the vertex array object to delete
  114216. */
  114217. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  114218. /** @hidden */
  114219. _releaseBuffer(buffer: DataBuffer): boolean;
  114220. protected _deleteBuffer(buffer: DataBuffer): void;
  114221. /**
  114222. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  114223. * @param instancesBuffer defines the webGL buffer to update and bind
  114224. * @param data defines the data to store in the buffer
  114225. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  114226. */
  114227. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  114228. /**
  114229. * Bind the content of a webGL buffer used with instantiation
  114230. * @param instancesBuffer defines the webGL buffer to bind
  114231. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  114232. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  114233. */
  114234. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  114235. /**
  114236. * Disable the instance attribute corresponding to the name in parameter
  114237. * @param name defines the name of the attribute to disable
  114238. */
  114239. disableInstanceAttributeByName(name: string): void;
  114240. /**
  114241. * Disable the instance attribute corresponding to the location in parameter
  114242. * @param attributeLocation defines the attribute location of the attribute to disable
  114243. */
  114244. disableInstanceAttribute(attributeLocation: number): void;
  114245. /**
  114246. * Disable the attribute corresponding to the location in parameter
  114247. * @param attributeLocation defines the attribute location of the attribute to disable
  114248. */
  114249. disableAttributeByIndex(attributeLocation: number): void;
  114250. /**
  114251. * Send a draw order
  114252. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  114253. * @param indexStart defines the starting index
  114254. * @param indexCount defines the number of index to draw
  114255. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114256. */
  114257. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  114258. /**
  114259. * Draw a list of points
  114260. * @param verticesStart defines the index of first vertex to draw
  114261. * @param verticesCount defines the count of vertices to draw
  114262. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114263. */
  114264. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114265. /**
  114266. * Draw a list of unindexed primitives
  114267. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  114268. * @param verticesStart defines the index of first vertex to draw
  114269. * @param verticesCount defines the count of vertices to draw
  114270. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114271. */
  114272. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114273. /**
  114274. * Draw a list of indexed primitives
  114275. * @param fillMode defines the primitive to use
  114276. * @param indexStart defines the starting index
  114277. * @param indexCount defines the number of index to draw
  114278. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114279. */
  114280. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  114281. /**
  114282. * Draw a list of unindexed primitives
  114283. * @param fillMode defines the primitive to use
  114284. * @param verticesStart defines the index of first vertex to draw
  114285. * @param verticesCount defines the count of vertices to draw
  114286. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114287. */
  114288. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114289. private _drawMode;
  114290. /** @hidden */
  114291. protected _reportDrawCall(): void;
  114292. /** @hidden */
  114293. _releaseEffect(effect: Effect): void;
  114294. /** @hidden */
  114295. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  114296. /**
  114297. * Create a new effect (used to store vertex/fragment shaders)
  114298. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  114299. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  114300. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  114301. * @param samplers defines an array of string used to represent textures
  114302. * @param defines defines the string containing the defines to use to compile the shaders
  114303. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  114304. * @param onCompiled defines a function to call when the effect creation is successful
  114305. * @param onError defines a function to call when the effect creation has failed
  114306. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  114307. * @returns the new Effect
  114308. */
  114309. 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;
  114310. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  114311. private _compileShader;
  114312. private _compileRawShader;
  114313. /** @hidden */
  114314. _getShaderSource(shader: WebGLShader): Nullable<string>;
  114315. /**
  114316. * Directly creates a webGL program
  114317. * @param pipelineContext defines the pipeline context to attach to
  114318. * @param vertexCode defines the vertex shader code to use
  114319. * @param fragmentCode defines the fragment shader code to use
  114320. * @param context defines the webGL context to use (if not set, the current one will be used)
  114321. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  114322. * @returns the new webGL program
  114323. */
  114324. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114325. /**
  114326. * Creates a webGL program
  114327. * @param pipelineContext defines the pipeline context to attach to
  114328. * @param vertexCode defines the vertex shader code to use
  114329. * @param fragmentCode defines the fragment shader code to use
  114330. * @param defines defines the string containing the defines to use to compile the shaders
  114331. * @param context defines the webGL context to use (if not set, the current one will be used)
  114332. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  114333. * @returns the new webGL program
  114334. */
  114335. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114336. /**
  114337. * Creates a new pipeline context
  114338. * @returns the new pipeline
  114339. */
  114340. createPipelineContext(): IPipelineContext;
  114341. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114342. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  114343. /** @hidden */
  114344. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  114345. /** @hidden */
  114346. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  114347. /** @hidden */
  114348. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  114349. /**
  114350. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  114351. * @param pipelineContext defines the pipeline context to use
  114352. * @param uniformsNames defines the list of uniform names
  114353. * @returns an array of webGL uniform locations
  114354. */
  114355. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  114356. /**
  114357. * Gets the lsit of active attributes for a given webGL program
  114358. * @param pipelineContext defines the pipeline context to use
  114359. * @param attributesNames defines the list of attribute names to get
  114360. * @returns an array of indices indicating the offset of each attribute
  114361. */
  114362. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  114363. /**
  114364. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  114365. * @param effect defines the effect to activate
  114366. */
  114367. enableEffect(effect: Nullable<Effect>): void;
  114368. /**
  114369. * Set the value of an uniform to a number (int)
  114370. * @param uniform defines the webGL uniform location where to store the value
  114371. * @param value defines the int number to store
  114372. */
  114373. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  114374. /**
  114375. * Set the value of an uniform to an array of int32
  114376. * @param uniform defines the webGL uniform location where to store the value
  114377. * @param array defines the array of int32 to store
  114378. */
  114379. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114380. /**
  114381. * Set the value of an uniform to an array of int32 (stored as vec2)
  114382. * @param uniform defines the webGL uniform location where to store the value
  114383. * @param array defines the array of int32 to store
  114384. */
  114385. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114386. /**
  114387. * Set the value of an uniform to an array of int32 (stored as vec3)
  114388. * @param uniform defines the webGL uniform location where to store the value
  114389. * @param array defines the array of int32 to store
  114390. */
  114391. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114392. /**
  114393. * Set the value of an uniform to an array of int32 (stored as vec4)
  114394. * @param uniform defines the webGL uniform location where to store the value
  114395. * @param array defines the array of int32 to store
  114396. */
  114397. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114398. /**
  114399. * Set the value of an uniform to an array of number
  114400. * @param uniform defines the webGL uniform location where to store the value
  114401. * @param array defines the array of number to store
  114402. */
  114403. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114404. /**
  114405. * Set the value of an uniform to an array of number (stored as vec2)
  114406. * @param uniform defines the webGL uniform location where to store the value
  114407. * @param array defines the array of number to store
  114408. */
  114409. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114410. /**
  114411. * Set the value of an uniform to an array of number (stored as vec3)
  114412. * @param uniform defines the webGL uniform location where to store the value
  114413. * @param array defines the array of number to store
  114414. */
  114415. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114416. /**
  114417. * Set the value of an uniform to an array of number (stored as vec4)
  114418. * @param uniform defines the webGL uniform location where to store the value
  114419. * @param array defines the array of number to store
  114420. */
  114421. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114422. /**
  114423. * Set the value of an uniform to an array of float32 (stored as matrices)
  114424. * @param uniform defines the webGL uniform location where to store the value
  114425. * @param matrices defines the array of float32 to store
  114426. */
  114427. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  114428. /**
  114429. * Set the value of an uniform to a matrix (3x3)
  114430. * @param uniform defines the webGL uniform location where to store the value
  114431. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  114432. */
  114433. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  114434. /**
  114435. * Set the value of an uniform to a matrix (2x2)
  114436. * @param uniform defines the webGL uniform location where to store the value
  114437. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  114438. */
  114439. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  114440. /**
  114441. * Set the value of an uniform to a number (float)
  114442. * @param uniform defines the webGL uniform location where to store the value
  114443. * @param value defines the float number to store
  114444. */
  114445. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  114446. /**
  114447. * Set the value of an uniform to a vec2
  114448. * @param uniform defines the webGL uniform location where to store the value
  114449. * @param x defines the 1st component of the value
  114450. * @param y defines the 2nd component of the value
  114451. */
  114452. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  114453. /**
  114454. * Set the value of an uniform to a vec3
  114455. * @param uniform defines the webGL uniform location where to store the value
  114456. * @param x defines the 1st component of the value
  114457. * @param y defines the 2nd component of the value
  114458. * @param z defines the 3rd component of the value
  114459. */
  114460. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  114461. /**
  114462. * Set the value of an uniform to a vec4
  114463. * @param uniform defines the webGL uniform location where to store the value
  114464. * @param x defines the 1st component of the value
  114465. * @param y defines the 2nd component of the value
  114466. * @param z defines the 3rd component of the value
  114467. * @param w defines the 4th component of the value
  114468. */
  114469. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  114470. /**
  114471. * Apply all cached states (depth, culling, stencil and alpha)
  114472. */
  114473. applyStates(): void;
  114474. /**
  114475. * Enable or disable color writing
  114476. * @param enable defines the state to set
  114477. */
  114478. setColorWrite(enable: boolean): void;
  114479. /**
  114480. * Gets a boolean indicating if color writing is enabled
  114481. * @returns the current color writing state
  114482. */
  114483. getColorWrite(): boolean;
  114484. /**
  114485. * Gets the depth culling state manager
  114486. */
  114487. get depthCullingState(): DepthCullingState;
  114488. /**
  114489. * Gets the alpha state manager
  114490. */
  114491. get alphaState(): AlphaState;
  114492. /**
  114493. * Gets the stencil state manager
  114494. */
  114495. get stencilState(): StencilState;
  114496. /**
  114497. * Clears the list of texture accessible through engine.
  114498. * This can help preventing texture load conflict due to name collision.
  114499. */
  114500. clearInternalTexturesCache(): void;
  114501. /**
  114502. * Force the entire cache to be cleared
  114503. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  114504. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  114505. */
  114506. wipeCaches(bruteForce?: boolean): void;
  114507. /** @hidden */
  114508. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  114509. min: number;
  114510. mag: number;
  114511. };
  114512. /** @hidden */
  114513. _createTexture(): WebGLTexture;
  114514. /**
  114515. * Usually called from Texture.ts.
  114516. * Passed information to create a WebGLTexture
  114517. * @param url defines a value which contains one of the following:
  114518. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  114519. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  114520. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  114521. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  114522. * @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)
  114523. * @param scene needed for loading to the correct scene
  114524. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  114525. * @param onLoad optional callback to be called upon successful completion
  114526. * @param onError optional callback to be called upon failure
  114527. * @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
  114528. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  114529. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  114530. * @param forcedExtension defines the extension to use to pick the right loader
  114531. * @param mimeType defines an optional mime type
  114532. * @returns a InternalTexture for assignment back into BABYLON.Texture
  114533. */
  114534. 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;
  114535. /**
  114536. * Loads an image as an HTMLImageElement.
  114537. * @param input url string, ArrayBuffer, or Blob to load
  114538. * @param onLoad callback called when the image successfully loads
  114539. * @param onError callback called when the image fails to load
  114540. * @param offlineProvider offline provider for caching
  114541. * @param mimeType optional mime type
  114542. * @returns the HTMLImageElement of the loaded image
  114543. * @hidden
  114544. */
  114545. 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>;
  114546. /**
  114547. * @hidden
  114548. */
  114549. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  114550. private _unpackFlipYCached;
  114551. /**
  114552. * In case you are sharing the context with other applications, it might
  114553. * be interested to not cache the unpack flip y state to ensure a consistent
  114554. * value would be set.
  114555. */
  114556. enableUnpackFlipYCached: boolean;
  114557. /** @hidden */
  114558. _unpackFlipY(value: boolean): void;
  114559. /** @hidden */
  114560. _getUnpackAlignement(): number;
  114561. private _getTextureTarget;
  114562. /**
  114563. * Update the sampling mode of a given texture
  114564. * @param samplingMode defines the required sampling mode
  114565. * @param texture defines the texture to update
  114566. * @param generateMipMaps defines whether to generate mipmaps for the texture
  114567. */
  114568. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  114569. /**
  114570. * Update the sampling mode of a given texture
  114571. * @param texture defines the texture to update
  114572. * @param wrapU defines the texture wrap mode of the u coordinates
  114573. * @param wrapV defines the texture wrap mode of the v coordinates
  114574. * @param wrapR defines the texture wrap mode of the r coordinates
  114575. */
  114576. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  114577. /** @hidden */
  114578. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  114579. width: number;
  114580. height: number;
  114581. layers?: number;
  114582. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  114583. /** @hidden */
  114584. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  114585. /** @hidden */
  114586. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  114587. /**
  114588. * Update a portion of an internal texture
  114589. * @param texture defines the texture to update
  114590. * @param imageData defines the data to store into the texture
  114591. * @param xOffset defines the x coordinates of the update rectangle
  114592. * @param yOffset defines the y coordinates of the update rectangle
  114593. * @param width defines the width of the update rectangle
  114594. * @param height defines the height of the update rectangle
  114595. * @param faceIndex defines the face index if texture is a cube (0 by default)
  114596. * @param lod defines the lod level to update (0 by default)
  114597. */
  114598. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  114599. /** @hidden */
  114600. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  114601. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  114602. private _prepareWebGLTexture;
  114603. /** @hidden */
  114604. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  114605. private _getDepthStencilBuffer;
  114606. /** @hidden */
  114607. _releaseFramebufferObjects(texture: InternalTexture): void;
  114608. /** @hidden */
  114609. _releaseTexture(texture: InternalTexture): void;
  114610. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  114611. protected _setProgram(program: WebGLProgram): void;
  114612. protected _boundUniforms: {
  114613. [key: number]: WebGLUniformLocation;
  114614. };
  114615. /**
  114616. * Binds an effect to the webGL context
  114617. * @param effect defines the effect to bind
  114618. */
  114619. bindSamplers(effect: Effect): void;
  114620. private _activateCurrentTexture;
  114621. /** @hidden */
  114622. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  114623. /** @hidden */
  114624. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  114625. /**
  114626. * Unbind all textures from the webGL context
  114627. */
  114628. unbindAllTextures(): void;
  114629. /**
  114630. * Sets a texture to the according uniform.
  114631. * @param channel The texture channel
  114632. * @param uniform The uniform to set
  114633. * @param texture The texture to apply
  114634. */
  114635. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  114636. private _bindSamplerUniformToChannel;
  114637. private _getTextureWrapMode;
  114638. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  114639. /**
  114640. * Sets an array of texture to the webGL context
  114641. * @param channel defines the channel where the texture array must be set
  114642. * @param uniform defines the associated uniform location
  114643. * @param textures defines the array of textures to bind
  114644. */
  114645. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  114646. /** @hidden */
  114647. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  114648. private _setTextureParameterFloat;
  114649. private _setTextureParameterInteger;
  114650. /**
  114651. * Unbind all vertex attributes from the webGL context
  114652. */
  114653. unbindAllAttributes(): void;
  114654. /**
  114655. * 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
  114656. */
  114657. releaseEffects(): void;
  114658. /**
  114659. * Dispose and release all associated resources
  114660. */
  114661. dispose(): void;
  114662. /**
  114663. * Attach a new callback raised when context lost event is fired
  114664. * @param callback defines the callback to call
  114665. */
  114666. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  114667. /**
  114668. * Attach a new callback raised when context restored event is fired
  114669. * @param callback defines the callback to call
  114670. */
  114671. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  114672. /**
  114673. * Get the current error code of the webGL context
  114674. * @returns the error code
  114675. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  114676. */
  114677. getError(): number;
  114678. private _canRenderToFloatFramebuffer;
  114679. private _canRenderToHalfFloatFramebuffer;
  114680. private _canRenderToFramebuffer;
  114681. /** @hidden */
  114682. _getWebGLTextureType(type: number): number;
  114683. /** @hidden */
  114684. _getInternalFormat(format: number): number;
  114685. /** @hidden */
  114686. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  114687. /** @hidden */
  114688. _getRGBAMultiSampleBufferFormat(type: number): number;
  114689. /** @hidden */
  114690. _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;
  114691. /**
  114692. * Loads a file from a url
  114693. * @param url url to load
  114694. * @param onSuccess callback called when the file successfully loads
  114695. * @param onProgress callback called while file is loading (if the server supports this mode)
  114696. * @param offlineProvider defines the offline provider for caching
  114697. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  114698. * @param onError callback called when the file fails to load
  114699. * @returns a file request object
  114700. * @hidden
  114701. */
  114702. 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;
  114703. /**
  114704. * Reads pixels from the current frame buffer. Please note that this function can be slow
  114705. * @param x defines the x coordinate of the rectangle where pixels must be read
  114706. * @param y defines the y coordinate of the rectangle where pixels must be read
  114707. * @param width defines the width of the rectangle where pixels must be read
  114708. * @param height defines the height of the rectangle where pixels must be read
  114709. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  114710. * @returns a Uint8Array containing RGBA colors
  114711. */
  114712. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  114713. private static _isSupported;
  114714. /**
  114715. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  114716. * @returns true if the engine can be created
  114717. * @ignorenaming
  114718. */
  114719. static isSupported(): boolean;
  114720. /**
  114721. * Find the next highest power of two.
  114722. * @param x Number to start search from.
  114723. * @return Next highest power of two.
  114724. */
  114725. static CeilingPOT(x: number): number;
  114726. /**
  114727. * Find the next lowest power of two.
  114728. * @param x Number to start search from.
  114729. * @return Next lowest power of two.
  114730. */
  114731. static FloorPOT(x: number): number;
  114732. /**
  114733. * Find the nearest power of two.
  114734. * @param x Number to start search from.
  114735. * @return Next nearest power of two.
  114736. */
  114737. static NearestPOT(x: number): number;
  114738. /**
  114739. * Get the closest exponent of two
  114740. * @param value defines the value to approximate
  114741. * @param max defines the maximum value to return
  114742. * @param mode defines how to define the closest value
  114743. * @returns closest exponent of two of the given value
  114744. */
  114745. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  114746. /**
  114747. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  114748. * @param func - the function to be called
  114749. * @param requester - the object that will request the next frame. Falls back to window.
  114750. * @returns frame number
  114751. */
  114752. static QueueNewFrame(func: () => void, requester?: any): number;
  114753. /**
  114754. * Gets host document
  114755. * @returns the host document object
  114756. */
  114757. getHostDocument(): Nullable<Document>;
  114758. }
  114759. }
  114760. declare module BABYLON {
  114761. /**
  114762. * Class representing spherical harmonics coefficients to the 3rd degree
  114763. */
  114764. export class SphericalHarmonics {
  114765. /**
  114766. * Defines whether or not the harmonics have been prescaled for rendering.
  114767. */
  114768. preScaled: boolean;
  114769. /**
  114770. * The l0,0 coefficients of the spherical harmonics
  114771. */
  114772. l00: Vector3;
  114773. /**
  114774. * The l1,-1 coefficients of the spherical harmonics
  114775. */
  114776. l1_1: Vector3;
  114777. /**
  114778. * The l1,0 coefficients of the spherical harmonics
  114779. */
  114780. l10: Vector3;
  114781. /**
  114782. * The l1,1 coefficients of the spherical harmonics
  114783. */
  114784. l11: Vector3;
  114785. /**
  114786. * The l2,-2 coefficients of the spherical harmonics
  114787. */
  114788. l2_2: Vector3;
  114789. /**
  114790. * The l2,-1 coefficients of the spherical harmonics
  114791. */
  114792. l2_1: Vector3;
  114793. /**
  114794. * The l2,0 coefficients of the spherical harmonics
  114795. */
  114796. l20: Vector3;
  114797. /**
  114798. * The l2,1 coefficients of the spherical harmonics
  114799. */
  114800. l21: Vector3;
  114801. /**
  114802. * The l2,2 coefficients of the spherical harmonics
  114803. */
  114804. l22: Vector3;
  114805. /**
  114806. * Adds a light to the spherical harmonics
  114807. * @param direction the direction of the light
  114808. * @param color the color of the light
  114809. * @param deltaSolidAngle the delta solid angle of the light
  114810. */
  114811. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  114812. /**
  114813. * Scales the spherical harmonics by the given amount
  114814. * @param scale the amount to scale
  114815. */
  114816. scaleInPlace(scale: number): void;
  114817. /**
  114818. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  114819. *
  114820. * ```
  114821. * E_lm = A_l * L_lm
  114822. * ```
  114823. *
  114824. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  114825. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  114826. * the scaling factors are given in equation 9.
  114827. */
  114828. convertIncidentRadianceToIrradiance(): void;
  114829. /**
  114830. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  114831. *
  114832. * ```
  114833. * L = (1/pi) * E * rho
  114834. * ```
  114835. *
  114836. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  114837. */
  114838. convertIrradianceToLambertianRadiance(): void;
  114839. /**
  114840. * Integrates the reconstruction coefficients directly in to the SH preventing further
  114841. * required operations at run time.
  114842. *
  114843. * This is simply done by scaling back the SH with Ylm constants parameter.
  114844. * The trigonometric part being applied by the shader at run time.
  114845. */
  114846. preScaleForRendering(): void;
  114847. /**
  114848. * Constructs a spherical harmonics from an array.
  114849. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  114850. * @returns the spherical harmonics
  114851. */
  114852. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  114853. /**
  114854. * Gets the spherical harmonics from polynomial
  114855. * @param polynomial the spherical polynomial
  114856. * @returns the spherical harmonics
  114857. */
  114858. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  114859. }
  114860. /**
  114861. * Class representing spherical polynomial coefficients to the 3rd degree
  114862. */
  114863. export class SphericalPolynomial {
  114864. private _harmonics;
  114865. /**
  114866. * The spherical harmonics used to create the polynomials.
  114867. */
  114868. get preScaledHarmonics(): SphericalHarmonics;
  114869. /**
  114870. * The x coefficients of the spherical polynomial
  114871. */
  114872. x: Vector3;
  114873. /**
  114874. * The y coefficients of the spherical polynomial
  114875. */
  114876. y: Vector3;
  114877. /**
  114878. * The z coefficients of the spherical polynomial
  114879. */
  114880. z: Vector3;
  114881. /**
  114882. * The xx coefficients of the spherical polynomial
  114883. */
  114884. xx: Vector3;
  114885. /**
  114886. * The yy coefficients of the spherical polynomial
  114887. */
  114888. yy: Vector3;
  114889. /**
  114890. * The zz coefficients of the spherical polynomial
  114891. */
  114892. zz: Vector3;
  114893. /**
  114894. * The xy coefficients of the spherical polynomial
  114895. */
  114896. xy: Vector3;
  114897. /**
  114898. * The yz coefficients of the spherical polynomial
  114899. */
  114900. yz: Vector3;
  114901. /**
  114902. * The zx coefficients of the spherical polynomial
  114903. */
  114904. zx: Vector3;
  114905. /**
  114906. * Adds an ambient color to the spherical polynomial
  114907. * @param color the color to add
  114908. */
  114909. addAmbient(color: Color3): void;
  114910. /**
  114911. * Scales the spherical polynomial by the given amount
  114912. * @param scale the amount to scale
  114913. */
  114914. scaleInPlace(scale: number): void;
  114915. /**
  114916. * Gets the spherical polynomial from harmonics
  114917. * @param harmonics the spherical harmonics
  114918. * @returns the spherical polynomial
  114919. */
  114920. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  114921. /**
  114922. * Constructs a spherical polynomial from an array.
  114923. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  114924. * @returns the spherical polynomial
  114925. */
  114926. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  114927. }
  114928. }
  114929. declare module BABYLON {
  114930. /**
  114931. * Defines the source of the internal texture
  114932. */
  114933. export enum InternalTextureSource {
  114934. /**
  114935. * The source of the texture data is unknown
  114936. */
  114937. Unknown = 0,
  114938. /**
  114939. * Texture data comes from an URL
  114940. */
  114941. Url = 1,
  114942. /**
  114943. * Texture data is only used for temporary storage
  114944. */
  114945. Temp = 2,
  114946. /**
  114947. * Texture data comes from raw data (ArrayBuffer)
  114948. */
  114949. Raw = 3,
  114950. /**
  114951. * Texture content is dynamic (video or dynamic texture)
  114952. */
  114953. Dynamic = 4,
  114954. /**
  114955. * Texture content is generated by rendering to it
  114956. */
  114957. RenderTarget = 5,
  114958. /**
  114959. * Texture content is part of a multi render target process
  114960. */
  114961. MultiRenderTarget = 6,
  114962. /**
  114963. * Texture data comes from a cube data file
  114964. */
  114965. Cube = 7,
  114966. /**
  114967. * Texture data comes from a raw cube data
  114968. */
  114969. CubeRaw = 8,
  114970. /**
  114971. * Texture data come from a prefiltered cube data file
  114972. */
  114973. CubePrefiltered = 9,
  114974. /**
  114975. * Texture content is raw 3D data
  114976. */
  114977. Raw3D = 10,
  114978. /**
  114979. * Texture content is raw 2D array data
  114980. */
  114981. Raw2DArray = 11,
  114982. /**
  114983. * Texture content is a depth texture
  114984. */
  114985. Depth = 12,
  114986. /**
  114987. * Texture data comes from a raw cube data encoded with RGBD
  114988. */
  114989. CubeRawRGBD = 13
  114990. }
  114991. /**
  114992. * Class used to store data associated with WebGL texture data for the engine
  114993. * This class should not be used directly
  114994. */
  114995. export class InternalTexture {
  114996. /** @hidden */
  114997. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  114998. /**
  114999. * Defines if the texture is ready
  115000. */
  115001. isReady: boolean;
  115002. /**
  115003. * Defines if the texture is a cube texture
  115004. */
  115005. isCube: boolean;
  115006. /**
  115007. * Defines if the texture contains 3D data
  115008. */
  115009. is3D: boolean;
  115010. /**
  115011. * Defines if the texture contains 2D array data
  115012. */
  115013. is2DArray: boolean;
  115014. /**
  115015. * Defines if the texture contains multiview data
  115016. */
  115017. isMultiview: boolean;
  115018. /**
  115019. * Gets the URL used to load this texture
  115020. */
  115021. url: string;
  115022. /**
  115023. * Gets the sampling mode of the texture
  115024. */
  115025. samplingMode: number;
  115026. /**
  115027. * Gets a boolean indicating if the texture needs mipmaps generation
  115028. */
  115029. generateMipMaps: boolean;
  115030. /**
  115031. * Gets the number of samples used by the texture (WebGL2+ only)
  115032. */
  115033. samples: number;
  115034. /**
  115035. * Gets the type of the texture (int, float...)
  115036. */
  115037. type: number;
  115038. /**
  115039. * Gets the format of the texture (RGB, RGBA...)
  115040. */
  115041. format: number;
  115042. /**
  115043. * Observable called when the texture is loaded
  115044. */
  115045. onLoadedObservable: Observable<InternalTexture>;
  115046. /**
  115047. * Gets the width of the texture
  115048. */
  115049. width: number;
  115050. /**
  115051. * Gets the height of the texture
  115052. */
  115053. height: number;
  115054. /**
  115055. * Gets the depth of the texture
  115056. */
  115057. depth: number;
  115058. /**
  115059. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  115060. */
  115061. baseWidth: number;
  115062. /**
  115063. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  115064. */
  115065. baseHeight: number;
  115066. /**
  115067. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  115068. */
  115069. baseDepth: number;
  115070. /**
  115071. * Gets a boolean indicating if the texture is inverted on Y axis
  115072. */
  115073. invertY: boolean;
  115074. /** @hidden */
  115075. _invertVScale: boolean;
  115076. /** @hidden */
  115077. _associatedChannel: number;
  115078. /** @hidden */
  115079. _source: InternalTextureSource;
  115080. /** @hidden */
  115081. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  115082. /** @hidden */
  115083. _bufferView: Nullable<ArrayBufferView>;
  115084. /** @hidden */
  115085. _bufferViewArray: Nullable<ArrayBufferView[]>;
  115086. /** @hidden */
  115087. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  115088. /** @hidden */
  115089. _size: number;
  115090. /** @hidden */
  115091. _extension: string;
  115092. /** @hidden */
  115093. _files: Nullable<string[]>;
  115094. /** @hidden */
  115095. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115096. /** @hidden */
  115097. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115098. /** @hidden */
  115099. _framebuffer: Nullable<WebGLFramebuffer>;
  115100. /** @hidden */
  115101. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  115102. /** @hidden */
  115103. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  115104. /** @hidden */
  115105. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  115106. /** @hidden */
  115107. _attachments: Nullable<number[]>;
  115108. /** @hidden */
  115109. _textureArray: Nullable<InternalTexture[]>;
  115110. /** @hidden */
  115111. _cachedCoordinatesMode: Nullable<number>;
  115112. /** @hidden */
  115113. _cachedWrapU: Nullable<number>;
  115114. /** @hidden */
  115115. _cachedWrapV: Nullable<number>;
  115116. /** @hidden */
  115117. _cachedWrapR: Nullable<number>;
  115118. /** @hidden */
  115119. _cachedAnisotropicFilteringLevel: Nullable<number>;
  115120. /** @hidden */
  115121. _isDisabled: boolean;
  115122. /** @hidden */
  115123. _compression: Nullable<string>;
  115124. /** @hidden */
  115125. _generateStencilBuffer: boolean;
  115126. /** @hidden */
  115127. _generateDepthBuffer: boolean;
  115128. /** @hidden */
  115129. _comparisonFunction: number;
  115130. /** @hidden */
  115131. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  115132. /** @hidden */
  115133. _lodGenerationScale: number;
  115134. /** @hidden */
  115135. _lodGenerationOffset: number;
  115136. /** @hidden */
  115137. _depthStencilTexture: Nullable<InternalTexture>;
  115138. /** @hidden */
  115139. _colorTextureArray: Nullable<WebGLTexture>;
  115140. /** @hidden */
  115141. _depthStencilTextureArray: Nullable<WebGLTexture>;
  115142. /** @hidden */
  115143. _lodTextureHigh: Nullable<BaseTexture>;
  115144. /** @hidden */
  115145. _lodTextureMid: Nullable<BaseTexture>;
  115146. /** @hidden */
  115147. _lodTextureLow: Nullable<BaseTexture>;
  115148. /** @hidden */
  115149. _isRGBD: boolean;
  115150. /** @hidden */
  115151. _linearSpecularLOD: boolean;
  115152. /** @hidden */
  115153. _irradianceTexture: Nullable<BaseTexture>;
  115154. /** @hidden */
  115155. _webGLTexture: Nullable<WebGLTexture>;
  115156. /** @hidden */
  115157. _references: number;
  115158. private _engine;
  115159. /**
  115160. * Gets the Engine the texture belongs to.
  115161. * @returns The babylon engine
  115162. */
  115163. getEngine(): ThinEngine;
  115164. /**
  115165. * Gets the data source type of the texture
  115166. */
  115167. get source(): InternalTextureSource;
  115168. /**
  115169. * Creates a new InternalTexture
  115170. * @param engine defines the engine to use
  115171. * @param source defines the type of data that will be used
  115172. * @param delayAllocation if the texture allocation should be delayed (default: false)
  115173. */
  115174. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  115175. /**
  115176. * Increments the number of references (ie. the number of Texture that point to it)
  115177. */
  115178. incrementReferences(): void;
  115179. /**
  115180. * Change the size of the texture (not the size of the content)
  115181. * @param width defines the new width
  115182. * @param height defines the new height
  115183. * @param depth defines the new depth (1 by default)
  115184. */
  115185. updateSize(width: int, height: int, depth?: int): void;
  115186. /** @hidden */
  115187. _rebuild(): void;
  115188. /** @hidden */
  115189. _swapAndDie(target: InternalTexture): void;
  115190. /**
  115191. * Dispose the current allocated resources
  115192. */
  115193. dispose(): void;
  115194. }
  115195. }
  115196. declare module BABYLON {
  115197. /**
  115198. * Class used to work with sound analyzer using fast fourier transform (FFT)
  115199. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115200. */
  115201. export class Analyser {
  115202. /**
  115203. * Gets or sets the smoothing
  115204. * @ignorenaming
  115205. */
  115206. SMOOTHING: number;
  115207. /**
  115208. * Gets or sets the FFT table size
  115209. * @ignorenaming
  115210. */
  115211. FFT_SIZE: number;
  115212. /**
  115213. * Gets or sets the bar graph amplitude
  115214. * @ignorenaming
  115215. */
  115216. BARGRAPHAMPLITUDE: number;
  115217. /**
  115218. * Gets or sets the position of the debug canvas
  115219. * @ignorenaming
  115220. */
  115221. DEBUGCANVASPOS: {
  115222. x: number;
  115223. y: number;
  115224. };
  115225. /**
  115226. * Gets or sets the debug canvas size
  115227. * @ignorenaming
  115228. */
  115229. DEBUGCANVASSIZE: {
  115230. width: number;
  115231. height: number;
  115232. };
  115233. private _byteFreqs;
  115234. private _byteTime;
  115235. private _floatFreqs;
  115236. private _webAudioAnalyser;
  115237. private _debugCanvas;
  115238. private _debugCanvasContext;
  115239. private _scene;
  115240. private _registerFunc;
  115241. private _audioEngine;
  115242. /**
  115243. * Creates a new analyser
  115244. * @param scene defines hosting scene
  115245. */
  115246. constructor(scene: Scene);
  115247. /**
  115248. * Get the number of data values you will have to play with for the visualization
  115249. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  115250. * @returns a number
  115251. */
  115252. getFrequencyBinCount(): number;
  115253. /**
  115254. * Gets the current frequency data as a byte array
  115255. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  115256. * @returns a Uint8Array
  115257. */
  115258. getByteFrequencyData(): Uint8Array;
  115259. /**
  115260. * Gets the current waveform as a byte array
  115261. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  115262. * @returns a Uint8Array
  115263. */
  115264. getByteTimeDomainData(): Uint8Array;
  115265. /**
  115266. * Gets the current frequency data as a float array
  115267. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  115268. * @returns a Float32Array
  115269. */
  115270. getFloatFrequencyData(): Float32Array;
  115271. /**
  115272. * Renders the debug canvas
  115273. */
  115274. drawDebugCanvas(): void;
  115275. /**
  115276. * Stops rendering the debug canvas and removes it
  115277. */
  115278. stopDebugCanvas(): void;
  115279. /**
  115280. * Connects two audio nodes
  115281. * @param inputAudioNode defines first node to connect
  115282. * @param outputAudioNode defines second node to connect
  115283. */
  115284. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  115285. /**
  115286. * Releases all associated resources
  115287. */
  115288. dispose(): void;
  115289. }
  115290. }
  115291. declare module BABYLON {
  115292. /**
  115293. * This represents an audio engine and it is responsible
  115294. * to play, synchronize and analyse sounds throughout the application.
  115295. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115296. */
  115297. export interface IAudioEngine extends IDisposable {
  115298. /**
  115299. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  115300. */
  115301. readonly canUseWebAudio: boolean;
  115302. /**
  115303. * Gets the current AudioContext if available.
  115304. */
  115305. readonly audioContext: Nullable<AudioContext>;
  115306. /**
  115307. * The master gain node defines the global audio volume of your audio engine.
  115308. */
  115309. readonly masterGain: GainNode;
  115310. /**
  115311. * Gets whether or not mp3 are supported by your browser.
  115312. */
  115313. readonly isMP3supported: boolean;
  115314. /**
  115315. * Gets whether or not ogg are supported by your browser.
  115316. */
  115317. readonly isOGGsupported: boolean;
  115318. /**
  115319. * Defines if Babylon should emit a warning if WebAudio is not supported.
  115320. * @ignoreNaming
  115321. */
  115322. WarnedWebAudioUnsupported: boolean;
  115323. /**
  115324. * Defines if the audio engine relies on a custom unlocked button.
  115325. * In this case, the embedded button will not be displayed.
  115326. */
  115327. useCustomUnlockedButton: boolean;
  115328. /**
  115329. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  115330. */
  115331. readonly unlocked: boolean;
  115332. /**
  115333. * Event raised when audio has been unlocked on the browser.
  115334. */
  115335. onAudioUnlockedObservable: Observable<AudioEngine>;
  115336. /**
  115337. * Event raised when audio has been locked on the browser.
  115338. */
  115339. onAudioLockedObservable: Observable<AudioEngine>;
  115340. /**
  115341. * Flags the audio engine in Locked state.
  115342. * This happens due to new browser policies preventing audio to autoplay.
  115343. */
  115344. lock(): void;
  115345. /**
  115346. * Unlocks the audio engine once a user action has been done on the dom.
  115347. * This is helpful to resume play once browser policies have been satisfied.
  115348. */
  115349. unlock(): void;
  115350. /**
  115351. * Gets the global volume sets on the master gain.
  115352. * @returns the global volume if set or -1 otherwise
  115353. */
  115354. getGlobalVolume(): number;
  115355. /**
  115356. * Sets the global volume of your experience (sets on the master gain).
  115357. * @param newVolume Defines the new global volume of the application
  115358. */
  115359. setGlobalVolume(newVolume: number): void;
  115360. /**
  115361. * Connect the audio engine to an audio analyser allowing some amazing
  115362. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  115363. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  115364. * @param analyser The analyser to connect to the engine
  115365. */
  115366. connectToAnalyser(analyser: Analyser): void;
  115367. }
  115368. /**
  115369. * This represents the default audio engine used in babylon.
  115370. * It is responsible to play, synchronize and analyse sounds throughout the application.
  115371. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115372. */
  115373. export class AudioEngine implements IAudioEngine {
  115374. private _audioContext;
  115375. private _audioContextInitialized;
  115376. private _muteButton;
  115377. private _hostElement;
  115378. /**
  115379. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  115380. */
  115381. canUseWebAudio: boolean;
  115382. /**
  115383. * The master gain node defines the global audio volume of your audio engine.
  115384. */
  115385. masterGain: GainNode;
  115386. /**
  115387. * Defines if Babylon should emit a warning if WebAudio is not supported.
  115388. * @ignoreNaming
  115389. */
  115390. WarnedWebAudioUnsupported: boolean;
  115391. /**
  115392. * Gets whether or not mp3 are supported by your browser.
  115393. */
  115394. isMP3supported: boolean;
  115395. /**
  115396. * Gets whether or not ogg are supported by your browser.
  115397. */
  115398. isOGGsupported: boolean;
  115399. /**
  115400. * Gets whether audio has been unlocked on the device.
  115401. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  115402. * a user interaction has happened.
  115403. */
  115404. unlocked: boolean;
  115405. /**
  115406. * Defines if the audio engine relies on a custom unlocked button.
  115407. * In this case, the embedded button will not be displayed.
  115408. */
  115409. useCustomUnlockedButton: boolean;
  115410. /**
  115411. * Event raised when audio has been unlocked on the browser.
  115412. */
  115413. onAudioUnlockedObservable: Observable<AudioEngine>;
  115414. /**
  115415. * Event raised when audio has been locked on the browser.
  115416. */
  115417. onAudioLockedObservable: Observable<AudioEngine>;
  115418. /**
  115419. * Gets the current AudioContext if available.
  115420. */
  115421. get audioContext(): Nullable<AudioContext>;
  115422. private _connectedAnalyser;
  115423. /**
  115424. * Instantiates a new audio engine.
  115425. *
  115426. * There should be only one per page as some browsers restrict the number
  115427. * of audio contexts you can create.
  115428. * @param hostElement defines the host element where to display the mute icon if necessary
  115429. */
  115430. constructor(hostElement?: Nullable<HTMLElement>);
  115431. /**
  115432. * Flags the audio engine in Locked state.
  115433. * This happens due to new browser policies preventing audio to autoplay.
  115434. */
  115435. lock(): void;
  115436. /**
  115437. * Unlocks the audio engine once a user action has been done on the dom.
  115438. * This is helpful to resume play once browser policies have been satisfied.
  115439. */
  115440. unlock(): void;
  115441. private _resumeAudioContext;
  115442. private _initializeAudioContext;
  115443. private _tryToRun;
  115444. private _triggerRunningState;
  115445. private _triggerSuspendedState;
  115446. private _displayMuteButton;
  115447. private _moveButtonToTopLeft;
  115448. private _onResize;
  115449. private _hideMuteButton;
  115450. /**
  115451. * Destroy and release the resources associated with the audio ccontext.
  115452. */
  115453. dispose(): void;
  115454. /**
  115455. * Gets the global volume sets on the master gain.
  115456. * @returns the global volume if set or -1 otherwise
  115457. */
  115458. getGlobalVolume(): number;
  115459. /**
  115460. * Sets the global volume of your experience (sets on the master gain).
  115461. * @param newVolume Defines the new global volume of the application
  115462. */
  115463. setGlobalVolume(newVolume: number): void;
  115464. /**
  115465. * Connect the audio engine to an audio analyser allowing some amazing
  115466. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  115467. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  115468. * @param analyser The analyser to connect to the engine
  115469. */
  115470. connectToAnalyser(analyser: Analyser): void;
  115471. }
  115472. }
  115473. declare module BABYLON {
  115474. /**
  115475. * Interface used to present a loading screen while loading a scene
  115476. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  115477. */
  115478. export interface ILoadingScreen {
  115479. /**
  115480. * Function called to display the loading screen
  115481. */
  115482. displayLoadingUI: () => void;
  115483. /**
  115484. * Function called to hide the loading screen
  115485. */
  115486. hideLoadingUI: () => void;
  115487. /**
  115488. * Gets or sets the color to use for the background
  115489. */
  115490. loadingUIBackgroundColor: string;
  115491. /**
  115492. * Gets or sets the text to display while loading
  115493. */
  115494. loadingUIText: string;
  115495. }
  115496. /**
  115497. * Class used for the default loading screen
  115498. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  115499. */
  115500. export class DefaultLoadingScreen implements ILoadingScreen {
  115501. private _renderingCanvas;
  115502. private _loadingText;
  115503. private _loadingDivBackgroundColor;
  115504. private _loadingDiv;
  115505. private _loadingTextDiv;
  115506. /** Gets or sets the logo url to use for the default loading screen */
  115507. static DefaultLogoUrl: string;
  115508. /** Gets or sets the spinner url to use for the default loading screen */
  115509. static DefaultSpinnerUrl: string;
  115510. /**
  115511. * Creates a new default loading screen
  115512. * @param _renderingCanvas defines the canvas used to render the scene
  115513. * @param _loadingText defines the default text to display
  115514. * @param _loadingDivBackgroundColor defines the default background color
  115515. */
  115516. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  115517. /**
  115518. * Function called to display the loading screen
  115519. */
  115520. displayLoadingUI(): void;
  115521. /**
  115522. * Function called to hide the loading screen
  115523. */
  115524. hideLoadingUI(): void;
  115525. /**
  115526. * Gets or sets the text to display while loading
  115527. */
  115528. set loadingUIText(text: string);
  115529. get loadingUIText(): string;
  115530. /**
  115531. * Gets or sets the color to use for the background
  115532. */
  115533. get loadingUIBackgroundColor(): string;
  115534. set loadingUIBackgroundColor(color: string);
  115535. private _resizeLoadingUI;
  115536. }
  115537. }
  115538. declare module BABYLON {
  115539. /**
  115540. * Interface for any object that can request an animation frame
  115541. */
  115542. export interface ICustomAnimationFrameRequester {
  115543. /**
  115544. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  115545. */
  115546. renderFunction?: Function;
  115547. /**
  115548. * Called to request the next frame to render to
  115549. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  115550. */
  115551. requestAnimationFrame: Function;
  115552. /**
  115553. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  115554. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  115555. */
  115556. requestID?: number;
  115557. }
  115558. }
  115559. declare module BABYLON {
  115560. /**
  115561. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  115562. */
  115563. export class PerformanceMonitor {
  115564. private _enabled;
  115565. private _rollingFrameTime;
  115566. private _lastFrameTimeMs;
  115567. /**
  115568. * constructor
  115569. * @param frameSampleSize The number of samples required to saturate the sliding window
  115570. */
  115571. constructor(frameSampleSize?: number);
  115572. /**
  115573. * Samples current frame
  115574. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  115575. */
  115576. sampleFrame(timeMs?: number): void;
  115577. /**
  115578. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  115579. */
  115580. get averageFrameTime(): number;
  115581. /**
  115582. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  115583. */
  115584. get averageFrameTimeVariance(): number;
  115585. /**
  115586. * Returns the frame time of the most recent frame
  115587. */
  115588. get instantaneousFrameTime(): number;
  115589. /**
  115590. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  115591. */
  115592. get averageFPS(): number;
  115593. /**
  115594. * Returns the average framerate in frames per second using the most recent frame time
  115595. */
  115596. get instantaneousFPS(): number;
  115597. /**
  115598. * Returns true if enough samples have been taken to completely fill the sliding window
  115599. */
  115600. get isSaturated(): boolean;
  115601. /**
  115602. * Enables contributions to the sliding window sample set
  115603. */
  115604. enable(): void;
  115605. /**
  115606. * Disables contributions to the sliding window sample set
  115607. * Samples will not be interpolated over the disabled period
  115608. */
  115609. disable(): void;
  115610. /**
  115611. * Returns true if sampling is enabled
  115612. */
  115613. get isEnabled(): boolean;
  115614. /**
  115615. * Resets performance monitor
  115616. */
  115617. reset(): void;
  115618. }
  115619. /**
  115620. * RollingAverage
  115621. *
  115622. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  115623. */
  115624. export class RollingAverage {
  115625. /**
  115626. * Current average
  115627. */
  115628. average: number;
  115629. /**
  115630. * Current variance
  115631. */
  115632. variance: number;
  115633. protected _samples: Array<number>;
  115634. protected _sampleCount: number;
  115635. protected _pos: number;
  115636. protected _m2: number;
  115637. /**
  115638. * constructor
  115639. * @param length The number of samples required to saturate the sliding window
  115640. */
  115641. constructor(length: number);
  115642. /**
  115643. * Adds a sample to the sample set
  115644. * @param v The sample value
  115645. */
  115646. add(v: number): void;
  115647. /**
  115648. * Returns previously added values or null if outside of history or outside the sliding window domain
  115649. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  115650. * @return Value previously recorded with add() or null if outside of range
  115651. */
  115652. history(i: number): number;
  115653. /**
  115654. * Returns true if enough samples have been taken to completely fill the sliding window
  115655. * @return true if sample-set saturated
  115656. */
  115657. isSaturated(): boolean;
  115658. /**
  115659. * Resets the rolling average (equivalent to 0 samples taken so far)
  115660. */
  115661. reset(): void;
  115662. /**
  115663. * Wraps a value around the sample range boundaries
  115664. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  115665. * @return Wrapped position in sample range
  115666. */
  115667. protected _wrapPosition(i: number): number;
  115668. }
  115669. }
  115670. declare module BABYLON {
  115671. /**
  115672. * This class is used to track a performance counter which is number based.
  115673. * The user has access to many properties which give statistics of different nature.
  115674. *
  115675. * The implementer can track two kinds of Performance Counter: time and count.
  115676. * 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.
  115677. * 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.
  115678. */
  115679. export class PerfCounter {
  115680. /**
  115681. * Gets or sets a global boolean to turn on and off all the counters
  115682. */
  115683. static Enabled: boolean;
  115684. /**
  115685. * Returns the smallest value ever
  115686. */
  115687. get min(): number;
  115688. /**
  115689. * Returns the biggest value ever
  115690. */
  115691. get max(): number;
  115692. /**
  115693. * Returns the average value since the performance counter is running
  115694. */
  115695. get average(): number;
  115696. /**
  115697. * Returns the average value of the last second the counter was monitored
  115698. */
  115699. get lastSecAverage(): number;
  115700. /**
  115701. * Returns the current value
  115702. */
  115703. get current(): number;
  115704. /**
  115705. * Gets the accumulated total
  115706. */
  115707. get total(): number;
  115708. /**
  115709. * Gets the total value count
  115710. */
  115711. get count(): number;
  115712. /**
  115713. * Creates a new counter
  115714. */
  115715. constructor();
  115716. /**
  115717. * Call this method to start monitoring a new frame.
  115718. * 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.
  115719. */
  115720. fetchNewFrame(): void;
  115721. /**
  115722. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  115723. * @param newCount the count value to add to the monitored count
  115724. * @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.
  115725. */
  115726. addCount(newCount: number, fetchResult: boolean): void;
  115727. /**
  115728. * Start monitoring this performance counter
  115729. */
  115730. beginMonitoring(): void;
  115731. /**
  115732. * Compute the time lapsed since the previous beginMonitoring() call.
  115733. * @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
  115734. */
  115735. endMonitoring(newFrame?: boolean): void;
  115736. private _fetchResult;
  115737. private _startMonitoringTime;
  115738. private _min;
  115739. private _max;
  115740. private _average;
  115741. private _current;
  115742. private _totalValueCount;
  115743. private _totalAccumulated;
  115744. private _lastSecAverage;
  115745. private _lastSecAccumulated;
  115746. private _lastSecTime;
  115747. private _lastSecValueCount;
  115748. }
  115749. }
  115750. declare module BABYLON {
  115751. interface ThinEngine {
  115752. /**
  115753. * Sets alpha constants used by some alpha blending modes
  115754. * @param r defines the red component
  115755. * @param g defines the green component
  115756. * @param b defines the blue component
  115757. * @param a defines the alpha component
  115758. */
  115759. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  115760. /**
  115761. * Sets the current alpha mode
  115762. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  115763. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  115764. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  115765. */
  115766. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  115767. /**
  115768. * Gets the current alpha mode
  115769. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  115770. * @returns the current alpha mode
  115771. */
  115772. getAlphaMode(): number;
  115773. /**
  115774. * Sets the current alpha equation
  115775. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  115776. */
  115777. setAlphaEquation(equation: number): void;
  115778. /**
  115779. * Gets the current alpha equation.
  115780. * @returns the current alpha equation
  115781. */
  115782. getAlphaEquation(): number;
  115783. }
  115784. }
  115785. declare module BABYLON {
  115786. interface ThinEngine {
  115787. /** @hidden */
  115788. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  115789. }
  115790. }
  115791. declare module BABYLON {
  115792. /**
  115793. * Defines the interface used by display changed events
  115794. */
  115795. export interface IDisplayChangedEventArgs {
  115796. /** Gets the vrDisplay object (if any) */
  115797. vrDisplay: Nullable<any>;
  115798. /** Gets a boolean indicating if webVR is supported */
  115799. vrSupported: boolean;
  115800. }
  115801. /**
  115802. * Defines the interface used by objects containing a viewport (like a camera)
  115803. */
  115804. interface IViewportOwnerLike {
  115805. /**
  115806. * Gets or sets the viewport
  115807. */
  115808. viewport: IViewportLike;
  115809. }
  115810. /**
  115811. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  115812. */
  115813. export class Engine extends ThinEngine {
  115814. /** Defines that alpha blending is disabled */
  115815. static readonly ALPHA_DISABLE: number;
  115816. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  115817. static readonly ALPHA_ADD: number;
  115818. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  115819. static readonly ALPHA_COMBINE: number;
  115820. /** Defines that alpha blending to DEST - SRC * DEST */
  115821. static readonly ALPHA_SUBTRACT: number;
  115822. /** Defines that alpha blending to SRC * DEST */
  115823. static readonly ALPHA_MULTIPLY: number;
  115824. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  115825. static readonly ALPHA_MAXIMIZED: number;
  115826. /** Defines that alpha blending to SRC + DEST */
  115827. static readonly ALPHA_ONEONE: number;
  115828. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  115829. static readonly ALPHA_PREMULTIPLIED: number;
  115830. /**
  115831. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  115832. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  115833. */
  115834. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  115835. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  115836. static readonly ALPHA_INTERPOLATE: number;
  115837. /**
  115838. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  115839. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  115840. */
  115841. static readonly ALPHA_SCREENMODE: number;
  115842. /** Defines that the ressource is not delayed*/
  115843. static readonly DELAYLOADSTATE_NONE: number;
  115844. /** Defines that the ressource was successfully delay loaded */
  115845. static readonly DELAYLOADSTATE_LOADED: number;
  115846. /** Defines that the ressource is currently delay loading */
  115847. static readonly DELAYLOADSTATE_LOADING: number;
  115848. /** Defines that the ressource is delayed and has not started loading */
  115849. static readonly DELAYLOADSTATE_NOTLOADED: number;
  115850. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  115851. static readonly NEVER: number;
  115852. /** 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 */
  115853. static readonly ALWAYS: number;
  115854. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  115855. static readonly LESS: number;
  115856. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  115857. static readonly EQUAL: number;
  115858. /** 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 */
  115859. static readonly LEQUAL: number;
  115860. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  115861. static readonly GREATER: number;
  115862. /** 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 */
  115863. static readonly GEQUAL: number;
  115864. /** 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 */
  115865. static readonly NOTEQUAL: number;
  115866. /** Passed to stencilOperation to specify that stencil value must be kept */
  115867. static readonly KEEP: number;
  115868. /** Passed to stencilOperation to specify that stencil value must be replaced */
  115869. static readonly REPLACE: number;
  115870. /** Passed to stencilOperation to specify that stencil value must be incremented */
  115871. static readonly INCR: number;
  115872. /** Passed to stencilOperation to specify that stencil value must be decremented */
  115873. static readonly DECR: number;
  115874. /** Passed to stencilOperation to specify that stencil value must be inverted */
  115875. static readonly INVERT: number;
  115876. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  115877. static readonly INCR_WRAP: number;
  115878. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  115879. static readonly DECR_WRAP: number;
  115880. /** Texture is not repeating outside of 0..1 UVs */
  115881. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  115882. /** Texture is repeating outside of 0..1 UVs */
  115883. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  115884. /** Texture is repeating and mirrored */
  115885. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  115886. /** ALPHA */
  115887. static readonly TEXTUREFORMAT_ALPHA: number;
  115888. /** LUMINANCE */
  115889. static readonly TEXTUREFORMAT_LUMINANCE: number;
  115890. /** LUMINANCE_ALPHA */
  115891. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  115892. /** RGB */
  115893. static readonly TEXTUREFORMAT_RGB: number;
  115894. /** RGBA */
  115895. static readonly TEXTUREFORMAT_RGBA: number;
  115896. /** RED */
  115897. static readonly TEXTUREFORMAT_RED: number;
  115898. /** RED (2nd reference) */
  115899. static readonly TEXTUREFORMAT_R: number;
  115900. /** RG */
  115901. static readonly TEXTUREFORMAT_RG: number;
  115902. /** RED_INTEGER */
  115903. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  115904. /** RED_INTEGER (2nd reference) */
  115905. static readonly TEXTUREFORMAT_R_INTEGER: number;
  115906. /** RG_INTEGER */
  115907. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  115908. /** RGB_INTEGER */
  115909. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  115910. /** RGBA_INTEGER */
  115911. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  115912. /** UNSIGNED_BYTE */
  115913. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  115914. /** UNSIGNED_BYTE (2nd reference) */
  115915. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  115916. /** FLOAT */
  115917. static readonly TEXTURETYPE_FLOAT: number;
  115918. /** HALF_FLOAT */
  115919. static readonly TEXTURETYPE_HALF_FLOAT: number;
  115920. /** BYTE */
  115921. static readonly TEXTURETYPE_BYTE: number;
  115922. /** SHORT */
  115923. static readonly TEXTURETYPE_SHORT: number;
  115924. /** UNSIGNED_SHORT */
  115925. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  115926. /** INT */
  115927. static readonly TEXTURETYPE_INT: number;
  115928. /** UNSIGNED_INT */
  115929. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  115930. /** UNSIGNED_SHORT_4_4_4_4 */
  115931. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  115932. /** UNSIGNED_SHORT_5_5_5_1 */
  115933. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  115934. /** UNSIGNED_SHORT_5_6_5 */
  115935. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  115936. /** UNSIGNED_INT_2_10_10_10_REV */
  115937. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  115938. /** UNSIGNED_INT_24_8 */
  115939. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  115940. /** UNSIGNED_INT_10F_11F_11F_REV */
  115941. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  115942. /** UNSIGNED_INT_5_9_9_9_REV */
  115943. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  115944. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  115945. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  115946. /** nearest is mag = nearest and min = nearest and mip = linear */
  115947. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  115948. /** Bilinear is mag = linear and min = linear and mip = nearest */
  115949. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  115950. /** Trilinear is mag = linear and min = linear and mip = linear */
  115951. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  115952. /** nearest is mag = nearest and min = nearest and mip = linear */
  115953. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  115954. /** Bilinear is mag = linear and min = linear and mip = nearest */
  115955. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  115956. /** Trilinear is mag = linear and min = linear and mip = linear */
  115957. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  115958. /** mag = nearest and min = nearest and mip = nearest */
  115959. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  115960. /** mag = nearest and min = linear and mip = nearest */
  115961. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  115962. /** mag = nearest and min = linear and mip = linear */
  115963. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  115964. /** mag = nearest and min = linear and mip = none */
  115965. static readonly TEXTURE_NEAREST_LINEAR: number;
  115966. /** mag = nearest and min = nearest and mip = none */
  115967. static readonly TEXTURE_NEAREST_NEAREST: number;
  115968. /** mag = linear and min = nearest and mip = nearest */
  115969. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  115970. /** mag = linear and min = nearest and mip = linear */
  115971. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  115972. /** mag = linear and min = linear and mip = none */
  115973. static readonly TEXTURE_LINEAR_LINEAR: number;
  115974. /** mag = linear and min = nearest and mip = none */
  115975. static readonly TEXTURE_LINEAR_NEAREST: number;
  115976. /** Explicit coordinates mode */
  115977. static readonly TEXTURE_EXPLICIT_MODE: number;
  115978. /** Spherical coordinates mode */
  115979. static readonly TEXTURE_SPHERICAL_MODE: number;
  115980. /** Planar coordinates mode */
  115981. static readonly TEXTURE_PLANAR_MODE: number;
  115982. /** Cubic coordinates mode */
  115983. static readonly TEXTURE_CUBIC_MODE: number;
  115984. /** Projection coordinates mode */
  115985. static readonly TEXTURE_PROJECTION_MODE: number;
  115986. /** Skybox coordinates mode */
  115987. static readonly TEXTURE_SKYBOX_MODE: number;
  115988. /** Inverse Cubic coordinates mode */
  115989. static readonly TEXTURE_INVCUBIC_MODE: number;
  115990. /** Equirectangular coordinates mode */
  115991. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  115992. /** Equirectangular Fixed coordinates mode */
  115993. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  115994. /** Equirectangular Fixed Mirrored coordinates mode */
  115995. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  115996. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  115997. static readonly SCALEMODE_FLOOR: number;
  115998. /** Defines that texture rescaling will look for the nearest power of 2 size */
  115999. static readonly SCALEMODE_NEAREST: number;
  116000. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  116001. static readonly SCALEMODE_CEILING: number;
  116002. /**
  116003. * Returns the current npm package of the sdk
  116004. */
  116005. static get NpmPackage(): string;
  116006. /**
  116007. * Returns the current version of the framework
  116008. */
  116009. static get Version(): string;
  116010. /** Gets the list of created engines */
  116011. static get Instances(): Engine[];
  116012. /**
  116013. * Gets the latest created engine
  116014. */
  116015. static get LastCreatedEngine(): Nullable<Engine>;
  116016. /**
  116017. * Gets the latest created scene
  116018. */
  116019. static get LastCreatedScene(): Nullable<Scene>;
  116020. /**
  116021. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  116022. * @param flag defines which part of the materials must be marked as dirty
  116023. * @param predicate defines a predicate used to filter which materials should be affected
  116024. */
  116025. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  116026. /**
  116027. * Method called to create the default loading screen.
  116028. * This can be overriden in your own app.
  116029. * @param canvas The rendering canvas element
  116030. * @returns The loading screen
  116031. */
  116032. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  116033. /**
  116034. * Method called to create the default rescale post process on each engine.
  116035. */
  116036. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  116037. /**
  116038. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  116039. **/
  116040. enableOfflineSupport: boolean;
  116041. /**
  116042. * 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)
  116043. **/
  116044. disableManifestCheck: boolean;
  116045. /**
  116046. * Gets the list of created scenes
  116047. */
  116048. scenes: Scene[];
  116049. /**
  116050. * Event raised when a new scene is created
  116051. */
  116052. onNewSceneAddedObservable: Observable<Scene>;
  116053. /**
  116054. * Gets the list of created postprocesses
  116055. */
  116056. postProcesses: PostProcess[];
  116057. /**
  116058. * Gets a boolean indicating if the pointer is currently locked
  116059. */
  116060. isPointerLock: boolean;
  116061. /**
  116062. * Observable event triggered each time the rendering canvas is resized
  116063. */
  116064. onResizeObservable: Observable<Engine>;
  116065. /**
  116066. * Observable event triggered each time the canvas loses focus
  116067. */
  116068. onCanvasBlurObservable: Observable<Engine>;
  116069. /**
  116070. * Observable event triggered each time the canvas gains focus
  116071. */
  116072. onCanvasFocusObservable: Observable<Engine>;
  116073. /**
  116074. * Observable event triggered each time the canvas receives pointerout event
  116075. */
  116076. onCanvasPointerOutObservable: Observable<PointerEvent>;
  116077. /**
  116078. * Observable raised when the engine begins a new frame
  116079. */
  116080. onBeginFrameObservable: Observable<Engine>;
  116081. /**
  116082. * If set, will be used to request the next animation frame for the render loop
  116083. */
  116084. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  116085. /**
  116086. * Observable raised when the engine ends the current frame
  116087. */
  116088. onEndFrameObservable: Observable<Engine>;
  116089. /**
  116090. * Observable raised when the engine is about to compile a shader
  116091. */
  116092. onBeforeShaderCompilationObservable: Observable<Engine>;
  116093. /**
  116094. * Observable raised when the engine has jsut compiled a shader
  116095. */
  116096. onAfterShaderCompilationObservable: Observable<Engine>;
  116097. /**
  116098. * Gets the audio engine
  116099. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116100. * @ignorenaming
  116101. */
  116102. static audioEngine: IAudioEngine;
  116103. /**
  116104. * Default AudioEngine factory responsible of creating the Audio Engine.
  116105. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  116106. */
  116107. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  116108. /**
  116109. * Default offline support factory responsible of creating a tool used to store data locally.
  116110. * By default, this will create a Database object if the workload has been embedded.
  116111. */
  116112. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  116113. private _loadingScreen;
  116114. private _pointerLockRequested;
  116115. private _rescalePostProcess;
  116116. private _deterministicLockstep;
  116117. private _lockstepMaxSteps;
  116118. private _timeStep;
  116119. protected get _supportsHardwareTextureRescaling(): boolean;
  116120. private _fps;
  116121. private _deltaTime;
  116122. /** @hidden */
  116123. _drawCalls: PerfCounter;
  116124. /** 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 */
  116125. canvasTabIndex: number;
  116126. /**
  116127. * Turn this value on if you want to pause FPS computation when in background
  116128. */
  116129. disablePerformanceMonitorInBackground: boolean;
  116130. private _performanceMonitor;
  116131. /**
  116132. * Gets the performance monitor attached to this engine
  116133. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  116134. */
  116135. get performanceMonitor(): PerformanceMonitor;
  116136. private _onFocus;
  116137. private _onBlur;
  116138. private _onCanvasPointerOut;
  116139. private _onCanvasBlur;
  116140. private _onCanvasFocus;
  116141. private _onFullscreenChange;
  116142. private _onPointerLockChange;
  116143. /**
  116144. * Gets the HTML element used to attach event listeners
  116145. * @returns a HTML element
  116146. */
  116147. getInputElement(): Nullable<HTMLElement>;
  116148. /**
  116149. * Creates a new engine
  116150. * @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
  116151. * @param antialias defines enable antialiasing (default: false)
  116152. * @param options defines further options to be sent to the getContext() function
  116153. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  116154. */
  116155. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  116156. /**
  116157. * Gets current aspect ratio
  116158. * @param viewportOwner defines the camera to use to get the aspect ratio
  116159. * @param useScreen defines if screen size must be used (or the current render target if any)
  116160. * @returns a number defining the aspect ratio
  116161. */
  116162. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  116163. /**
  116164. * Gets current screen aspect ratio
  116165. * @returns a number defining the aspect ratio
  116166. */
  116167. getScreenAspectRatio(): number;
  116168. /**
  116169. * Gets the client rect of the HTML canvas attached with the current webGL context
  116170. * @returns a client rectanglee
  116171. */
  116172. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  116173. /**
  116174. * Gets the client rect of the HTML element used for events
  116175. * @returns a client rectanglee
  116176. */
  116177. getInputElementClientRect(): Nullable<ClientRect>;
  116178. /**
  116179. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  116180. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116181. * @returns true if engine is in deterministic lock step mode
  116182. */
  116183. isDeterministicLockStep(): boolean;
  116184. /**
  116185. * Gets the max steps when engine is running in deterministic lock step
  116186. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  116187. * @returns the max steps
  116188. */
  116189. getLockstepMaxSteps(): number;
  116190. /**
  116191. * Returns the time in ms between steps when using deterministic lock step.
  116192. * @returns time step in (ms)
  116193. */
  116194. getTimeStep(): number;
  116195. /**
  116196. * Force the mipmap generation for the given render target texture
  116197. * @param texture defines the render target texture to use
  116198. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  116199. */
  116200. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  116201. /** States */
  116202. /**
  116203. * Set various states to the webGL context
  116204. * @param culling defines backface culling state
  116205. * @param zOffset defines the value to apply to zOffset (0 by default)
  116206. * @param force defines if states must be applied even if cache is up to date
  116207. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  116208. */
  116209. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  116210. /**
  116211. * Set the z offset to apply to current rendering
  116212. * @param value defines the offset to apply
  116213. */
  116214. setZOffset(value: number): void;
  116215. /**
  116216. * Gets the current value of the zOffset
  116217. * @returns the current zOffset state
  116218. */
  116219. getZOffset(): number;
  116220. /**
  116221. * Enable or disable depth buffering
  116222. * @param enable defines the state to set
  116223. */
  116224. setDepthBuffer(enable: boolean): void;
  116225. /**
  116226. * Gets a boolean indicating if depth writing is enabled
  116227. * @returns the current depth writing state
  116228. */
  116229. getDepthWrite(): boolean;
  116230. /**
  116231. * Enable or disable depth writing
  116232. * @param enable defines the state to set
  116233. */
  116234. setDepthWrite(enable: boolean): void;
  116235. /**
  116236. * Gets a boolean indicating if stencil buffer is enabled
  116237. * @returns the current stencil buffer state
  116238. */
  116239. getStencilBuffer(): boolean;
  116240. /**
  116241. * Enable or disable the stencil buffer
  116242. * @param enable defines if the stencil buffer must be enabled or disabled
  116243. */
  116244. setStencilBuffer(enable: boolean): void;
  116245. /**
  116246. * Gets the current stencil mask
  116247. * @returns a number defining the new stencil mask to use
  116248. */
  116249. getStencilMask(): number;
  116250. /**
  116251. * Sets the current stencil mask
  116252. * @param mask defines the new stencil mask to use
  116253. */
  116254. setStencilMask(mask: number): void;
  116255. /**
  116256. * Gets the current stencil function
  116257. * @returns a number defining the stencil function to use
  116258. */
  116259. getStencilFunction(): number;
  116260. /**
  116261. * Gets the current stencil reference value
  116262. * @returns a number defining the stencil reference value to use
  116263. */
  116264. getStencilFunctionReference(): number;
  116265. /**
  116266. * Gets the current stencil mask
  116267. * @returns a number defining the stencil mask to use
  116268. */
  116269. getStencilFunctionMask(): number;
  116270. /**
  116271. * Sets the current stencil function
  116272. * @param stencilFunc defines the new stencil function to use
  116273. */
  116274. setStencilFunction(stencilFunc: number): void;
  116275. /**
  116276. * Sets the current stencil reference
  116277. * @param reference defines the new stencil reference to use
  116278. */
  116279. setStencilFunctionReference(reference: number): void;
  116280. /**
  116281. * Sets the current stencil mask
  116282. * @param mask defines the new stencil mask to use
  116283. */
  116284. setStencilFunctionMask(mask: number): void;
  116285. /**
  116286. * Gets the current stencil operation when stencil fails
  116287. * @returns a number defining stencil operation to use when stencil fails
  116288. */
  116289. getStencilOperationFail(): number;
  116290. /**
  116291. * Gets the current stencil operation when depth fails
  116292. * @returns a number defining stencil operation to use when depth fails
  116293. */
  116294. getStencilOperationDepthFail(): number;
  116295. /**
  116296. * Gets the current stencil operation when stencil passes
  116297. * @returns a number defining stencil operation to use when stencil passes
  116298. */
  116299. getStencilOperationPass(): number;
  116300. /**
  116301. * Sets the stencil operation to use when stencil fails
  116302. * @param operation defines the stencil operation to use when stencil fails
  116303. */
  116304. setStencilOperationFail(operation: number): void;
  116305. /**
  116306. * Sets the stencil operation to use when depth fails
  116307. * @param operation defines the stencil operation to use when depth fails
  116308. */
  116309. setStencilOperationDepthFail(operation: number): void;
  116310. /**
  116311. * Sets the stencil operation to use when stencil passes
  116312. * @param operation defines the stencil operation to use when stencil passes
  116313. */
  116314. setStencilOperationPass(operation: number): void;
  116315. /**
  116316. * Sets a boolean indicating if the dithering state is enabled or disabled
  116317. * @param value defines the dithering state
  116318. */
  116319. setDitheringState(value: boolean): void;
  116320. /**
  116321. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  116322. * @param value defines the rasterizer state
  116323. */
  116324. setRasterizerState(value: boolean): void;
  116325. /**
  116326. * Gets the current depth function
  116327. * @returns a number defining the depth function
  116328. */
  116329. getDepthFunction(): Nullable<number>;
  116330. /**
  116331. * Sets the current depth function
  116332. * @param depthFunc defines the function to use
  116333. */
  116334. setDepthFunction(depthFunc: number): void;
  116335. /**
  116336. * Sets the current depth function to GREATER
  116337. */
  116338. setDepthFunctionToGreater(): void;
  116339. /**
  116340. * Sets the current depth function to GEQUAL
  116341. */
  116342. setDepthFunctionToGreaterOrEqual(): void;
  116343. /**
  116344. * Sets the current depth function to LESS
  116345. */
  116346. setDepthFunctionToLess(): void;
  116347. /**
  116348. * Sets the current depth function to LEQUAL
  116349. */
  116350. setDepthFunctionToLessOrEqual(): void;
  116351. private _cachedStencilBuffer;
  116352. private _cachedStencilFunction;
  116353. private _cachedStencilMask;
  116354. private _cachedStencilOperationPass;
  116355. private _cachedStencilOperationFail;
  116356. private _cachedStencilOperationDepthFail;
  116357. private _cachedStencilReference;
  116358. /**
  116359. * Caches the the state of the stencil buffer
  116360. */
  116361. cacheStencilState(): void;
  116362. /**
  116363. * Restores the state of the stencil buffer
  116364. */
  116365. restoreStencilState(): void;
  116366. /**
  116367. * Directly set the WebGL Viewport
  116368. * @param x defines the x coordinate of the viewport (in screen space)
  116369. * @param y defines the y coordinate of the viewport (in screen space)
  116370. * @param width defines the width of the viewport (in screen space)
  116371. * @param height defines the height of the viewport (in screen space)
  116372. * @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
  116373. */
  116374. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  116375. /**
  116376. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  116377. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  116378. * @param y defines the y-coordinate of the corner of the clear rectangle
  116379. * @param width defines the width of the clear rectangle
  116380. * @param height defines the height of the clear rectangle
  116381. * @param clearColor defines the clear color
  116382. */
  116383. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  116384. /**
  116385. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  116386. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  116387. * @param y defines the y-coordinate of the corner of the clear rectangle
  116388. * @param width defines the width of the clear rectangle
  116389. * @param height defines the height of the clear rectangle
  116390. */
  116391. enableScissor(x: number, y: number, width: number, height: number): void;
  116392. /**
  116393. * Disable previously set scissor test rectangle
  116394. */
  116395. disableScissor(): void;
  116396. protected _reportDrawCall(): void;
  116397. /**
  116398. * Initializes a webVR display and starts listening to display change events
  116399. * The onVRDisplayChangedObservable will be notified upon these changes
  116400. * @returns The onVRDisplayChangedObservable
  116401. */
  116402. initWebVR(): Observable<IDisplayChangedEventArgs>;
  116403. /** @hidden */
  116404. _prepareVRComponent(): void;
  116405. /** @hidden */
  116406. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  116407. /** @hidden */
  116408. _submitVRFrame(): void;
  116409. /**
  116410. * Call this function to leave webVR mode
  116411. * Will do nothing if webVR is not supported or if there is no webVR device
  116412. * @see https://doc.babylonjs.com/how_to/webvr_camera
  116413. */
  116414. disableVR(): void;
  116415. /**
  116416. * Gets a boolean indicating that the system is in VR mode and is presenting
  116417. * @returns true if VR mode is engaged
  116418. */
  116419. isVRPresenting(): boolean;
  116420. /** @hidden */
  116421. _requestVRFrame(): void;
  116422. /** @hidden */
  116423. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  116424. /**
  116425. * Gets the source code of the vertex shader associated with a specific webGL program
  116426. * @param program defines the program to use
  116427. * @returns a string containing the source code of the vertex shader associated with the program
  116428. */
  116429. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  116430. /**
  116431. * Gets the source code of the fragment shader associated with a specific webGL program
  116432. * @param program defines the program to use
  116433. * @returns a string containing the source code of the fragment shader associated with the program
  116434. */
  116435. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  116436. /**
  116437. * Sets a depth stencil texture from a render target to the according uniform.
  116438. * @param channel The texture channel
  116439. * @param uniform The uniform to set
  116440. * @param texture The render target texture containing the depth stencil texture to apply
  116441. */
  116442. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  116443. /**
  116444. * Sets a texture to the webGL context from a postprocess
  116445. * @param channel defines the channel to use
  116446. * @param postProcess defines the source postprocess
  116447. */
  116448. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  116449. /**
  116450. * Binds the output of the passed in post process to the texture channel specified
  116451. * @param channel The channel the texture should be bound to
  116452. * @param postProcess The post process which's output should be bound
  116453. */
  116454. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  116455. protected _rebuildBuffers(): void;
  116456. /** @hidden */
  116457. _renderFrame(): void;
  116458. _renderLoop(): void;
  116459. /** @hidden */
  116460. _renderViews(): boolean;
  116461. /**
  116462. * Toggle full screen mode
  116463. * @param requestPointerLock defines if a pointer lock should be requested from the user
  116464. */
  116465. switchFullscreen(requestPointerLock: boolean): void;
  116466. /**
  116467. * Enters full screen mode
  116468. * @param requestPointerLock defines if a pointer lock should be requested from the user
  116469. */
  116470. enterFullscreen(requestPointerLock: boolean): void;
  116471. /**
  116472. * Exits full screen mode
  116473. */
  116474. exitFullscreen(): void;
  116475. /**
  116476. * Enters Pointerlock mode
  116477. */
  116478. enterPointerlock(): void;
  116479. /**
  116480. * Exits Pointerlock mode
  116481. */
  116482. exitPointerlock(): void;
  116483. /**
  116484. * Begin a new frame
  116485. */
  116486. beginFrame(): void;
  116487. /**
  116488. * Enf the current frame
  116489. */
  116490. endFrame(): void;
  116491. resize(): void;
  116492. /**
  116493. * Force a specific size of the canvas
  116494. * @param width defines the new canvas' width
  116495. * @param height defines the new canvas' height
  116496. * @returns true if the size was changed
  116497. */
  116498. setSize(width: number, height: number): boolean;
  116499. /**
  116500. * Updates a dynamic vertex buffer.
  116501. * @param vertexBuffer the vertex buffer to update
  116502. * @param data the data used to update the vertex buffer
  116503. * @param byteOffset the byte offset of the data
  116504. * @param byteLength the byte length of the data
  116505. */
  116506. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  116507. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  116508. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116509. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116510. _releaseTexture(texture: InternalTexture): void;
  116511. /**
  116512. * @hidden
  116513. * Rescales a texture
  116514. * @param source input texutre
  116515. * @param destination destination texture
  116516. * @param scene scene to use to render the resize
  116517. * @param internalFormat format to use when resizing
  116518. * @param onComplete callback to be called when resize has completed
  116519. */
  116520. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  116521. /**
  116522. * Gets the current framerate
  116523. * @returns a number representing the framerate
  116524. */
  116525. getFps(): number;
  116526. /**
  116527. * Gets the time spent between current and previous frame
  116528. * @returns a number representing the delta time in ms
  116529. */
  116530. getDeltaTime(): number;
  116531. private _measureFps;
  116532. /** @hidden */
  116533. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  116534. /**
  116535. * Update a dynamic index buffer
  116536. * @param indexBuffer defines the target index buffer
  116537. * @param indices defines the data to update
  116538. * @param offset defines the offset in the target index buffer where update should start
  116539. */
  116540. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  116541. /**
  116542. * Updates the sample count of a render target texture
  116543. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  116544. * @param texture defines the texture to update
  116545. * @param samples defines the sample count to set
  116546. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  116547. */
  116548. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  116549. /**
  116550. * Updates a depth texture Comparison Mode and Function.
  116551. * If the comparison Function is equal to 0, the mode will be set to none.
  116552. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  116553. * @param texture The texture to set the comparison function for
  116554. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  116555. */
  116556. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  116557. /**
  116558. * Creates a webGL buffer to use with instanciation
  116559. * @param capacity defines the size of the buffer
  116560. * @returns the webGL buffer
  116561. */
  116562. createInstancesBuffer(capacity: number): DataBuffer;
  116563. /**
  116564. * Delete a webGL buffer used with instanciation
  116565. * @param buffer defines the webGL buffer to delete
  116566. */
  116567. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  116568. private _clientWaitAsync;
  116569. /** @hidden */
  116570. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  116571. dispose(): void;
  116572. private _disableTouchAction;
  116573. /**
  116574. * Display the loading screen
  116575. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116576. */
  116577. displayLoadingUI(): void;
  116578. /**
  116579. * Hide the loading screen
  116580. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116581. */
  116582. hideLoadingUI(): void;
  116583. /**
  116584. * Gets the current loading screen object
  116585. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116586. */
  116587. get loadingScreen(): ILoadingScreen;
  116588. /**
  116589. * Sets the current loading screen object
  116590. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116591. */
  116592. set loadingScreen(loadingScreen: ILoadingScreen);
  116593. /**
  116594. * Sets the current loading screen text
  116595. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116596. */
  116597. set loadingUIText(text: string);
  116598. /**
  116599. * Sets the current loading screen background color
  116600. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116601. */
  116602. set loadingUIBackgroundColor(color: string);
  116603. /** Pointerlock and fullscreen */
  116604. /**
  116605. * Ask the browser to promote the current element to pointerlock mode
  116606. * @param element defines the DOM element to promote
  116607. */
  116608. static _RequestPointerlock(element: HTMLElement): void;
  116609. /**
  116610. * Asks the browser to exit pointerlock mode
  116611. */
  116612. static _ExitPointerlock(): void;
  116613. /**
  116614. * Ask the browser to promote the current element to fullscreen rendering mode
  116615. * @param element defines the DOM element to promote
  116616. */
  116617. static _RequestFullscreen(element: HTMLElement): void;
  116618. /**
  116619. * Asks the browser to exit fullscreen mode
  116620. */
  116621. static _ExitFullscreen(): void;
  116622. }
  116623. }
  116624. declare module BABYLON {
  116625. /**
  116626. * The engine store class is responsible to hold all the instances of Engine and Scene created
  116627. * during the life time of the application.
  116628. */
  116629. export class EngineStore {
  116630. /** Gets the list of created engines */
  116631. static Instances: Engine[];
  116632. /** @hidden */
  116633. static _LastCreatedScene: Nullable<Scene>;
  116634. /**
  116635. * Gets the latest created engine
  116636. */
  116637. static get LastCreatedEngine(): Nullable<Engine>;
  116638. /**
  116639. * Gets the latest created scene
  116640. */
  116641. static get LastCreatedScene(): Nullable<Scene>;
  116642. /**
  116643. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  116644. * @ignorenaming
  116645. */
  116646. static UseFallbackTexture: boolean;
  116647. /**
  116648. * Texture content used if a texture cannot loaded
  116649. * @ignorenaming
  116650. */
  116651. static FallbackTexture: string;
  116652. }
  116653. }
  116654. declare module BABYLON {
  116655. /**
  116656. * Helper class that provides a small promise polyfill
  116657. */
  116658. export class PromisePolyfill {
  116659. /**
  116660. * Static function used to check if the polyfill is required
  116661. * If this is the case then the function will inject the polyfill to window.Promise
  116662. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  116663. */
  116664. static Apply(force?: boolean): void;
  116665. }
  116666. }
  116667. declare module BABYLON {
  116668. /**
  116669. * Interface for screenshot methods with describe argument called `size` as object with options
  116670. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  116671. */
  116672. export interface IScreenshotSize {
  116673. /**
  116674. * number in pixels for canvas height
  116675. */
  116676. height?: number;
  116677. /**
  116678. * multiplier allowing render at a higher or lower resolution
  116679. * If value is defined then height and width will be ignored and taken from camera
  116680. */
  116681. precision?: number;
  116682. /**
  116683. * number in pixels for canvas width
  116684. */
  116685. width?: number;
  116686. }
  116687. }
  116688. declare module BABYLON {
  116689. interface IColor4Like {
  116690. r: float;
  116691. g: float;
  116692. b: float;
  116693. a: float;
  116694. }
  116695. /**
  116696. * Class containing a set of static utilities functions
  116697. */
  116698. export class Tools {
  116699. /**
  116700. * Gets or sets the base URL to use to load assets
  116701. */
  116702. static get BaseUrl(): string;
  116703. static set BaseUrl(value: string);
  116704. /**
  116705. * Enable/Disable Custom HTTP Request Headers globally.
  116706. * default = false
  116707. * @see CustomRequestHeaders
  116708. */
  116709. static UseCustomRequestHeaders: boolean;
  116710. /**
  116711. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  116712. * i.e. when loading files, where the server/service expects an Authorization header
  116713. */
  116714. static CustomRequestHeaders: {
  116715. [key: string]: string;
  116716. };
  116717. /**
  116718. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  116719. */
  116720. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  116721. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  116722. /**
  116723. * Default behaviour for cors in the application.
  116724. * It can be a string if the expected behavior is identical in the entire app.
  116725. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  116726. */
  116727. static get CorsBehavior(): string | ((url: string | string[]) => string);
  116728. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  116729. /**
  116730. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  116731. * @ignorenaming
  116732. */
  116733. static get UseFallbackTexture(): boolean;
  116734. static set UseFallbackTexture(value: boolean);
  116735. /**
  116736. * Use this object to register external classes like custom textures or material
  116737. * to allow the laoders to instantiate them
  116738. */
  116739. static get RegisteredExternalClasses(): {
  116740. [key: string]: Object;
  116741. };
  116742. static set RegisteredExternalClasses(classes: {
  116743. [key: string]: Object;
  116744. });
  116745. /**
  116746. * Texture content used if a texture cannot loaded
  116747. * @ignorenaming
  116748. */
  116749. static get fallbackTexture(): string;
  116750. static set fallbackTexture(value: string);
  116751. /**
  116752. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  116753. * @param u defines the coordinate on X axis
  116754. * @param v defines the coordinate on Y axis
  116755. * @param width defines the width of the source data
  116756. * @param height defines the height of the source data
  116757. * @param pixels defines the source byte array
  116758. * @param color defines the output color
  116759. */
  116760. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  116761. /**
  116762. * Interpolates between a and b via alpha
  116763. * @param a The lower value (returned when alpha = 0)
  116764. * @param b The upper value (returned when alpha = 1)
  116765. * @param alpha The interpolation-factor
  116766. * @return The mixed value
  116767. */
  116768. static Mix(a: number, b: number, alpha: number): number;
  116769. /**
  116770. * Tries to instantiate a new object from a given class name
  116771. * @param className defines the class name to instantiate
  116772. * @returns the new object or null if the system was not able to do the instantiation
  116773. */
  116774. static Instantiate(className: string): any;
  116775. /**
  116776. * Provides a slice function that will work even on IE
  116777. * @param data defines the array to slice
  116778. * @param start defines the start of the data (optional)
  116779. * @param end defines the end of the data (optional)
  116780. * @returns the new sliced array
  116781. */
  116782. static Slice<T>(data: T, start?: number, end?: number): T;
  116783. /**
  116784. * Polyfill for setImmediate
  116785. * @param action defines the action to execute after the current execution block
  116786. */
  116787. static SetImmediate(action: () => void): void;
  116788. /**
  116789. * Function indicating if a number is an exponent of 2
  116790. * @param value defines the value to test
  116791. * @returns true if the value is an exponent of 2
  116792. */
  116793. static IsExponentOfTwo(value: number): boolean;
  116794. private static _tmpFloatArray;
  116795. /**
  116796. * Returns the nearest 32-bit single precision float representation of a Number
  116797. * @param value A Number. If the parameter is of a different type, it will get converted
  116798. * to a number or to NaN if it cannot be converted
  116799. * @returns number
  116800. */
  116801. static FloatRound(value: number): number;
  116802. /**
  116803. * Extracts the filename from a path
  116804. * @param path defines the path to use
  116805. * @returns the filename
  116806. */
  116807. static GetFilename(path: string): string;
  116808. /**
  116809. * Extracts the "folder" part of a path (everything before the filename).
  116810. * @param uri The URI to extract the info from
  116811. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  116812. * @returns The "folder" part of the path
  116813. */
  116814. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  116815. /**
  116816. * Extracts text content from a DOM element hierarchy
  116817. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  116818. */
  116819. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  116820. /**
  116821. * Convert an angle in radians to degrees
  116822. * @param angle defines the angle to convert
  116823. * @returns the angle in degrees
  116824. */
  116825. static ToDegrees(angle: number): number;
  116826. /**
  116827. * Convert an angle in degrees to radians
  116828. * @param angle defines the angle to convert
  116829. * @returns the angle in radians
  116830. */
  116831. static ToRadians(angle: number): number;
  116832. /**
  116833. * Returns an array if obj is not an array
  116834. * @param obj defines the object to evaluate as an array
  116835. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  116836. * @returns either obj directly if obj is an array or a new array containing obj
  116837. */
  116838. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  116839. /**
  116840. * Gets the pointer prefix to use
  116841. * @param engine defines the engine we are finding the prefix for
  116842. * @returns "pointer" if touch is enabled. Else returns "mouse"
  116843. */
  116844. static GetPointerPrefix(engine: Engine): string;
  116845. /**
  116846. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  116847. * @param url define the url we are trying
  116848. * @param element define the dom element where to configure the cors policy
  116849. */
  116850. static SetCorsBehavior(url: string | string[], element: {
  116851. crossOrigin: string | null;
  116852. }): void;
  116853. /**
  116854. * Removes unwanted characters from an url
  116855. * @param url defines the url to clean
  116856. * @returns the cleaned url
  116857. */
  116858. static CleanUrl(url: string): string;
  116859. /**
  116860. * Gets or sets a function used to pre-process url before using them to load assets
  116861. */
  116862. static get PreprocessUrl(): (url: string) => string;
  116863. static set PreprocessUrl(processor: (url: string) => string);
  116864. /**
  116865. * Loads an image as an HTMLImageElement.
  116866. * @param input url string, ArrayBuffer, or Blob to load
  116867. * @param onLoad callback called when the image successfully loads
  116868. * @param onError callback called when the image fails to load
  116869. * @param offlineProvider offline provider for caching
  116870. * @param mimeType optional mime type
  116871. * @returns the HTMLImageElement of the loaded image
  116872. */
  116873. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  116874. /**
  116875. * Loads a file from a url
  116876. * @param url url string, ArrayBuffer, or Blob to load
  116877. * @param onSuccess callback called when the file successfully loads
  116878. * @param onProgress callback called while file is loading (if the server supports this mode)
  116879. * @param offlineProvider defines the offline provider for caching
  116880. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116881. * @param onError callback called when the file fails to load
  116882. * @returns a file request object
  116883. */
  116884. 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;
  116885. /**
  116886. * Loads a file from a url
  116887. * @param url the file url to load
  116888. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116889. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  116890. */
  116891. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  116892. /**
  116893. * Load a script (identified by an url). When the url returns, the
  116894. * content of this file is added into a new script element, attached to the DOM (body element)
  116895. * @param scriptUrl defines the url of the script to laod
  116896. * @param onSuccess defines the callback called when the script is loaded
  116897. * @param onError defines the callback to call if an error occurs
  116898. * @param scriptId defines the id of the script element
  116899. */
  116900. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  116901. /**
  116902. * Load an asynchronous script (identified by an url). When the url returns, the
  116903. * content of this file is added into a new script element, attached to the DOM (body element)
  116904. * @param scriptUrl defines the url of the script to laod
  116905. * @param scriptId defines the id of the script element
  116906. * @returns a promise request object
  116907. */
  116908. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  116909. /**
  116910. * Loads a file from a blob
  116911. * @param fileToLoad defines the blob to use
  116912. * @param callback defines the callback to call when data is loaded
  116913. * @param progressCallback defines the callback to call during loading process
  116914. * @returns a file request object
  116915. */
  116916. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  116917. /**
  116918. * Reads a file from a File object
  116919. * @param file defines the file to load
  116920. * @param onSuccess defines the callback to call when data is loaded
  116921. * @param onProgress defines the callback to call during loading process
  116922. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  116923. * @param onError defines the callback to call when an error occurs
  116924. * @returns a file request object
  116925. */
  116926. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  116927. /**
  116928. * Creates a data url from a given string content
  116929. * @param content defines the content to convert
  116930. * @returns the new data url link
  116931. */
  116932. static FileAsURL(content: string): string;
  116933. /**
  116934. * Format the given number to a specific decimal format
  116935. * @param value defines the number to format
  116936. * @param decimals defines the number of decimals to use
  116937. * @returns the formatted string
  116938. */
  116939. static Format(value: number, decimals?: number): string;
  116940. /**
  116941. * Tries to copy an object by duplicating every property
  116942. * @param source defines the source object
  116943. * @param destination defines the target object
  116944. * @param doNotCopyList defines a list of properties to avoid
  116945. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  116946. */
  116947. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  116948. /**
  116949. * Gets a boolean indicating if the given object has no own property
  116950. * @param obj defines the object to test
  116951. * @returns true if object has no own property
  116952. */
  116953. static IsEmpty(obj: any): boolean;
  116954. /**
  116955. * Function used to register events at window level
  116956. * @param windowElement defines the Window object to use
  116957. * @param events defines the events to register
  116958. */
  116959. static RegisterTopRootEvents(windowElement: Window, events: {
  116960. name: string;
  116961. handler: Nullable<(e: FocusEvent) => any>;
  116962. }[]): void;
  116963. /**
  116964. * Function used to unregister events from window level
  116965. * @param windowElement defines the Window object to use
  116966. * @param events defines the events to unregister
  116967. */
  116968. static UnregisterTopRootEvents(windowElement: Window, events: {
  116969. name: string;
  116970. handler: Nullable<(e: FocusEvent) => any>;
  116971. }[]): void;
  116972. /**
  116973. * @ignore
  116974. */
  116975. static _ScreenshotCanvas: HTMLCanvasElement;
  116976. /**
  116977. * Dumps the current bound framebuffer
  116978. * @param width defines the rendering width
  116979. * @param height defines the rendering height
  116980. * @param engine defines the hosting engine
  116981. * @param successCallback defines the callback triggered once the data are available
  116982. * @param mimeType defines the mime type of the result
  116983. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  116984. */
  116985. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  116986. /**
  116987. * Converts the canvas data to blob.
  116988. * This acts as a polyfill for browsers not supporting the to blob function.
  116989. * @param canvas Defines the canvas to extract the data from
  116990. * @param successCallback Defines the callback triggered once the data are available
  116991. * @param mimeType Defines the mime type of the result
  116992. */
  116993. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  116994. /**
  116995. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  116996. * @param successCallback defines the callback triggered once the data are available
  116997. * @param mimeType defines the mime type of the result
  116998. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  116999. */
  117000. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  117001. /**
  117002. * Downloads a blob in the browser
  117003. * @param blob defines the blob to download
  117004. * @param fileName defines the name of the downloaded file
  117005. */
  117006. static Download(blob: Blob, fileName: string): void;
  117007. /**
  117008. * Captures a screenshot of the current rendering
  117009. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117010. * @param engine defines the rendering engine
  117011. * @param camera defines the source camera
  117012. * @param size This parameter can be set to a single number or to an object with the
  117013. * following (optional) properties: precision, width, height. If a single number is passed,
  117014. * it will be used for both width and height. If an object is passed, the screenshot size
  117015. * will be derived from the parameters. The precision property is a multiplier allowing
  117016. * rendering at a higher or lower resolution
  117017. * @param successCallback defines the callback receives a single parameter which contains the
  117018. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117019. * src parameter of an <img> to display it
  117020. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117021. * Check your browser for supported MIME types
  117022. */
  117023. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  117024. /**
  117025. * Captures a screenshot of the current rendering
  117026. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117027. * @param engine defines the rendering engine
  117028. * @param camera defines the source camera
  117029. * @param size This parameter can be set to a single number or to an object with the
  117030. * following (optional) properties: precision, width, height. If a single number is passed,
  117031. * it will be used for both width and height. If an object is passed, the screenshot size
  117032. * will be derived from the parameters. The precision property is a multiplier allowing
  117033. * rendering at a higher or lower resolution
  117034. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117035. * Check your browser for supported MIME types
  117036. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117037. * to the src parameter of an <img> to display it
  117038. */
  117039. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  117040. /**
  117041. * Generates an image screenshot from the specified camera.
  117042. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117043. * @param engine The engine to use for rendering
  117044. * @param camera The camera to use for rendering
  117045. * @param size This parameter can be set to a single number or to an object with the
  117046. * following (optional) properties: precision, width, height. If a single number is passed,
  117047. * it will be used for both width and height. If an object is passed, the screenshot size
  117048. * will be derived from the parameters. The precision property is a multiplier allowing
  117049. * rendering at a higher or lower resolution
  117050. * @param successCallback The callback receives a single parameter which contains the
  117051. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117052. * src parameter of an <img> to display it
  117053. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117054. * Check your browser for supported MIME types
  117055. * @param samples Texture samples (default: 1)
  117056. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117057. * @param fileName A name for for the downloaded file.
  117058. */
  117059. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  117060. /**
  117061. * Generates an image screenshot from the specified camera.
  117062. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117063. * @param engine The engine to use for rendering
  117064. * @param camera The camera to use for rendering
  117065. * @param size This parameter can be set to a single number or to an object with the
  117066. * following (optional) properties: precision, width, height. If a single number is passed,
  117067. * it will be used for both width and height. If an object is passed, the screenshot size
  117068. * will be derived from the parameters. The precision property is a multiplier allowing
  117069. * rendering at a higher or lower resolution
  117070. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117071. * Check your browser for supported MIME types
  117072. * @param samples Texture samples (default: 1)
  117073. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117074. * @param fileName A name for for the downloaded file.
  117075. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117076. * to the src parameter of an <img> to display it
  117077. */
  117078. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  117079. /**
  117080. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  117081. * Be aware Math.random() could cause collisions, but:
  117082. * "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"
  117083. * @returns a pseudo random id
  117084. */
  117085. static RandomId(): string;
  117086. /**
  117087. * Test if the given uri is a base64 string
  117088. * @param uri The uri to test
  117089. * @return True if the uri is a base64 string or false otherwise
  117090. */
  117091. static IsBase64(uri: string): boolean;
  117092. /**
  117093. * Decode the given base64 uri.
  117094. * @param uri The uri to decode
  117095. * @return The decoded base64 data.
  117096. */
  117097. static DecodeBase64(uri: string): ArrayBuffer;
  117098. /**
  117099. * Gets the absolute url.
  117100. * @param url the input url
  117101. * @return the absolute url
  117102. */
  117103. static GetAbsoluteUrl(url: string): string;
  117104. /**
  117105. * No log
  117106. */
  117107. static readonly NoneLogLevel: number;
  117108. /**
  117109. * Only message logs
  117110. */
  117111. static readonly MessageLogLevel: number;
  117112. /**
  117113. * Only warning logs
  117114. */
  117115. static readonly WarningLogLevel: number;
  117116. /**
  117117. * Only error logs
  117118. */
  117119. static readonly ErrorLogLevel: number;
  117120. /**
  117121. * All logs
  117122. */
  117123. static readonly AllLogLevel: number;
  117124. /**
  117125. * Gets a value indicating the number of loading errors
  117126. * @ignorenaming
  117127. */
  117128. static get errorsCount(): number;
  117129. /**
  117130. * Callback called when a new log is added
  117131. */
  117132. static OnNewCacheEntry: (entry: string) => void;
  117133. /**
  117134. * Log a message to the console
  117135. * @param message defines the message to log
  117136. */
  117137. static Log(message: string): void;
  117138. /**
  117139. * Write a warning message to the console
  117140. * @param message defines the message to log
  117141. */
  117142. static Warn(message: string): void;
  117143. /**
  117144. * Write an error message to the console
  117145. * @param message defines the message to log
  117146. */
  117147. static Error(message: string): void;
  117148. /**
  117149. * Gets current log cache (list of logs)
  117150. */
  117151. static get LogCache(): string;
  117152. /**
  117153. * Clears the log cache
  117154. */
  117155. static ClearLogCache(): void;
  117156. /**
  117157. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  117158. */
  117159. static set LogLevels(level: number);
  117160. /**
  117161. * Checks if the window object exists
  117162. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  117163. */
  117164. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  117165. /**
  117166. * No performance log
  117167. */
  117168. static readonly PerformanceNoneLogLevel: number;
  117169. /**
  117170. * Use user marks to log performance
  117171. */
  117172. static readonly PerformanceUserMarkLogLevel: number;
  117173. /**
  117174. * Log performance to the console
  117175. */
  117176. static readonly PerformanceConsoleLogLevel: number;
  117177. private static _performance;
  117178. /**
  117179. * Sets the current performance log level
  117180. */
  117181. static set PerformanceLogLevel(level: number);
  117182. private static _StartPerformanceCounterDisabled;
  117183. private static _EndPerformanceCounterDisabled;
  117184. private static _StartUserMark;
  117185. private static _EndUserMark;
  117186. private static _StartPerformanceConsole;
  117187. private static _EndPerformanceConsole;
  117188. /**
  117189. * Starts a performance counter
  117190. */
  117191. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  117192. /**
  117193. * Ends a specific performance coutner
  117194. */
  117195. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  117196. /**
  117197. * Gets either window.performance.now() if supported or Date.now() else
  117198. */
  117199. static get Now(): number;
  117200. /**
  117201. * This method will return the name of the class used to create the instance of the given object.
  117202. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  117203. * @param object the object to get the class name from
  117204. * @param isType defines if the object is actually a type
  117205. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  117206. */
  117207. static GetClassName(object: any, isType?: boolean): string;
  117208. /**
  117209. * Gets the first element of an array satisfying a given predicate
  117210. * @param array defines the array to browse
  117211. * @param predicate defines the predicate to use
  117212. * @returns null if not found or the element
  117213. */
  117214. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  117215. /**
  117216. * This method will return the name of the full name of the class, including its owning module (if any).
  117217. * 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).
  117218. * @param object the object to get the class name from
  117219. * @param isType defines if the object is actually a type
  117220. * @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.
  117221. * @ignorenaming
  117222. */
  117223. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  117224. /**
  117225. * Returns a promise that resolves after the given amount of time.
  117226. * @param delay Number of milliseconds to delay
  117227. * @returns Promise that resolves after the given amount of time
  117228. */
  117229. static DelayAsync(delay: number): Promise<void>;
  117230. /**
  117231. * Utility function to detect if the current user agent is Safari
  117232. * @returns whether or not the current user agent is safari
  117233. */
  117234. static IsSafari(): boolean;
  117235. }
  117236. /**
  117237. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  117238. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  117239. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  117240. * @param name The name of the class, case should be preserved
  117241. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  117242. */
  117243. export function className(name: string, module?: string): (target: Object) => void;
  117244. /**
  117245. * An implementation of a loop for asynchronous functions.
  117246. */
  117247. export class AsyncLoop {
  117248. /**
  117249. * Defines the number of iterations for the loop
  117250. */
  117251. iterations: number;
  117252. /**
  117253. * Defines the current index of the loop.
  117254. */
  117255. index: number;
  117256. private _done;
  117257. private _fn;
  117258. private _successCallback;
  117259. /**
  117260. * Constructor.
  117261. * @param iterations the number of iterations.
  117262. * @param func the function to run each iteration
  117263. * @param successCallback the callback that will be called upon succesful execution
  117264. * @param offset starting offset.
  117265. */
  117266. constructor(
  117267. /**
  117268. * Defines the number of iterations for the loop
  117269. */
  117270. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  117271. /**
  117272. * Execute the next iteration. Must be called after the last iteration was finished.
  117273. */
  117274. executeNext(): void;
  117275. /**
  117276. * Break the loop and run the success callback.
  117277. */
  117278. breakLoop(): void;
  117279. /**
  117280. * Create and run an async loop.
  117281. * @param iterations the number of iterations.
  117282. * @param fn the function to run each iteration
  117283. * @param successCallback the callback that will be called upon succesful execution
  117284. * @param offset starting offset.
  117285. * @returns the created async loop object
  117286. */
  117287. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  117288. /**
  117289. * A for-loop that will run a given number of iterations synchronous and the rest async.
  117290. * @param iterations total number of iterations
  117291. * @param syncedIterations number of synchronous iterations in each async iteration.
  117292. * @param fn the function to call each iteration.
  117293. * @param callback a success call back that will be called when iterating stops.
  117294. * @param breakFunction a break condition (optional)
  117295. * @param timeout timeout settings for the setTimeout function. default - 0.
  117296. * @returns the created async loop object
  117297. */
  117298. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  117299. }
  117300. }
  117301. declare module BABYLON {
  117302. /**
  117303. * This class implement a typical dictionary using a string as key and the generic type T as value.
  117304. * The underlying implementation relies on an associative array to ensure the best performances.
  117305. * The value can be anything including 'null' but except 'undefined'
  117306. */
  117307. export class StringDictionary<T> {
  117308. /**
  117309. * This will clear this dictionary and copy the content from the 'source' one.
  117310. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  117311. * @param source the dictionary to take the content from and copy to this dictionary
  117312. */
  117313. copyFrom(source: StringDictionary<T>): void;
  117314. /**
  117315. * Get a value based from its key
  117316. * @param key the given key to get the matching value from
  117317. * @return the value if found, otherwise undefined is returned
  117318. */
  117319. get(key: string): T | undefined;
  117320. /**
  117321. * Get a value from its key or add it if it doesn't exist.
  117322. * This method will ensure you that a given key/data will be present in the dictionary.
  117323. * @param key the given key to get the matching value from
  117324. * @param factory the factory that will create the value if the key is not present in the dictionary.
  117325. * The factory will only be invoked if there's no data for the given key.
  117326. * @return the value corresponding to the key.
  117327. */
  117328. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  117329. /**
  117330. * Get a value from its key if present in the dictionary otherwise add it
  117331. * @param key the key to get the value from
  117332. * @param val if there's no such key/value pair in the dictionary add it with this value
  117333. * @return the value corresponding to the key
  117334. */
  117335. getOrAdd(key: string, val: T): T;
  117336. /**
  117337. * Check if there's a given key in the dictionary
  117338. * @param key the key to check for
  117339. * @return true if the key is present, false otherwise
  117340. */
  117341. contains(key: string): boolean;
  117342. /**
  117343. * Add a new key and its corresponding value
  117344. * @param key the key to add
  117345. * @param value the value corresponding to the key
  117346. * @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
  117347. */
  117348. add(key: string, value: T): boolean;
  117349. /**
  117350. * Update a specific value associated to a key
  117351. * @param key defines the key to use
  117352. * @param value defines the value to store
  117353. * @returns true if the value was updated (or false if the key was not found)
  117354. */
  117355. set(key: string, value: T): boolean;
  117356. /**
  117357. * Get the element of the given key and remove it from the dictionary
  117358. * @param key defines the key to search
  117359. * @returns the value associated with the key or null if not found
  117360. */
  117361. getAndRemove(key: string): Nullable<T>;
  117362. /**
  117363. * Remove a key/value from the dictionary.
  117364. * @param key the key to remove
  117365. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  117366. */
  117367. remove(key: string): boolean;
  117368. /**
  117369. * Clear the whole content of the dictionary
  117370. */
  117371. clear(): void;
  117372. /**
  117373. * Gets the current count
  117374. */
  117375. get count(): number;
  117376. /**
  117377. * Execute a callback on each key/val of the dictionary.
  117378. * Note that you can remove any element in this dictionary in the callback implementation
  117379. * @param callback the callback to execute on a given key/value pair
  117380. */
  117381. forEach(callback: (key: string, val: T) => void): void;
  117382. /**
  117383. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  117384. * If the callback returns null or undefined the method will iterate to the next key/value pair
  117385. * Note that you can remove any element in this dictionary in the callback implementation
  117386. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  117387. * @returns the first item
  117388. */
  117389. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  117390. private _count;
  117391. private _data;
  117392. }
  117393. }
  117394. declare module BABYLON {
  117395. /** @hidden */
  117396. export interface ICollisionCoordinator {
  117397. createCollider(): Collider;
  117398. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  117399. init(scene: Scene): void;
  117400. }
  117401. /** @hidden */
  117402. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  117403. private _scene;
  117404. private _scaledPosition;
  117405. private _scaledVelocity;
  117406. private _finalPosition;
  117407. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  117408. createCollider(): Collider;
  117409. init(scene: Scene): void;
  117410. private _collideWithWorld;
  117411. }
  117412. }
  117413. declare module BABYLON {
  117414. /**
  117415. * Class used to manage all inputs for the scene.
  117416. */
  117417. export class InputManager {
  117418. /** The distance in pixel that you have to move to prevent some events */
  117419. static DragMovementThreshold: number;
  117420. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  117421. static LongPressDelay: number;
  117422. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  117423. static DoubleClickDelay: number;
  117424. /** If you need to check double click without raising a single click at first click, enable this flag */
  117425. static ExclusiveDoubleClickMode: boolean;
  117426. private _wheelEventName;
  117427. private _onPointerMove;
  117428. private _onPointerDown;
  117429. private _onPointerUp;
  117430. private _initClickEvent;
  117431. private _initActionManager;
  117432. private _delayedSimpleClick;
  117433. private _delayedSimpleClickTimeout;
  117434. private _previousDelayedSimpleClickTimeout;
  117435. private _meshPickProceed;
  117436. private _previousButtonPressed;
  117437. private _currentPickResult;
  117438. private _previousPickResult;
  117439. private _totalPointersPressed;
  117440. private _doubleClickOccured;
  117441. private _pointerOverMesh;
  117442. private _pickedDownMesh;
  117443. private _pickedUpMesh;
  117444. private _pointerX;
  117445. private _pointerY;
  117446. private _unTranslatedPointerX;
  117447. private _unTranslatedPointerY;
  117448. private _startingPointerPosition;
  117449. private _previousStartingPointerPosition;
  117450. private _startingPointerTime;
  117451. private _previousStartingPointerTime;
  117452. private _pointerCaptures;
  117453. private _onKeyDown;
  117454. private _onKeyUp;
  117455. private _onCanvasFocusObserver;
  117456. private _onCanvasBlurObserver;
  117457. private _scene;
  117458. /**
  117459. * Creates a new InputManager
  117460. * @param scene defines the hosting scene
  117461. */
  117462. constructor(scene: Scene);
  117463. /**
  117464. * Gets the mesh that is currently under the pointer
  117465. */
  117466. get meshUnderPointer(): Nullable<AbstractMesh>;
  117467. /**
  117468. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  117469. */
  117470. get unTranslatedPointer(): Vector2;
  117471. /**
  117472. * Gets or sets the current on-screen X position of the pointer
  117473. */
  117474. get pointerX(): number;
  117475. set pointerX(value: number);
  117476. /**
  117477. * Gets or sets the current on-screen Y position of the pointer
  117478. */
  117479. get pointerY(): number;
  117480. set pointerY(value: number);
  117481. private _updatePointerPosition;
  117482. private _processPointerMove;
  117483. private _setRayOnPointerInfo;
  117484. private _checkPrePointerObservable;
  117485. /**
  117486. * Use this method to simulate a pointer move on a mesh
  117487. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117488. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117489. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117490. */
  117491. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  117492. /**
  117493. * Use this method to simulate a pointer down on a mesh
  117494. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117495. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117496. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117497. */
  117498. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  117499. private _processPointerDown;
  117500. /** @hidden */
  117501. _isPointerSwiping(): boolean;
  117502. /**
  117503. * Use this method to simulate a pointer up on a mesh
  117504. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117505. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117506. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117507. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  117508. */
  117509. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  117510. private _processPointerUp;
  117511. /**
  117512. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  117513. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  117514. * @returns true if the pointer was captured
  117515. */
  117516. isPointerCaptured(pointerId?: number): boolean;
  117517. /**
  117518. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  117519. * @param attachUp defines if you want to attach events to pointerup
  117520. * @param attachDown defines if you want to attach events to pointerdown
  117521. * @param attachMove defines if you want to attach events to pointermove
  117522. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  117523. */
  117524. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  117525. /**
  117526. * Detaches all event handlers
  117527. */
  117528. detachControl(): void;
  117529. /**
  117530. * Force the value of meshUnderPointer
  117531. * @param mesh defines the mesh to use
  117532. */
  117533. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  117534. /**
  117535. * Gets the mesh under the pointer
  117536. * @returns a Mesh or null if no mesh is under the pointer
  117537. */
  117538. getPointerOverMesh(): Nullable<AbstractMesh>;
  117539. }
  117540. }
  117541. declare module BABYLON {
  117542. /**
  117543. * This class defines the direct association between an animation and a target
  117544. */
  117545. export class TargetedAnimation {
  117546. /**
  117547. * Animation to perform
  117548. */
  117549. animation: Animation;
  117550. /**
  117551. * Target to animate
  117552. */
  117553. target: any;
  117554. /**
  117555. * Returns the string "TargetedAnimation"
  117556. * @returns "TargetedAnimation"
  117557. */
  117558. getClassName(): string;
  117559. /**
  117560. * Serialize the object
  117561. * @returns the JSON object representing the current entity
  117562. */
  117563. serialize(): any;
  117564. }
  117565. /**
  117566. * Use this class to create coordinated animations on multiple targets
  117567. */
  117568. export class AnimationGroup implements IDisposable {
  117569. /** The name of the animation group */
  117570. name: string;
  117571. private _scene;
  117572. private _targetedAnimations;
  117573. private _animatables;
  117574. private _from;
  117575. private _to;
  117576. private _isStarted;
  117577. private _isPaused;
  117578. private _speedRatio;
  117579. private _loopAnimation;
  117580. private _isAdditive;
  117581. /**
  117582. * Gets or sets the unique id of the node
  117583. */
  117584. uniqueId: number;
  117585. /**
  117586. * This observable will notify when one animation have ended
  117587. */
  117588. onAnimationEndObservable: Observable<TargetedAnimation>;
  117589. /**
  117590. * Observer raised when one animation loops
  117591. */
  117592. onAnimationLoopObservable: Observable<TargetedAnimation>;
  117593. /**
  117594. * Observer raised when all animations have looped
  117595. */
  117596. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  117597. /**
  117598. * This observable will notify when all animations have ended.
  117599. */
  117600. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  117601. /**
  117602. * This observable will notify when all animations have paused.
  117603. */
  117604. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  117605. /**
  117606. * This observable will notify when all animations are playing.
  117607. */
  117608. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  117609. /**
  117610. * Gets the first frame
  117611. */
  117612. get from(): number;
  117613. /**
  117614. * Gets the last frame
  117615. */
  117616. get to(): number;
  117617. /**
  117618. * Define if the animations are started
  117619. */
  117620. get isStarted(): boolean;
  117621. /**
  117622. * Gets a value indicating that the current group is playing
  117623. */
  117624. get isPlaying(): boolean;
  117625. /**
  117626. * Gets or sets the speed ratio to use for all animations
  117627. */
  117628. get speedRatio(): number;
  117629. /**
  117630. * Gets or sets the speed ratio to use for all animations
  117631. */
  117632. set speedRatio(value: number);
  117633. /**
  117634. * Gets or sets if all animations should loop or not
  117635. */
  117636. get loopAnimation(): boolean;
  117637. set loopAnimation(value: boolean);
  117638. /**
  117639. * Gets or sets if all animations should be evaluated additively
  117640. */
  117641. get isAdditive(): boolean;
  117642. set isAdditive(value: boolean);
  117643. /**
  117644. * Gets the targeted animations for this animation group
  117645. */
  117646. get targetedAnimations(): Array<TargetedAnimation>;
  117647. /**
  117648. * returning the list of animatables controlled by this animation group.
  117649. */
  117650. get animatables(): Array<Animatable>;
  117651. /**
  117652. * Gets the list of target animations
  117653. */
  117654. get children(): TargetedAnimation[];
  117655. /**
  117656. * Instantiates a new Animation Group.
  117657. * This helps managing several animations at once.
  117658. * @see https://doc.babylonjs.com/how_to/group
  117659. * @param name Defines the name of the group
  117660. * @param scene Defines the scene the group belongs to
  117661. */
  117662. constructor(
  117663. /** The name of the animation group */
  117664. name: string, scene?: Nullable<Scene>);
  117665. /**
  117666. * Add an animation (with its target) in the group
  117667. * @param animation defines the animation we want to add
  117668. * @param target defines the target of the animation
  117669. * @returns the TargetedAnimation object
  117670. */
  117671. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  117672. /**
  117673. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  117674. * It can add constant keys at begin or end
  117675. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  117676. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  117677. * @returns the animation group
  117678. */
  117679. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  117680. private _animationLoopCount;
  117681. private _animationLoopFlags;
  117682. private _processLoop;
  117683. /**
  117684. * Start all animations on given targets
  117685. * @param loop defines if animations must loop
  117686. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  117687. * @param from defines the from key (optional)
  117688. * @param to defines the to key (optional)
  117689. * @param isAdditive defines the additive state for the resulting animatables (optional)
  117690. * @returns the current animation group
  117691. */
  117692. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  117693. /**
  117694. * Pause all animations
  117695. * @returns the animation group
  117696. */
  117697. pause(): AnimationGroup;
  117698. /**
  117699. * Play all animations to initial state
  117700. * This function will start() the animations if they were not started or will restart() them if they were paused
  117701. * @param loop defines if animations must loop
  117702. * @returns the animation group
  117703. */
  117704. play(loop?: boolean): AnimationGroup;
  117705. /**
  117706. * Reset all animations to initial state
  117707. * @returns the animation group
  117708. */
  117709. reset(): AnimationGroup;
  117710. /**
  117711. * Restart animations from key 0
  117712. * @returns the animation group
  117713. */
  117714. restart(): AnimationGroup;
  117715. /**
  117716. * Stop all animations
  117717. * @returns the animation group
  117718. */
  117719. stop(): AnimationGroup;
  117720. /**
  117721. * Set animation weight for all animatables
  117722. * @param weight defines the weight to use
  117723. * @return the animationGroup
  117724. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  117725. */
  117726. setWeightForAllAnimatables(weight: number): AnimationGroup;
  117727. /**
  117728. * Synchronize and normalize all animatables with a source animatable
  117729. * @param root defines the root animatable to synchronize with
  117730. * @return the animationGroup
  117731. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  117732. */
  117733. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  117734. /**
  117735. * Goes to a specific frame in this animation group
  117736. * @param frame the frame number to go to
  117737. * @return the animationGroup
  117738. */
  117739. goToFrame(frame: number): AnimationGroup;
  117740. /**
  117741. * Dispose all associated resources
  117742. */
  117743. dispose(): void;
  117744. private _checkAnimationGroupEnded;
  117745. /**
  117746. * Clone the current animation group and returns a copy
  117747. * @param newName defines the name of the new group
  117748. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  117749. * @returns the new aniamtion group
  117750. */
  117751. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  117752. /**
  117753. * Serializes the animationGroup to an object
  117754. * @returns Serialized object
  117755. */
  117756. serialize(): any;
  117757. /**
  117758. * Returns a new AnimationGroup object parsed from the source provided.
  117759. * @param parsedAnimationGroup defines the source
  117760. * @param scene defines the scene that will receive the animationGroup
  117761. * @returns a new AnimationGroup
  117762. */
  117763. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  117764. /**
  117765. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  117766. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  117767. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  117768. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  117769. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  117770. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  117771. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  117772. */
  117773. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  117774. /**
  117775. * Returns the string "AnimationGroup"
  117776. * @returns "AnimationGroup"
  117777. */
  117778. getClassName(): string;
  117779. /**
  117780. * Creates a detailled string about the object
  117781. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  117782. * @returns a string representing the object
  117783. */
  117784. toString(fullDetails?: boolean): string;
  117785. }
  117786. }
  117787. declare module BABYLON {
  117788. /**
  117789. * Define an interface for all classes that will hold resources
  117790. */
  117791. export interface IDisposable {
  117792. /**
  117793. * Releases all held resources
  117794. */
  117795. dispose(): void;
  117796. }
  117797. /** Interface defining initialization parameters for Scene class */
  117798. export interface SceneOptions {
  117799. /**
  117800. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  117801. * It will improve performance when the number of geometries becomes important.
  117802. */
  117803. useGeometryUniqueIdsMap?: boolean;
  117804. /**
  117805. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  117806. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  117807. */
  117808. useMaterialMeshMap?: boolean;
  117809. /**
  117810. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  117811. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  117812. */
  117813. useClonedMeshMap?: boolean;
  117814. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  117815. virtual?: boolean;
  117816. }
  117817. /**
  117818. * Represents a scene to be rendered by the engine.
  117819. * @see https://doc.babylonjs.com/features/scene
  117820. */
  117821. export class Scene extends AbstractScene implements IAnimatable {
  117822. /** The fog is deactivated */
  117823. static readonly FOGMODE_NONE: number;
  117824. /** The fog density is following an exponential function */
  117825. static readonly FOGMODE_EXP: number;
  117826. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  117827. static readonly FOGMODE_EXP2: number;
  117828. /** The fog density is following a linear function. */
  117829. static readonly FOGMODE_LINEAR: number;
  117830. /**
  117831. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  117832. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117833. */
  117834. static MinDeltaTime: number;
  117835. /**
  117836. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  117837. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117838. */
  117839. static MaxDeltaTime: number;
  117840. /**
  117841. * Factory used to create the default material.
  117842. * @param name The name of the material to create
  117843. * @param scene The scene to create the material for
  117844. * @returns The default material
  117845. */
  117846. static DefaultMaterialFactory(scene: Scene): Material;
  117847. /**
  117848. * Factory used to create the a collision coordinator.
  117849. * @returns The collision coordinator
  117850. */
  117851. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  117852. /** @hidden */
  117853. _inputManager: InputManager;
  117854. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  117855. cameraToUseForPointers: Nullable<Camera>;
  117856. /** @hidden */
  117857. readonly _isScene: boolean;
  117858. /** @hidden */
  117859. _blockEntityCollection: boolean;
  117860. /**
  117861. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  117862. */
  117863. autoClear: boolean;
  117864. /**
  117865. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  117866. */
  117867. autoClearDepthAndStencil: boolean;
  117868. /**
  117869. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  117870. */
  117871. clearColor: Color4;
  117872. /**
  117873. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  117874. */
  117875. ambientColor: Color3;
  117876. /**
  117877. * This is use to store the default BRDF lookup for PBR materials in your scene.
  117878. * It should only be one of the following (if not the default embedded one):
  117879. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  117880. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  117881. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  117882. * The material properties need to be setup according to the type of texture in use.
  117883. */
  117884. environmentBRDFTexture: BaseTexture;
  117885. /** @hidden */
  117886. protected _environmentTexture: Nullable<BaseTexture>;
  117887. /**
  117888. * Texture used in all pbr material as the reflection texture.
  117889. * As in the majority of the scene they are the same (exception for multi room and so on),
  117890. * this is easier to reference from here than from all the materials.
  117891. */
  117892. get environmentTexture(): Nullable<BaseTexture>;
  117893. /**
  117894. * Texture used in all pbr material as the reflection texture.
  117895. * As in the majority of the scene they are the same (exception for multi room and so on),
  117896. * this is easier to set here than in all the materials.
  117897. */
  117898. set environmentTexture(value: Nullable<BaseTexture>);
  117899. /** @hidden */
  117900. protected _environmentIntensity: number;
  117901. /**
  117902. * Intensity of the environment in all pbr material.
  117903. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  117904. * As in the majority of the scene they are the same (exception for multi room and so on),
  117905. * this is easier to reference from here than from all the materials.
  117906. */
  117907. get environmentIntensity(): number;
  117908. /**
  117909. * Intensity of the environment in all pbr material.
  117910. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  117911. * As in the majority of the scene they are the same (exception for multi room and so on),
  117912. * this is easier to set here than in all the materials.
  117913. */
  117914. set environmentIntensity(value: number);
  117915. /** @hidden */
  117916. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  117917. /**
  117918. * Default image processing configuration used either in the rendering
  117919. * Forward main pass or through the imageProcessingPostProcess if present.
  117920. * As in the majority of the scene they are the same (exception for multi camera),
  117921. * this is easier to reference from here than from all the materials and post process.
  117922. *
  117923. * No setter as we it is a shared configuration, you can set the values instead.
  117924. */
  117925. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  117926. private _forceWireframe;
  117927. /**
  117928. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  117929. */
  117930. set forceWireframe(value: boolean);
  117931. get forceWireframe(): boolean;
  117932. private _skipFrustumClipping;
  117933. /**
  117934. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  117935. */
  117936. set skipFrustumClipping(value: boolean);
  117937. get skipFrustumClipping(): boolean;
  117938. private _forcePointsCloud;
  117939. /**
  117940. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  117941. */
  117942. set forcePointsCloud(value: boolean);
  117943. get forcePointsCloud(): boolean;
  117944. /**
  117945. * Gets or sets the active clipplane 1
  117946. */
  117947. clipPlane: Nullable<Plane>;
  117948. /**
  117949. * Gets or sets the active clipplane 2
  117950. */
  117951. clipPlane2: Nullable<Plane>;
  117952. /**
  117953. * Gets or sets the active clipplane 3
  117954. */
  117955. clipPlane3: Nullable<Plane>;
  117956. /**
  117957. * Gets or sets the active clipplane 4
  117958. */
  117959. clipPlane4: Nullable<Plane>;
  117960. /**
  117961. * Gets or sets the active clipplane 5
  117962. */
  117963. clipPlane5: Nullable<Plane>;
  117964. /**
  117965. * Gets or sets the active clipplane 6
  117966. */
  117967. clipPlane6: Nullable<Plane>;
  117968. /**
  117969. * Gets or sets a boolean indicating if animations are enabled
  117970. */
  117971. animationsEnabled: boolean;
  117972. private _animationPropertiesOverride;
  117973. /**
  117974. * Gets or sets the animation properties override
  117975. */
  117976. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  117977. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  117978. /**
  117979. * Gets or sets a boolean indicating if a constant deltatime has to be used
  117980. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  117981. */
  117982. useConstantAnimationDeltaTime: boolean;
  117983. /**
  117984. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  117985. * Please note that it requires to run a ray cast through the scene on every frame
  117986. */
  117987. constantlyUpdateMeshUnderPointer: boolean;
  117988. /**
  117989. * Defines the HTML cursor to use when hovering over interactive elements
  117990. */
  117991. hoverCursor: string;
  117992. /**
  117993. * Defines the HTML default cursor to use (empty by default)
  117994. */
  117995. defaultCursor: string;
  117996. /**
  117997. * Defines whether cursors are handled by the scene.
  117998. */
  117999. doNotHandleCursors: boolean;
  118000. /**
  118001. * This is used to call preventDefault() on pointer down
  118002. * in order to block unwanted artifacts like system double clicks
  118003. */
  118004. preventDefaultOnPointerDown: boolean;
  118005. /**
  118006. * This is used to call preventDefault() on pointer up
  118007. * in order to block unwanted artifacts like system double clicks
  118008. */
  118009. preventDefaultOnPointerUp: boolean;
  118010. /**
  118011. * Gets or sets user defined metadata
  118012. */
  118013. metadata: any;
  118014. /**
  118015. * For internal use only. Please do not use.
  118016. */
  118017. reservedDataStore: any;
  118018. /**
  118019. * Gets the name of the plugin used to load this scene (null by default)
  118020. */
  118021. loadingPluginName: string;
  118022. /**
  118023. * Use this array to add regular expressions used to disable offline support for specific urls
  118024. */
  118025. disableOfflineSupportExceptionRules: RegExp[];
  118026. /**
  118027. * An event triggered when the scene is disposed.
  118028. */
  118029. onDisposeObservable: Observable<Scene>;
  118030. private _onDisposeObserver;
  118031. /** Sets a function to be executed when this scene is disposed. */
  118032. set onDispose(callback: () => void);
  118033. /**
  118034. * An event triggered before rendering the scene (right after animations and physics)
  118035. */
  118036. onBeforeRenderObservable: Observable<Scene>;
  118037. private _onBeforeRenderObserver;
  118038. /** Sets a function to be executed before rendering this scene */
  118039. set beforeRender(callback: Nullable<() => void>);
  118040. /**
  118041. * An event triggered after rendering the scene
  118042. */
  118043. onAfterRenderObservable: Observable<Scene>;
  118044. /**
  118045. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  118046. */
  118047. onAfterRenderCameraObservable: Observable<Camera>;
  118048. private _onAfterRenderObserver;
  118049. /** Sets a function to be executed after rendering this scene */
  118050. set afterRender(callback: Nullable<() => void>);
  118051. /**
  118052. * An event triggered before animating the scene
  118053. */
  118054. onBeforeAnimationsObservable: Observable<Scene>;
  118055. /**
  118056. * An event triggered after animations processing
  118057. */
  118058. onAfterAnimationsObservable: Observable<Scene>;
  118059. /**
  118060. * An event triggered before draw calls are ready to be sent
  118061. */
  118062. onBeforeDrawPhaseObservable: Observable<Scene>;
  118063. /**
  118064. * An event triggered after draw calls have been sent
  118065. */
  118066. onAfterDrawPhaseObservable: Observable<Scene>;
  118067. /**
  118068. * An event triggered when the scene is ready
  118069. */
  118070. onReadyObservable: Observable<Scene>;
  118071. /**
  118072. * An event triggered before rendering a camera
  118073. */
  118074. onBeforeCameraRenderObservable: Observable<Camera>;
  118075. private _onBeforeCameraRenderObserver;
  118076. /** Sets a function to be executed before rendering a camera*/
  118077. set beforeCameraRender(callback: () => void);
  118078. /**
  118079. * An event triggered after rendering a camera
  118080. */
  118081. onAfterCameraRenderObservable: Observable<Camera>;
  118082. private _onAfterCameraRenderObserver;
  118083. /** Sets a function to be executed after rendering a camera*/
  118084. set afterCameraRender(callback: () => void);
  118085. /**
  118086. * An event triggered when active meshes evaluation is about to start
  118087. */
  118088. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  118089. /**
  118090. * An event triggered when active meshes evaluation is done
  118091. */
  118092. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  118093. /**
  118094. * An event triggered when particles rendering is about to start
  118095. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118096. */
  118097. onBeforeParticlesRenderingObservable: Observable<Scene>;
  118098. /**
  118099. * An event triggered when particles rendering is done
  118100. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118101. */
  118102. onAfterParticlesRenderingObservable: Observable<Scene>;
  118103. /**
  118104. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  118105. */
  118106. onDataLoadedObservable: Observable<Scene>;
  118107. /**
  118108. * An event triggered when a camera is created
  118109. */
  118110. onNewCameraAddedObservable: Observable<Camera>;
  118111. /**
  118112. * An event triggered when a camera is removed
  118113. */
  118114. onCameraRemovedObservable: Observable<Camera>;
  118115. /**
  118116. * An event triggered when a light is created
  118117. */
  118118. onNewLightAddedObservable: Observable<Light>;
  118119. /**
  118120. * An event triggered when a light is removed
  118121. */
  118122. onLightRemovedObservable: Observable<Light>;
  118123. /**
  118124. * An event triggered when a geometry is created
  118125. */
  118126. onNewGeometryAddedObservable: Observable<Geometry>;
  118127. /**
  118128. * An event triggered when a geometry is removed
  118129. */
  118130. onGeometryRemovedObservable: Observable<Geometry>;
  118131. /**
  118132. * An event triggered when a transform node is created
  118133. */
  118134. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  118135. /**
  118136. * An event triggered when a transform node is removed
  118137. */
  118138. onTransformNodeRemovedObservable: Observable<TransformNode>;
  118139. /**
  118140. * An event triggered when a mesh is created
  118141. */
  118142. onNewMeshAddedObservable: Observable<AbstractMesh>;
  118143. /**
  118144. * An event triggered when a mesh is removed
  118145. */
  118146. onMeshRemovedObservable: Observable<AbstractMesh>;
  118147. /**
  118148. * An event triggered when a skeleton is created
  118149. */
  118150. onNewSkeletonAddedObservable: Observable<Skeleton>;
  118151. /**
  118152. * An event triggered when a skeleton is removed
  118153. */
  118154. onSkeletonRemovedObservable: Observable<Skeleton>;
  118155. /**
  118156. * An event triggered when a material is created
  118157. */
  118158. onNewMaterialAddedObservable: Observable<Material>;
  118159. /**
  118160. * An event triggered when a material is removed
  118161. */
  118162. onMaterialRemovedObservable: Observable<Material>;
  118163. /**
  118164. * An event triggered when a texture is created
  118165. */
  118166. onNewTextureAddedObservable: Observable<BaseTexture>;
  118167. /**
  118168. * An event triggered when a texture is removed
  118169. */
  118170. onTextureRemovedObservable: Observable<BaseTexture>;
  118171. /**
  118172. * An event triggered when render targets are about to be rendered
  118173. * Can happen multiple times per frame.
  118174. */
  118175. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  118176. /**
  118177. * An event triggered when render targets were rendered.
  118178. * Can happen multiple times per frame.
  118179. */
  118180. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  118181. /**
  118182. * An event triggered before calculating deterministic simulation step
  118183. */
  118184. onBeforeStepObservable: Observable<Scene>;
  118185. /**
  118186. * An event triggered after calculating deterministic simulation step
  118187. */
  118188. onAfterStepObservable: Observable<Scene>;
  118189. /**
  118190. * An event triggered when the activeCamera property is updated
  118191. */
  118192. onActiveCameraChanged: Observable<Scene>;
  118193. /**
  118194. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  118195. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  118196. * 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)
  118197. */
  118198. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  118199. /**
  118200. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  118201. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  118202. * 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)
  118203. */
  118204. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  118205. /**
  118206. * This Observable will when a mesh has been imported into the scene.
  118207. */
  118208. onMeshImportedObservable: Observable<AbstractMesh>;
  118209. /**
  118210. * This Observable will when an animation file has been imported into the scene.
  118211. */
  118212. onAnimationFileImportedObservable: Observable<Scene>;
  118213. /**
  118214. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  118215. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  118216. */
  118217. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  118218. /** @hidden */
  118219. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  118220. /**
  118221. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  118222. */
  118223. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  118224. /**
  118225. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  118226. */
  118227. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  118228. /**
  118229. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  118230. */
  118231. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  118232. /** Callback called when a pointer move is detected */
  118233. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  118234. /** Callback called when a pointer down is detected */
  118235. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  118236. /** Callback called when a pointer up is detected */
  118237. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  118238. /** Callback called when a pointer pick is detected */
  118239. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  118240. /**
  118241. * 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).
  118242. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  118243. */
  118244. onPrePointerObservable: Observable<PointerInfoPre>;
  118245. /**
  118246. * Observable event triggered each time an input event is received from the rendering canvas
  118247. */
  118248. onPointerObservable: Observable<PointerInfo>;
  118249. /**
  118250. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  118251. */
  118252. get unTranslatedPointer(): Vector2;
  118253. /**
  118254. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  118255. */
  118256. static get DragMovementThreshold(): number;
  118257. static set DragMovementThreshold(value: number);
  118258. /**
  118259. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  118260. */
  118261. static get LongPressDelay(): number;
  118262. static set LongPressDelay(value: number);
  118263. /**
  118264. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  118265. */
  118266. static get DoubleClickDelay(): number;
  118267. static set DoubleClickDelay(value: number);
  118268. /** If you need to check double click without raising a single click at first click, enable this flag */
  118269. static get ExclusiveDoubleClickMode(): boolean;
  118270. static set ExclusiveDoubleClickMode(value: boolean);
  118271. /** @hidden */
  118272. _mirroredCameraPosition: Nullable<Vector3>;
  118273. /**
  118274. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  118275. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  118276. */
  118277. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  118278. /**
  118279. * Observable event triggered each time an keyboard event is received from the hosting window
  118280. */
  118281. onKeyboardObservable: Observable<KeyboardInfo>;
  118282. private _useRightHandedSystem;
  118283. /**
  118284. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  118285. */
  118286. set useRightHandedSystem(value: boolean);
  118287. get useRightHandedSystem(): boolean;
  118288. private _timeAccumulator;
  118289. private _currentStepId;
  118290. private _currentInternalStep;
  118291. /**
  118292. * Sets the step Id used by deterministic lock step
  118293. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118294. * @param newStepId defines the step Id
  118295. */
  118296. setStepId(newStepId: number): void;
  118297. /**
  118298. * Gets the step Id used by deterministic lock step
  118299. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118300. * @returns the step Id
  118301. */
  118302. getStepId(): number;
  118303. /**
  118304. * Gets the internal step used by deterministic lock step
  118305. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118306. * @returns the internal step
  118307. */
  118308. getInternalStep(): number;
  118309. private _fogEnabled;
  118310. /**
  118311. * Gets or sets a boolean indicating if fog is enabled on this scene
  118312. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118313. * (Default is true)
  118314. */
  118315. set fogEnabled(value: boolean);
  118316. get fogEnabled(): boolean;
  118317. private _fogMode;
  118318. /**
  118319. * Gets or sets the fog mode to use
  118320. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118321. * | mode | value |
  118322. * | --- | --- |
  118323. * | FOGMODE_NONE | 0 |
  118324. * | FOGMODE_EXP | 1 |
  118325. * | FOGMODE_EXP2 | 2 |
  118326. * | FOGMODE_LINEAR | 3 |
  118327. */
  118328. set fogMode(value: number);
  118329. get fogMode(): number;
  118330. /**
  118331. * Gets or sets the fog color to use
  118332. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118333. * (Default is Color3(0.2, 0.2, 0.3))
  118334. */
  118335. fogColor: Color3;
  118336. /**
  118337. * Gets or sets the fog density to use
  118338. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118339. * (Default is 0.1)
  118340. */
  118341. fogDensity: number;
  118342. /**
  118343. * Gets or sets the fog start distance to use
  118344. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118345. * (Default is 0)
  118346. */
  118347. fogStart: number;
  118348. /**
  118349. * Gets or sets the fog end distance to use
  118350. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118351. * (Default is 1000)
  118352. */
  118353. fogEnd: number;
  118354. /**
  118355. * Flag indicating that the frame buffer binding is handled by another component
  118356. */
  118357. prePass: boolean;
  118358. private _shadowsEnabled;
  118359. /**
  118360. * Gets or sets a boolean indicating if shadows are enabled on this scene
  118361. */
  118362. set shadowsEnabled(value: boolean);
  118363. get shadowsEnabled(): boolean;
  118364. private _lightsEnabled;
  118365. /**
  118366. * Gets or sets a boolean indicating if lights are enabled on this scene
  118367. */
  118368. set lightsEnabled(value: boolean);
  118369. get lightsEnabled(): boolean;
  118370. /** All of the active cameras added to this scene. */
  118371. activeCameras: Camera[];
  118372. /** @hidden */
  118373. _activeCamera: Nullable<Camera>;
  118374. /** Gets or sets the current active camera */
  118375. get activeCamera(): Nullable<Camera>;
  118376. set activeCamera(value: Nullable<Camera>);
  118377. private _defaultMaterial;
  118378. /** The default material used on meshes when no material is affected */
  118379. get defaultMaterial(): Material;
  118380. /** The default material used on meshes when no material is affected */
  118381. set defaultMaterial(value: Material);
  118382. private _texturesEnabled;
  118383. /**
  118384. * Gets or sets a boolean indicating if textures are enabled on this scene
  118385. */
  118386. set texturesEnabled(value: boolean);
  118387. get texturesEnabled(): boolean;
  118388. /**
  118389. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  118390. */
  118391. physicsEnabled: boolean;
  118392. /**
  118393. * Gets or sets a boolean indicating if particles are enabled on this scene
  118394. */
  118395. particlesEnabled: boolean;
  118396. /**
  118397. * Gets or sets a boolean indicating if sprites are enabled on this scene
  118398. */
  118399. spritesEnabled: boolean;
  118400. private _skeletonsEnabled;
  118401. /**
  118402. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  118403. */
  118404. set skeletonsEnabled(value: boolean);
  118405. get skeletonsEnabled(): boolean;
  118406. /**
  118407. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  118408. */
  118409. lensFlaresEnabled: boolean;
  118410. /**
  118411. * Gets or sets a boolean indicating if collisions are enabled on this scene
  118412. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  118413. */
  118414. collisionsEnabled: boolean;
  118415. private _collisionCoordinator;
  118416. /** @hidden */
  118417. get collisionCoordinator(): ICollisionCoordinator;
  118418. /**
  118419. * Defines the gravity applied to this scene (used only for collisions)
  118420. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  118421. */
  118422. gravity: Vector3;
  118423. /**
  118424. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  118425. */
  118426. postProcessesEnabled: boolean;
  118427. /**
  118428. * The list of postprocesses added to the scene
  118429. */
  118430. postProcesses: PostProcess[];
  118431. /**
  118432. * Gets the current postprocess manager
  118433. */
  118434. postProcessManager: PostProcessManager;
  118435. /**
  118436. * Gets or sets a boolean indicating if render targets are enabled on this scene
  118437. */
  118438. renderTargetsEnabled: boolean;
  118439. /**
  118440. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  118441. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  118442. */
  118443. dumpNextRenderTargets: boolean;
  118444. /**
  118445. * The list of user defined render targets added to the scene
  118446. */
  118447. customRenderTargets: RenderTargetTexture[];
  118448. /**
  118449. * Defines if texture loading must be delayed
  118450. * If true, textures will only be loaded when they need to be rendered
  118451. */
  118452. useDelayedTextureLoading: boolean;
  118453. /**
  118454. * Gets the list of meshes imported to the scene through SceneLoader
  118455. */
  118456. importedMeshesFiles: String[];
  118457. /**
  118458. * Gets or sets a boolean indicating if probes are enabled on this scene
  118459. */
  118460. probesEnabled: boolean;
  118461. /**
  118462. * Gets or sets the current offline provider to use to store scene data
  118463. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  118464. */
  118465. offlineProvider: IOfflineProvider;
  118466. /**
  118467. * Gets or sets the action manager associated with the scene
  118468. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  118469. */
  118470. actionManager: AbstractActionManager;
  118471. private _meshesForIntersections;
  118472. /**
  118473. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  118474. */
  118475. proceduralTexturesEnabled: boolean;
  118476. private _engine;
  118477. private _totalVertices;
  118478. /** @hidden */
  118479. _activeIndices: PerfCounter;
  118480. /** @hidden */
  118481. _activeParticles: PerfCounter;
  118482. /** @hidden */
  118483. _activeBones: PerfCounter;
  118484. private _animationRatio;
  118485. /** @hidden */
  118486. _animationTimeLast: number;
  118487. /** @hidden */
  118488. _animationTime: number;
  118489. /**
  118490. * Gets or sets a general scale for animation speed
  118491. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  118492. */
  118493. animationTimeScale: number;
  118494. /** @hidden */
  118495. _cachedMaterial: Nullable<Material>;
  118496. /** @hidden */
  118497. _cachedEffect: Nullable<Effect>;
  118498. /** @hidden */
  118499. _cachedVisibility: Nullable<number>;
  118500. private _renderId;
  118501. private _frameId;
  118502. private _executeWhenReadyTimeoutId;
  118503. private _intermediateRendering;
  118504. private _viewUpdateFlag;
  118505. private _projectionUpdateFlag;
  118506. /** @hidden */
  118507. _toBeDisposed: Nullable<IDisposable>[];
  118508. private _activeRequests;
  118509. /** @hidden */
  118510. _pendingData: any[];
  118511. private _isDisposed;
  118512. /**
  118513. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  118514. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  118515. */
  118516. dispatchAllSubMeshesOfActiveMeshes: boolean;
  118517. private _activeMeshes;
  118518. private _processedMaterials;
  118519. private _renderTargets;
  118520. /** @hidden */
  118521. _activeParticleSystems: SmartArray<IParticleSystem>;
  118522. private _activeSkeletons;
  118523. private _softwareSkinnedMeshes;
  118524. private _renderingManager;
  118525. /** @hidden */
  118526. _activeAnimatables: Animatable[];
  118527. private _transformMatrix;
  118528. private _sceneUbo;
  118529. /** @hidden */
  118530. _viewMatrix: Matrix;
  118531. private _projectionMatrix;
  118532. /** @hidden */
  118533. _forcedViewPosition: Nullable<Vector3>;
  118534. /** @hidden */
  118535. _frustumPlanes: Plane[];
  118536. /**
  118537. * Gets the list of frustum planes (built from the active camera)
  118538. */
  118539. get frustumPlanes(): Plane[];
  118540. /**
  118541. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  118542. * This is useful if there are more lights that the maximum simulteanous authorized
  118543. */
  118544. requireLightSorting: boolean;
  118545. /** @hidden */
  118546. readonly useMaterialMeshMap: boolean;
  118547. /** @hidden */
  118548. readonly useClonedMeshMap: boolean;
  118549. private _externalData;
  118550. private _uid;
  118551. /**
  118552. * @hidden
  118553. * Backing store of defined scene components.
  118554. */
  118555. _components: ISceneComponent[];
  118556. /**
  118557. * @hidden
  118558. * Backing store of defined scene components.
  118559. */
  118560. _serializableComponents: ISceneSerializableComponent[];
  118561. /**
  118562. * List of components to register on the next registration step.
  118563. */
  118564. private _transientComponents;
  118565. /**
  118566. * Registers the transient components if needed.
  118567. */
  118568. private _registerTransientComponents;
  118569. /**
  118570. * @hidden
  118571. * Add a component to the scene.
  118572. * Note that the ccomponent could be registered on th next frame if this is called after
  118573. * the register component stage.
  118574. * @param component Defines the component to add to the scene
  118575. */
  118576. _addComponent(component: ISceneComponent): void;
  118577. /**
  118578. * @hidden
  118579. * Gets a component from the scene.
  118580. * @param name defines the name of the component to retrieve
  118581. * @returns the component or null if not present
  118582. */
  118583. _getComponent(name: string): Nullable<ISceneComponent>;
  118584. /**
  118585. * @hidden
  118586. * Defines the actions happening before camera updates.
  118587. */
  118588. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  118589. /**
  118590. * @hidden
  118591. * Defines the actions happening before clear the canvas.
  118592. */
  118593. _beforeClearStage: Stage<SimpleStageAction>;
  118594. /**
  118595. * @hidden
  118596. * Defines the actions when collecting render targets for the frame.
  118597. */
  118598. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  118599. /**
  118600. * @hidden
  118601. * Defines the actions happening for one camera in the frame.
  118602. */
  118603. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  118604. /**
  118605. * @hidden
  118606. * Defines the actions happening during the per mesh ready checks.
  118607. */
  118608. _isReadyForMeshStage: Stage<MeshStageAction>;
  118609. /**
  118610. * @hidden
  118611. * Defines the actions happening before evaluate active mesh checks.
  118612. */
  118613. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  118614. /**
  118615. * @hidden
  118616. * Defines the actions happening during the evaluate sub mesh checks.
  118617. */
  118618. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  118619. /**
  118620. * @hidden
  118621. * Defines the actions happening during the active mesh stage.
  118622. */
  118623. _activeMeshStage: Stage<ActiveMeshStageAction>;
  118624. /**
  118625. * @hidden
  118626. * Defines the actions happening during the per camera render target step.
  118627. */
  118628. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  118629. /**
  118630. * @hidden
  118631. * Defines the actions happening just before the active camera is drawing.
  118632. */
  118633. _beforeCameraDrawStage: Stage<CameraStageAction>;
  118634. /**
  118635. * @hidden
  118636. * Defines the actions happening just before a render target is drawing.
  118637. */
  118638. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  118639. /**
  118640. * @hidden
  118641. * Defines the actions happening just before a rendering group is drawing.
  118642. */
  118643. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  118644. /**
  118645. * @hidden
  118646. * Defines the actions happening just before a mesh is drawing.
  118647. */
  118648. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  118649. /**
  118650. * @hidden
  118651. * Defines the actions happening just after a mesh has been drawn.
  118652. */
  118653. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  118654. /**
  118655. * @hidden
  118656. * Defines the actions happening just after a rendering group has been drawn.
  118657. */
  118658. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  118659. /**
  118660. * @hidden
  118661. * Defines the actions happening just after the active camera has been drawn.
  118662. */
  118663. _afterCameraDrawStage: Stage<CameraStageAction>;
  118664. /**
  118665. * @hidden
  118666. * Defines the actions happening just after a render target has been drawn.
  118667. */
  118668. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  118669. /**
  118670. * @hidden
  118671. * Defines the actions happening just after rendering all cameras and computing intersections.
  118672. */
  118673. _afterRenderStage: Stage<SimpleStageAction>;
  118674. /**
  118675. * @hidden
  118676. * Defines the actions happening when a pointer move event happens.
  118677. */
  118678. _pointerMoveStage: Stage<PointerMoveStageAction>;
  118679. /**
  118680. * @hidden
  118681. * Defines the actions happening when a pointer down event happens.
  118682. */
  118683. _pointerDownStage: Stage<PointerUpDownStageAction>;
  118684. /**
  118685. * @hidden
  118686. * Defines the actions happening when a pointer up event happens.
  118687. */
  118688. _pointerUpStage: Stage<PointerUpDownStageAction>;
  118689. /**
  118690. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  118691. */
  118692. private geometriesByUniqueId;
  118693. /**
  118694. * Creates a new Scene
  118695. * @param engine defines the engine to use to render this scene
  118696. * @param options defines the scene options
  118697. */
  118698. constructor(engine: Engine, options?: SceneOptions);
  118699. /**
  118700. * Gets a string idenfifying the name of the class
  118701. * @returns "Scene" string
  118702. */
  118703. getClassName(): string;
  118704. private _defaultMeshCandidates;
  118705. /**
  118706. * @hidden
  118707. */
  118708. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  118709. private _defaultSubMeshCandidates;
  118710. /**
  118711. * @hidden
  118712. */
  118713. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  118714. /**
  118715. * Sets the default candidate providers for the scene.
  118716. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  118717. * and getCollidingSubMeshCandidates to their default function
  118718. */
  118719. setDefaultCandidateProviders(): void;
  118720. /**
  118721. * Gets the mesh that is currently under the pointer
  118722. */
  118723. get meshUnderPointer(): Nullable<AbstractMesh>;
  118724. /**
  118725. * Gets or sets the current on-screen X position of the pointer
  118726. */
  118727. get pointerX(): number;
  118728. set pointerX(value: number);
  118729. /**
  118730. * Gets or sets the current on-screen Y position of the pointer
  118731. */
  118732. get pointerY(): number;
  118733. set pointerY(value: number);
  118734. /**
  118735. * Gets the cached material (ie. the latest rendered one)
  118736. * @returns the cached material
  118737. */
  118738. getCachedMaterial(): Nullable<Material>;
  118739. /**
  118740. * Gets the cached effect (ie. the latest rendered one)
  118741. * @returns the cached effect
  118742. */
  118743. getCachedEffect(): Nullable<Effect>;
  118744. /**
  118745. * Gets the cached visibility state (ie. the latest rendered one)
  118746. * @returns the cached visibility state
  118747. */
  118748. getCachedVisibility(): Nullable<number>;
  118749. /**
  118750. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  118751. * @param material defines the current material
  118752. * @param effect defines the current effect
  118753. * @param visibility defines the current visibility state
  118754. * @returns true if one parameter is not cached
  118755. */
  118756. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  118757. /**
  118758. * Gets the engine associated with the scene
  118759. * @returns an Engine
  118760. */
  118761. getEngine(): Engine;
  118762. /**
  118763. * Gets the total number of vertices rendered per frame
  118764. * @returns the total number of vertices rendered per frame
  118765. */
  118766. getTotalVertices(): number;
  118767. /**
  118768. * Gets the performance counter for total vertices
  118769. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118770. */
  118771. get totalVerticesPerfCounter(): PerfCounter;
  118772. /**
  118773. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  118774. * @returns the total number of active indices rendered per frame
  118775. */
  118776. getActiveIndices(): number;
  118777. /**
  118778. * Gets the performance counter for active indices
  118779. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118780. */
  118781. get totalActiveIndicesPerfCounter(): PerfCounter;
  118782. /**
  118783. * Gets the total number of active particles rendered per frame
  118784. * @returns the total number of active particles rendered per frame
  118785. */
  118786. getActiveParticles(): number;
  118787. /**
  118788. * Gets the performance counter for active particles
  118789. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118790. */
  118791. get activeParticlesPerfCounter(): PerfCounter;
  118792. /**
  118793. * Gets the total number of active bones rendered per frame
  118794. * @returns the total number of active bones rendered per frame
  118795. */
  118796. getActiveBones(): number;
  118797. /**
  118798. * Gets the performance counter for active bones
  118799. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118800. */
  118801. get activeBonesPerfCounter(): PerfCounter;
  118802. /**
  118803. * Gets the array of active meshes
  118804. * @returns an array of AbstractMesh
  118805. */
  118806. getActiveMeshes(): SmartArray<AbstractMesh>;
  118807. /**
  118808. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  118809. * @returns a number
  118810. */
  118811. getAnimationRatio(): number;
  118812. /**
  118813. * Gets an unique Id for the current render phase
  118814. * @returns a number
  118815. */
  118816. getRenderId(): number;
  118817. /**
  118818. * Gets an unique Id for the current frame
  118819. * @returns a number
  118820. */
  118821. getFrameId(): number;
  118822. /** Call this function if you want to manually increment the render Id*/
  118823. incrementRenderId(): void;
  118824. private _createUbo;
  118825. /**
  118826. * Use this method to simulate a pointer move on a mesh
  118827. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118828. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118829. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118830. * @returns the current scene
  118831. */
  118832. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  118833. /**
  118834. * Use this method to simulate a pointer down on a mesh
  118835. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118836. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118837. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118838. * @returns the current scene
  118839. */
  118840. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  118841. /**
  118842. * Use this method to simulate a pointer up on a mesh
  118843. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118844. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118845. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118846. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118847. * @returns the current scene
  118848. */
  118849. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  118850. /**
  118851. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118852. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118853. * @returns true if the pointer was captured
  118854. */
  118855. isPointerCaptured(pointerId?: number): boolean;
  118856. /**
  118857. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118858. * @param attachUp defines if you want to attach events to pointerup
  118859. * @param attachDown defines if you want to attach events to pointerdown
  118860. * @param attachMove defines if you want to attach events to pointermove
  118861. */
  118862. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  118863. /** Detaches all event handlers*/
  118864. detachControl(): void;
  118865. /**
  118866. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  118867. * Delay loaded resources are not taking in account
  118868. * @return true if all required resources are ready
  118869. */
  118870. isReady(): boolean;
  118871. /** Resets all cached information relative to material (including effect and visibility) */
  118872. resetCachedMaterial(): void;
  118873. /**
  118874. * Registers a function to be called before every frame render
  118875. * @param func defines the function to register
  118876. */
  118877. registerBeforeRender(func: () => void): void;
  118878. /**
  118879. * Unregisters a function called before every frame render
  118880. * @param func defines the function to unregister
  118881. */
  118882. unregisterBeforeRender(func: () => void): void;
  118883. /**
  118884. * Registers a function to be called after every frame render
  118885. * @param func defines the function to register
  118886. */
  118887. registerAfterRender(func: () => void): void;
  118888. /**
  118889. * Unregisters a function called after every frame render
  118890. * @param func defines the function to unregister
  118891. */
  118892. unregisterAfterRender(func: () => void): void;
  118893. private _executeOnceBeforeRender;
  118894. /**
  118895. * The provided function will run before render once and will be disposed afterwards.
  118896. * A timeout delay can be provided so that the function will be executed in N ms.
  118897. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  118898. * @param func The function to be executed.
  118899. * @param timeout optional delay in ms
  118900. */
  118901. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  118902. /** @hidden */
  118903. _addPendingData(data: any): void;
  118904. /** @hidden */
  118905. _removePendingData(data: any): void;
  118906. /**
  118907. * Returns the number of items waiting to be loaded
  118908. * @returns the number of items waiting to be loaded
  118909. */
  118910. getWaitingItemsCount(): number;
  118911. /**
  118912. * Returns a boolean indicating if the scene is still loading data
  118913. */
  118914. get isLoading(): boolean;
  118915. /**
  118916. * Registers a function to be executed when the scene is ready
  118917. * @param {Function} func - the function to be executed
  118918. */
  118919. executeWhenReady(func: () => void): void;
  118920. /**
  118921. * Returns a promise that resolves when the scene is ready
  118922. * @returns A promise that resolves when the scene is ready
  118923. */
  118924. whenReadyAsync(): Promise<void>;
  118925. /** @hidden */
  118926. _checkIsReady(): void;
  118927. /**
  118928. * Gets all animatable attached to the scene
  118929. */
  118930. get animatables(): Animatable[];
  118931. /**
  118932. * Resets the last animation time frame.
  118933. * Useful to override when animations start running when loading a scene for the first time.
  118934. */
  118935. resetLastAnimationTimeFrame(): void;
  118936. /**
  118937. * Gets the current view matrix
  118938. * @returns a Matrix
  118939. */
  118940. getViewMatrix(): Matrix;
  118941. /**
  118942. * Gets the current projection matrix
  118943. * @returns a Matrix
  118944. */
  118945. getProjectionMatrix(): Matrix;
  118946. /**
  118947. * Gets the current transform matrix
  118948. * @returns a Matrix made of View * Projection
  118949. */
  118950. getTransformMatrix(): Matrix;
  118951. /**
  118952. * Sets the current transform matrix
  118953. * @param viewL defines the View matrix to use
  118954. * @param projectionL defines the Projection matrix to use
  118955. * @param viewR defines the right View matrix to use (if provided)
  118956. * @param projectionR defines the right Projection matrix to use (if provided)
  118957. */
  118958. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  118959. /**
  118960. * Gets the uniform buffer used to store scene data
  118961. * @returns a UniformBuffer
  118962. */
  118963. getSceneUniformBuffer(): UniformBuffer;
  118964. /**
  118965. * Gets an unique (relatively to the current scene) Id
  118966. * @returns an unique number for the scene
  118967. */
  118968. getUniqueId(): number;
  118969. /**
  118970. * Add a mesh to the list of scene's meshes
  118971. * @param newMesh defines the mesh to add
  118972. * @param recursive if all child meshes should also be added to the scene
  118973. */
  118974. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  118975. /**
  118976. * Remove a mesh for the list of scene's meshes
  118977. * @param toRemove defines the mesh to remove
  118978. * @param recursive if all child meshes should also be removed from the scene
  118979. * @returns the index where the mesh was in the mesh list
  118980. */
  118981. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  118982. /**
  118983. * Add a transform node to the list of scene's transform nodes
  118984. * @param newTransformNode defines the transform node to add
  118985. */
  118986. addTransformNode(newTransformNode: TransformNode): void;
  118987. /**
  118988. * Remove a transform node for the list of scene's transform nodes
  118989. * @param toRemove defines the transform node to remove
  118990. * @returns the index where the transform node was in the transform node list
  118991. */
  118992. removeTransformNode(toRemove: TransformNode): number;
  118993. /**
  118994. * Remove a skeleton for the list of scene's skeletons
  118995. * @param toRemove defines the skeleton to remove
  118996. * @returns the index where the skeleton was in the skeleton list
  118997. */
  118998. removeSkeleton(toRemove: Skeleton): number;
  118999. /**
  119000. * Remove a morph target for the list of scene's morph targets
  119001. * @param toRemove defines the morph target to remove
  119002. * @returns the index where the morph target was in the morph target list
  119003. */
  119004. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  119005. /**
  119006. * Remove a light for the list of scene's lights
  119007. * @param toRemove defines the light to remove
  119008. * @returns the index where the light was in the light list
  119009. */
  119010. removeLight(toRemove: Light): number;
  119011. /**
  119012. * Remove a camera for the list of scene's cameras
  119013. * @param toRemove defines the camera to remove
  119014. * @returns the index where the camera was in the camera list
  119015. */
  119016. removeCamera(toRemove: Camera): number;
  119017. /**
  119018. * Remove a particle system for the list of scene's particle systems
  119019. * @param toRemove defines the particle system to remove
  119020. * @returns the index where the particle system was in the particle system list
  119021. */
  119022. removeParticleSystem(toRemove: IParticleSystem): number;
  119023. /**
  119024. * Remove a animation for the list of scene's animations
  119025. * @param toRemove defines the animation to remove
  119026. * @returns the index where the animation was in the animation list
  119027. */
  119028. removeAnimation(toRemove: Animation): number;
  119029. /**
  119030. * Will stop the animation of the given target
  119031. * @param target - the target
  119032. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  119033. * @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)
  119034. */
  119035. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  119036. /**
  119037. * Removes the given animation group from this scene.
  119038. * @param toRemove The animation group to remove
  119039. * @returns The index of the removed animation group
  119040. */
  119041. removeAnimationGroup(toRemove: AnimationGroup): number;
  119042. /**
  119043. * Removes the given multi-material from this scene.
  119044. * @param toRemove The multi-material to remove
  119045. * @returns The index of the removed multi-material
  119046. */
  119047. removeMultiMaterial(toRemove: MultiMaterial): number;
  119048. /**
  119049. * Removes the given material from this scene.
  119050. * @param toRemove The material to remove
  119051. * @returns The index of the removed material
  119052. */
  119053. removeMaterial(toRemove: Material): number;
  119054. /**
  119055. * Removes the given action manager from this scene.
  119056. * @param toRemove The action manager to remove
  119057. * @returns The index of the removed action manager
  119058. */
  119059. removeActionManager(toRemove: AbstractActionManager): number;
  119060. /**
  119061. * Removes the given texture from this scene.
  119062. * @param toRemove The texture to remove
  119063. * @returns The index of the removed texture
  119064. */
  119065. removeTexture(toRemove: BaseTexture): number;
  119066. /**
  119067. * Adds the given light to this scene
  119068. * @param newLight The light to add
  119069. */
  119070. addLight(newLight: Light): void;
  119071. /**
  119072. * Sorts the list list based on light priorities
  119073. */
  119074. sortLightsByPriority(): void;
  119075. /**
  119076. * Adds the given camera to this scene
  119077. * @param newCamera The camera to add
  119078. */
  119079. addCamera(newCamera: Camera): void;
  119080. /**
  119081. * Adds the given skeleton to this scene
  119082. * @param newSkeleton The skeleton to add
  119083. */
  119084. addSkeleton(newSkeleton: Skeleton): void;
  119085. /**
  119086. * Adds the given particle system to this scene
  119087. * @param newParticleSystem The particle system to add
  119088. */
  119089. addParticleSystem(newParticleSystem: IParticleSystem): void;
  119090. /**
  119091. * Adds the given animation to this scene
  119092. * @param newAnimation The animation to add
  119093. */
  119094. addAnimation(newAnimation: Animation): void;
  119095. /**
  119096. * Adds the given animation group to this scene.
  119097. * @param newAnimationGroup The animation group to add
  119098. */
  119099. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  119100. /**
  119101. * Adds the given multi-material to this scene
  119102. * @param newMultiMaterial The multi-material to add
  119103. */
  119104. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  119105. /**
  119106. * Adds the given material to this scene
  119107. * @param newMaterial The material to add
  119108. */
  119109. addMaterial(newMaterial: Material): void;
  119110. /**
  119111. * Adds the given morph target to this scene
  119112. * @param newMorphTargetManager The morph target to add
  119113. */
  119114. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  119115. /**
  119116. * Adds the given geometry to this scene
  119117. * @param newGeometry The geometry to add
  119118. */
  119119. addGeometry(newGeometry: Geometry): void;
  119120. /**
  119121. * Adds the given action manager to this scene
  119122. * @param newActionManager The action manager to add
  119123. */
  119124. addActionManager(newActionManager: AbstractActionManager): void;
  119125. /**
  119126. * Adds the given texture to this scene.
  119127. * @param newTexture The texture to add
  119128. */
  119129. addTexture(newTexture: BaseTexture): void;
  119130. /**
  119131. * Switch active camera
  119132. * @param newCamera defines the new active camera
  119133. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  119134. */
  119135. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  119136. /**
  119137. * sets the active camera of the scene using its ID
  119138. * @param id defines the camera's ID
  119139. * @return the new active camera or null if none found.
  119140. */
  119141. setActiveCameraByID(id: string): Nullable<Camera>;
  119142. /**
  119143. * sets the active camera of the scene using its name
  119144. * @param name defines the camera's name
  119145. * @returns the new active camera or null if none found.
  119146. */
  119147. setActiveCameraByName(name: string): Nullable<Camera>;
  119148. /**
  119149. * get an animation group using its name
  119150. * @param name defines the material's name
  119151. * @return the animation group or null if none found.
  119152. */
  119153. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  119154. /**
  119155. * Get a material using its unique id
  119156. * @param uniqueId defines the material's unique id
  119157. * @return the material or null if none found.
  119158. */
  119159. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  119160. /**
  119161. * get a material using its id
  119162. * @param id defines the material's ID
  119163. * @return the material or null if none found.
  119164. */
  119165. getMaterialByID(id: string): Nullable<Material>;
  119166. /**
  119167. * Gets a the last added material using a given id
  119168. * @param id defines the material's ID
  119169. * @return the last material with the given id or null if none found.
  119170. */
  119171. getLastMaterialByID(id: string): Nullable<Material>;
  119172. /**
  119173. * Gets a material using its name
  119174. * @param name defines the material's name
  119175. * @return the material or null if none found.
  119176. */
  119177. getMaterialByName(name: string): Nullable<Material>;
  119178. /**
  119179. * Get a texture using its unique id
  119180. * @param uniqueId defines the texture's unique id
  119181. * @return the texture or null if none found.
  119182. */
  119183. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  119184. /**
  119185. * Gets a camera using its id
  119186. * @param id defines the id to look for
  119187. * @returns the camera or null if not found
  119188. */
  119189. getCameraByID(id: string): Nullable<Camera>;
  119190. /**
  119191. * Gets a camera using its unique id
  119192. * @param uniqueId defines the unique id to look for
  119193. * @returns the camera or null if not found
  119194. */
  119195. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  119196. /**
  119197. * Gets a camera using its name
  119198. * @param name defines the camera's name
  119199. * @return the camera or null if none found.
  119200. */
  119201. getCameraByName(name: string): Nullable<Camera>;
  119202. /**
  119203. * Gets a bone using its id
  119204. * @param id defines the bone's id
  119205. * @return the bone or null if not found
  119206. */
  119207. getBoneByID(id: string): Nullable<Bone>;
  119208. /**
  119209. * Gets a bone using its id
  119210. * @param name defines the bone's name
  119211. * @return the bone or null if not found
  119212. */
  119213. getBoneByName(name: string): Nullable<Bone>;
  119214. /**
  119215. * Gets a light node using its name
  119216. * @param name defines the the light's name
  119217. * @return the light or null if none found.
  119218. */
  119219. getLightByName(name: string): Nullable<Light>;
  119220. /**
  119221. * Gets a light node using its id
  119222. * @param id defines the light's id
  119223. * @return the light or null if none found.
  119224. */
  119225. getLightByID(id: string): Nullable<Light>;
  119226. /**
  119227. * Gets a light node using its scene-generated unique ID
  119228. * @param uniqueId defines the light's unique id
  119229. * @return the light or null if none found.
  119230. */
  119231. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  119232. /**
  119233. * Gets a particle system by id
  119234. * @param id defines the particle system id
  119235. * @return the corresponding system or null if none found
  119236. */
  119237. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  119238. /**
  119239. * Gets a geometry using its ID
  119240. * @param id defines the geometry's id
  119241. * @return the geometry or null if none found.
  119242. */
  119243. getGeometryByID(id: string): Nullable<Geometry>;
  119244. private _getGeometryByUniqueID;
  119245. /**
  119246. * Add a new geometry to this scene
  119247. * @param geometry defines the geometry to be added to the scene.
  119248. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  119249. * @return a boolean defining if the geometry was added or not
  119250. */
  119251. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  119252. /**
  119253. * Removes an existing geometry
  119254. * @param geometry defines the geometry to be removed from the scene
  119255. * @return a boolean defining if the geometry was removed or not
  119256. */
  119257. removeGeometry(geometry: Geometry): boolean;
  119258. /**
  119259. * Gets the list of geometries attached to the scene
  119260. * @returns an array of Geometry
  119261. */
  119262. getGeometries(): Geometry[];
  119263. /**
  119264. * Gets the first added mesh found of a given ID
  119265. * @param id defines the id to search for
  119266. * @return the mesh found or null if not found at all
  119267. */
  119268. getMeshByID(id: string): Nullable<AbstractMesh>;
  119269. /**
  119270. * Gets a list of meshes using their id
  119271. * @param id defines the id to search for
  119272. * @returns a list of meshes
  119273. */
  119274. getMeshesByID(id: string): Array<AbstractMesh>;
  119275. /**
  119276. * Gets the first added transform node found of a given ID
  119277. * @param id defines the id to search for
  119278. * @return the found transform node or null if not found at all.
  119279. */
  119280. getTransformNodeByID(id: string): Nullable<TransformNode>;
  119281. /**
  119282. * Gets a transform node with its auto-generated unique id
  119283. * @param uniqueId efines the unique id to search for
  119284. * @return the found transform node or null if not found at all.
  119285. */
  119286. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  119287. /**
  119288. * Gets a list of transform nodes using their id
  119289. * @param id defines the id to search for
  119290. * @returns a list of transform nodes
  119291. */
  119292. getTransformNodesByID(id: string): Array<TransformNode>;
  119293. /**
  119294. * Gets a mesh with its auto-generated unique id
  119295. * @param uniqueId defines the unique id to search for
  119296. * @return the found mesh or null if not found at all.
  119297. */
  119298. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  119299. /**
  119300. * Gets a the last added mesh using a given id
  119301. * @param id defines the id to search for
  119302. * @return the found mesh or null if not found at all.
  119303. */
  119304. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  119305. /**
  119306. * Gets a the last added node (Mesh, Camera, Light) using a given id
  119307. * @param id defines the id to search for
  119308. * @return the found node or null if not found at all
  119309. */
  119310. getLastEntryByID(id: string): Nullable<Node>;
  119311. /**
  119312. * Gets a node (Mesh, Camera, Light) using a given id
  119313. * @param id defines the id to search for
  119314. * @return the found node or null if not found at all
  119315. */
  119316. getNodeByID(id: string): Nullable<Node>;
  119317. /**
  119318. * Gets a node (Mesh, Camera, Light) using a given name
  119319. * @param name defines the name to search for
  119320. * @return the found node or null if not found at all.
  119321. */
  119322. getNodeByName(name: string): Nullable<Node>;
  119323. /**
  119324. * Gets a mesh using a given name
  119325. * @param name defines the name to search for
  119326. * @return the found mesh or null if not found at all.
  119327. */
  119328. getMeshByName(name: string): Nullable<AbstractMesh>;
  119329. /**
  119330. * Gets a transform node using a given name
  119331. * @param name defines the name to search for
  119332. * @return the found transform node or null if not found at all.
  119333. */
  119334. getTransformNodeByName(name: string): Nullable<TransformNode>;
  119335. /**
  119336. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  119337. * @param id defines the id to search for
  119338. * @return the found skeleton or null if not found at all.
  119339. */
  119340. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  119341. /**
  119342. * Gets a skeleton using a given auto generated unique id
  119343. * @param uniqueId defines the unique id to search for
  119344. * @return the found skeleton or null if not found at all.
  119345. */
  119346. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  119347. /**
  119348. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  119349. * @param id defines the id to search for
  119350. * @return the found skeleton or null if not found at all.
  119351. */
  119352. getSkeletonById(id: string): Nullable<Skeleton>;
  119353. /**
  119354. * Gets a skeleton using a given name
  119355. * @param name defines the name to search for
  119356. * @return the found skeleton or null if not found at all.
  119357. */
  119358. getSkeletonByName(name: string): Nullable<Skeleton>;
  119359. /**
  119360. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  119361. * @param id defines the id to search for
  119362. * @return the found morph target manager or null if not found at all.
  119363. */
  119364. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  119365. /**
  119366. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  119367. * @param id defines the id to search for
  119368. * @return the found morph target or null if not found at all.
  119369. */
  119370. getMorphTargetById(id: string): Nullable<MorphTarget>;
  119371. /**
  119372. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  119373. * @param name defines the name to search for
  119374. * @return the found morph target or null if not found at all.
  119375. */
  119376. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  119377. /**
  119378. * Gets a boolean indicating if the given mesh is active
  119379. * @param mesh defines the mesh to look for
  119380. * @returns true if the mesh is in the active list
  119381. */
  119382. isActiveMesh(mesh: AbstractMesh): boolean;
  119383. /**
  119384. * Return a unique id as a string which can serve as an identifier for the scene
  119385. */
  119386. get uid(): string;
  119387. /**
  119388. * Add an externaly attached data from its key.
  119389. * This method call will fail and return false, if such key already exists.
  119390. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  119391. * @param key the unique key that identifies the data
  119392. * @param data the data object to associate to the key for this Engine instance
  119393. * @return true if no such key were already present and the data was added successfully, false otherwise
  119394. */
  119395. addExternalData<T>(key: string, data: T): boolean;
  119396. /**
  119397. * Get an externaly attached data from its key
  119398. * @param key the unique key that identifies the data
  119399. * @return the associated data, if present (can be null), or undefined if not present
  119400. */
  119401. getExternalData<T>(key: string): Nullable<T>;
  119402. /**
  119403. * Get an externaly attached data from its key, create it using a factory if it's not already present
  119404. * @param key the unique key that identifies the data
  119405. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  119406. * @return the associated data, can be null if the factory returned null.
  119407. */
  119408. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  119409. /**
  119410. * Remove an externaly attached data from the Engine instance
  119411. * @param key the unique key that identifies the data
  119412. * @return true if the data was successfully removed, false if it doesn't exist
  119413. */
  119414. removeExternalData(key: string): boolean;
  119415. private _evaluateSubMesh;
  119416. /**
  119417. * Clear the processed materials smart array preventing retention point in material dispose.
  119418. */
  119419. freeProcessedMaterials(): void;
  119420. private _preventFreeActiveMeshesAndRenderingGroups;
  119421. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  119422. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  119423. * when disposing several meshes in a row or a hierarchy of meshes.
  119424. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  119425. */
  119426. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  119427. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  119428. /**
  119429. * Clear the active meshes smart array preventing retention point in mesh dispose.
  119430. */
  119431. freeActiveMeshes(): void;
  119432. /**
  119433. * Clear the info related to rendering groups preventing retention points during dispose.
  119434. */
  119435. freeRenderingGroups(): void;
  119436. /** @hidden */
  119437. _isInIntermediateRendering(): boolean;
  119438. /**
  119439. * Lambda returning the list of potentially active meshes.
  119440. */
  119441. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  119442. /**
  119443. * Lambda returning the list of potentially active sub meshes.
  119444. */
  119445. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  119446. /**
  119447. * Lambda returning the list of potentially intersecting sub meshes.
  119448. */
  119449. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  119450. /**
  119451. * Lambda returning the list of potentially colliding sub meshes.
  119452. */
  119453. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  119454. private _activeMeshesFrozen;
  119455. private _skipEvaluateActiveMeshesCompletely;
  119456. /**
  119457. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  119458. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  119459. * @returns the current scene
  119460. */
  119461. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  119462. /**
  119463. * Use this function to restart evaluating active meshes on every frame
  119464. * @returns the current scene
  119465. */
  119466. unfreezeActiveMeshes(): Scene;
  119467. private _evaluateActiveMeshes;
  119468. private _activeMesh;
  119469. /**
  119470. * Update the transform matrix to update from the current active camera
  119471. * @param force defines a boolean used to force the update even if cache is up to date
  119472. */
  119473. updateTransformMatrix(force?: boolean): void;
  119474. private _bindFrameBuffer;
  119475. /** @hidden */
  119476. _allowPostProcessClearColor: boolean;
  119477. /** @hidden */
  119478. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  119479. private _processSubCameras;
  119480. private _checkIntersections;
  119481. /** @hidden */
  119482. _advancePhysicsEngineStep(step: number): void;
  119483. /**
  119484. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  119485. */
  119486. getDeterministicFrameTime: () => number;
  119487. /** @hidden */
  119488. _animate(): void;
  119489. /** Execute all animations (for a frame) */
  119490. animate(): void;
  119491. /**
  119492. * Render the scene
  119493. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  119494. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  119495. */
  119496. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  119497. /**
  119498. * Freeze all materials
  119499. * A frozen material will not be updatable but should be faster to render
  119500. */
  119501. freezeMaterials(): void;
  119502. /**
  119503. * Unfreeze all materials
  119504. * A frozen material will not be updatable but should be faster to render
  119505. */
  119506. unfreezeMaterials(): void;
  119507. /**
  119508. * Releases all held ressources
  119509. */
  119510. dispose(): void;
  119511. /**
  119512. * Gets if the scene is already disposed
  119513. */
  119514. get isDisposed(): boolean;
  119515. /**
  119516. * Call this function to reduce memory footprint of the scene.
  119517. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  119518. */
  119519. clearCachedVertexData(): void;
  119520. /**
  119521. * This function will remove the local cached buffer data from texture.
  119522. * It will save memory but will prevent the texture from being rebuilt
  119523. */
  119524. cleanCachedTextureBuffer(): void;
  119525. /**
  119526. * Get the world extend vectors with an optional filter
  119527. *
  119528. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  119529. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  119530. */
  119531. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  119532. min: Vector3;
  119533. max: Vector3;
  119534. };
  119535. /**
  119536. * Creates a ray that can be used to pick in the scene
  119537. * @param x defines the x coordinate of the origin (on-screen)
  119538. * @param y defines the y coordinate of the origin (on-screen)
  119539. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  119540. * @param camera defines the camera to use for the picking
  119541. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  119542. * @returns a Ray
  119543. */
  119544. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  119545. /**
  119546. * Creates a ray that can be used to pick in the scene
  119547. * @param x defines the x coordinate of the origin (on-screen)
  119548. * @param y defines the y coordinate of the origin (on-screen)
  119549. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  119550. * @param result defines the ray where to store the picking ray
  119551. * @param camera defines the camera to use for the picking
  119552. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  119553. * @returns the current scene
  119554. */
  119555. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  119556. /**
  119557. * Creates a ray that can be used to pick in the scene
  119558. * @param x defines the x coordinate of the origin (on-screen)
  119559. * @param y defines the y coordinate of the origin (on-screen)
  119560. * @param camera defines the camera to use for the picking
  119561. * @returns a Ray
  119562. */
  119563. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  119564. /**
  119565. * Creates a ray that can be used to pick in the scene
  119566. * @param x defines the x coordinate of the origin (on-screen)
  119567. * @param y defines the y coordinate of the origin (on-screen)
  119568. * @param result defines the ray where to store the picking ray
  119569. * @param camera defines the camera to use for the picking
  119570. * @returns the current scene
  119571. */
  119572. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  119573. /** Launch a ray to try to pick a mesh in the scene
  119574. * @param x position on screen
  119575. * @param y position on screen
  119576. * @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
  119577. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119578. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119579. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119580. * @returns a PickingInfo
  119581. */
  119582. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  119583. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  119584. * @param x position on screen
  119585. * @param y position on screen
  119586. * @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
  119587. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119588. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119589. * @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)
  119590. */
  119591. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  119592. /** Use the given ray to pick a mesh in the scene
  119593. * @param ray The ray to use to pick meshes
  119594. * @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
  119595. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119596. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119597. * @returns a PickingInfo
  119598. */
  119599. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  119600. /**
  119601. * Launch a ray to try to pick a mesh in the scene
  119602. * @param x X position on screen
  119603. * @param y Y position on screen
  119604. * @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
  119605. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119606. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119607. * @returns an array of PickingInfo
  119608. */
  119609. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  119610. /**
  119611. * Launch a ray to try to pick a mesh in the scene
  119612. * @param ray Ray to use
  119613. * @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
  119614. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119615. * @returns an array of PickingInfo
  119616. */
  119617. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  119618. /**
  119619. * Force the value of meshUnderPointer
  119620. * @param mesh defines the mesh to use
  119621. */
  119622. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  119623. /**
  119624. * Gets the mesh under the pointer
  119625. * @returns a Mesh or null if no mesh is under the pointer
  119626. */
  119627. getPointerOverMesh(): Nullable<AbstractMesh>;
  119628. /** @hidden */
  119629. _rebuildGeometries(): void;
  119630. /** @hidden */
  119631. _rebuildTextures(): void;
  119632. private _getByTags;
  119633. /**
  119634. * Get a list of meshes by tags
  119635. * @param tagsQuery defines the tags query to use
  119636. * @param forEach defines a predicate used to filter results
  119637. * @returns an array of Mesh
  119638. */
  119639. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  119640. /**
  119641. * Get a list of cameras by tags
  119642. * @param tagsQuery defines the tags query to use
  119643. * @param forEach defines a predicate used to filter results
  119644. * @returns an array of Camera
  119645. */
  119646. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  119647. /**
  119648. * Get a list of lights by tags
  119649. * @param tagsQuery defines the tags query to use
  119650. * @param forEach defines a predicate used to filter results
  119651. * @returns an array of Light
  119652. */
  119653. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  119654. /**
  119655. * Get a list of materials by tags
  119656. * @param tagsQuery defines the tags query to use
  119657. * @param forEach defines a predicate used to filter results
  119658. * @returns an array of Material
  119659. */
  119660. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  119661. /**
  119662. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  119663. * This allowed control for front to back rendering or reversly depending of the special needs.
  119664. *
  119665. * @param renderingGroupId The rendering group id corresponding to its index
  119666. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  119667. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  119668. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  119669. */
  119670. 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;
  119671. /**
  119672. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  119673. *
  119674. * @param renderingGroupId The rendering group id corresponding to its index
  119675. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  119676. * @param depth Automatically clears depth between groups if true and autoClear is true.
  119677. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  119678. */
  119679. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  119680. /**
  119681. * Gets the current auto clear configuration for one rendering group of the rendering
  119682. * manager.
  119683. * @param index the rendering group index to get the information for
  119684. * @returns The auto clear setup for the requested rendering group
  119685. */
  119686. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  119687. private _blockMaterialDirtyMechanism;
  119688. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  119689. get blockMaterialDirtyMechanism(): boolean;
  119690. set blockMaterialDirtyMechanism(value: boolean);
  119691. /**
  119692. * Will flag all materials as dirty to trigger new shader compilation
  119693. * @param flag defines the flag used to specify which material part must be marked as dirty
  119694. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  119695. */
  119696. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  119697. /** @hidden */
  119698. _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;
  119699. /** @hidden */
  119700. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  119701. /** @hidden */
  119702. _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;
  119703. /** @hidden */
  119704. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  119705. /** @hidden */
  119706. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  119707. /** @hidden */
  119708. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  119709. }
  119710. }
  119711. declare module BABYLON {
  119712. /**
  119713. * Set of assets to keep when moving a scene into an asset container.
  119714. */
  119715. export class KeepAssets extends AbstractScene {
  119716. }
  119717. /**
  119718. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  119719. */
  119720. export class InstantiatedEntries {
  119721. /**
  119722. * List of new root nodes (eg. nodes with no parent)
  119723. */
  119724. rootNodes: TransformNode[];
  119725. /**
  119726. * List of new skeletons
  119727. */
  119728. skeletons: Skeleton[];
  119729. /**
  119730. * List of new animation groups
  119731. */
  119732. animationGroups: AnimationGroup[];
  119733. }
  119734. /**
  119735. * Container with a set of assets that can be added or removed from a scene.
  119736. */
  119737. export class AssetContainer extends AbstractScene {
  119738. private _wasAddedToScene;
  119739. /**
  119740. * The scene the AssetContainer belongs to.
  119741. */
  119742. scene: Scene;
  119743. /**
  119744. * Instantiates an AssetContainer.
  119745. * @param scene The scene the AssetContainer belongs to.
  119746. */
  119747. constructor(scene: Scene);
  119748. /**
  119749. * Instantiate or clone all meshes and add the new ones to the scene.
  119750. * Skeletons and animation groups will all be cloned
  119751. * @param nameFunction defines an optional function used to get new names for clones
  119752. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  119753. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  119754. */
  119755. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  119756. /**
  119757. * Adds all the assets from the container to the scene.
  119758. */
  119759. addAllToScene(): void;
  119760. /**
  119761. * Removes all the assets in the container from the scene
  119762. */
  119763. removeAllFromScene(): void;
  119764. /**
  119765. * Disposes all the assets in the container
  119766. */
  119767. dispose(): void;
  119768. private _moveAssets;
  119769. /**
  119770. * Removes all the assets contained in the scene and adds them to the container.
  119771. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  119772. */
  119773. moveAllFromScene(keepAssets?: KeepAssets): void;
  119774. /**
  119775. * 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.
  119776. * @returns the root mesh
  119777. */
  119778. createRootMesh(): Mesh;
  119779. /**
  119780. * Merge animations (direct and animation groups) from this asset container into a scene
  119781. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  119782. * @param animatables set of animatables to retarget to a node from the scene
  119783. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  119784. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  119785. */
  119786. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  119787. }
  119788. }
  119789. declare module BABYLON {
  119790. /**
  119791. * Defines how the parser contract is defined.
  119792. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  119793. */
  119794. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  119795. /**
  119796. * Defines how the individual parser contract is defined.
  119797. * These parser can parse an individual asset
  119798. */
  119799. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  119800. /**
  119801. * Base class of the scene acting as a container for the different elements composing a scene.
  119802. * This class is dynamically extended by the different components of the scene increasing
  119803. * flexibility and reducing coupling
  119804. */
  119805. export abstract class AbstractScene {
  119806. /**
  119807. * Stores the list of available parsers in the application.
  119808. */
  119809. private static _BabylonFileParsers;
  119810. /**
  119811. * Stores the list of available individual parsers in the application.
  119812. */
  119813. private static _IndividualBabylonFileParsers;
  119814. /**
  119815. * Adds a parser in the list of available ones
  119816. * @param name Defines the name of the parser
  119817. * @param parser Defines the parser to add
  119818. */
  119819. static AddParser(name: string, parser: BabylonFileParser): void;
  119820. /**
  119821. * Gets a general parser from the list of avaialble ones
  119822. * @param name Defines the name of the parser
  119823. * @returns the requested parser or null
  119824. */
  119825. static GetParser(name: string): Nullable<BabylonFileParser>;
  119826. /**
  119827. * Adds n individual parser in the list of available ones
  119828. * @param name Defines the name of the parser
  119829. * @param parser Defines the parser to add
  119830. */
  119831. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  119832. /**
  119833. * Gets an individual parser from the list of avaialble ones
  119834. * @param name Defines the name of the parser
  119835. * @returns the requested parser or null
  119836. */
  119837. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  119838. /**
  119839. * Parser json data and populate both a scene and its associated container object
  119840. * @param jsonData Defines the data to parse
  119841. * @param scene Defines the scene to parse the data for
  119842. * @param container Defines the container attached to the parsing sequence
  119843. * @param rootUrl Defines the root url of the data
  119844. */
  119845. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  119846. /**
  119847. * Gets the list of root nodes (ie. nodes with no parent)
  119848. */
  119849. rootNodes: Node[];
  119850. /** All of the cameras added to this scene
  119851. * @see https://doc.babylonjs.com/babylon101/cameras
  119852. */
  119853. cameras: Camera[];
  119854. /**
  119855. * All of the lights added to this scene
  119856. * @see https://doc.babylonjs.com/babylon101/lights
  119857. */
  119858. lights: Light[];
  119859. /**
  119860. * All of the (abstract) meshes added to this scene
  119861. */
  119862. meshes: AbstractMesh[];
  119863. /**
  119864. * The list of skeletons added to the scene
  119865. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  119866. */
  119867. skeletons: Skeleton[];
  119868. /**
  119869. * All of the particle systems added to this scene
  119870. * @see https://doc.babylonjs.com/babylon101/particles
  119871. */
  119872. particleSystems: IParticleSystem[];
  119873. /**
  119874. * Gets a list of Animations associated with the scene
  119875. */
  119876. animations: Animation[];
  119877. /**
  119878. * All of the animation groups added to this scene
  119879. * @see https://doc.babylonjs.com/how_to/group
  119880. */
  119881. animationGroups: AnimationGroup[];
  119882. /**
  119883. * All of the multi-materials added to this scene
  119884. * @see https://doc.babylonjs.com/how_to/multi_materials
  119885. */
  119886. multiMaterials: MultiMaterial[];
  119887. /**
  119888. * All of the materials added to this scene
  119889. * In the context of a Scene, it is not supposed to be modified manually.
  119890. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  119891. * Note also that the order of the Material within the array is not significant and might change.
  119892. * @see https://doc.babylonjs.com/babylon101/materials
  119893. */
  119894. materials: Material[];
  119895. /**
  119896. * The list of morph target managers added to the scene
  119897. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  119898. */
  119899. morphTargetManagers: MorphTargetManager[];
  119900. /**
  119901. * The list of geometries used in the scene.
  119902. */
  119903. geometries: Geometry[];
  119904. /**
  119905. * All of the tranform nodes added to this scene
  119906. * In the context of a Scene, it is not supposed to be modified manually.
  119907. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  119908. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  119909. * @see https://doc.babylonjs.com/how_to/transformnode
  119910. */
  119911. transformNodes: TransformNode[];
  119912. /**
  119913. * ActionManagers available on the scene.
  119914. */
  119915. actionManagers: AbstractActionManager[];
  119916. /**
  119917. * Textures to keep.
  119918. */
  119919. textures: BaseTexture[];
  119920. /**
  119921. * Environment texture for the scene
  119922. */
  119923. environmentTexture: Nullable<BaseTexture>;
  119924. /**
  119925. * @returns all meshes, lights, cameras, transformNodes and bones
  119926. */
  119927. getNodes(): Array<Node>;
  119928. }
  119929. }
  119930. declare module BABYLON {
  119931. /**
  119932. * Interface used to define options for Sound class
  119933. */
  119934. export interface ISoundOptions {
  119935. /**
  119936. * Does the sound autoplay once loaded.
  119937. */
  119938. autoplay?: boolean;
  119939. /**
  119940. * Does the sound loop after it finishes playing once.
  119941. */
  119942. loop?: boolean;
  119943. /**
  119944. * Sound's volume
  119945. */
  119946. volume?: number;
  119947. /**
  119948. * Is it a spatial sound?
  119949. */
  119950. spatialSound?: boolean;
  119951. /**
  119952. * Maximum distance to hear that sound
  119953. */
  119954. maxDistance?: number;
  119955. /**
  119956. * Uses user defined attenuation function
  119957. */
  119958. useCustomAttenuation?: boolean;
  119959. /**
  119960. * Define the roll off factor of spatial sounds.
  119961. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119962. */
  119963. rolloffFactor?: number;
  119964. /**
  119965. * Define the reference distance the sound should be heard perfectly.
  119966. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119967. */
  119968. refDistance?: number;
  119969. /**
  119970. * Define the distance attenuation model the sound will follow.
  119971. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119972. */
  119973. distanceModel?: string;
  119974. /**
  119975. * Defines the playback speed (1 by default)
  119976. */
  119977. playbackRate?: number;
  119978. /**
  119979. * Defines if the sound is from a streaming source
  119980. */
  119981. streaming?: boolean;
  119982. /**
  119983. * Defines an optional length (in seconds) inside the sound file
  119984. */
  119985. length?: number;
  119986. /**
  119987. * Defines an optional offset (in seconds) inside the sound file
  119988. */
  119989. offset?: number;
  119990. /**
  119991. * If true, URLs will not be required to state the audio file codec to use.
  119992. */
  119993. skipCodecCheck?: boolean;
  119994. }
  119995. /**
  119996. * Defines a sound that can be played in the application.
  119997. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  119998. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  119999. */
  120000. export class Sound {
  120001. /**
  120002. * The name of the sound in the scene.
  120003. */
  120004. name: string;
  120005. /**
  120006. * Does the sound autoplay once loaded.
  120007. */
  120008. autoplay: boolean;
  120009. /**
  120010. * Does the sound loop after it finishes playing once.
  120011. */
  120012. loop: boolean;
  120013. /**
  120014. * Does the sound use a custom attenuation curve to simulate the falloff
  120015. * happening when the source gets further away from the camera.
  120016. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  120017. */
  120018. useCustomAttenuation: boolean;
  120019. /**
  120020. * The sound track id this sound belongs to.
  120021. */
  120022. soundTrackId: number;
  120023. /**
  120024. * Is this sound currently played.
  120025. */
  120026. isPlaying: boolean;
  120027. /**
  120028. * Is this sound currently paused.
  120029. */
  120030. isPaused: boolean;
  120031. /**
  120032. * Does this sound enables spatial sound.
  120033. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120034. */
  120035. spatialSound: boolean;
  120036. /**
  120037. * Define the reference distance the sound should be heard perfectly.
  120038. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120039. */
  120040. refDistance: number;
  120041. /**
  120042. * Define the roll off factor of spatial sounds.
  120043. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120044. */
  120045. rolloffFactor: number;
  120046. /**
  120047. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  120048. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120049. */
  120050. maxDistance: number;
  120051. /**
  120052. * Define the distance attenuation model the sound will follow.
  120053. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120054. */
  120055. distanceModel: string;
  120056. /**
  120057. * @hidden
  120058. * Back Compat
  120059. **/
  120060. onended: () => any;
  120061. /**
  120062. * Gets or sets an object used to store user defined information for the sound.
  120063. */
  120064. metadata: any;
  120065. /**
  120066. * Observable event when the current playing sound finishes.
  120067. */
  120068. onEndedObservable: Observable<Sound>;
  120069. private _panningModel;
  120070. private _playbackRate;
  120071. private _streaming;
  120072. private _startTime;
  120073. private _startOffset;
  120074. private _position;
  120075. /** @hidden */
  120076. _positionInEmitterSpace: boolean;
  120077. private _localDirection;
  120078. private _volume;
  120079. private _isReadyToPlay;
  120080. private _isDirectional;
  120081. private _readyToPlayCallback;
  120082. private _audioBuffer;
  120083. private _soundSource;
  120084. private _streamingSource;
  120085. private _soundPanner;
  120086. private _soundGain;
  120087. private _inputAudioNode;
  120088. private _outputAudioNode;
  120089. private _coneInnerAngle;
  120090. private _coneOuterAngle;
  120091. private _coneOuterGain;
  120092. private _scene;
  120093. private _connectedTransformNode;
  120094. private _customAttenuationFunction;
  120095. private _registerFunc;
  120096. private _isOutputConnected;
  120097. private _htmlAudioElement;
  120098. private _urlType;
  120099. private _length?;
  120100. private _offset?;
  120101. /** @hidden */
  120102. static _SceneComponentInitialization: (scene: Scene) => void;
  120103. /**
  120104. * Create a sound and attach it to a scene
  120105. * @param name Name of your sound
  120106. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  120107. * @param scene defines the scene the sound belongs to
  120108. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  120109. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  120110. */
  120111. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  120112. /**
  120113. * Release the sound and its associated resources
  120114. */
  120115. dispose(): void;
  120116. /**
  120117. * Gets if the sounds is ready to be played or not.
  120118. * @returns true if ready, otherwise false
  120119. */
  120120. isReady(): boolean;
  120121. private _soundLoaded;
  120122. /**
  120123. * Sets the data of the sound from an audiobuffer
  120124. * @param audioBuffer The audioBuffer containing the data
  120125. */
  120126. setAudioBuffer(audioBuffer: AudioBuffer): void;
  120127. /**
  120128. * Updates the current sounds options such as maxdistance, loop...
  120129. * @param options A JSON object containing values named as the object properties
  120130. */
  120131. updateOptions(options: ISoundOptions): void;
  120132. private _createSpatialParameters;
  120133. private _updateSpatialParameters;
  120134. /**
  120135. * Switch the panning model to HRTF:
  120136. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  120137. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120138. */
  120139. switchPanningModelToHRTF(): void;
  120140. /**
  120141. * Switch the panning model to Equal Power:
  120142. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  120143. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120144. */
  120145. switchPanningModelToEqualPower(): void;
  120146. private _switchPanningModel;
  120147. /**
  120148. * Connect this sound to a sound track audio node like gain...
  120149. * @param soundTrackAudioNode the sound track audio node to connect to
  120150. */
  120151. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  120152. /**
  120153. * Transform this sound into a directional source
  120154. * @param coneInnerAngle Size of the inner cone in degree
  120155. * @param coneOuterAngle Size of the outer cone in degree
  120156. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  120157. */
  120158. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  120159. /**
  120160. * Gets or sets the inner angle for the directional cone.
  120161. */
  120162. get directionalConeInnerAngle(): number;
  120163. /**
  120164. * Gets or sets the inner angle for the directional cone.
  120165. */
  120166. set directionalConeInnerAngle(value: number);
  120167. /**
  120168. * Gets or sets the outer angle for the directional cone.
  120169. */
  120170. get directionalConeOuterAngle(): number;
  120171. /**
  120172. * Gets or sets the outer angle for the directional cone.
  120173. */
  120174. set directionalConeOuterAngle(value: number);
  120175. /**
  120176. * Sets the position of the emitter if spatial sound is enabled
  120177. * @param newPosition Defines the new posisiton
  120178. */
  120179. setPosition(newPosition: Vector3): void;
  120180. /**
  120181. * Sets the local direction of the emitter if spatial sound is enabled
  120182. * @param newLocalDirection Defines the new local direction
  120183. */
  120184. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  120185. private _updateDirection;
  120186. /** @hidden */
  120187. updateDistanceFromListener(): void;
  120188. /**
  120189. * Sets a new custom attenuation function for the sound.
  120190. * @param callback Defines the function used for the attenuation
  120191. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  120192. */
  120193. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  120194. /**
  120195. * Play the sound
  120196. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  120197. * @param offset (optional) Start the sound at a specific time in seconds
  120198. * @param length (optional) Sound duration (in seconds)
  120199. */
  120200. play(time?: number, offset?: number, length?: number): void;
  120201. private _onended;
  120202. /**
  120203. * Stop the sound
  120204. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  120205. */
  120206. stop(time?: number): void;
  120207. /**
  120208. * Put the sound in pause
  120209. */
  120210. pause(): void;
  120211. /**
  120212. * Sets a dedicated volume for this sounds
  120213. * @param newVolume Define the new volume of the sound
  120214. * @param time Define time for gradual change to new volume
  120215. */
  120216. setVolume(newVolume: number, time?: number): void;
  120217. /**
  120218. * Set the sound play back rate
  120219. * @param newPlaybackRate Define the playback rate the sound should be played at
  120220. */
  120221. setPlaybackRate(newPlaybackRate: number): void;
  120222. /**
  120223. * Gets the volume of the sound.
  120224. * @returns the volume of the sound
  120225. */
  120226. getVolume(): number;
  120227. /**
  120228. * Attach the sound to a dedicated mesh
  120229. * @param transformNode The transform node to connect the sound with
  120230. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  120231. */
  120232. attachToMesh(transformNode: TransformNode): void;
  120233. /**
  120234. * Detach the sound from the previously attached mesh
  120235. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  120236. */
  120237. detachFromMesh(): void;
  120238. private _onRegisterAfterWorldMatrixUpdate;
  120239. /**
  120240. * Clone the current sound in the scene.
  120241. * @returns the new sound clone
  120242. */
  120243. clone(): Nullable<Sound>;
  120244. /**
  120245. * Gets the current underlying audio buffer containing the data
  120246. * @returns the audio buffer
  120247. */
  120248. getAudioBuffer(): Nullable<AudioBuffer>;
  120249. /**
  120250. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  120251. * @returns the source node
  120252. */
  120253. getSoundSource(): Nullable<AudioBufferSourceNode>;
  120254. /**
  120255. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  120256. * @returns the gain node
  120257. */
  120258. getSoundGain(): Nullable<GainNode>;
  120259. /**
  120260. * Serializes the Sound in a JSON representation
  120261. * @returns the JSON representation of the sound
  120262. */
  120263. serialize(): any;
  120264. /**
  120265. * Parse a JSON representation of a sound to innstantiate in a given scene
  120266. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  120267. * @param scene Define the scene the new parsed sound should be created in
  120268. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  120269. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  120270. * @returns the newly parsed sound
  120271. */
  120272. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  120273. }
  120274. }
  120275. declare module BABYLON {
  120276. /**
  120277. * This defines an action helpful to play a defined sound on a triggered action.
  120278. */
  120279. export class PlaySoundAction extends Action {
  120280. private _sound;
  120281. /**
  120282. * Instantiate the action
  120283. * @param triggerOptions defines the trigger options
  120284. * @param sound defines the sound to play
  120285. * @param condition defines the trigger related conditions
  120286. */
  120287. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  120288. /** @hidden */
  120289. _prepare(): void;
  120290. /**
  120291. * Execute the action and play the sound.
  120292. */
  120293. execute(): void;
  120294. /**
  120295. * Serializes the actions and its related information.
  120296. * @param parent defines the object to serialize in
  120297. * @returns the serialized object
  120298. */
  120299. serialize(parent: any): any;
  120300. }
  120301. /**
  120302. * This defines an action helpful to stop a defined sound on a triggered action.
  120303. */
  120304. export class StopSoundAction extends Action {
  120305. private _sound;
  120306. /**
  120307. * Instantiate the action
  120308. * @param triggerOptions defines the trigger options
  120309. * @param sound defines the sound to stop
  120310. * @param condition defines the trigger related conditions
  120311. */
  120312. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  120313. /** @hidden */
  120314. _prepare(): void;
  120315. /**
  120316. * Execute the action and stop the sound.
  120317. */
  120318. execute(): void;
  120319. /**
  120320. * Serializes the actions and its related information.
  120321. * @param parent defines the object to serialize in
  120322. * @returns the serialized object
  120323. */
  120324. serialize(parent: any): any;
  120325. }
  120326. }
  120327. declare module BABYLON {
  120328. /**
  120329. * This defines an action responsible to change the value of a property
  120330. * by interpolating between its current value and the newly set one once triggered.
  120331. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  120332. */
  120333. export class InterpolateValueAction extends Action {
  120334. /**
  120335. * Defines the path of the property where the value should be interpolated
  120336. */
  120337. propertyPath: string;
  120338. /**
  120339. * Defines the target value at the end of the interpolation.
  120340. */
  120341. value: any;
  120342. /**
  120343. * Defines the time it will take for the property to interpolate to the value.
  120344. */
  120345. duration: number;
  120346. /**
  120347. * Defines if the other scene animations should be stopped when the action has been triggered
  120348. */
  120349. stopOtherAnimations?: boolean;
  120350. /**
  120351. * Defines a callback raised once the interpolation animation has been done.
  120352. */
  120353. onInterpolationDone?: () => void;
  120354. /**
  120355. * Observable triggered once the interpolation animation has been done.
  120356. */
  120357. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  120358. private _target;
  120359. private _effectiveTarget;
  120360. private _property;
  120361. /**
  120362. * Instantiate the action
  120363. * @param triggerOptions defines the trigger options
  120364. * @param target defines the object containing the value to interpolate
  120365. * @param propertyPath defines the path to the property in the target object
  120366. * @param value defines the target value at the end of the interpolation
  120367. * @param duration deines the time it will take for the property to interpolate to the value.
  120368. * @param condition defines the trigger related conditions
  120369. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  120370. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  120371. */
  120372. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  120373. /** @hidden */
  120374. _prepare(): void;
  120375. /**
  120376. * Execute the action starts the value interpolation.
  120377. */
  120378. execute(): void;
  120379. /**
  120380. * Serializes the actions and its related information.
  120381. * @param parent defines the object to serialize in
  120382. * @returns the serialized object
  120383. */
  120384. serialize(parent: any): any;
  120385. }
  120386. }
  120387. declare module BABYLON {
  120388. /**
  120389. * Options allowed during the creation of a sound track.
  120390. */
  120391. export interface ISoundTrackOptions {
  120392. /**
  120393. * The volume the sound track should take during creation
  120394. */
  120395. volume?: number;
  120396. /**
  120397. * Define if the sound track is the main sound track of the scene
  120398. */
  120399. mainTrack?: boolean;
  120400. }
  120401. /**
  120402. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  120403. * It will be also used in a future release to apply effects on a specific track.
  120404. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  120405. */
  120406. export class SoundTrack {
  120407. /**
  120408. * The unique identifier of the sound track in the scene.
  120409. */
  120410. id: number;
  120411. /**
  120412. * The list of sounds included in the sound track.
  120413. */
  120414. soundCollection: Array<Sound>;
  120415. private _outputAudioNode;
  120416. private _scene;
  120417. private _connectedAnalyser;
  120418. private _options;
  120419. private _isInitialized;
  120420. /**
  120421. * Creates a new sound track.
  120422. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  120423. * @param scene Define the scene the sound track belongs to
  120424. * @param options
  120425. */
  120426. constructor(scene: Scene, options?: ISoundTrackOptions);
  120427. private _initializeSoundTrackAudioGraph;
  120428. /**
  120429. * Release the sound track and its associated resources
  120430. */
  120431. dispose(): void;
  120432. /**
  120433. * Adds a sound to this sound track
  120434. * @param sound define the cound to add
  120435. * @ignoreNaming
  120436. */
  120437. AddSound(sound: Sound): void;
  120438. /**
  120439. * Removes a sound to this sound track
  120440. * @param sound define the cound to remove
  120441. * @ignoreNaming
  120442. */
  120443. RemoveSound(sound: Sound): void;
  120444. /**
  120445. * Set a global volume for the full sound track.
  120446. * @param newVolume Define the new volume of the sound track
  120447. */
  120448. setVolume(newVolume: number): void;
  120449. /**
  120450. * Switch the panning model to HRTF:
  120451. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  120452. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120453. */
  120454. switchPanningModelToHRTF(): void;
  120455. /**
  120456. * Switch the panning model to Equal Power:
  120457. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  120458. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120459. */
  120460. switchPanningModelToEqualPower(): void;
  120461. /**
  120462. * Connect the sound track to an audio analyser allowing some amazing
  120463. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  120464. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  120465. * @param analyser The analyser to connect to the engine
  120466. */
  120467. connectToAnalyser(analyser: Analyser): void;
  120468. }
  120469. }
  120470. declare module BABYLON {
  120471. interface AbstractScene {
  120472. /**
  120473. * The list of sounds used in the scene.
  120474. */
  120475. sounds: Nullable<Array<Sound>>;
  120476. }
  120477. interface Scene {
  120478. /**
  120479. * @hidden
  120480. * Backing field
  120481. */
  120482. _mainSoundTrack: SoundTrack;
  120483. /**
  120484. * The main sound track played by the scene.
  120485. * It cotains your primary collection of sounds.
  120486. */
  120487. mainSoundTrack: SoundTrack;
  120488. /**
  120489. * The list of sound tracks added to the scene
  120490. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120491. */
  120492. soundTracks: Nullable<Array<SoundTrack>>;
  120493. /**
  120494. * Gets a sound using a given name
  120495. * @param name defines the name to search for
  120496. * @return the found sound or null if not found at all.
  120497. */
  120498. getSoundByName(name: string): Nullable<Sound>;
  120499. /**
  120500. * Gets or sets if audio support is enabled
  120501. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120502. */
  120503. audioEnabled: boolean;
  120504. /**
  120505. * Gets or sets if audio will be output to headphones
  120506. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120507. */
  120508. headphone: boolean;
  120509. /**
  120510. * Gets or sets custom audio listener position provider
  120511. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120512. */
  120513. audioListenerPositionProvider: Nullable<() => Vector3>;
  120514. /**
  120515. * Gets or sets a refresh rate when using 3D audio positioning
  120516. */
  120517. audioPositioningRefreshRate: number;
  120518. }
  120519. /**
  120520. * Defines the sound scene component responsible to manage any sounds
  120521. * in a given scene.
  120522. */
  120523. export class AudioSceneComponent implements ISceneSerializableComponent {
  120524. /**
  120525. * The component name helpfull to identify the component in the list of scene components.
  120526. */
  120527. readonly name: string;
  120528. /**
  120529. * The scene the component belongs to.
  120530. */
  120531. scene: Scene;
  120532. private _audioEnabled;
  120533. /**
  120534. * Gets whether audio is enabled or not.
  120535. * Please use related enable/disable method to switch state.
  120536. */
  120537. get audioEnabled(): boolean;
  120538. private _headphone;
  120539. /**
  120540. * Gets whether audio is outputing to headphone or not.
  120541. * Please use the according Switch methods to change output.
  120542. */
  120543. get headphone(): boolean;
  120544. /**
  120545. * Gets or sets a refresh rate when using 3D audio positioning
  120546. */
  120547. audioPositioningRefreshRate: number;
  120548. private _audioListenerPositionProvider;
  120549. /**
  120550. * Gets the current audio listener position provider
  120551. */
  120552. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  120553. /**
  120554. * Sets a custom listener position for all sounds in the scene
  120555. * By default, this is the position of the first active camera
  120556. */
  120557. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  120558. /**
  120559. * Creates a new instance of the component for the given scene
  120560. * @param scene Defines the scene to register the component in
  120561. */
  120562. constructor(scene: Scene);
  120563. /**
  120564. * Registers the component in a given scene
  120565. */
  120566. register(): void;
  120567. /**
  120568. * Rebuilds the elements related to this component in case of
  120569. * context lost for instance.
  120570. */
  120571. rebuild(): void;
  120572. /**
  120573. * Serializes the component data to the specified json object
  120574. * @param serializationObject The object to serialize to
  120575. */
  120576. serialize(serializationObject: any): void;
  120577. /**
  120578. * Adds all the elements from the container to the scene
  120579. * @param container the container holding the elements
  120580. */
  120581. addFromContainer(container: AbstractScene): void;
  120582. /**
  120583. * Removes all the elements in the container from the scene
  120584. * @param container contains the elements to remove
  120585. * @param dispose if the removed element should be disposed (default: false)
  120586. */
  120587. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  120588. /**
  120589. * Disposes the component and the associated ressources.
  120590. */
  120591. dispose(): void;
  120592. /**
  120593. * Disables audio in the associated scene.
  120594. */
  120595. disableAudio(): void;
  120596. /**
  120597. * Enables audio in the associated scene.
  120598. */
  120599. enableAudio(): void;
  120600. /**
  120601. * Switch audio to headphone output.
  120602. */
  120603. switchAudioModeForHeadphones(): void;
  120604. /**
  120605. * Switch audio to normal speakers.
  120606. */
  120607. switchAudioModeForNormalSpeakers(): void;
  120608. private _cachedCameraDirection;
  120609. private _cachedCameraPosition;
  120610. private _lastCheck;
  120611. private _afterRender;
  120612. }
  120613. }
  120614. declare module BABYLON {
  120615. /**
  120616. * Wraps one or more Sound objects and selects one with random weight for playback.
  120617. */
  120618. export class WeightedSound {
  120619. /** When true a Sound will be selected and played when the current playing Sound completes. */
  120620. loop: boolean;
  120621. private _coneInnerAngle;
  120622. private _coneOuterAngle;
  120623. private _volume;
  120624. /** A Sound is currently playing. */
  120625. isPlaying: boolean;
  120626. /** A Sound is currently paused. */
  120627. isPaused: boolean;
  120628. private _sounds;
  120629. private _weights;
  120630. private _currentIndex?;
  120631. /**
  120632. * Creates a new WeightedSound from the list of sounds given.
  120633. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  120634. * @param sounds Array of Sounds that will be selected from.
  120635. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  120636. */
  120637. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  120638. /**
  120639. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  120640. */
  120641. get directionalConeInnerAngle(): number;
  120642. /**
  120643. * The size of cone in degress for a directional sound in which there will be no attenuation.
  120644. */
  120645. set directionalConeInnerAngle(value: number);
  120646. /**
  120647. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  120648. * Listener angles between innerAngle and outerAngle will falloff linearly.
  120649. */
  120650. get directionalConeOuterAngle(): number;
  120651. /**
  120652. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  120653. * Listener angles between innerAngle and outerAngle will falloff linearly.
  120654. */
  120655. set directionalConeOuterAngle(value: number);
  120656. /**
  120657. * Playback volume.
  120658. */
  120659. get volume(): number;
  120660. /**
  120661. * Playback volume.
  120662. */
  120663. set volume(value: number);
  120664. private _onended;
  120665. /**
  120666. * Suspend playback
  120667. */
  120668. pause(): void;
  120669. /**
  120670. * Stop playback
  120671. */
  120672. stop(): void;
  120673. /**
  120674. * Start playback.
  120675. * @param startOffset Position the clip head at a specific time in seconds.
  120676. */
  120677. play(startOffset?: number): void;
  120678. }
  120679. }
  120680. declare module BABYLON {
  120681. /**
  120682. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  120683. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  120684. */
  120685. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  120686. /**
  120687. * Gets the name of the behavior.
  120688. */
  120689. get name(): string;
  120690. /**
  120691. * The easing function used by animations
  120692. */
  120693. static EasingFunction: BackEase;
  120694. /**
  120695. * The easing mode used by animations
  120696. */
  120697. static EasingMode: number;
  120698. /**
  120699. * The duration of the animation, in milliseconds
  120700. */
  120701. transitionDuration: number;
  120702. /**
  120703. * Length of the distance animated by the transition when lower radius is reached
  120704. */
  120705. lowerRadiusTransitionRange: number;
  120706. /**
  120707. * Length of the distance animated by the transition when upper radius is reached
  120708. */
  120709. upperRadiusTransitionRange: number;
  120710. private _autoTransitionRange;
  120711. /**
  120712. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  120713. */
  120714. get autoTransitionRange(): boolean;
  120715. /**
  120716. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  120717. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  120718. */
  120719. set autoTransitionRange(value: boolean);
  120720. private _attachedCamera;
  120721. private _onAfterCheckInputsObserver;
  120722. private _onMeshTargetChangedObserver;
  120723. /**
  120724. * Initializes the behavior.
  120725. */
  120726. init(): void;
  120727. /**
  120728. * Attaches the behavior to its arc rotate camera.
  120729. * @param camera Defines the camera to attach the behavior to
  120730. */
  120731. attach(camera: ArcRotateCamera): void;
  120732. /**
  120733. * Detaches the behavior from its current arc rotate camera.
  120734. */
  120735. detach(): void;
  120736. private _radiusIsAnimating;
  120737. private _radiusBounceTransition;
  120738. private _animatables;
  120739. private _cachedWheelPrecision;
  120740. /**
  120741. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  120742. * @param radiusLimit The limit to check against.
  120743. * @return Bool to indicate if at limit.
  120744. */
  120745. private _isRadiusAtLimit;
  120746. /**
  120747. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  120748. * @param radiusDelta The delta by which to animate to. Can be negative.
  120749. */
  120750. private _applyBoundRadiusAnimation;
  120751. /**
  120752. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  120753. */
  120754. protected _clearAnimationLocks(): void;
  120755. /**
  120756. * Stops and removes all animations that have been applied to the camera
  120757. */
  120758. stopAllAnimations(): void;
  120759. }
  120760. }
  120761. declare module BABYLON {
  120762. /**
  120763. * 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.
  120764. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  120765. */
  120766. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  120767. /**
  120768. * Gets the name of the behavior.
  120769. */
  120770. get name(): string;
  120771. private _mode;
  120772. private _radiusScale;
  120773. private _positionScale;
  120774. private _defaultElevation;
  120775. private _elevationReturnTime;
  120776. private _elevationReturnWaitTime;
  120777. private _zoomStopsAnimation;
  120778. private _framingTime;
  120779. /**
  120780. * The easing function used by animations
  120781. */
  120782. static EasingFunction: ExponentialEase;
  120783. /**
  120784. * The easing mode used by animations
  120785. */
  120786. static EasingMode: number;
  120787. /**
  120788. * Sets the current mode used by the behavior
  120789. */
  120790. set mode(mode: number);
  120791. /**
  120792. * Gets current mode used by the behavior.
  120793. */
  120794. get mode(): number;
  120795. /**
  120796. * Sets the scale applied to the radius (1 by default)
  120797. */
  120798. set radiusScale(radius: number);
  120799. /**
  120800. * Gets the scale applied to the radius
  120801. */
  120802. get radiusScale(): number;
  120803. /**
  120804. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  120805. */
  120806. set positionScale(scale: number);
  120807. /**
  120808. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  120809. */
  120810. get positionScale(): number;
  120811. /**
  120812. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  120813. * behaviour is triggered, in radians.
  120814. */
  120815. set defaultElevation(elevation: number);
  120816. /**
  120817. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  120818. * behaviour is triggered, in radians.
  120819. */
  120820. get defaultElevation(): number;
  120821. /**
  120822. * Sets the time (in milliseconds) taken to return to the default beta position.
  120823. * Negative value indicates camera should not return to default.
  120824. */
  120825. set elevationReturnTime(speed: number);
  120826. /**
  120827. * Gets the time (in milliseconds) taken to return to the default beta position.
  120828. * Negative value indicates camera should not return to default.
  120829. */
  120830. get elevationReturnTime(): number;
  120831. /**
  120832. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  120833. */
  120834. set elevationReturnWaitTime(time: number);
  120835. /**
  120836. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  120837. */
  120838. get elevationReturnWaitTime(): number;
  120839. /**
  120840. * Sets the flag that indicates if user zooming should stop animation.
  120841. */
  120842. set zoomStopsAnimation(flag: boolean);
  120843. /**
  120844. * Gets the flag that indicates if user zooming should stop animation.
  120845. */
  120846. get zoomStopsAnimation(): boolean;
  120847. /**
  120848. * Sets the transition time when framing the mesh, in milliseconds
  120849. */
  120850. set framingTime(time: number);
  120851. /**
  120852. * Gets the transition time when framing the mesh, in milliseconds
  120853. */
  120854. get framingTime(): number;
  120855. /**
  120856. * Define if the behavior should automatically change the configured
  120857. * camera limits and sensibilities.
  120858. */
  120859. autoCorrectCameraLimitsAndSensibility: boolean;
  120860. private _onPrePointerObservableObserver;
  120861. private _onAfterCheckInputsObserver;
  120862. private _onMeshTargetChangedObserver;
  120863. private _attachedCamera;
  120864. private _isPointerDown;
  120865. private _lastInteractionTime;
  120866. /**
  120867. * Initializes the behavior.
  120868. */
  120869. init(): void;
  120870. /**
  120871. * Attaches the behavior to its arc rotate camera.
  120872. * @param camera Defines the camera to attach the behavior to
  120873. */
  120874. attach(camera: ArcRotateCamera): void;
  120875. /**
  120876. * Detaches the behavior from its current arc rotate camera.
  120877. */
  120878. detach(): void;
  120879. private _animatables;
  120880. private _betaIsAnimating;
  120881. private _betaTransition;
  120882. private _radiusTransition;
  120883. private _vectorTransition;
  120884. /**
  120885. * Targets the given mesh and updates zoom level accordingly.
  120886. * @param mesh The mesh to target.
  120887. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120888. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120889. */
  120890. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120891. /**
  120892. * Targets the given mesh with its children and updates zoom level accordingly.
  120893. * @param mesh The mesh to target.
  120894. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120895. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120896. */
  120897. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120898. /**
  120899. * Targets the given meshes with their children and updates zoom level accordingly.
  120900. * @param meshes The mesh to target.
  120901. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120902. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120903. */
  120904. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120905. /**
  120906. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  120907. * @param minimumWorld Determines the smaller position of the bounding box extend
  120908. * @param maximumWorld Determines the bigger position of the bounding box extend
  120909. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120910. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120911. */
  120912. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120913. /**
  120914. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  120915. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  120916. * frustum width.
  120917. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  120918. * to fully enclose the mesh in the viewing frustum.
  120919. */
  120920. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  120921. /**
  120922. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  120923. * is automatically returned to its default position (expected to be above ground plane).
  120924. */
  120925. private _maintainCameraAboveGround;
  120926. /**
  120927. * Returns the frustum slope based on the canvas ratio and camera FOV
  120928. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  120929. */
  120930. private _getFrustumSlope;
  120931. /**
  120932. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  120933. */
  120934. private _clearAnimationLocks;
  120935. /**
  120936. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  120937. */
  120938. private _applyUserInteraction;
  120939. /**
  120940. * Stops and removes all animations that have been applied to the camera
  120941. */
  120942. stopAllAnimations(): void;
  120943. /**
  120944. * Gets a value indicating if the user is moving the camera
  120945. */
  120946. get isUserIsMoving(): boolean;
  120947. /**
  120948. * The camera can move all the way towards the mesh.
  120949. */
  120950. static IgnoreBoundsSizeMode: number;
  120951. /**
  120952. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  120953. */
  120954. static FitFrustumSidesMode: number;
  120955. }
  120956. }
  120957. declare module BABYLON {
  120958. /**
  120959. * Base class for Camera Pointer Inputs.
  120960. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  120961. * for example usage.
  120962. */
  120963. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  120964. /**
  120965. * Defines the camera the input is attached to.
  120966. */
  120967. abstract camera: Camera;
  120968. /**
  120969. * Whether keyboard modifier keys are pressed at time of last mouse event.
  120970. */
  120971. protected _altKey: boolean;
  120972. protected _ctrlKey: boolean;
  120973. protected _metaKey: boolean;
  120974. protected _shiftKey: boolean;
  120975. /**
  120976. * Which mouse buttons were pressed at time of last mouse event.
  120977. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  120978. */
  120979. protected _buttonsPressed: number;
  120980. /**
  120981. * Defines the buttons associated with the input to handle camera move.
  120982. */
  120983. buttons: number[];
  120984. /**
  120985. * Attach the input controls to a specific dom element to get the input from.
  120986. * @param element Defines the element the controls should be listened from
  120987. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  120988. */
  120989. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120990. /**
  120991. * Detach the current controls from the specified dom element.
  120992. * @param element Defines the element to stop listening the inputs from
  120993. */
  120994. detachControl(element: Nullable<HTMLElement>): void;
  120995. /**
  120996. * Gets the class name of the current input.
  120997. * @returns the class name
  120998. */
  120999. getClassName(): string;
  121000. /**
  121001. * Get the friendly name associated with the input class.
  121002. * @returns the input friendly name
  121003. */
  121004. getSimpleName(): string;
  121005. /**
  121006. * Called on pointer POINTERDOUBLETAP event.
  121007. * Override this method to provide functionality on POINTERDOUBLETAP event.
  121008. */
  121009. protected onDoubleTap(type: string): void;
  121010. /**
  121011. * Called on pointer POINTERMOVE event if only a single touch is active.
  121012. * Override this method to provide functionality.
  121013. */
  121014. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121015. /**
  121016. * Called on pointer POINTERMOVE event if multiple touches are active.
  121017. * Override this method to provide functionality.
  121018. */
  121019. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121020. /**
  121021. * Called on JS contextmenu event.
  121022. * Override this method to provide functionality.
  121023. */
  121024. protected onContextMenu(evt: PointerEvent): void;
  121025. /**
  121026. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121027. * press.
  121028. * Override this method to provide functionality.
  121029. */
  121030. protected onButtonDown(evt: PointerEvent): void;
  121031. /**
  121032. * Called each time a new POINTERUP event occurs. Ie, for each button
  121033. * release.
  121034. * Override this method to provide functionality.
  121035. */
  121036. protected onButtonUp(evt: PointerEvent): void;
  121037. /**
  121038. * Called when window becomes inactive.
  121039. * Override this method to provide functionality.
  121040. */
  121041. protected onLostFocus(): void;
  121042. private _pointerInput;
  121043. private _observer;
  121044. private _onLostFocus;
  121045. private pointA;
  121046. private pointB;
  121047. }
  121048. }
  121049. declare module BABYLON {
  121050. /**
  121051. * Manage the pointers inputs to control an arc rotate camera.
  121052. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121053. */
  121054. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  121055. /**
  121056. * Defines the camera the input is attached to.
  121057. */
  121058. camera: ArcRotateCamera;
  121059. /**
  121060. * Gets the class name of the current input.
  121061. * @returns the class name
  121062. */
  121063. getClassName(): string;
  121064. /**
  121065. * Defines the buttons associated with the input to handle camera move.
  121066. */
  121067. buttons: number[];
  121068. /**
  121069. * Defines the pointer angular sensibility along the X axis or how fast is
  121070. * the camera rotating.
  121071. */
  121072. angularSensibilityX: number;
  121073. /**
  121074. * Defines the pointer angular sensibility along the Y axis or how fast is
  121075. * the camera rotating.
  121076. */
  121077. angularSensibilityY: number;
  121078. /**
  121079. * Defines the pointer pinch precision or how fast is the camera zooming.
  121080. */
  121081. pinchPrecision: number;
  121082. /**
  121083. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  121084. * from 0.
  121085. * It defines the percentage of current camera.radius to use as delta when
  121086. * pinch zoom is used.
  121087. */
  121088. pinchDeltaPercentage: number;
  121089. /**
  121090. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  121091. * that any object in the plane at the camera's target point will scale
  121092. * perfectly with finger motion.
  121093. * Overrides pinchDeltaPercentage and pinchPrecision.
  121094. */
  121095. useNaturalPinchZoom: boolean;
  121096. /**
  121097. * Defines the pointer panning sensibility or how fast is the camera moving.
  121098. */
  121099. panningSensibility: number;
  121100. /**
  121101. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  121102. */
  121103. multiTouchPanning: boolean;
  121104. /**
  121105. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  121106. * zoom (pinch) through multitouch.
  121107. */
  121108. multiTouchPanAndZoom: boolean;
  121109. /**
  121110. * Revers pinch action direction.
  121111. */
  121112. pinchInwards: boolean;
  121113. private _isPanClick;
  121114. private _twoFingerActivityCount;
  121115. private _isPinching;
  121116. /**
  121117. * Called on pointer POINTERMOVE event if only a single touch is active.
  121118. */
  121119. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121120. /**
  121121. * Called on pointer POINTERDOUBLETAP event.
  121122. */
  121123. protected onDoubleTap(type: string): void;
  121124. /**
  121125. * Called on pointer POINTERMOVE event if multiple touches are active.
  121126. */
  121127. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121128. /**
  121129. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121130. * press.
  121131. */
  121132. protected onButtonDown(evt: PointerEvent): void;
  121133. /**
  121134. * Called each time a new POINTERUP event occurs. Ie, for each button
  121135. * release.
  121136. */
  121137. protected onButtonUp(evt: PointerEvent): void;
  121138. /**
  121139. * Called when window becomes inactive.
  121140. */
  121141. protected onLostFocus(): void;
  121142. }
  121143. }
  121144. declare module BABYLON {
  121145. /**
  121146. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  121147. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121148. */
  121149. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  121150. /**
  121151. * Defines the camera the input is attached to.
  121152. */
  121153. camera: ArcRotateCamera;
  121154. /**
  121155. * Defines the list of key codes associated with the up action (increase alpha)
  121156. */
  121157. keysUp: number[];
  121158. /**
  121159. * Defines the list of key codes associated with the down action (decrease alpha)
  121160. */
  121161. keysDown: number[];
  121162. /**
  121163. * Defines the list of key codes associated with the left action (increase beta)
  121164. */
  121165. keysLeft: number[];
  121166. /**
  121167. * Defines the list of key codes associated with the right action (decrease beta)
  121168. */
  121169. keysRight: number[];
  121170. /**
  121171. * Defines the list of key codes associated with the reset action.
  121172. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  121173. */
  121174. keysReset: number[];
  121175. /**
  121176. * Defines the panning sensibility of the inputs.
  121177. * (How fast is the camera panning)
  121178. */
  121179. panningSensibility: number;
  121180. /**
  121181. * Defines the zooming sensibility of the inputs.
  121182. * (How fast is the camera zooming)
  121183. */
  121184. zoomingSensibility: number;
  121185. /**
  121186. * Defines whether maintaining the alt key down switch the movement mode from
  121187. * orientation to zoom.
  121188. */
  121189. useAltToZoom: boolean;
  121190. /**
  121191. * Rotation speed of the camera
  121192. */
  121193. angularSpeed: number;
  121194. private _keys;
  121195. private _ctrlPressed;
  121196. private _altPressed;
  121197. private _onCanvasBlurObserver;
  121198. private _onKeyboardObserver;
  121199. private _engine;
  121200. private _scene;
  121201. /**
  121202. * Attach the input controls to a specific dom element to get the input from.
  121203. * @param element Defines the element the controls should be listened from
  121204. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121205. */
  121206. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121207. /**
  121208. * Detach the current controls from the specified dom element.
  121209. * @param element Defines the element to stop listening the inputs from
  121210. */
  121211. detachControl(element: Nullable<HTMLElement>): void;
  121212. /**
  121213. * Update the current camera state depending on the inputs that have been used this frame.
  121214. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121215. */
  121216. checkInputs(): void;
  121217. /**
  121218. * Gets the class name of the current intput.
  121219. * @returns the class name
  121220. */
  121221. getClassName(): string;
  121222. /**
  121223. * Get the friendly name associated with the input class.
  121224. * @returns the input friendly name
  121225. */
  121226. getSimpleName(): string;
  121227. }
  121228. }
  121229. declare module BABYLON {
  121230. /**
  121231. * Manage the mouse wheel inputs to control an arc rotate camera.
  121232. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121233. */
  121234. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  121235. /**
  121236. * Defines the camera the input is attached to.
  121237. */
  121238. camera: ArcRotateCamera;
  121239. /**
  121240. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  121241. */
  121242. wheelPrecision: number;
  121243. /**
  121244. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  121245. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  121246. */
  121247. wheelDeltaPercentage: number;
  121248. private _wheel;
  121249. private _observer;
  121250. private computeDeltaFromMouseWheelLegacyEvent;
  121251. /**
  121252. * Attach the input controls to a specific dom element to get the input from.
  121253. * @param element Defines the element the controls should be listened from
  121254. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121255. */
  121256. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121257. /**
  121258. * Detach the current controls from the specified dom element.
  121259. * @param element Defines the element to stop listening the inputs from
  121260. */
  121261. detachControl(element: Nullable<HTMLElement>): void;
  121262. /**
  121263. * Gets the class name of the current intput.
  121264. * @returns the class name
  121265. */
  121266. getClassName(): string;
  121267. /**
  121268. * Get the friendly name associated with the input class.
  121269. * @returns the input friendly name
  121270. */
  121271. getSimpleName(): string;
  121272. }
  121273. }
  121274. declare module BABYLON {
  121275. /**
  121276. * Default Inputs manager for the ArcRotateCamera.
  121277. * It groups all the default supported inputs for ease of use.
  121278. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121279. */
  121280. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  121281. /**
  121282. * Instantiates a new ArcRotateCameraInputsManager.
  121283. * @param camera Defines the camera the inputs belong to
  121284. */
  121285. constructor(camera: ArcRotateCamera);
  121286. /**
  121287. * Add mouse wheel input support to the input manager.
  121288. * @returns the current input manager
  121289. */
  121290. addMouseWheel(): ArcRotateCameraInputsManager;
  121291. /**
  121292. * Add pointers input support to the input manager.
  121293. * @returns the current input manager
  121294. */
  121295. addPointers(): ArcRotateCameraInputsManager;
  121296. /**
  121297. * Add keyboard input support to the input manager.
  121298. * @returns the current input manager
  121299. */
  121300. addKeyboard(): ArcRotateCameraInputsManager;
  121301. }
  121302. }
  121303. declare module BABYLON {
  121304. /**
  121305. * This represents an orbital type of camera.
  121306. *
  121307. * 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.
  121308. * 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.
  121309. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  121310. */
  121311. export class ArcRotateCamera extends TargetCamera {
  121312. /**
  121313. * Defines the rotation angle of the camera along the longitudinal axis.
  121314. */
  121315. alpha: number;
  121316. /**
  121317. * Defines the rotation angle of the camera along the latitudinal axis.
  121318. */
  121319. beta: number;
  121320. /**
  121321. * Defines the radius of the camera from it s target point.
  121322. */
  121323. radius: number;
  121324. protected _target: Vector3;
  121325. protected _targetHost: Nullable<AbstractMesh>;
  121326. /**
  121327. * Defines the target point of the camera.
  121328. * The camera looks towards it form the radius distance.
  121329. */
  121330. get target(): Vector3;
  121331. set target(value: Vector3);
  121332. /**
  121333. * Define the current local position of the camera in the scene
  121334. */
  121335. get position(): Vector3;
  121336. set position(newPosition: Vector3);
  121337. protected _upVector: Vector3;
  121338. protected _upToYMatrix: Matrix;
  121339. protected _YToUpMatrix: Matrix;
  121340. /**
  121341. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  121342. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  121343. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  121344. */
  121345. set upVector(vec: Vector3);
  121346. get upVector(): Vector3;
  121347. /**
  121348. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  121349. */
  121350. setMatUp(): void;
  121351. /**
  121352. * Current inertia value on the longitudinal axis.
  121353. * The bigger this number the longer it will take for the camera to stop.
  121354. */
  121355. inertialAlphaOffset: number;
  121356. /**
  121357. * Current inertia value on the latitudinal axis.
  121358. * The bigger this number the longer it will take for the camera to stop.
  121359. */
  121360. inertialBetaOffset: number;
  121361. /**
  121362. * Current inertia value on the radius axis.
  121363. * The bigger this number the longer it will take for the camera to stop.
  121364. */
  121365. inertialRadiusOffset: number;
  121366. /**
  121367. * Minimum allowed angle on the longitudinal axis.
  121368. * This can help limiting how the Camera is able to move in the scene.
  121369. */
  121370. lowerAlphaLimit: Nullable<number>;
  121371. /**
  121372. * Maximum allowed angle on the longitudinal axis.
  121373. * This can help limiting how the Camera is able to move in the scene.
  121374. */
  121375. upperAlphaLimit: Nullable<number>;
  121376. /**
  121377. * Minimum allowed angle on the latitudinal axis.
  121378. * This can help limiting how the Camera is able to move in the scene.
  121379. */
  121380. lowerBetaLimit: number;
  121381. /**
  121382. * Maximum allowed angle on the latitudinal axis.
  121383. * This can help limiting how the Camera is able to move in the scene.
  121384. */
  121385. upperBetaLimit: number;
  121386. /**
  121387. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  121388. * This can help limiting how the Camera is able to move in the scene.
  121389. */
  121390. lowerRadiusLimit: Nullable<number>;
  121391. /**
  121392. * Maximum allowed distance of the camera to the target (The camera can not get further).
  121393. * This can help limiting how the Camera is able to move in the scene.
  121394. */
  121395. upperRadiusLimit: Nullable<number>;
  121396. /**
  121397. * Defines the current inertia value used during panning of the camera along the X axis.
  121398. */
  121399. inertialPanningX: number;
  121400. /**
  121401. * Defines the current inertia value used during panning of the camera along the Y axis.
  121402. */
  121403. inertialPanningY: number;
  121404. /**
  121405. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  121406. * Basically if your fingers moves away from more than this distance you will be considered
  121407. * in pinch mode.
  121408. */
  121409. pinchToPanMaxDistance: number;
  121410. /**
  121411. * Defines the maximum distance the camera can pan.
  121412. * This could help keeping the cammera always in your scene.
  121413. */
  121414. panningDistanceLimit: Nullable<number>;
  121415. /**
  121416. * Defines the target of the camera before paning.
  121417. */
  121418. panningOriginTarget: Vector3;
  121419. /**
  121420. * Defines the value of the inertia used during panning.
  121421. * 0 would mean stop inertia and one would mean no decelleration at all.
  121422. */
  121423. panningInertia: number;
  121424. /**
  121425. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  121426. */
  121427. get angularSensibilityX(): number;
  121428. set angularSensibilityX(value: number);
  121429. /**
  121430. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  121431. */
  121432. get angularSensibilityY(): number;
  121433. set angularSensibilityY(value: number);
  121434. /**
  121435. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  121436. */
  121437. get pinchPrecision(): number;
  121438. set pinchPrecision(value: number);
  121439. /**
  121440. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  121441. * It will be used instead of pinchDeltaPrecision if different from 0.
  121442. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  121443. */
  121444. get pinchDeltaPercentage(): number;
  121445. set pinchDeltaPercentage(value: number);
  121446. /**
  121447. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  121448. * and pinch delta percentage.
  121449. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  121450. * that any object in the plane at the camera's target point will scale
  121451. * perfectly with finger motion.
  121452. */
  121453. get useNaturalPinchZoom(): boolean;
  121454. set useNaturalPinchZoom(value: boolean);
  121455. /**
  121456. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  121457. */
  121458. get panningSensibility(): number;
  121459. set panningSensibility(value: number);
  121460. /**
  121461. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  121462. */
  121463. get keysUp(): number[];
  121464. set keysUp(value: number[]);
  121465. /**
  121466. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  121467. */
  121468. get keysDown(): number[];
  121469. set keysDown(value: number[]);
  121470. /**
  121471. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  121472. */
  121473. get keysLeft(): number[];
  121474. set keysLeft(value: number[]);
  121475. /**
  121476. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  121477. */
  121478. get keysRight(): number[];
  121479. set keysRight(value: number[]);
  121480. /**
  121481. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  121482. */
  121483. get wheelPrecision(): number;
  121484. set wheelPrecision(value: number);
  121485. /**
  121486. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  121487. * It will be used instead of pinchDeltaPrecision if different from 0.
  121488. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  121489. */
  121490. get wheelDeltaPercentage(): number;
  121491. set wheelDeltaPercentage(value: number);
  121492. /**
  121493. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  121494. */
  121495. zoomOnFactor: number;
  121496. /**
  121497. * Defines a screen offset for the camera position.
  121498. */
  121499. targetScreenOffset: Vector2;
  121500. /**
  121501. * Allows the camera to be completely reversed.
  121502. * If false the camera can not arrive upside down.
  121503. */
  121504. allowUpsideDown: boolean;
  121505. /**
  121506. * Define if double tap/click is used to restore the previously saved state of the camera.
  121507. */
  121508. useInputToRestoreState: boolean;
  121509. /** @hidden */
  121510. _viewMatrix: Matrix;
  121511. /** @hidden */
  121512. _useCtrlForPanning: boolean;
  121513. /** @hidden */
  121514. _panningMouseButton: number;
  121515. /**
  121516. * Defines the input associated to the camera.
  121517. */
  121518. inputs: ArcRotateCameraInputsManager;
  121519. /** @hidden */
  121520. _reset: () => void;
  121521. /**
  121522. * Defines the allowed panning axis.
  121523. */
  121524. panningAxis: Vector3;
  121525. protected _localDirection: Vector3;
  121526. protected _transformedDirection: Vector3;
  121527. private _bouncingBehavior;
  121528. /**
  121529. * Gets the bouncing behavior of the camera if it has been enabled.
  121530. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121531. */
  121532. get bouncingBehavior(): Nullable<BouncingBehavior>;
  121533. /**
  121534. * Defines if the bouncing behavior of the camera is enabled on the camera.
  121535. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121536. */
  121537. get useBouncingBehavior(): boolean;
  121538. set useBouncingBehavior(value: boolean);
  121539. private _framingBehavior;
  121540. /**
  121541. * Gets the framing behavior of the camera if it has been enabled.
  121542. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121543. */
  121544. get framingBehavior(): Nullable<FramingBehavior>;
  121545. /**
  121546. * Defines if the framing behavior of the camera is enabled on the camera.
  121547. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121548. */
  121549. get useFramingBehavior(): boolean;
  121550. set useFramingBehavior(value: boolean);
  121551. private _autoRotationBehavior;
  121552. /**
  121553. * Gets the auto rotation behavior of the camera if it has been enabled.
  121554. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121555. */
  121556. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  121557. /**
  121558. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  121559. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121560. */
  121561. get useAutoRotationBehavior(): boolean;
  121562. set useAutoRotationBehavior(value: boolean);
  121563. /**
  121564. * Observable triggered when the mesh target has been changed on the camera.
  121565. */
  121566. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  121567. /**
  121568. * Event raised when the camera is colliding with a mesh.
  121569. */
  121570. onCollide: (collidedMesh: AbstractMesh) => void;
  121571. /**
  121572. * Defines whether the camera should check collision with the objects oh the scene.
  121573. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  121574. */
  121575. checkCollisions: boolean;
  121576. /**
  121577. * Defines the collision radius of the camera.
  121578. * This simulates a sphere around the camera.
  121579. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  121580. */
  121581. collisionRadius: Vector3;
  121582. protected _collider: Collider;
  121583. protected _previousPosition: Vector3;
  121584. protected _collisionVelocity: Vector3;
  121585. protected _newPosition: Vector3;
  121586. protected _previousAlpha: number;
  121587. protected _previousBeta: number;
  121588. protected _previousRadius: number;
  121589. protected _collisionTriggered: boolean;
  121590. protected _targetBoundingCenter: Nullable<Vector3>;
  121591. private _computationVector;
  121592. /**
  121593. * Instantiates a new ArcRotateCamera in a given scene
  121594. * @param name Defines the name of the camera
  121595. * @param alpha Defines the camera rotation along the logitudinal axis
  121596. * @param beta Defines the camera rotation along the latitudinal axis
  121597. * @param radius Defines the camera distance from its target
  121598. * @param target Defines the camera target
  121599. * @param scene Defines the scene the camera belongs to
  121600. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  121601. */
  121602. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  121603. /** @hidden */
  121604. _initCache(): void;
  121605. /** @hidden */
  121606. _updateCache(ignoreParentClass?: boolean): void;
  121607. protected _getTargetPosition(): Vector3;
  121608. private _storedAlpha;
  121609. private _storedBeta;
  121610. private _storedRadius;
  121611. private _storedTarget;
  121612. private _storedTargetScreenOffset;
  121613. /**
  121614. * Stores the current state of the camera (alpha, beta, radius and target)
  121615. * @returns the camera itself
  121616. */
  121617. storeState(): Camera;
  121618. /**
  121619. * @hidden
  121620. * Restored camera state. You must call storeState() first
  121621. */
  121622. _restoreStateValues(): boolean;
  121623. /** @hidden */
  121624. _isSynchronizedViewMatrix(): boolean;
  121625. /**
  121626. * Attached controls to the current camera.
  121627. * @param element Defines the element the controls should be listened from
  121628. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121629. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  121630. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  121631. */
  121632. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  121633. /**
  121634. * Detach the current controls from the camera.
  121635. * The camera will stop reacting to inputs.
  121636. * @param element Defines the element to stop listening the inputs from
  121637. */
  121638. detachControl(element: HTMLElement): void;
  121639. /** @hidden */
  121640. _checkInputs(): void;
  121641. protected _checkLimits(): void;
  121642. /**
  121643. * Rebuilds angles (alpha, beta) and radius from the give position and target
  121644. */
  121645. rebuildAnglesAndRadius(): void;
  121646. /**
  121647. * Use a position to define the current camera related information like alpha, beta and radius
  121648. * @param position Defines the position to set the camera at
  121649. */
  121650. setPosition(position: Vector3): void;
  121651. /**
  121652. * Defines the target the camera should look at.
  121653. * This will automatically adapt alpha beta and radius to fit within the new target.
  121654. * @param target Defines the new target as a Vector or a mesh
  121655. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  121656. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  121657. */
  121658. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  121659. /** @hidden */
  121660. _getViewMatrix(): Matrix;
  121661. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  121662. /**
  121663. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  121664. * @param meshes Defines the mesh to zoom on
  121665. * @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)
  121666. */
  121667. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  121668. /**
  121669. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  121670. * The target will be changed but the radius
  121671. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  121672. * @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)
  121673. */
  121674. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  121675. min: Vector3;
  121676. max: Vector3;
  121677. distance: number;
  121678. }, doNotUpdateMaxZ?: boolean): void;
  121679. /**
  121680. * @override
  121681. * Override Camera.createRigCamera
  121682. */
  121683. createRigCamera(name: string, cameraIndex: number): Camera;
  121684. /**
  121685. * @hidden
  121686. * @override
  121687. * Override Camera._updateRigCameras
  121688. */
  121689. _updateRigCameras(): void;
  121690. /**
  121691. * Destroy the camera and release the current resources hold by it.
  121692. */
  121693. dispose(): void;
  121694. /**
  121695. * Gets the current object class name.
  121696. * @return the class name
  121697. */
  121698. getClassName(): string;
  121699. }
  121700. }
  121701. declare module BABYLON {
  121702. /**
  121703. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  121704. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121705. */
  121706. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  121707. /**
  121708. * Gets the name of the behavior.
  121709. */
  121710. get name(): string;
  121711. private _zoomStopsAnimation;
  121712. private _idleRotationSpeed;
  121713. private _idleRotationWaitTime;
  121714. private _idleRotationSpinupTime;
  121715. /**
  121716. * Sets the flag that indicates if user zooming should stop animation.
  121717. */
  121718. set zoomStopsAnimation(flag: boolean);
  121719. /**
  121720. * Gets the flag that indicates if user zooming should stop animation.
  121721. */
  121722. get zoomStopsAnimation(): boolean;
  121723. /**
  121724. * Sets the default speed at which the camera rotates around the model.
  121725. */
  121726. set idleRotationSpeed(speed: number);
  121727. /**
  121728. * Gets the default speed at which the camera rotates around the model.
  121729. */
  121730. get idleRotationSpeed(): number;
  121731. /**
  121732. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  121733. */
  121734. set idleRotationWaitTime(time: number);
  121735. /**
  121736. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  121737. */
  121738. get idleRotationWaitTime(): number;
  121739. /**
  121740. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  121741. */
  121742. set idleRotationSpinupTime(time: number);
  121743. /**
  121744. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  121745. */
  121746. get idleRotationSpinupTime(): number;
  121747. /**
  121748. * Gets a value indicating if the camera is currently rotating because of this behavior
  121749. */
  121750. get rotationInProgress(): boolean;
  121751. private _onPrePointerObservableObserver;
  121752. private _onAfterCheckInputsObserver;
  121753. private _attachedCamera;
  121754. private _isPointerDown;
  121755. private _lastFrameTime;
  121756. private _lastInteractionTime;
  121757. private _cameraRotationSpeed;
  121758. /**
  121759. * Initializes the behavior.
  121760. */
  121761. init(): void;
  121762. /**
  121763. * Attaches the behavior to its arc rotate camera.
  121764. * @param camera Defines the camera to attach the behavior to
  121765. */
  121766. attach(camera: ArcRotateCamera): void;
  121767. /**
  121768. * Detaches the behavior from its current arc rotate camera.
  121769. */
  121770. detach(): void;
  121771. /**
  121772. * Returns true if user is scrolling.
  121773. * @return true if user is scrolling.
  121774. */
  121775. private _userIsZooming;
  121776. private _lastFrameRadius;
  121777. private _shouldAnimationStopForInteraction;
  121778. /**
  121779. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  121780. */
  121781. private _applyUserInteraction;
  121782. private _userIsMoving;
  121783. }
  121784. }
  121785. declare module BABYLON {
  121786. /**
  121787. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  121788. */
  121789. export class AttachToBoxBehavior implements Behavior<Mesh> {
  121790. private ui;
  121791. /**
  121792. * The name of the behavior
  121793. */
  121794. name: string;
  121795. /**
  121796. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  121797. */
  121798. distanceAwayFromFace: number;
  121799. /**
  121800. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  121801. */
  121802. distanceAwayFromBottomOfFace: number;
  121803. private _faceVectors;
  121804. private _target;
  121805. private _scene;
  121806. private _onRenderObserver;
  121807. private _tmpMatrix;
  121808. private _tmpVector;
  121809. /**
  121810. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  121811. * @param ui The transform node that should be attched to the mesh
  121812. */
  121813. constructor(ui: TransformNode);
  121814. /**
  121815. * Initializes the behavior
  121816. */
  121817. init(): void;
  121818. private _closestFace;
  121819. private _zeroVector;
  121820. private _lookAtTmpMatrix;
  121821. private _lookAtToRef;
  121822. /**
  121823. * Attaches the AttachToBoxBehavior to the passed in mesh
  121824. * @param target The mesh that the specified node will be attached to
  121825. */
  121826. attach(target: Mesh): void;
  121827. /**
  121828. * Detaches the behavior from the mesh
  121829. */
  121830. detach(): void;
  121831. }
  121832. }
  121833. declare module BABYLON {
  121834. /**
  121835. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  121836. */
  121837. export class FadeInOutBehavior implements Behavior<Mesh> {
  121838. /**
  121839. * Time in milliseconds to delay before fading in (Default: 0)
  121840. */
  121841. delay: number;
  121842. /**
  121843. * Time in milliseconds for the mesh to fade in (Default: 300)
  121844. */
  121845. fadeInTime: number;
  121846. private _millisecondsPerFrame;
  121847. private _hovered;
  121848. private _hoverValue;
  121849. private _ownerNode;
  121850. /**
  121851. * Instatiates the FadeInOutBehavior
  121852. */
  121853. constructor();
  121854. /**
  121855. * The name of the behavior
  121856. */
  121857. get name(): string;
  121858. /**
  121859. * Initializes the behavior
  121860. */
  121861. init(): void;
  121862. /**
  121863. * Attaches the fade behavior on the passed in mesh
  121864. * @param ownerNode The mesh that will be faded in/out once attached
  121865. */
  121866. attach(ownerNode: Mesh): void;
  121867. /**
  121868. * Detaches the behavior from the mesh
  121869. */
  121870. detach(): void;
  121871. /**
  121872. * Triggers the mesh to begin fading in or out
  121873. * @param value if the object should fade in or out (true to fade in)
  121874. */
  121875. fadeIn(value: boolean): void;
  121876. private _update;
  121877. private _setAllVisibility;
  121878. }
  121879. }
  121880. declare module BABYLON {
  121881. /**
  121882. * Class containing a set of static utilities functions for managing Pivots
  121883. * @hidden
  121884. */
  121885. export class PivotTools {
  121886. private static _PivotCached;
  121887. private static _OldPivotPoint;
  121888. private static _PivotTranslation;
  121889. private static _PivotTmpVector;
  121890. /** @hidden */
  121891. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  121892. /** @hidden */
  121893. static _RestorePivotPoint(mesh: AbstractMesh): void;
  121894. }
  121895. }
  121896. declare module BABYLON {
  121897. /**
  121898. * Class containing static functions to help procedurally build meshes
  121899. */
  121900. export class PlaneBuilder {
  121901. /**
  121902. * Creates a plane mesh
  121903. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  121904. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  121905. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  121906. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121907. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121908. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121909. * @param name defines the name of the mesh
  121910. * @param options defines the options used to create the mesh
  121911. * @param scene defines the hosting scene
  121912. * @returns the plane mesh
  121913. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  121914. */
  121915. static CreatePlane(name: string, options: {
  121916. size?: number;
  121917. width?: number;
  121918. height?: number;
  121919. sideOrientation?: number;
  121920. frontUVs?: Vector4;
  121921. backUVs?: Vector4;
  121922. updatable?: boolean;
  121923. sourcePlane?: Plane;
  121924. }, scene?: Nullable<Scene>): Mesh;
  121925. }
  121926. }
  121927. declare module BABYLON {
  121928. /**
  121929. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  121930. */
  121931. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  121932. private static _AnyMouseID;
  121933. /**
  121934. * Abstract mesh the behavior is set on
  121935. */
  121936. attachedNode: AbstractMesh;
  121937. private _dragPlane;
  121938. private _scene;
  121939. private _pointerObserver;
  121940. private _beforeRenderObserver;
  121941. private static _planeScene;
  121942. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  121943. /**
  121944. * 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)
  121945. */
  121946. maxDragAngle: number;
  121947. /**
  121948. * @hidden
  121949. */
  121950. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  121951. /**
  121952. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  121953. */
  121954. currentDraggingPointerID: number;
  121955. /**
  121956. * The last position where the pointer hit the drag plane in world space
  121957. */
  121958. lastDragPosition: Vector3;
  121959. /**
  121960. * If the behavior is currently in a dragging state
  121961. */
  121962. dragging: boolean;
  121963. /**
  121964. * 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)
  121965. */
  121966. dragDeltaRatio: number;
  121967. /**
  121968. * If the drag plane orientation should be updated during the dragging (Default: true)
  121969. */
  121970. updateDragPlane: boolean;
  121971. private _debugMode;
  121972. private _moving;
  121973. /**
  121974. * Fires each time the attached mesh is dragged with the pointer
  121975. * * delta between last drag position and current drag position in world space
  121976. * * dragDistance along the drag axis
  121977. * * dragPlaneNormal normal of the current drag plane used during the drag
  121978. * * dragPlanePoint in world space where the drag intersects the drag plane
  121979. */
  121980. onDragObservable: Observable<{
  121981. delta: Vector3;
  121982. dragPlanePoint: Vector3;
  121983. dragPlaneNormal: Vector3;
  121984. dragDistance: number;
  121985. pointerId: number;
  121986. }>;
  121987. /**
  121988. * Fires each time a drag begins (eg. mouse down on mesh)
  121989. */
  121990. onDragStartObservable: Observable<{
  121991. dragPlanePoint: Vector3;
  121992. pointerId: number;
  121993. }>;
  121994. /**
  121995. * Fires each time a drag ends (eg. mouse release after drag)
  121996. */
  121997. onDragEndObservable: Observable<{
  121998. dragPlanePoint: Vector3;
  121999. pointerId: number;
  122000. }>;
  122001. /**
  122002. * If the attached mesh should be moved when dragged
  122003. */
  122004. moveAttached: boolean;
  122005. /**
  122006. * If the drag behavior will react to drag events (Default: true)
  122007. */
  122008. enabled: boolean;
  122009. /**
  122010. * If pointer events should start and release the drag (Default: true)
  122011. */
  122012. startAndReleaseDragOnPointerEvents: boolean;
  122013. /**
  122014. * If camera controls should be detached during the drag
  122015. */
  122016. detachCameraControls: boolean;
  122017. /**
  122018. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  122019. */
  122020. useObjectOrientationForDragging: boolean;
  122021. private _options;
  122022. /**
  122023. * Gets the options used by the behavior
  122024. */
  122025. get options(): {
  122026. dragAxis?: Vector3;
  122027. dragPlaneNormal?: Vector3;
  122028. };
  122029. /**
  122030. * Sets the options used by the behavior
  122031. */
  122032. set options(options: {
  122033. dragAxis?: Vector3;
  122034. dragPlaneNormal?: Vector3;
  122035. });
  122036. /**
  122037. * Creates a pointer drag behavior that can be attached to a mesh
  122038. * @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)
  122039. */
  122040. constructor(options?: {
  122041. dragAxis?: Vector3;
  122042. dragPlaneNormal?: Vector3;
  122043. });
  122044. /**
  122045. * Predicate to determine if it is valid to move the object to a new position when it is moved
  122046. */
  122047. validateDrag: (targetPosition: Vector3) => boolean;
  122048. /**
  122049. * The name of the behavior
  122050. */
  122051. get name(): string;
  122052. /**
  122053. * Initializes the behavior
  122054. */
  122055. init(): void;
  122056. private _tmpVector;
  122057. private _alternatePickedPoint;
  122058. private _worldDragAxis;
  122059. private _targetPosition;
  122060. private _attachedElement;
  122061. /**
  122062. * Attaches the drag behavior the passed in mesh
  122063. * @param ownerNode The mesh that will be dragged around once attached
  122064. * @param predicate Predicate to use for pick filtering
  122065. */
  122066. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  122067. /**
  122068. * Force relase the drag action by code.
  122069. */
  122070. releaseDrag(): void;
  122071. private _startDragRay;
  122072. private _lastPointerRay;
  122073. /**
  122074. * Simulates the start of a pointer drag event on the behavior
  122075. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  122076. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  122077. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  122078. */
  122079. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  122080. private _startDrag;
  122081. private _dragDelta;
  122082. private _moveDrag;
  122083. private _pickWithRayOnDragPlane;
  122084. private _pointA;
  122085. private _pointC;
  122086. private _localAxis;
  122087. private _lookAt;
  122088. private _updateDragPlanePosition;
  122089. /**
  122090. * Detaches the behavior from the mesh
  122091. */
  122092. detach(): void;
  122093. }
  122094. }
  122095. declare module BABYLON {
  122096. /**
  122097. * A behavior that when attached to a mesh will allow the mesh to be scaled
  122098. */
  122099. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  122100. private _dragBehaviorA;
  122101. private _dragBehaviorB;
  122102. private _startDistance;
  122103. private _initialScale;
  122104. private _targetScale;
  122105. private _ownerNode;
  122106. private _sceneRenderObserver;
  122107. /**
  122108. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  122109. */
  122110. constructor();
  122111. /**
  122112. * The name of the behavior
  122113. */
  122114. get name(): string;
  122115. /**
  122116. * Initializes the behavior
  122117. */
  122118. init(): void;
  122119. private _getCurrentDistance;
  122120. /**
  122121. * Attaches the scale behavior the passed in mesh
  122122. * @param ownerNode The mesh that will be scaled around once attached
  122123. */
  122124. attach(ownerNode: Mesh): void;
  122125. /**
  122126. * Detaches the behavior from the mesh
  122127. */
  122128. detach(): void;
  122129. }
  122130. }
  122131. declare module BABYLON {
  122132. /**
  122133. * 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
  122134. */
  122135. export class SixDofDragBehavior implements Behavior<Mesh> {
  122136. private static _virtualScene;
  122137. private _ownerNode;
  122138. private _sceneRenderObserver;
  122139. private _scene;
  122140. private _targetPosition;
  122141. private _virtualOriginMesh;
  122142. private _virtualDragMesh;
  122143. private _pointerObserver;
  122144. private _moving;
  122145. private _startingOrientation;
  122146. private _attachedElement;
  122147. /**
  122148. * 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)
  122149. */
  122150. private zDragFactor;
  122151. /**
  122152. * If the object should rotate to face the drag origin
  122153. */
  122154. rotateDraggedObject: boolean;
  122155. /**
  122156. * If the behavior is currently in a dragging state
  122157. */
  122158. dragging: boolean;
  122159. /**
  122160. * 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)
  122161. */
  122162. dragDeltaRatio: number;
  122163. /**
  122164. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  122165. */
  122166. currentDraggingPointerID: number;
  122167. /**
  122168. * If camera controls should be detached during the drag
  122169. */
  122170. detachCameraControls: boolean;
  122171. /**
  122172. * Fires each time a drag starts
  122173. */
  122174. onDragStartObservable: Observable<{}>;
  122175. /**
  122176. * Fires each time a drag ends (eg. mouse release after drag)
  122177. */
  122178. onDragEndObservable: Observable<{}>;
  122179. /**
  122180. * 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
  122181. */
  122182. constructor();
  122183. /**
  122184. * The name of the behavior
  122185. */
  122186. get name(): string;
  122187. /**
  122188. * Initializes the behavior
  122189. */
  122190. init(): void;
  122191. /**
  122192. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  122193. */
  122194. private get _pointerCamera();
  122195. /**
  122196. * Attaches the scale behavior the passed in mesh
  122197. * @param ownerNode The mesh that will be scaled around once attached
  122198. */
  122199. attach(ownerNode: Mesh): void;
  122200. /**
  122201. * Detaches the behavior from the mesh
  122202. */
  122203. detach(): void;
  122204. }
  122205. }
  122206. declare module BABYLON {
  122207. /**
  122208. * Class used to apply inverse kinematics to bones
  122209. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  122210. */
  122211. export class BoneIKController {
  122212. private static _tmpVecs;
  122213. private static _tmpQuat;
  122214. private static _tmpMats;
  122215. /**
  122216. * Gets or sets the target mesh
  122217. */
  122218. targetMesh: AbstractMesh;
  122219. /** Gets or sets the mesh used as pole */
  122220. poleTargetMesh: AbstractMesh;
  122221. /**
  122222. * Gets or sets the bone used as pole
  122223. */
  122224. poleTargetBone: Nullable<Bone>;
  122225. /**
  122226. * Gets or sets the target position
  122227. */
  122228. targetPosition: Vector3;
  122229. /**
  122230. * Gets or sets the pole target position
  122231. */
  122232. poleTargetPosition: Vector3;
  122233. /**
  122234. * Gets or sets the pole target local offset
  122235. */
  122236. poleTargetLocalOffset: Vector3;
  122237. /**
  122238. * Gets or sets the pole angle
  122239. */
  122240. poleAngle: number;
  122241. /**
  122242. * Gets or sets the mesh associated with the controller
  122243. */
  122244. mesh: AbstractMesh;
  122245. /**
  122246. * 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)
  122247. */
  122248. slerpAmount: number;
  122249. private _bone1Quat;
  122250. private _bone1Mat;
  122251. private _bone2Ang;
  122252. private _bone1;
  122253. private _bone2;
  122254. private _bone1Length;
  122255. private _bone2Length;
  122256. private _maxAngle;
  122257. private _maxReach;
  122258. private _rightHandedSystem;
  122259. private _bendAxis;
  122260. private _slerping;
  122261. private _adjustRoll;
  122262. /**
  122263. * Gets or sets maximum allowed angle
  122264. */
  122265. get maxAngle(): number;
  122266. set maxAngle(value: number);
  122267. /**
  122268. * Creates a new BoneIKController
  122269. * @param mesh defines the mesh to control
  122270. * @param bone defines the bone to control
  122271. * @param options defines options to set up the controller
  122272. */
  122273. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  122274. targetMesh?: AbstractMesh;
  122275. poleTargetMesh?: AbstractMesh;
  122276. poleTargetBone?: Bone;
  122277. poleTargetLocalOffset?: Vector3;
  122278. poleAngle?: number;
  122279. bendAxis?: Vector3;
  122280. maxAngle?: number;
  122281. slerpAmount?: number;
  122282. });
  122283. private _setMaxAngle;
  122284. /**
  122285. * Force the controller to update the bones
  122286. */
  122287. update(): void;
  122288. }
  122289. }
  122290. declare module BABYLON {
  122291. /**
  122292. * Class used to make a bone look toward a point in space
  122293. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  122294. */
  122295. export class BoneLookController {
  122296. private static _tmpVecs;
  122297. private static _tmpQuat;
  122298. private static _tmpMats;
  122299. /**
  122300. * The target Vector3 that the bone will look at
  122301. */
  122302. target: Vector3;
  122303. /**
  122304. * The mesh that the bone is attached to
  122305. */
  122306. mesh: AbstractMesh;
  122307. /**
  122308. * The bone that will be looking to the target
  122309. */
  122310. bone: Bone;
  122311. /**
  122312. * The up axis of the coordinate system that is used when the bone is rotated
  122313. */
  122314. upAxis: Vector3;
  122315. /**
  122316. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  122317. */
  122318. upAxisSpace: Space;
  122319. /**
  122320. * Used to make an adjustment to the yaw of the bone
  122321. */
  122322. adjustYaw: number;
  122323. /**
  122324. * Used to make an adjustment to the pitch of the bone
  122325. */
  122326. adjustPitch: number;
  122327. /**
  122328. * Used to make an adjustment to the roll of the bone
  122329. */
  122330. adjustRoll: number;
  122331. /**
  122332. * 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)
  122333. */
  122334. slerpAmount: number;
  122335. private _minYaw;
  122336. private _maxYaw;
  122337. private _minPitch;
  122338. private _maxPitch;
  122339. private _minYawSin;
  122340. private _minYawCos;
  122341. private _maxYawSin;
  122342. private _maxYawCos;
  122343. private _midYawConstraint;
  122344. private _minPitchTan;
  122345. private _maxPitchTan;
  122346. private _boneQuat;
  122347. private _slerping;
  122348. private _transformYawPitch;
  122349. private _transformYawPitchInv;
  122350. private _firstFrameSkipped;
  122351. private _yawRange;
  122352. private _fowardAxis;
  122353. /**
  122354. * Gets or sets the minimum yaw angle that the bone can look to
  122355. */
  122356. get minYaw(): number;
  122357. set minYaw(value: number);
  122358. /**
  122359. * Gets or sets the maximum yaw angle that the bone can look to
  122360. */
  122361. get maxYaw(): number;
  122362. set maxYaw(value: number);
  122363. /**
  122364. * Gets or sets the minimum pitch angle that the bone can look to
  122365. */
  122366. get minPitch(): number;
  122367. set minPitch(value: number);
  122368. /**
  122369. * Gets or sets the maximum pitch angle that the bone can look to
  122370. */
  122371. get maxPitch(): number;
  122372. set maxPitch(value: number);
  122373. /**
  122374. * Create a BoneLookController
  122375. * @param mesh the mesh that the bone belongs to
  122376. * @param bone the bone that will be looking to the target
  122377. * @param target the target Vector3 to look at
  122378. * @param options optional settings:
  122379. * * maxYaw: the maximum angle the bone will yaw to
  122380. * * minYaw: the minimum angle the bone will yaw to
  122381. * * maxPitch: the maximum angle the bone will pitch to
  122382. * * minPitch: the minimum angle the bone will yaw to
  122383. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  122384. * * upAxis: the up axis of the coordinate system
  122385. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  122386. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  122387. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  122388. * * adjustYaw: used to make an adjustment to the yaw of the bone
  122389. * * adjustPitch: used to make an adjustment to the pitch of the bone
  122390. * * adjustRoll: used to make an adjustment to the roll of the bone
  122391. **/
  122392. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  122393. maxYaw?: number;
  122394. minYaw?: number;
  122395. maxPitch?: number;
  122396. minPitch?: number;
  122397. slerpAmount?: number;
  122398. upAxis?: Vector3;
  122399. upAxisSpace?: Space;
  122400. yawAxis?: Vector3;
  122401. pitchAxis?: Vector3;
  122402. adjustYaw?: number;
  122403. adjustPitch?: number;
  122404. adjustRoll?: number;
  122405. });
  122406. /**
  122407. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  122408. */
  122409. update(): void;
  122410. private _getAngleDiff;
  122411. private _getAngleBetween;
  122412. private _isAngleBetween;
  122413. }
  122414. }
  122415. declare module BABYLON {
  122416. /**
  122417. * Manage the gamepad inputs to control an arc rotate camera.
  122418. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122419. */
  122420. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  122421. /**
  122422. * Defines the camera the input is attached to.
  122423. */
  122424. camera: ArcRotateCamera;
  122425. /**
  122426. * Defines the gamepad the input is gathering event from.
  122427. */
  122428. gamepad: Nullable<Gamepad>;
  122429. /**
  122430. * Defines the gamepad rotation sensiblity.
  122431. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  122432. */
  122433. gamepadRotationSensibility: number;
  122434. /**
  122435. * Defines the gamepad move sensiblity.
  122436. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  122437. */
  122438. gamepadMoveSensibility: number;
  122439. private _yAxisScale;
  122440. /**
  122441. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  122442. */
  122443. get invertYAxis(): boolean;
  122444. set invertYAxis(value: boolean);
  122445. private _onGamepadConnectedObserver;
  122446. private _onGamepadDisconnectedObserver;
  122447. /**
  122448. * Attach the input controls to a specific dom element to get the input from.
  122449. * @param element Defines the element the controls should be listened from
  122450. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122451. */
  122452. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122453. /**
  122454. * Detach the current controls from the specified dom element.
  122455. * @param element Defines the element to stop listening the inputs from
  122456. */
  122457. detachControl(element: Nullable<HTMLElement>): void;
  122458. /**
  122459. * Update the current camera state depending on the inputs that have been used this frame.
  122460. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122461. */
  122462. checkInputs(): void;
  122463. /**
  122464. * Gets the class name of the current intput.
  122465. * @returns the class name
  122466. */
  122467. getClassName(): string;
  122468. /**
  122469. * Get the friendly name associated with the input class.
  122470. * @returns the input friendly name
  122471. */
  122472. getSimpleName(): string;
  122473. }
  122474. }
  122475. declare module BABYLON {
  122476. interface ArcRotateCameraInputsManager {
  122477. /**
  122478. * Add orientation input support to the input manager.
  122479. * @returns the current input manager
  122480. */
  122481. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  122482. }
  122483. /**
  122484. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  122485. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122486. */
  122487. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  122488. /**
  122489. * Defines the camera the input is attached to.
  122490. */
  122491. camera: ArcRotateCamera;
  122492. /**
  122493. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  122494. */
  122495. alphaCorrection: number;
  122496. /**
  122497. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  122498. */
  122499. gammaCorrection: number;
  122500. private _alpha;
  122501. private _gamma;
  122502. private _dirty;
  122503. private _deviceOrientationHandler;
  122504. /**
  122505. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  122506. */
  122507. constructor();
  122508. /**
  122509. * Attach the input controls to a specific dom element to get the input from.
  122510. * @param element Defines the element the controls should be listened from
  122511. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122512. */
  122513. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122514. /** @hidden */
  122515. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  122516. /**
  122517. * Update the current camera state depending on the inputs that have been used this frame.
  122518. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122519. */
  122520. checkInputs(): void;
  122521. /**
  122522. * Detach the current controls from the specified dom element.
  122523. * @param element Defines the element to stop listening the inputs from
  122524. */
  122525. detachControl(element: Nullable<HTMLElement>): void;
  122526. /**
  122527. * Gets the class name of the current intput.
  122528. * @returns the class name
  122529. */
  122530. getClassName(): string;
  122531. /**
  122532. * Get the friendly name associated with the input class.
  122533. * @returns the input friendly name
  122534. */
  122535. getSimpleName(): string;
  122536. }
  122537. }
  122538. declare module BABYLON {
  122539. /**
  122540. * Listen to mouse events to control the camera.
  122541. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122542. */
  122543. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  122544. /**
  122545. * Defines the camera the input is attached to.
  122546. */
  122547. camera: FlyCamera;
  122548. /**
  122549. * Defines if touch is enabled. (Default is true.)
  122550. */
  122551. touchEnabled: boolean;
  122552. /**
  122553. * Defines the buttons associated with the input to handle camera rotation.
  122554. */
  122555. buttons: number[];
  122556. /**
  122557. * Assign buttons for Yaw control.
  122558. */
  122559. buttonsYaw: number[];
  122560. /**
  122561. * Assign buttons for Pitch control.
  122562. */
  122563. buttonsPitch: number[];
  122564. /**
  122565. * Assign buttons for Roll control.
  122566. */
  122567. buttonsRoll: number[];
  122568. /**
  122569. * Detect if any button is being pressed while mouse is moved.
  122570. * -1 = Mouse locked.
  122571. * 0 = Left button.
  122572. * 1 = Middle Button.
  122573. * 2 = Right Button.
  122574. */
  122575. activeButton: number;
  122576. /**
  122577. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  122578. * Higher values reduce its sensitivity.
  122579. */
  122580. angularSensibility: number;
  122581. private _mousemoveCallback;
  122582. private _observer;
  122583. private _rollObserver;
  122584. private previousPosition;
  122585. private noPreventDefault;
  122586. private element;
  122587. /**
  122588. * Listen to mouse events to control the camera.
  122589. * @param touchEnabled Define if touch is enabled. (Default is true.)
  122590. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122591. */
  122592. constructor(touchEnabled?: boolean);
  122593. /**
  122594. * Attach the mouse control to the HTML DOM element.
  122595. * @param element Defines the element that listens to the input events.
  122596. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  122597. */
  122598. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122599. /**
  122600. * Detach the current controls from the specified dom element.
  122601. * @param element Defines the element to stop listening the inputs from
  122602. */
  122603. detachControl(element: Nullable<HTMLElement>): void;
  122604. /**
  122605. * Gets the class name of the current input.
  122606. * @returns the class name.
  122607. */
  122608. getClassName(): string;
  122609. /**
  122610. * Get the friendly name associated with the input class.
  122611. * @returns the input's friendly name.
  122612. */
  122613. getSimpleName(): string;
  122614. private _pointerInput;
  122615. private _onMouseMove;
  122616. /**
  122617. * Rotate camera by mouse offset.
  122618. */
  122619. private rotateCamera;
  122620. }
  122621. }
  122622. declare module BABYLON {
  122623. /**
  122624. * Default Inputs manager for the FlyCamera.
  122625. * It groups all the default supported inputs for ease of use.
  122626. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122627. */
  122628. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  122629. /**
  122630. * Instantiates a new FlyCameraInputsManager.
  122631. * @param camera Defines the camera the inputs belong to.
  122632. */
  122633. constructor(camera: FlyCamera);
  122634. /**
  122635. * Add keyboard input support to the input manager.
  122636. * @returns the new FlyCameraKeyboardMoveInput().
  122637. */
  122638. addKeyboard(): FlyCameraInputsManager;
  122639. /**
  122640. * Add mouse input support to the input manager.
  122641. * @param touchEnabled Enable touch screen support.
  122642. * @returns the new FlyCameraMouseInput().
  122643. */
  122644. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  122645. }
  122646. }
  122647. declare module BABYLON {
  122648. /**
  122649. * This is a flying camera, designed for 3D movement and rotation in all directions,
  122650. * such as in a 3D Space Shooter or a Flight Simulator.
  122651. */
  122652. export class FlyCamera extends TargetCamera {
  122653. /**
  122654. * Define the collision ellipsoid of the camera.
  122655. * This is helpful for simulating a camera body, like a player's body.
  122656. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122657. */
  122658. ellipsoid: Vector3;
  122659. /**
  122660. * Define an offset for the position of the ellipsoid around the camera.
  122661. * This can be helpful if the camera is attached away from the player's body center,
  122662. * such as at its head.
  122663. */
  122664. ellipsoidOffset: Vector3;
  122665. /**
  122666. * Enable or disable collisions of the camera with the rest of the scene objects.
  122667. */
  122668. checkCollisions: boolean;
  122669. /**
  122670. * Enable or disable gravity on the camera.
  122671. */
  122672. applyGravity: boolean;
  122673. /**
  122674. * Define the current direction the camera is moving to.
  122675. */
  122676. cameraDirection: Vector3;
  122677. /**
  122678. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  122679. * This overrides and empties cameraRotation.
  122680. */
  122681. rotationQuaternion: Quaternion;
  122682. /**
  122683. * Track Roll to maintain the wanted Rolling when looking around.
  122684. */
  122685. _trackRoll: number;
  122686. /**
  122687. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  122688. */
  122689. rollCorrect: number;
  122690. /**
  122691. * Mimic a banked turn, Rolling the camera when Yawing.
  122692. * It's recommended to use rollCorrect = 10 for faster banking correction.
  122693. */
  122694. bankedTurn: boolean;
  122695. /**
  122696. * Limit in radians for how much Roll banking will add. (Default: 90°)
  122697. */
  122698. bankedTurnLimit: number;
  122699. /**
  122700. * Value of 0 disables the banked Roll.
  122701. * Value of 1 is equal to the Yaw angle in radians.
  122702. */
  122703. bankedTurnMultiplier: number;
  122704. /**
  122705. * The inputs manager loads all the input sources, such as keyboard and mouse.
  122706. */
  122707. inputs: FlyCameraInputsManager;
  122708. /**
  122709. * Gets the input sensibility for mouse input.
  122710. * Higher values reduce sensitivity.
  122711. */
  122712. get angularSensibility(): number;
  122713. /**
  122714. * Sets the input sensibility for a mouse input.
  122715. * Higher values reduce sensitivity.
  122716. */
  122717. set angularSensibility(value: number);
  122718. /**
  122719. * Get the keys for camera movement forward.
  122720. */
  122721. get keysForward(): number[];
  122722. /**
  122723. * Set the keys for camera movement forward.
  122724. */
  122725. set keysForward(value: number[]);
  122726. /**
  122727. * Get the keys for camera movement backward.
  122728. */
  122729. get keysBackward(): number[];
  122730. set keysBackward(value: number[]);
  122731. /**
  122732. * Get the keys for camera movement up.
  122733. */
  122734. get keysUp(): number[];
  122735. /**
  122736. * Set the keys for camera movement up.
  122737. */
  122738. set keysUp(value: number[]);
  122739. /**
  122740. * Get the keys for camera movement down.
  122741. */
  122742. get keysDown(): number[];
  122743. /**
  122744. * Set the keys for camera movement down.
  122745. */
  122746. set keysDown(value: number[]);
  122747. /**
  122748. * Get the keys for camera movement left.
  122749. */
  122750. get keysLeft(): number[];
  122751. /**
  122752. * Set the keys for camera movement left.
  122753. */
  122754. set keysLeft(value: number[]);
  122755. /**
  122756. * Set the keys for camera movement right.
  122757. */
  122758. get keysRight(): number[];
  122759. /**
  122760. * Set the keys for camera movement right.
  122761. */
  122762. set keysRight(value: number[]);
  122763. /**
  122764. * Event raised when the camera collides with a mesh in the scene.
  122765. */
  122766. onCollide: (collidedMesh: AbstractMesh) => void;
  122767. private _collider;
  122768. private _needMoveForGravity;
  122769. private _oldPosition;
  122770. private _diffPosition;
  122771. private _newPosition;
  122772. /** @hidden */
  122773. _localDirection: Vector3;
  122774. /** @hidden */
  122775. _transformedDirection: Vector3;
  122776. /**
  122777. * Instantiates a FlyCamera.
  122778. * This is a flying camera, designed for 3D movement and rotation in all directions,
  122779. * such as in a 3D Space Shooter or a Flight Simulator.
  122780. * @param name Define the name of the camera in the scene.
  122781. * @param position Define the starting position of the camera in the scene.
  122782. * @param scene Define the scene the camera belongs to.
  122783. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  122784. */
  122785. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122786. /**
  122787. * Attach a control to the HTML DOM element.
  122788. * @param element Defines the element that listens to the input events.
  122789. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  122790. */
  122791. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122792. /**
  122793. * Detach a control from the HTML DOM element.
  122794. * The camera will stop reacting to that input.
  122795. * @param element Defines the element that listens to the input events.
  122796. */
  122797. detachControl(element: HTMLElement): void;
  122798. private _collisionMask;
  122799. /**
  122800. * Get the mask that the camera ignores in collision events.
  122801. */
  122802. get collisionMask(): number;
  122803. /**
  122804. * Set the mask that the camera ignores in collision events.
  122805. */
  122806. set collisionMask(mask: number);
  122807. /** @hidden */
  122808. _collideWithWorld(displacement: Vector3): void;
  122809. /** @hidden */
  122810. private _onCollisionPositionChange;
  122811. /** @hidden */
  122812. _checkInputs(): void;
  122813. /** @hidden */
  122814. _decideIfNeedsToMove(): boolean;
  122815. /** @hidden */
  122816. _updatePosition(): void;
  122817. /**
  122818. * Restore the Roll to its target value at the rate specified.
  122819. * @param rate - Higher means slower restoring.
  122820. * @hidden
  122821. */
  122822. restoreRoll(rate: number): void;
  122823. /**
  122824. * Destroy the camera and release the current resources held by it.
  122825. */
  122826. dispose(): void;
  122827. /**
  122828. * Get the current object class name.
  122829. * @returns the class name.
  122830. */
  122831. getClassName(): string;
  122832. }
  122833. }
  122834. declare module BABYLON {
  122835. /**
  122836. * Listen to keyboard events to control the camera.
  122837. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122838. */
  122839. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  122840. /**
  122841. * Defines the camera the input is attached to.
  122842. */
  122843. camera: FlyCamera;
  122844. /**
  122845. * The list of keyboard keys used to control the forward move of the camera.
  122846. */
  122847. keysForward: number[];
  122848. /**
  122849. * The list of keyboard keys used to control the backward move of the camera.
  122850. */
  122851. keysBackward: number[];
  122852. /**
  122853. * The list of keyboard keys used to control the forward move of the camera.
  122854. */
  122855. keysUp: number[];
  122856. /**
  122857. * The list of keyboard keys used to control the backward move of the camera.
  122858. */
  122859. keysDown: number[];
  122860. /**
  122861. * The list of keyboard keys used to control the right strafe move of the camera.
  122862. */
  122863. keysRight: number[];
  122864. /**
  122865. * The list of keyboard keys used to control the left strafe move of the camera.
  122866. */
  122867. keysLeft: number[];
  122868. private _keys;
  122869. private _onCanvasBlurObserver;
  122870. private _onKeyboardObserver;
  122871. private _engine;
  122872. private _scene;
  122873. /**
  122874. * Attach the input controls to a specific dom element to get the input from.
  122875. * @param element Defines the element the controls should be listened from
  122876. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122877. */
  122878. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122879. /**
  122880. * Detach the current controls from the specified dom element.
  122881. * @param element Defines the element to stop listening the inputs from
  122882. */
  122883. detachControl(element: Nullable<HTMLElement>): void;
  122884. /**
  122885. * Gets the class name of the current intput.
  122886. * @returns the class name
  122887. */
  122888. getClassName(): string;
  122889. /** @hidden */
  122890. _onLostFocus(e: FocusEvent): void;
  122891. /**
  122892. * Get the friendly name associated with the input class.
  122893. * @returns the input friendly name
  122894. */
  122895. getSimpleName(): string;
  122896. /**
  122897. * Update the current camera state depending on the inputs that have been used this frame.
  122898. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122899. */
  122900. checkInputs(): void;
  122901. }
  122902. }
  122903. declare module BABYLON {
  122904. /**
  122905. * Manage the mouse wheel inputs to control a follow camera.
  122906. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122907. */
  122908. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  122909. /**
  122910. * Defines the camera the input is attached to.
  122911. */
  122912. camera: FollowCamera;
  122913. /**
  122914. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  122915. */
  122916. axisControlRadius: boolean;
  122917. /**
  122918. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  122919. */
  122920. axisControlHeight: boolean;
  122921. /**
  122922. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  122923. */
  122924. axisControlRotation: boolean;
  122925. /**
  122926. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  122927. * relation to mouseWheel events.
  122928. */
  122929. wheelPrecision: number;
  122930. /**
  122931. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122932. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122933. */
  122934. wheelDeltaPercentage: number;
  122935. private _wheel;
  122936. private _observer;
  122937. /**
  122938. * Attach the input controls to a specific dom element to get the input from.
  122939. * @param element Defines the element the controls should be listened from
  122940. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122941. */
  122942. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122943. /**
  122944. * Detach the current controls from the specified dom element.
  122945. * @param element Defines the element to stop listening the inputs from
  122946. */
  122947. detachControl(element: Nullable<HTMLElement>): void;
  122948. /**
  122949. * Gets the class name of the current intput.
  122950. * @returns the class name
  122951. */
  122952. getClassName(): string;
  122953. /**
  122954. * Get the friendly name associated with the input class.
  122955. * @returns the input friendly name
  122956. */
  122957. getSimpleName(): string;
  122958. }
  122959. }
  122960. declare module BABYLON {
  122961. /**
  122962. * Manage the pointers inputs to control an follow camera.
  122963. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122964. */
  122965. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  122966. /**
  122967. * Defines the camera the input is attached to.
  122968. */
  122969. camera: FollowCamera;
  122970. /**
  122971. * Gets the class name of the current input.
  122972. * @returns the class name
  122973. */
  122974. getClassName(): string;
  122975. /**
  122976. * Defines the pointer angular sensibility along the X axis or how fast is
  122977. * the camera rotating.
  122978. * A negative number will reverse the axis direction.
  122979. */
  122980. angularSensibilityX: number;
  122981. /**
  122982. * Defines the pointer angular sensibility along the Y axis or how fast is
  122983. * the camera rotating.
  122984. * A negative number will reverse the axis direction.
  122985. */
  122986. angularSensibilityY: number;
  122987. /**
  122988. * Defines the pointer pinch precision or how fast is the camera zooming.
  122989. * A negative number will reverse the axis direction.
  122990. */
  122991. pinchPrecision: number;
  122992. /**
  122993. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122994. * from 0.
  122995. * It defines the percentage of current camera.radius to use as delta when
  122996. * pinch zoom is used.
  122997. */
  122998. pinchDeltaPercentage: number;
  122999. /**
  123000. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  123001. */
  123002. axisXControlRadius: boolean;
  123003. /**
  123004. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  123005. */
  123006. axisXControlHeight: boolean;
  123007. /**
  123008. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  123009. */
  123010. axisXControlRotation: boolean;
  123011. /**
  123012. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  123013. */
  123014. axisYControlRadius: boolean;
  123015. /**
  123016. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  123017. */
  123018. axisYControlHeight: boolean;
  123019. /**
  123020. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  123021. */
  123022. axisYControlRotation: boolean;
  123023. /**
  123024. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  123025. */
  123026. axisPinchControlRadius: boolean;
  123027. /**
  123028. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  123029. */
  123030. axisPinchControlHeight: boolean;
  123031. /**
  123032. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  123033. */
  123034. axisPinchControlRotation: boolean;
  123035. /**
  123036. * Log error messages if basic misconfiguration has occurred.
  123037. */
  123038. warningEnable: boolean;
  123039. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  123040. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  123041. private _warningCounter;
  123042. private _warning;
  123043. }
  123044. }
  123045. declare module BABYLON {
  123046. /**
  123047. * Default Inputs manager for the FollowCamera.
  123048. * It groups all the default supported inputs for ease of use.
  123049. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123050. */
  123051. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  123052. /**
  123053. * Instantiates a new FollowCameraInputsManager.
  123054. * @param camera Defines the camera the inputs belong to
  123055. */
  123056. constructor(camera: FollowCamera);
  123057. /**
  123058. * Add keyboard input support to the input manager.
  123059. * @returns the current input manager
  123060. */
  123061. addKeyboard(): FollowCameraInputsManager;
  123062. /**
  123063. * Add mouse wheel input support to the input manager.
  123064. * @returns the current input manager
  123065. */
  123066. addMouseWheel(): FollowCameraInputsManager;
  123067. /**
  123068. * Add pointers input support to the input manager.
  123069. * @returns the current input manager
  123070. */
  123071. addPointers(): FollowCameraInputsManager;
  123072. /**
  123073. * Add orientation input support to the input manager.
  123074. * @returns the current input manager
  123075. */
  123076. addVRDeviceOrientation(): FollowCameraInputsManager;
  123077. }
  123078. }
  123079. declare module BABYLON {
  123080. /**
  123081. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  123082. * an arc rotate version arcFollowCamera are available.
  123083. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123084. */
  123085. export class FollowCamera extends TargetCamera {
  123086. /**
  123087. * Distance the follow camera should follow an object at
  123088. */
  123089. radius: number;
  123090. /**
  123091. * Minimum allowed distance of the camera to the axis of rotation
  123092. * (The camera can not get closer).
  123093. * This can help limiting how the Camera is able to move in the scene.
  123094. */
  123095. lowerRadiusLimit: Nullable<number>;
  123096. /**
  123097. * Maximum allowed distance of the camera to the axis of rotation
  123098. * (The camera can not get further).
  123099. * This can help limiting how the Camera is able to move in the scene.
  123100. */
  123101. upperRadiusLimit: Nullable<number>;
  123102. /**
  123103. * Define a rotation offset between the camera and the object it follows
  123104. */
  123105. rotationOffset: number;
  123106. /**
  123107. * Minimum allowed angle to camera position relative to target object.
  123108. * This can help limiting how the Camera is able to move in the scene.
  123109. */
  123110. lowerRotationOffsetLimit: Nullable<number>;
  123111. /**
  123112. * Maximum allowed angle to camera position relative to target object.
  123113. * This can help limiting how the Camera is able to move in the scene.
  123114. */
  123115. upperRotationOffsetLimit: Nullable<number>;
  123116. /**
  123117. * Define a height offset between the camera and the object it follows.
  123118. * It can help following an object from the top (like a car chaing a plane)
  123119. */
  123120. heightOffset: number;
  123121. /**
  123122. * Minimum allowed height of camera position relative to target object.
  123123. * This can help limiting how the Camera is able to move in the scene.
  123124. */
  123125. lowerHeightOffsetLimit: Nullable<number>;
  123126. /**
  123127. * Maximum allowed height of camera position relative to target object.
  123128. * This can help limiting how the Camera is able to move in the scene.
  123129. */
  123130. upperHeightOffsetLimit: Nullable<number>;
  123131. /**
  123132. * Define how fast the camera can accelerate to follow it s target.
  123133. */
  123134. cameraAcceleration: number;
  123135. /**
  123136. * Define the speed limit of the camera following an object.
  123137. */
  123138. maxCameraSpeed: number;
  123139. /**
  123140. * Define the target of the camera.
  123141. */
  123142. lockedTarget: Nullable<AbstractMesh>;
  123143. /**
  123144. * Defines the input associated with the camera.
  123145. */
  123146. inputs: FollowCameraInputsManager;
  123147. /**
  123148. * Instantiates the follow camera.
  123149. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123150. * @param name Define the name of the camera in the scene
  123151. * @param position Define the position of the camera
  123152. * @param scene Define the scene the camera belong to
  123153. * @param lockedTarget Define the target of the camera
  123154. */
  123155. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  123156. private _follow;
  123157. /**
  123158. * Attached controls to the current camera.
  123159. * @param element Defines the element the controls should be listened from
  123160. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123161. */
  123162. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123163. /**
  123164. * Detach the current controls from the camera.
  123165. * The camera will stop reacting to inputs.
  123166. * @param element Defines the element to stop listening the inputs from
  123167. */
  123168. detachControl(element: HTMLElement): void;
  123169. /** @hidden */
  123170. _checkInputs(): void;
  123171. private _checkLimits;
  123172. /**
  123173. * Gets the camera class name.
  123174. * @returns the class name
  123175. */
  123176. getClassName(): string;
  123177. }
  123178. /**
  123179. * Arc Rotate version of the follow camera.
  123180. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  123181. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123182. */
  123183. export class ArcFollowCamera extends TargetCamera {
  123184. /** The longitudinal angle of the camera */
  123185. alpha: number;
  123186. /** The latitudinal angle of the camera */
  123187. beta: number;
  123188. /** The radius of the camera from its target */
  123189. radius: number;
  123190. /** Define the camera target (the mesh it should follow) */
  123191. target: Nullable<AbstractMesh>;
  123192. private _cartesianCoordinates;
  123193. /**
  123194. * Instantiates a new ArcFollowCamera
  123195. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123196. * @param name Define the name of the camera
  123197. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  123198. * @param beta Define the rotation angle of the camera around the elevation axis
  123199. * @param radius Define the radius of the camera from its target point
  123200. * @param target Define the target of the camera
  123201. * @param scene Define the scene the camera belongs to
  123202. */
  123203. constructor(name: string,
  123204. /** The longitudinal angle of the camera */
  123205. alpha: number,
  123206. /** The latitudinal angle of the camera */
  123207. beta: number,
  123208. /** The radius of the camera from its target */
  123209. radius: number,
  123210. /** Define the camera target (the mesh it should follow) */
  123211. target: Nullable<AbstractMesh>, scene: Scene);
  123212. private _follow;
  123213. /** @hidden */
  123214. _checkInputs(): void;
  123215. /**
  123216. * Returns the class name of the object.
  123217. * It is mostly used internally for serialization purposes.
  123218. */
  123219. getClassName(): string;
  123220. }
  123221. }
  123222. declare module BABYLON {
  123223. /**
  123224. * Manage the keyboard inputs to control the movement of a follow camera.
  123225. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123226. */
  123227. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  123228. /**
  123229. * Defines the camera the input is attached to.
  123230. */
  123231. camera: FollowCamera;
  123232. /**
  123233. * Defines the list of key codes associated with the up action (increase heightOffset)
  123234. */
  123235. keysHeightOffsetIncr: number[];
  123236. /**
  123237. * Defines the list of key codes associated with the down action (decrease heightOffset)
  123238. */
  123239. keysHeightOffsetDecr: number[];
  123240. /**
  123241. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  123242. */
  123243. keysHeightOffsetModifierAlt: boolean;
  123244. /**
  123245. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  123246. */
  123247. keysHeightOffsetModifierCtrl: boolean;
  123248. /**
  123249. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  123250. */
  123251. keysHeightOffsetModifierShift: boolean;
  123252. /**
  123253. * Defines the list of key codes associated with the left action (increase rotationOffset)
  123254. */
  123255. keysRotationOffsetIncr: number[];
  123256. /**
  123257. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  123258. */
  123259. keysRotationOffsetDecr: number[];
  123260. /**
  123261. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  123262. */
  123263. keysRotationOffsetModifierAlt: boolean;
  123264. /**
  123265. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  123266. */
  123267. keysRotationOffsetModifierCtrl: boolean;
  123268. /**
  123269. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  123270. */
  123271. keysRotationOffsetModifierShift: boolean;
  123272. /**
  123273. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  123274. */
  123275. keysRadiusIncr: number[];
  123276. /**
  123277. * Defines the list of key codes associated with the zoom-out action (increase radius)
  123278. */
  123279. keysRadiusDecr: number[];
  123280. /**
  123281. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  123282. */
  123283. keysRadiusModifierAlt: boolean;
  123284. /**
  123285. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  123286. */
  123287. keysRadiusModifierCtrl: boolean;
  123288. /**
  123289. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  123290. */
  123291. keysRadiusModifierShift: boolean;
  123292. /**
  123293. * Defines the rate of change of heightOffset.
  123294. */
  123295. heightSensibility: number;
  123296. /**
  123297. * Defines the rate of change of rotationOffset.
  123298. */
  123299. rotationSensibility: number;
  123300. /**
  123301. * Defines the rate of change of radius.
  123302. */
  123303. radiusSensibility: number;
  123304. private _keys;
  123305. private _ctrlPressed;
  123306. private _altPressed;
  123307. private _shiftPressed;
  123308. private _onCanvasBlurObserver;
  123309. private _onKeyboardObserver;
  123310. private _engine;
  123311. private _scene;
  123312. /**
  123313. * Attach the input controls to a specific dom element to get the input from.
  123314. * @param element Defines the element the controls should be listened from
  123315. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123316. */
  123317. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123318. /**
  123319. * Detach the current controls from the specified dom element.
  123320. * @param element Defines the element to stop listening the inputs from
  123321. */
  123322. detachControl(element: Nullable<HTMLElement>): void;
  123323. /**
  123324. * Update the current camera state depending on the inputs that have been used this frame.
  123325. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123326. */
  123327. checkInputs(): void;
  123328. /**
  123329. * Gets the class name of the current input.
  123330. * @returns the class name
  123331. */
  123332. getClassName(): string;
  123333. /**
  123334. * Get the friendly name associated with the input class.
  123335. * @returns the input friendly name
  123336. */
  123337. getSimpleName(): string;
  123338. /**
  123339. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123340. * allow modification of the heightOffset value.
  123341. */
  123342. private _modifierHeightOffset;
  123343. /**
  123344. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123345. * allow modification of the rotationOffset value.
  123346. */
  123347. private _modifierRotationOffset;
  123348. /**
  123349. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123350. * allow modification of the radius value.
  123351. */
  123352. private _modifierRadius;
  123353. }
  123354. }
  123355. declare module BABYLON {
  123356. interface FreeCameraInputsManager {
  123357. /**
  123358. * @hidden
  123359. */
  123360. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  123361. /**
  123362. * Add orientation input support to the input manager.
  123363. * @returns the current input manager
  123364. */
  123365. addDeviceOrientation(): FreeCameraInputsManager;
  123366. }
  123367. /**
  123368. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  123369. * Screen rotation is taken into account.
  123370. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123371. */
  123372. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  123373. private _camera;
  123374. private _screenOrientationAngle;
  123375. private _constantTranform;
  123376. private _screenQuaternion;
  123377. private _alpha;
  123378. private _beta;
  123379. private _gamma;
  123380. /**
  123381. * Can be used to detect if a device orientation sensor is available on a device
  123382. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  123383. * @returns a promise that will resolve on orientation change
  123384. */
  123385. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  123386. /**
  123387. * @hidden
  123388. */
  123389. _onDeviceOrientationChangedObservable: Observable<void>;
  123390. /**
  123391. * Instantiates a new input
  123392. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123393. */
  123394. constructor();
  123395. /**
  123396. * Define the camera controlled by the input.
  123397. */
  123398. get camera(): FreeCamera;
  123399. set camera(camera: FreeCamera);
  123400. /**
  123401. * Attach the input controls to a specific dom element to get the input from.
  123402. * @param element Defines the element the controls should be listened from
  123403. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123404. */
  123405. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123406. private _orientationChanged;
  123407. private _deviceOrientation;
  123408. /**
  123409. * Detach the current controls from the specified dom element.
  123410. * @param element Defines the element to stop listening the inputs from
  123411. */
  123412. detachControl(element: Nullable<HTMLElement>): void;
  123413. /**
  123414. * Update the current camera state depending on the inputs that have been used this frame.
  123415. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123416. */
  123417. checkInputs(): void;
  123418. /**
  123419. * Gets the class name of the current intput.
  123420. * @returns the class name
  123421. */
  123422. getClassName(): string;
  123423. /**
  123424. * Get the friendly name associated with the input class.
  123425. * @returns the input friendly name
  123426. */
  123427. getSimpleName(): string;
  123428. }
  123429. }
  123430. declare module BABYLON {
  123431. /**
  123432. * Manage the gamepad inputs to control a free camera.
  123433. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123434. */
  123435. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  123436. /**
  123437. * Define the camera the input is attached to.
  123438. */
  123439. camera: FreeCamera;
  123440. /**
  123441. * Define the Gamepad controlling the input
  123442. */
  123443. gamepad: Nullable<Gamepad>;
  123444. /**
  123445. * Defines the gamepad rotation sensiblity.
  123446. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123447. */
  123448. gamepadAngularSensibility: number;
  123449. /**
  123450. * Defines the gamepad move sensiblity.
  123451. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123452. */
  123453. gamepadMoveSensibility: number;
  123454. private _yAxisScale;
  123455. /**
  123456. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123457. */
  123458. get invertYAxis(): boolean;
  123459. set invertYAxis(value: boolean);
  123460. private _onGamepadConnectedObserver;
  123461. private _onGamepadDisconnectedObserver;
  123462. private _cameraTransform;
  123463. private _deltaTransform;
  123464. private _vector3;
  123465. private _vector2;
  123466. /**
  123467. * Attach the input controls to a specific dom element to get the input from.
  123468. * @param element Defines the element the controls should be listened from
  123469. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123470. */
  123471. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123472. /**
  123473. * Detach the current controls from the specified dom element.
  123474. * @param element Defines the element to stop listening the inputs from
  123475. */
  123476. detachControl(element: Nullable<HTMLElement>): void;
  123477. /**
  123478. * Update the current camera state depending on the inputs that have been used this frame.
  123479. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123480. */
  123481. checkInputs(): void;
  123482. /**
  123483. * Gets the class name of the current intput.
  123484. * @returns the class name
  123485. */
  123486. getClassName(): string;
  123487. /**
  123488. * Get the friendly name associated with the input class.
  123489. * @returns the input friendly name
  123490. */
  123491. getSimpleName(): string;
  123492. }
  123493. }
  123494. declare module BABYLON {
  123495. /**
  123496. * Defines the potential axis of a Joystick
  123497. */
  123498. export enum JoystickAxis {
  123499. /** X axis */
  123500. X = 0,
  123501. /** Y axis */
  123502. Y = 1,
  123503. /** Z axis */
  123504. Z = 2
  123505. }
  123506. /**
  123507. * Represents the different customization options available
  123508. * for VirtualJoystick
  123509. */
  123510. interface VirtualJoystickCustomizations {
  123511. /**
  123512. * Size of the joystick's puck
  123513. */
  123514. puckSize: number;
  123515. /**
  123516. * Size of the joystick's container
  123517. */
  123518. containerSize: number;
  123519. /**
  123520. * Color of the joystick && puck
  123521. */
  123522. color: string;
  123523. /**
  123524. * Image URL for the joystick's puck
  123525. */
  123526. puckImage?: string;
  123527. /**
  123528. * Image URL for the joystick's container
  123529. */
  123530. containerImage?: string;
  123531. /**
  123532. * Defines the unmoving position of the joystick container
  123533. */
  123534. position?: {
  123535. x: number;
  123536. y: number;
  123537. };
  123538. /**
  123539. * Defines whether or not the joystick container is always visible
  123540. */
  123541. alwaysVisible: boolean;
  123542. /**
  123543. * Defines whether or not to limit the movement of the puck to the joystick's container
  123544. */
  123545. limitToContainer: boolean;
  123546. }
  123547. /**
  123548. * Class used to define virtual joystick (used in touch mode)
  123549. */
  123550. export class VirtualJoystick {
  123551. /**
  123552. * Gets or sets a boolean indicating that left and right values must be inverted
  123553. */
  123554. reverseLeftRight: boolean;
  123555. /**
  123556. * Gets or sets a boolean indicating that up and down values must be inverted
  123557. */
  123558. reverseUpDown: boolean;
  123559. /**
  123560. * Gets the offset value for the position (ie. the change of the position value)
  123561. */
  123562. deltaPosition: Vector3;
  123563. /**
  123564. * Gets a boolean indicating if the virtual joystick was pressed
  123565. */
  123566. pressed: boolean;
  123567. /**
  123568. * Canvas the virtual joystick will render onto, default z-index of this is 5
  123569. */
  123570. static Canvas: Nullable<HTMLCanvasElement>;
  123571. /**
  123572. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  123573. */
  123574. limitToContainer: boolean;
  123575. private static _globalJoystickIndex;
  123576. private static _alwaysVisibleSticks;
  123577. private static vjCanvasContext;
  123578. private static vjCanvasWidth;
  123579. private static vjCanvasHeight;
  123580. private static halfWidth;
  123581. private static _GetDefaultOptions;
  123582. private _action;
  123583. private _axisTargetedByLeftAndRight;
  123584. private _axisTargetedByUpAndDown;
  123585. private _joystickSensibility;
  123586. private _inversedSensibility;
  123587. private _joystickPointerID;
  123588. private _joystickColor;
  123589. private _joystickPointerPos;
  123590. private _joystickPreviousPointerPos;
  123591. private _joystickPointerStartPos;
  123592. private _deltaJoystickVector;
  123593. private _leftJoystick;
  123594. private _touches;
  123595. private _joystickPosition;
  123596. private _alwaysVisible;
  123597. private _puckImage;
  123598. private _containerImage;
  123599. private _joystickPuckSize;
  123600. private _joystickContainerSize;
  123601. private _clearPuckSize;
  123602. private _clearContainerSize;
  123603. private _clearPuckSizeOffset;
  123604. private _clearContainerSizeOffset;
  123605. private _onPointerDownHandlerRef;
  123606. private _onPointerMoveHandlerRef;
  123607. private _onPointerUpHandlerRef;
  123608. private _onResize;
  123609. /**
  123610. * Creates a new virtual joystick
  123611. * @param leftJoystick defines that the joystick is for left hand (false by default)
  123612. * @param customizations Defines the options we want to customize the VirtualJoystick
  123613. */
  123614. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  123615. /**
  123616. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  123617. * @param newJoystickSensibility defines the new sensibility
  123618. */
  123619. setJoystickSensibility(newJoystickSensibility: number): void;
  123620. private _onPointerDown;
  123621. private _onPointerMove;
  123622. private _onPointerUp;
  123623. /**
  123624. * Change the color of the virtual joystick
  123625. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  123626. */
  123627. setJoystickColor(newColor: string): void;
  123628. /**
  123629. * Size of the joystick's container
  123630. */
  123631. set containerSize(newSize: number);
  123632. get containerSize(): number;
  123633. /**
  123634. * Size of the joystick's puck
  123635. */
  123636. set puckSize(newSize: number);
  123637. get puckSize(): number;
  123638. /**
  123639. * Clears the set position of the joystick
  123640. */
  123641. clearPosition(): void;
  123642. /**
  123643. * Defines whether or not the joystick container is always visible
  123644. */
  123645. set alwaysVisible(value: boolean);
  123646. get alwaysVisible(): boolean;
  123647. /**
  123648. * Sets the constant position of the Joystick container
  123649. * @param x X axis coordinate
  123650. * @param y Y axis coordinate
  123651. */
  123652. setPosition(x: number, y: number): void;
  123653. /**
  123654. * Defines a callback to call when the joystick is touched
  123655. * @param action defines the callback
  123656. */
  123657. setActionOnTouch(action: () => any): void;
  123658. /**
  123659. * Defines which axis you'd like to control for left & right
  123660. * @param axis defines the axis to use
  123661. */
  123662. setAxisForLeftRight(axis: JoystickAxis): void;
  123663. /**
  123664. * Defines which axis you'd like to control for up & down
  123665. * @param axis defines the axis to use
  123666. */
  123667. setAxisForUpDown(axis: JoystickAxis): void;
  123668. /**
  123669. * Clears the canvas from the previous puck / container draw
  123670. */
  123671. private _clearPreviousDraw;
  123672. /**
  123673. * Loads `urlPath` to be used for the container's image
  123674. * @param urlPath defines the urlPath of an image to use
  123675. */
  123676. setContainerImage(urlPath: string): void;
  123677. /**
  123678. * Loads `urlPath` to be used for the puck's image
  123679. * @param urlPath defines the urlPath of an image to use
  123680. */
  123681. setPuckImage(urlPath: string): void;
  123682. /**
  123683. * Draws the Virtual Joystick's container
  123684. */
  123685. private _drawContainer;
  123686. /**
  123687. * Draws the Virtual Joystick's puck
  123688. */
  123689. private _drawPuck;
  123690. private _drawVirtualJoystick;
  123691. /**
  123692. * Release internal HTML canvas
  123693. */
  123694. releaseCanvas(): void;
  123695. }
  123696. }
  123697. declare module BABYLON {
  123698. interface FreeCameraInputsManager {
  123699. /**
  123700. * Add virtual joystick input support to the input manager.
  123701. * @returns the current input manager
  123702. */
  123703. addVirtualJoystick(): FreeCameraInputsManager;
  123704. }
  123705. /**
  123706. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  123707. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123708. */
  123709. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  123710. /**
  123711. * Defines the camera the input is attached to.
  123712. */
  123713. camera: FreeCamera;
  123714. private _leftjoystick;
  123715. private _rightjoystick;
  123716. /**
  123717. * Gets the left stick of the virtual joystick.
  123718. * @returns The virtual Joystick
  123719. */
  123720. getLeftJoystick(): VirtualJoystick;
  123721. /**
  123722. * Gets the right stick of the virtual joystick.
  123723. * @returns The virtual Joystick
  123724. */
  123725. getRightJoystick(): VirtualJoystick;
  123726. /**
  123727. * Update the current camera state depending on the inputs that have been used this frame.
  123728. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123729. */
  123730. checkInputs(): void;
  123731. /**
  123732. * Attach the input controls to a specific dom element to get the input from.
  123733. * @param element Defines the element the controls should be listened from
  123734. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123735. */
  123736. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123737. /**
  123738. * Detach the current controls from the specified dom element.
  123739. * @param element Defines the element to stop listening the inputs from
  123740. */
  123741. detachControl(element: Nullable<HTMLElement>): void;
  123742. /**
  123743. * Gets the class name of the current intput.
  123744. * @returns the class name
  123745. */
  123746. getClassName(): string;
  123747. /**
  123748. * Get the friendly name associated with the input class.
  123749. * @returns the input friendly name
  123750. */
  123751. getSimpleName(): string;
  123752. }
  123753. }
  123754. declare module BABYLON {
  123755. /**
  123756. * This represents a FPS type of camera controlled by touch.
  123757. * This is like a universal camera minus the Gamepad controls.
  123758. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  123759. */
  123760. export class TouchCamera extends FreeCamera {
  123761. /**
  123762. * Defines the touch sensibility for rotation.
  123763. * The higher the faster.
  123764. */
  123765. get touchAngularSensibility(): number;
  123766. set touchAngularSensibility(value: number);
  123767. /**
  123768. * Defines the touch sensibility for move.
  123769. * The higher the faster.
  123770. */
  123771. get touchMoveSensibility(): number;
  123772. set touchMoveSensibility(value: number);
  123773. /**
  123774. * Instantiates a new touch camera.
  123775. * This represents a FPS type of camera controlled by touch.
  123776. * This is like a universal camera minus the Gamepad controls.
  123777. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  123778. * @param name Define the name of the camera in the scene
  123779. * @param position Define the start position of the camera in the scene
  123780. * @param scene Define the scene the camera belongs to
  123781. */
  123782. constructor(name: string, position: Vector3, scene: Scene);
  123783. /**
  123784. * Gets the current object class name.
  123785. * @return the class name
  123786. */
  123787. getClassName(): string;
  123788. /** @hidden */
  123789. _setupInputs(): void;
  123790. }
  123791. }
  123792. declare module BABYLON {
  123793. /**
  123794. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  123795. * being tilted forward or back and left or right.
  123796. */
  123797. export class DeviceOrientationCamera extends FreeCamera {
  123798. private _initialQuaternion;
  123799. private _quaternionCache;
  123800. private _tmpDragQuaternion;
  123801. private _disablePointerInputWhenUsingDeviceOrientation;
  123802. /**
  123803. * Creates a new device orientation camera
  123804. * @param name The name of the camera
  123805. * @param position The start position camera
  123806. * @param scene The scene the camera belongs to
  123807. */
  123808. constructor(name: string, position: Vector3, scene: Scene);
  123809. /**
  123810. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  123811. */
  123812. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  123813. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  123814. private _dragFactor;
  123815. /**
  123816. * Enabled turning on the y axis when the orientation sensor is active
  123817. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  123818. */
  123819. enableHorizontalDragging(dragFactor?: number): void;
  123820. /**
  123821. * Gets the current instance class name ("DeviceOrientationCamera").
  123822. * This helps avoiding instanceof at run time.
  123823. * @returns the class name
  123824. */
  123825. getClassName(): string;
  123826. /**
  123827. * @hidden
  123828. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  123829. */
  123830. _checkInputs(): void;
  123831. /**
  123832. * Reset the camera to its default orientation on the specified axis only.
  123833. * @param axis The axis to reset
  123834. */
  123835. resetToCurrentRotation(axis?: Axis): void;
  123836. }
  123837. }
  123838. declare module BABYLON {
  123839. /**
  123840. * Defines supported buttons for XBox360 compatible gamepads
  123841. */
  123842. export enum Xbox360Button {
  123843. /** A */
  123844. A = 0,
  123845. /** B */
  123846. B = 1,
  123847. /** X */
  123848. X = 2,
  123849. /** Y */
  123850. Y = 3,
  123851. /** Left button */
  123852. LB = 4,
  123853. /** Right button */
  123854. RB = 5,
  123855. /** Back */
  123856. Back = 8,
  123857. /** Start */
  123858. Start = 9,
  123859. /** Left stick */
  123860. LeftStick = 10,
  123861. /** Right stick */
  123862. RightStick = 11
  123863. }
  123864. /** Defines values for XBox360 DPad */
  123865. export enum Xbox360Dpad {
  123866. /** Up */
  123867. Up = 12,
  123868. /** Down */
  123869. Down = 13,
  123870. /** Left */
  123871. Left = 14,
  123872. /** Right */
  123873. Right = 15
  123874. }
  123875. /**
  123876. * Defines a XBox360 gamepad
  123877. */
  123878. export class Xbox360Pad extends Gamepad {
  123879. private _leftTrigger;
  123880. private _rightTrigger;
  123881. private _onlefttriggerchanged;
  123882. private _onrighttriggerchanged;
  123883. private _onbuttondown;
  123884. private _onbuttonup;
  123885. private _ondpaddown;
  123886. private _ondpadup;
  123887. /** Observable raised when a button is pressed */
  123888. onButtonDownObservable: Observable<Xbox360Button>;
  123889. /** Observable raised when a button is released */
  123890. onButtonUpObservable: Observable<Xbox360Button>;
  123891. /** Observable raised when a pad is pressed */
  123892. onPadDownObservable: Observable<Xbox360Dpad>;
  123893. /** Observable raised when a pad is released */
  123894. onPadUpObservable: Observable<Xbox360Dpad>;
  123895. private _buttonA;
  123896. private _buttonB;
  123897. private _buttonX;
  123898. private _buttonY;
  123899. private _buttonBack;
  123900. private _buttonStart;
  123901. private _buttonLB;
  123902. private _buttonRB;
  123903. private _buttonLeftStick;
  123904. private _buttonRightStick;
  123905. private _dPadUp;
  123906. private _dPadDown;
  123907. private _dPadLeft;
  123908. private _dPadRight;
  123909. private _isXboxOnePad;
  123910. /**
  123911. * Creates a new XBox360 gamepad object
  123912. * @param id defines the id of this gamepad
  123913. * @param index defines its index
  123914. * @param gamepad defines the internal HTML gamepad object
  123915. * @param xboxOne defines if it is a XBox One gamepad
  123916. */
  123917. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  123918. /**
  123919. * Defines the callback to call when left trigger is pressed
  123920. * @param callback defines the callback to use
  123921. */
  123922. onlefttriggerchanged(callback: (value: number) => void): void;
  123923. /**
  123924. * Defines the callback to call when right trigger is pressed
  123925. * @param callback defines the callback to use
  123926. */
  123927. onrighttriggerchanged(callback: (value: number) => void): void;
  123928. /**
  123929. * Gets the left trigger value
  123930. */
  123931. get leftTrigger(): number;
  123932. /**
  123933. * Sets the left trigger value
  123934. */
  123935. set leftTrigger(newValue: number);
  123936. /**
  123937. * Gets the right trigger value
  123938. */
  123939. get rightTrigger(): number;
  123940. /**
  123941. * Sets the right trigger value
  123942. */
  123943. set rightTrigger(newValue: number);
  123944. /**
  123945. * Defines the callback to call when a button is pressed
  123946. * @param callback defines the callback to use
  123947. */
  123948. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  123949. /**
  123950. * Defines the callback to call when a button is released
  123951. * @param callback defines the callback to use
  123952. */
  123953. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  123954. /**
  123955. * Defines the callback to call when a pad is pressed
  123956. * @param callback defines the callback to use
  123957. */
  123958. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  123959. /**
  123960. * Defines the callback to call when a pad is released
  123961. * @param callback defines the callback to use
  123962. */
  123963. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  123964. private _setButtonValue;
  123965. private _setDPadValue;
  123966. /**
  123967. * Gets the value of the `A` button
  123968. */
  123969. get buttonA(): number;
  123970. /**
  123971. * Sets the value of the `A` button
  123972. */
  123973. set buttonA(value: number);
  123974. /**
  123975. * Gets the value of the `B` button
  123976. */
  123977. get buttonB(): number;
  123978. /**
  123979. * Sets the value of the `B` button
  123980. */
  123981. set buttonB(value: number);
  123982. /**
  123983. * Gets the value of the `X` button
  123984. */
  123985. get buttonX(): number;
  123986. /**
  123987. * Sets the value of the `X` button
  123988. */
  123989. set buttonX(value: number);
  123990. /**
  123991. * Gets the value of the `Y` button
  123992. */
  123993. get buttonY(): number;
  123994. /**
  123995. * Sets the value of the `Y` button
  123996. */
  123997. set buttonY(value: number);
  123998. /**
  123999. * Gets the value of the `Start` button
  124000. */
  124001. get buttonStart(): number;
  124002. /**
  124003. * Sets the value of the `Start` button
  124004. */
  124005. set buttonStart(value: number);
  124006. /**
  124007. * Gets the value of the `Back` button
  124008. */
  124009. get buttonBack(): number;
  124010. /**
  124011. * Sets the value of the `Back` button
  124012. */
  124013. set buttonBack(value: number);
  124014. /**
  124015. * Gets the value of the `Left` button
  124016. */
  124017. get buttonLB(): number;
  124018. /**
  124019. * Sets the value of the `Left` button
  124020. */
  124021. set buttonLB(value: number);
  124022. /**
  124023. * Gets the value of the `Right` button
  124024. */
  124025. get buttonRB(): number;
  124026. /**
  124027. * Sets the value of the `Right` button
  124028. */
  124029. set buttonRB(value: number);
  124030. /**
  124031. * Gets the value of the Left joystick
  124032. */
  124033. get buttonLeftStick(): number;
  124034. /**
  124035. * Sets the value of the Left joystick
  124036. */
  124037. set buttonLeftStick(value: number);
  124038. /**
  124039. * Gets the value of the Right joystick
  124040. */
  124041. get buttonRightStick(): number;
  124042. /**
  124043. * Sets the value of the Right joystick
  124044. */
  124045. set buttonRightStick(value: number);
  124046. /**
  124047. * Gets the value of D-pad up
  124048. */
  124049. get dPadUp(): number;
  124050. /**
  124051. * Sets the value of D-pad up
  124052. */
  124053. set dPadUp(value: number);
  124054. /**
  124055. * Gets the value of D-pad down
  124056. */
  124057. get dPadDown(): number;
  124058. /**
  124059. * Sets the value of D-pad down
  124060. */
  124061. set dPadDown(value: number);
  124062. /**
  124063. * Gets the value of D-pad left
  124064. */
  124065. get dPadLeft(): number;
  124066. /**
  124067. * Sets the value of D-pad left
  124068. */
  124069. set dPadLeft(value: number);
  124070. /**
  124071. * Gets the value of D-pad right
  124072. */
  124073. get dPadRight(): number;
  124074. /**
  124075. * Sets the value of D-pad right
  124076. */
  124077. set dPadRight(value: number);
  124078. /**
  124079. * Force the gamepad to synchronize with device values
  124080. */
  124081. update(): void;
  124082. /**
  124083. * Disposes the gamepad
  124084. */
  124085. dispose(): void;
  124086. }
  124087. }
  124088. declare module BABYLON {
  124089. /**
  124090. * Defines supported buttons for DualShock compatible gamepads
  124091. */
  124092. export enum DualShockButton {
  124093. /** Cross */
  124094. Cross = 0,
  124095. /** Circle */
  124096. Circle = 1,
  124097. /** Square */
  124098. Square = 2,
  124099. /** Triangle */
  124100. Triangle = 3,
  124101. /** L1 */
  124102. L1 = 4,
  124103. /** R1 */
  124104. R1 = 5,
  124105. /** Share */
  124106. Share = 8,
  124107. /** Options */
  124108. Options = 9,
  124109. /** Left stick */
  124110. LeftStick = 10,
  124111. /** Right stick */
  124112. RightStick = 11
  124113. }
  124114. /** Defines values for DualShock DPad */
  124115. export enum DualShockDpad {
  124116. /** Up */
  124117. Up = 12,
  124118. /** Down */
  124119. Down = 13,
  124120. /** Left */
  124121. Left = 14,
  124122. /** Right */
  124123. Right = 15
  124124. }
  124125. /**
  124126. * Defines a DualShock gamepad
  124127. */
  124128. export class DualShockPad extends Gamepad {
  124129. private _leftTrigger;
  124130. private _rightTrigger;
  124131. private _onlefttriggerchanged;
  124132. private _onrighttriggerchanged;
  124133. private _onbuttondown;
  124134. private _onbuttonup;
  124135. private _ondpaddown;
  124136. private _ondpadup;
  124137. /** Observable raised when a button is pressed */
  124138. onButtonDownObservable: Observable<DualShockButton>;
  124139. /** Observable raised when a button is released */
  124140. onButtonUpObservable: Observable<DualShockButton>;
  124141. /** Observable raised when a pad is pressed */
  124142. onPadDownObservable: Observable<DualShockDpad>;
  124143. /** Observable raised when a pad is released */
  124144. onPadUpObservable: Observable<DualShockDpad>;
  124145. private _buttonCross;
  124146. private _buttonCircle;
  124147. private _buttonSquare;
  124148. private _buttonTriangle;
  124149. private _buttonShare;
  124150. private _buttonOptions;
  124151. private _buttonL1;
  124152. private _buttonR1;
  124153. private _buttonLeftStick;
  124154. private _buttonRightStick;
  124155. private _dPadUp;
  124156. private _dPadDown;
  124157. private _dPadLeft;
  124158. private _dPadRight;
  124159. /**
  124160. * Creates a new DualShock gamepad object
  124161. * @param id defines the id of this gamepad
  124162. * @param index defines its index
  124163. * @param gamepad defines the internal HTML gamepad object
  124164. */
  124165. constructor(id: string, index: number, gamepad: any);
  124166. /**
  124167. * Defines the callback to call when left trigger is pressed
  124168. * @param callback defines the callback to use
  124169. */
  124170. onlefttriggerchanged(callback: (value: number) => void): void;
  124171. /**
  124172. * Defines the callback to call when right trigger is pressed
  124173. * @param callback defines the callback to use
  124174. */
  124175. onrighttriggerchanged(callback: (value: number) => void): void;
  124176. /**
  124177. * Gets the left trigger value
  124178. */
  124179. get leftTrigger(): number;
  124180. /**
  124181. * Sets the left trigger value
  124182. */
  124183. set leftTrigger(newValue: number);
  124184. /**
  124185. * Gets the right trigger value
  124186. */
  124187. get rightTrigger(): number;
  124188. /**
  124189. * Sets the right trigger value
  124190. */
  124191. set rightTrigger(newValue: number);
  124192. /**
  124193. * Defines the callback to call when a button is pressed
  124194. * @param callback defines the callback to use
  124195. */
  124196. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  124197. /**
  124198. * Defines the callback to call when a button is released
  124199. * @param callback defines the callback to use
  124200. */
  124201. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  124202. /**
  124203. * Defines the callback to call when a pad is pressed
  124204. * @param callback defines the callback to use
  124205. */
  124206. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  124207. /**
  124208. * Defines the callback to call when a pad is released
  124209. * @param callback defines the callback to use
  124210. */
  124211. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  124212. private _setButtonValue;
  124213. private _setDPadValue;
  124214. /**
  124215. * Gets the value of the `Cross` button
  124216. */
  124217. get buttonCross(): number;
  124218. /**
  124219. * Sets the value of the `Cross` button
  124220. */
  124221. set buttonCross(value: number);
  124222. /**
  124223. * Gets the value of the `Circle` button
  124224. */
  124225. get buttonCircle(): number;
  124226. /**
  124227. * Sets the value of the `Circle` button
  124228. */
  124229. set buttonCircle(value: number);
  124230. /**
  124231. * Gets the value of the `Square` button
  124232. */
  124233. get buttonSquare(): number;
  124234. /**
  124235. * Sets the value of the `Square` button
  124236. */
  124237. set buttonSquare(value: number);
  124238. /**
  124239. * Gets the value of the `Triangle` button
  124240. */
  124241. get buttonTriangle(): number;
  124242. /**
  124243. * Sets the value of the `Triangle` button
  124244. */
  124245. set buttonTriangle(value: number);
  124246. /**
  124247. * Gets the value of the `Options` button
  124248. */
  124249. get buttonOptions(): number;
  124250. /**
  124251. * Sets the value of the `Options` button
  124252. */
  124253. set buttonOptions(value: number);
  124254. /**
  124255. * Gets the value of the `Share` button
  124256. */
  124257. get buttonShare(): number;
  124258. /**
  124259. * Sets the value of the `Share` button
  124260. */
  124261. set buttonShare(value: number);
  124262. /**
  124263. * Gets the value of the `L1` button
  124264. */
  124265. get buttonL1(): number;
  124266. /**
  124267. * Sets the value of the `L1` button
  124268. */
  124269. set buttonL1(value: number);
  124270. /**
  124271. * Gets the value of the `R1` button
  124272. */
  124273. get buttonR1(): number;
  124274. /**
  124275. * Sets the value of the `R1` button
  124276. */
  124277. set buttonR1(value: number);
  124278. /**
  124279. * Gets the value of the Left joystick
  124280. */
  124281. get buttonLeftStick(): number;
  124282. /**
  124283. * Sets the value of the Left joystick
  124284. */
  124285. set buttonLeftStick(value: number);
  124286. /**
  124287. * Gets the value of the Right joystick
  124288. */
  124289. get buttonRightStick(): number;
  124290. /**
  124291. * Sets the value of the Right joystick
  124292. */
  124293. set buttonRightStick(value: number);
  124294. /**
  124295. * Gets the value of D-pad up
  124296. */
  124297. get dPadUp(): number;
  124298. /**
  124299. * Sets the value of D-pad up
  124300. */
  124301. set dPadUp(value: number);
  124302. /**
  124303. * Gets the value of D-pad down
  124304. */
  124305. get dPadDown(): number;
  124306. /**
  124307. * Sets the value of D-pad down
  124308. */
  124309. set dPadDown(value: number);
  124310. /**
  124311. * Gets the value of D-pad left
  124312. */
  124313. get dPadLeft(): number;
  124314. /**
  124315. * Sets the value of D-pad left
  124316. */
  124317. set dPadLeft(value: number);
  124318. /**
  124319. * Gets the value of D-pad right
  124320. */
  124321. get dPadRight(): number;
  124322. /**
  124323. * Sets the value of D-pad right
  124324. */
  124325. set dPadRight(value: number);
  124326. /**
  124327. * Force the gamepad to synchronize with device values
  124328. */
  124329. update(): void;
  124330. /**
  124331. * Disposes the gamepad
  124332. */
  124333. dispose(): void;
  124334. }
  124335. }
  124336. declare module BABYLON {
  124337. /**
  124338. * Manager for handling gamepads
  124339. */
  124340. export class GamepadManager {
  124341. private _scene?;
  124342. private _babylonGamepads;
  124343. private _oneGamepadConnected;
  124344. /** @hidden */
  124345. _isMonitoring: boolean;
  124346. private _gamepadEventSupported;
  124347. private _gamepadSupport?;
  124348. /**
  124349. * observable to be triggered when the gamepad controller has been connected
  124350. */
  124351. onGamepadConnectedObservable: Observable<Gamepad>;
  124352. /**
  124353. * observable to be triggered when the gamepad controller has been disconnected
  124354. */
  124355. onGamepadDisconnectedObservable: Observable<Gamepad>;
  124356. private _onGamepadConnectedEvent;
  124357. private _onGamepadDisconnectedEvent;
  124358. /**
  124359. * Initializes the gamepad manager
  124360. * @param _scene BabylonJS scene
  124361. */
  124362. constructor(_scene?: Scene | undefined);
  124363. /**
  124364. * The gamepads in the game pad manager
  124365. */
  124366. get gamepads(): Gamepad[];
  124367. /**
  124368. * Get the gamepad controllers based on type
  124369. * @param type The type of gamepad controller
  124370. * @returns Nullable gamepad
  124371. */
  124372. getGamepadByType(type?: number): Nullable<Gamepad>;
  124373. /**
  124374. * Disposes the gamepad manager
  124375. */
  124376. dispose(): void;
  124377. private _addNewGamepad;
  124378. private _startMonitoringGamepads;
  124379. private _stopMonitoringGamepads;
  124380. /** @hidden */
  124381. _checkGamepadsStatus(): void;
  124382. private _updateGamepadObjects;
  124383. }
  124384. }
  124385. declare module BABYLON {
  124386. interface Scene {
  124387. /** @hidden */
  124388. _gamepadManager: Nullable<GamepadManager>;
  124389. /**
  124390. * Gets the gamepad manager associated with the scene
  124391. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  124392. */
  124393. gamepadManager: GamepadManager;
  124394. }
  124395. /**
  124396. * Interface representing a free camera inputs manager
  124397. */
  124398. interface FreeCameraInputsManager {
  124399. /**
  124400. * Adds gamepad input support to the FreeCameraInputsManager.
  124401. * @returns the FreeCameraInputsManager
  124402. */
  124403. addGamepad(): FreeCameraInputsManager;
  124404. }
  124405. /**
  124406. * Interface representing an arc rotate camera inputs manager
  124407. */
  124408. interface ArcRotateCameraInputsManager {
  124409. /**
  124410. * Adds gamepad input support to the ArcRotateCamera InputManager.
  124411. * @returns the camera inputs manager
  124412. */
  124413. addGamepad(): ArcRotateCameraInputsManager;
  124414. }
  124415. /**
  124416. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  124417. */
  124418. export class GamepadSystemSceneComponent implements ISceneComponent {
  124419. /**
  124420. * The component name helpfull to identify the component in the list of scene components.
  124421. */
  124422. readonly name: string;
  124423. /**
  124424. * The scene the component belongs to.
  124425. */
  124426. scene: Scene;
  124427. /**
  124428. * Creates a new instance of the component for the given scene
  124429. * @param scene Defines the scene to register the component in
  124430. */
  124431. constructor(scene: Scene);
  124432. /**
  124433. * Registers the component in a given scene
  124434. */
  124435. register(): void;
  124436. /**
  124437. * Rebuilds the elements related to this component in case of
  124438. * context lost for instance.
  124439. */
  124440. rebuild(): void;
  124441. /**
  124442. * Disposes the component and the associated ressources
  124443. */
  124444. dispose(): void;
  124445. private _beforeCameraUpdate;
  124446. }
  124447. }
  124448. declare module BABYLON {
  124449. /**
  124450. * 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,
  124451. * which still works and will still be found in many Playgrounds.
  124452. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124453. */
  124454. export class UniversalCamera extends TouchCamera {
  124455. /**
  124456. * Defines the gamepad rotation sensiblity.
  124457. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124458. */
  124459. get gamepadAngularSensibility(): number;
  124460. set gamepadAngularSensibility(value: number);
  124461. /**
  124462. * Defines the gamepad move sensiblity.
  124463. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124464. */
  124465. get gamepadMoveSensibility(): number;
  124466. set gamepadMoveSensibility(value: number);
  124467. /**
  124468. * 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,
  124469. * which still works and will still be found in many Playgrounds.
  124470. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124471. * @param name Define the name of the camera in the scene
  124472. * @param position Define the start position of the camera in the scene
  124473. * @param scene Define the scene the camera belongs to
  124474. */
  124475. constructor(name: string, position: Vector3, scene: Scene);
  124476. /**
  124477. * Gets the current object class name.
  124478. * @return the class name
  124479. */
  124480. getClassName(): string;
  124481. }
  124482. }
  124483. declare module BABYLON {
  124484. /**
  124485. * This represents a FPS type of camera. This is only here for back compat purpose.
  124486. * Please use the UniversalCamera instead as both are identical.
  124487. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124488. */
  124489. export class GamepadCamera extends UniversalCamera {
  124490. /**
  124491. * Instantiates a new Gamepad Camera
  124492. * This represents a FPS type of camera. This is only here for back compat purpose.
  124493. * Please use the UniversalCamera instead as both are identical.
  124494. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124495. * @param name Define the name of the camera in the scene
  124496. * @param position Define the start position of the camera in the scene
  124497. * @param scene Define the scene the camera belongs to
  124498. */
  124499. constructor(name: string, position: Vector3, scene: Scene);
  124500. /**
  124501. * Gets the current object class name.
  124502. * @return the class name
  124503. */
  124504. getClassName(): string;
  124505. }
  124506. }
  124507. declare module BABYLON {
  124508. /** @hidden */
  124509. export var passPixelShader: {
  124510. name: string;
  124511. shader: string;
  124512. };
  124513. }
  124514. declare module BABYLON {
  124515. /** @hidden */
  124516. export var passCubePixelShader: {
  124517. name: string;
  124518. shader: string;
  124519. };
  124520. }
  124521. declare module BABYLON {
  124522. /**
  124523. * PassPostProcess which produces an output the same as it's input
  124524. */
  124525. export class PassPostProcess extends PostProcess {
  124526. /**
  124527. * Creates the PassPostProcess
  124528. * @param name The name of the effect.
  124529. * @param options The required width/height ratio to downsize to before computing the render pass.
  124530. * @param camera The camera to apply the render pass to.
  124531. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124532. * @param engine The engine which the post process will be applied. (default: current engine)
  124533. * @param reusable If the post process can be reused on the same frame. (default: false)
  124534. * @param textureType The type of texture to be used when performing the post processing.
  124535. * @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)
  124536. */
  124537. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124538. }
  124539. /**
  124540. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  124541. */
  124542. export class PassCubePostProcess extends PostProcess {
  124543. private _face;
  124544. /**
  124545. * Gets or sets the cube face to display.
  124546. * * 0 is +X
  124547. * * 1 is -X
  124548. * * 2 is +Y
  124549. * * 3 is -Y
  124550. * * 4 is +Z
  124551. * * 5 is -Z
  124552. */
  124553. get face(): number;
  124554. set face(value: number);
  124555. /**
  124556. * Creates the PassCubePostProcess
  124557. * @param name The name of the effect.
  124558. * @param options The required width/height ratio to downsize to before computing the render pass.
  124559. * @param camera The camera to apply the render pass to.
  124560. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124561. * @param engine The engine which the post process will be applied. (default: current engine)
  124562. * @param reusable If the post process can be reused on the same frame. (default: false)
  124563. * @param textureType The type of texture to be used when performing the post processing.
  124564. * @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)
  124565. */
  124566. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124567. }
  124568. }
  124569. declare module BABYLON {
  124570. /** @hidden */
  124571. export var anaglyphPixelShader: {
  124572. name: string;
  124573. shader: string;
  124574. };
  124575. }
  124576. declare module BABYLON {
  124577. /**
  124578. * Postprocess used to generate anaglyphic rendering
  124579. */
  124580. export class AnaglyphPostProcess extends PostProcess {
  124581. private _passedProcess;
  124582. /**
  124583. * Creates a new AnaglyphPostProcess
  124584. * @param name defines postprocess name
  124585. * @param options defines creation options or target ratio scale
  124586. * @param rigCameras defines cameras using this postprocess
  124587. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  124588. * @param engine defines hosting engine
  124589. * @param reusable defines if the postprocess will be reused multiple times per frame
  124590. */
  124591. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  124592. }
  124593. }
  124594. declare module BABYLON {
  124595. /**
  124596. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  124597. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124598. */
  124599. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  124600. /**
  124601. * Creates a new AnaglyphArcRotateCamera
  124602. * @param name defines camera name
  124603. * @param alpha defines alpha angle (in radians)
  124604. * @param beta defines beta angle (in radians)
  124605. * @param radius defines radius
  124606. * @param target defines camera target
  124607. * @param interaxialDistance defines distance between each color axis
  124608. * @param scene defines the hosting scene
  124609. */
  124610. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  124611. /**
  124612. * Gets camera class name
  124613. * @returns AnaglyphArcRotateCamera
  124614. */
  124615. getClassName(): string;
  124616. }
  124617. }
  124618. declare module BABYLON {
  124619. /**
  124620. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  124621. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124622. */
  124623. export class AnaglyphFreeCamera extends FreeCamera {
  124624. /**
  124625. * Creates a new AnaglyphFreeCamera
  124626. * @param name defines camera name
  124627. * @param position defines initial position
  124628. * @param interaxialDistance defines distance between each color axis
  124629. * @param scene defines the hosting scene
  124630. */
  124631. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124632. /**
  124633. * Gets camera class name
  124634. * @returns AnaglyphFreeCamera
  124635. */
  124636. getClassName(): string;
  124637. }
  124638. }
  124639. declare module BABYLON {
  124640. /**
  124641. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  124642. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124643. */
  124644. export class AnaglyphGamepadCamera extends GamepadCamera {
  124645. /**
  124646. * Creates a new AnaglyphGamepadCamera
  124647. * @param name defines camera name
  124648. * @param position defines initial position
  124649. * @param interaxialDistance defines distance between each color axis
  124650. * @param scene defines the hosting scene
  124651. */
  124652. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124653. /**
  124654. * Gets camera class name
  124655. * @returns AnaglyphGamepadCamera
  124656. */
  124657. getClassName(): string;
  124658. }
  124659. }
  124660. declare module BABYLON {
  124661. /**
  124662. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  124663. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124664. */
  124665. export class AnaglyphUniversalCamera extends UniversalCamera {
  124666. /**
  124667. * Creates a new AnaglyphUniversalCamera
  124668. * @param name defines camera name
  124669. * @param position defines initial position
  124670. * @param interaxialDistance defines distance between each color axis
  124671. * @param scene defines the hosting scene
  124672. */
  124673. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124674. /**
  124675. * Gets camera class name
  124676. * @returns AnaglyphUniversalCamera
  124677. */
  124678. getClassName(): string;
  124679. }
  124680. }
  124681. declare module BABYLON {
  124682. /**
  124683. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  124684. * @see https://doc.babylonjs.com/features/cameras
  124685. */
  124686. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  124687. /**
  124688. * Creates a new StereoscopicArcRotateCamera
  124689. * @param name defines camera name
  124690. * @param alpha defines alpha angle (in radians)
  124691. * @param beta defines beta angle (in radians)
  124692. * @param radius defines radius
  124693. * @param target defines camera target
  124694. * @param interaxialDistance defines distance between each color axis
  124695. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124696. * @param scene defines the hosting scene
  124697. */
  124698. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124699. /**
  124700. * Gets camera class name
  124701. * @returns StereoscopicArcRotateCamera
  124702. */
  124703. getClassName(): string;
  124704. }
  124705. }
  124706. declare module BABYLON {
  124707. /**
  124708. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  124709. * @see https://doc.babylonjs.com/features/cameras
  124710. */
  124711. export class StereoscopicFreeCamera extends FreeCamera {
  124712. /**
  124713. * Creates a new StereoscopicFreeCamera
  124714. * @param name defines camera name
  124715. * @param position defines initial position
  124716. * @param interaxialDistance defines distance between each color axis
  124717. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124718. * @param scene defines the hosting scene
  124719. */
  124720. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124721. /**
  124722. * Gets camera class name
  124723. * @returns StereoscopicFreeCamera
  124724. */
  124725. getClassName(): string;
  124726. }
  124727. }
  124728. declare module BABYLON {
  124729. /**
  124730. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  124731. * @see https://doc.babylonjs.com/features/cameras
  124732. */
  124733. export class StereoscopicGamepadCamera extends GamepadCamera {
  124734. /**
  124735. * Creates a new StereoscopicGamepadCamera
  124736. * @param name defines camera name
  124737. * @param position defines initial position
  124738. * @param interaxialDistance defines distance between each color axis
  124739. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124740. * @param scene defines the hosting scene
  124741. */
  124742. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124743. /**
  124744. * Gets camera class name
  124745. * @returns StereoscopicGamepadCamera
  124746. */
  124747. getClassName(): string;
  124748. }
  124749. }
  124750. declare module BABYLON {
  124751. /**
  124752. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  124753. * @see https://doc.babylonjs.com/features/cameras
  124754. */
  124755. export class StereoscopicUniversalCamera extends UniversalCamera {
  124756. /**
  124757. * Creates a new StereoscopicUniversalCamera
  124758. * @param name defines camera name
  124759. * @param position defines initial position
  124760. * @param interaxialDistance defines distance between each color axis
  124761. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124762. * @param scene defines the hosting scene
  124763. */
  124764. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124765. /**
  124766. * Gets camera class name
  124767. * @returns StereoscopicUniversalCamera
  124768. */
  124769. getClassName(): string;
  124770. }
  124771. }
  124772. declare module BABYLON {
  124773. /**
  124774. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  124775. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  124776. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  124777. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  124778. */
  124779. export class VirtualJoysticksCamera extends FreeCamera {
  124780. /**
  124781. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  124782. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  124783. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  124784. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  124785. * @param name Define the name of the camera in the scene
  124786. * @param position Define the start position of the camera in the scene
  124787. * @param scene Define the scene the camera belongs to
  124788. */
  124789. constructor(name: string, position: Vector3, scene: Scene);
  124790. /**
  124791. * Gets the current object class name.
  124792. * @return the class name
  124793. */
  124794. getClassName(): string;
  124795. }
  124796. }
  124797. declare module BABYLON {
  124798. /**
  124799. * This represents all the required metrics to create a VR camera.
  124800. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  124801. */
  124802. export class VRCameraMetrics {
  124803. /**
  124804. * Define the horizontal resolution off the screen.
  124805. */
  124806. hResolution: number;
  124807. /**
  124808. * Define the vertical resolution off the screen.
  124809. */
  124810. vResolution: number;
  124811. /**
  124812. * Define the horizontal screen size.
  124813. */
  124814. hScreenSize: number;
  124815. /**
  124816. * Define the vertical screen size.
  124817. */
  124818. vScreenSize: number;
  124819. /**
  124820. * Define the vertical screen center position.
  124821. */
  124822. vScreenCenter: number;
  124823. /**
  124824. * Define the distance of the eyes to the screen.
  124825. */
  124826. eyeToScreenDistance: number;
  124827. /**
  124828. * Define the distance between both lenses
  124829. */
  124830. lensSeparationDistance: number;
  124831. /**
  124832. * Define the distance between both viewer's eyes.
  124833. */
  124834. interpupillaryDistance: number;
  124835. /**
  124836. * Define the distortion factor of the VR postprocess.
  124837. * Please, touch with care.
  124838. */
  124839. distortionK: number[];
  124840. /**
  124841. * Define the chromatic aberration correction factors for the VR post process.
  124842. */
  124843. chromaAbCorrection: number[];
  124844. /**
  124845. * Define the scale factor of the post process.
  124846. * The smaller the better but the slower.
  124847. */
  124848. postProcessScaleFactor: number;
  124849. /**
  124850. * Define an offset for the lens center.
  124851. */
  124852. lensCenterOffset: number;
  124853. /**
  124854. * Define if the current vr camera should compensate the distortion of the lense or not.
  124855. */
  124856. compensateDistortion: boolean;
  124857. /**
  124858. * Defines if multiview should be enabled when rendering (Default: false)
  124859. */
  124860. multiviewEnabled: boolean;
  124861. /**
  124862. * Gets the rendering aspect ratio based on the provided resolutions.
  124863. */
  124864. get aspectRatio(): number;
  124865. /**
  124866. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  124867. */
  124868. get aspectRatioFov(): number;
  124869. /**
  124870. * @hidden
  124871. */
  124872. get leftHMatrix(): Matrix;
  124873. /**
  124874. * @hidden
  124875. */
  124876. get rightHMatrix(): Matrix;
  124877. /**
  124878. * @hidden
  124879. */
  124880. get leftPreViewMatrix(): Matrix;
  124881. /**
  124882. * @hidden
  124883. */
  124884. get rightPreViewMatrix(): Matrix;
  124885. /**
  124886. * Get the default VRMetrics based on the most generic setup.
  124887. * @returns the default vr metrics
  124888. */
  124889. static GetDefault(): VRCameraMetrics;
  124890. }
  124891. }
  124892. declare module BABYLON {
  124893. /** @hidden */
  124894. export var vrDistortionCorrectionPixelShader: {
  124895. name: string;
  124896. shader: string;
  124897. };
  124898. }
  124899. declare module BABYLON {
  124900. /**
  124901. * VRDistortionCorrectionPostProcess used for mobile VR
  124902. */
  124903. export class VRDistortionCorrectionPostProcess extends PostProcess {
  124904. private _isRightEye;
  124905. private _distortionFactors;
  124906. private _postProcessScaleFactor;
  124907. private _lensCenterOffset;
  124908. private _scaleIn;
  124909. private _scaleFactor;
  124910. private _lensCenter;
  124911. /**
  124912. * Initializes the VRDistortionCorrectionPostProcess
  124913. * @param name The name of the effect.
  124914. * @param camera The camera to apply the render pass to.
  124915. * @param isRightEye If this is for the right eye distortion
  124916. * @param vrMetrics All the required metrics for the VR camera
  124917. */
  124918. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  124919. }
  124920. }
  124921. declare module BABYLON {
  124922. /**
  124923. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  124924. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124925. */
  124926. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  124927. /**
  124928. * Creates a new VRDeviceOrientationArcRotateCamera
  124929. * @param name defines camera name
  124930. * @param alpha defines the camera rotation along the logitudinal axis
  124931. * @param beta defines the camera rotation along the latitudinal axis
  124932. * @param radius defines the camera distance from its target
  124933. * @param target defines the camera target
  124934. * @param scene defines the scene the camera belongs to
  124935. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124936. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124937. */
  124938. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124939. /**
  124940. * Gets camera class name
  124941. * @returns VRDeviceOrientationArcRotateCamera
  124942. */
  124943. getClassName(): string;
  124944. }
  124945. }
  124946. declare module BABYLON {
  124947. /**
  124948. * Camera used to simulate VR rendering (based on FreeCamera)
  124949. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124950. */
  124951. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  124952. /**
  124953. * Creates a new VRDeviceOrientationFreeCamera
  124954. * @param name defines camera name
  124955. * @param position defines the start position of the camera
  124956. * @param scene defines the scene the camera belongs to
  124957. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124958. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124959. */
  124960. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124961. /**
  124962. * Gets camera class name
  124963. * @returns VRDeviceOrientationFreeCamera
  124964. */
  124965. getClassName(): string;
  124966. }
  124967. }
  124968. declare module BABYLON {
  124969. /**
  124970. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  124971. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124972. */
  124973. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  124974. /**
  124975. * Creates a new VRDeviceOrientationGamepadCamera
  124976. * @param name defines camera name
  124977. * @param position defines the start position of the camera
  124978. * @param scene defines the scene the camera belongs to
  124979. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124980. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124981. */
  124982. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124983. /**
  124984. * Gets camera class name
  124985. * @returns VRDeviceOrientationGamepadCamera
  124986. */
  124987. getClassName(): string;
  124988. }
  124989. }
  124990. declare module BABYLON {
  124991. /**
  124992. * A class extending Texture allowing drawing on a texture
  124993. * @see https://doc.babylonjs.com/how_to/dynamictexture
  124994. */
  124995. export class DynamicTexture extends Texture {
  124996. private _generateMipMaps;
  124997. private _canvas;
  124998. private _context;
  124999. /**
  125000. * Creates a DynamicTexture
  125001. * @param name defines the name of the texture
  125002. * @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
  125003. * @param scene defines the scene where you want the texture
  125004. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  125005. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  125006. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  125007. */
  125008. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  125009. /**
  125010. * Get the current class name of the texture useful for serialization or dynamic coding.
  125011. * @returns "DynamicTexture"
  125012. */
  125013. getClassName(): string;
  125014. /**
  125015. * Gets the current state of canRescale
  125016. */
  125017. get canRescale(): boolean;
  125018. private _recreate;
  125019. /**
  125020. * Scales the texture
  125021. * @param ratio the scale factor to apply to both width and height
  125022. */
  125023. scale(ratio: number): void;
  125024. /**
  125025. * Resizes the texture
  125026. * @param width the new width
  125027. * @param height the new height
  125028. */
  125029. scaleTo(width: number, height: number): void;
  125030. /**
  125031. * Gets the context of the canvas used by the texture
  125032. * @returns the canvas context of the dynamic texture
  125033. */
  125034. getContext(): CanvasRenderingContext2D;
  125035. /**
  125036. * Clears the texture
  125037. */
  125038. clear(): void;
  125039. /**
  125040. * Updates the texture
  125041. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125042. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  125043. */
  125044. update(invertY?: boolean, premulAlpha?: boolean): void;
  125045. /**
  125046. * Draws text onto the texture
  125047. * @param text defines the text to be drawn
  125048. * @param x defines the placement of the text from the left
  125049. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  125050. * @param font defines the font to be used with font-style, font-size, font-name
  125051. * @param color defines the color used for the text
  125052. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  125053. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125054. * @param update defines whether texture is immediately update (default is true)
  125055. */
  125056. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  125057. /**
  125058. * Clones the texture
  125059. * @returns the clone of the texture.
  125060. */
  125061. clone(): DynamicTexture;
  125062. /**
  125063. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  125064. * @returns a serialized dynamic texture object
  125065. */
  125066. serialize(): any;
  125067. private _IsCanvasElement;
  125068. /** @hidden */
  125069. _rebuild(): void;
  125070. }
  125071. }
  125072. declare module BABYLON {
  125073. /**
  125074. * Class containing static functions to help procedurally build meshes
  125075. */
  125076. export class GroundBuilder {
  125077. /**
  125078. * Creates a ground mesh
  125079. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  125080. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  125081. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125082. * @param name defines the name of the mesh
  125083. * @param options defines the options used to create the mesh
  125084. * @param scene defines the hosting scene
  125085. * @returns the ground mesh
  125086. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  125087. */
  125088. static CreateGround(name: string, options: {
  125089. width?: number;
  125090. height?: number;
  125091. subdivisions?: number;
  125092. subdivisionsX?: number;
  125093. subdivisionsY?: number;
  125094. updatable?: boolean;
  125095. }, scene: any): Mesh;
  125096. /**
  125097. * Creates a tiled ground mesh
  125098. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  125099. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  125100. * * 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
  125101. * * 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
  125102. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125103. * @param name defines the name of the mesh
  125104. * @param options defines the options used to create the mesh
  125105. * @param scene defines the hosting scene
  125106. * @returns the tiled ground mesh
  125107. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  125108. */
  125109. static CreateTiledGround(name: string, options: {
  125110. xmin: number;
  125111. zmin: number;
  125112. xmax: number;
  125113. zmax: number;
  125114. subdivisions?: {
  125115. w: number;
  125116. h: number;
  125117. };
  125118. precision?: {
  125119. w: number;
  125120. h: number;
  125121. };
  125122. updatable?: boolean;
  125123. }, scene?: Nullable<Scene>): Mesh;
  125124. /**
  125125. * Creates a ground mesh from a height map
  125126. * * The parameter `url` sets the URL of the height map image resource.
  125127. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  125128. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  125129. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  125130. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  125131. * * 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.
  125132. * * 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).
  125133. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  125134. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125135. * @param name defines the name of the mesh
  125136. * @param url defines the url to the height map
  125137. * @param options defines the options used to create the mesh
  125138. * @param scene defines the hosting scene
  125139. * @returns the ground mesh
  125140. * @see https://doc.babylonjs.com/babylon101/height_map
  125141. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  125142. */
  125143. static CreateGroundFromHeightMap(name: string, url: string, options: {
  125144. width?: number;
  125145. height?: number;
  125146. subdivisions?: number;
  125147. minHeight?: number;
  125148. maxHeight?: number;
  125149. colorFilter?: Color3;
  125150. alphaFilter?: number;
  125151. updatable?: boolean;
  125152. onReady?: (mesh: GroundMesh) => void;
  125153. }, scene?: Nullable<Scene>): GroundMesh;
  125154. }
  125155. }
  125156. declare module BABYLON {
  125157. /**
  125158. * Class containing static functions to help procedurally build meshes
  125159. */
  125160. export class TorusBuilder {
  125161. /**
  125162. * Creates a torus mesh
  125163. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  125164. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  125165. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  125166. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125167. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125168. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125169. * @param name defines the name of the mesh
  125170. * @param options defines the options used to create the mesh
  125171. * @param scene defines the hosting scene
  125172. * @returns the torus mesh
  125173. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  125174. */
  125175. static CreateTorus(name: string, options: {
  125176. diameter?: number;
  125177. thickness?: number;
  125178. tessellation?: number;
  125179. updatable?: boolean;
  125180. sideOrientation?: number;
  125181. frontUVs?: Vector4;
  125182. backUVs?: Vector4;
  125183. }, scene: any): Mesh;
  125184. }
  125185. }
  125186. declare module BABYLON {
  125187. /**
  125188. * Class containing static functions to help procedurally build meshes
  125189. */
  125190. export class CylinderBuilder {
  125191. /**
  125192. * Creates a cylinder or a cone mesh
  125193. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  125194. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  125195. * * 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.
  125196. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  125197. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  125198. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  125199. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  125200. * * 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).
  125201. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  125202. * * 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).
  125203. * * 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
  125204. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  125205. * * 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
  125206. * * 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.
  125207. * * If `enclose` is false, a ring surface is one element.
  125208. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  125209. * * 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
  125210. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125211. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125212. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125213. * @param name defines the name of the mesh
  125214. * @param options defines the options used to create the mesh
  125215. * @param scene defines the hosting scene
  125216. * @returns the cylinder mesh
  125217. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  125218. */
  125219. static CreateCylinder(name: string, options: {
  125220. height?: number;
  125221. diameterTop?: number;
  125222. diameterBottom?: number;
  125223. diameter?: number;
  125224. tessellation?: number;
  125225. subdivisions?: number;
  125226. arc?: number;
  125227. faceColors?: Color4[];
  125228. faceUV?: Vector4[];
  125229. updatable?: boolean;
  125230. hasRings?: boolean;
  125231. enclose?: boolean;
  125232. cap?: number;
  125233. sideOrientation?: number;
  125234. frontUVs?: Vector4;
  125235. backUVs?: Vector4;
  125236. }, scene: any): Mesh;
  125237. }
  125238. }
  125239. declare module BABYLON {
  125240. /**
  125241. * States of the webXR experience
  125242. */
  125243. export enum WebXRState {
  125244. /**
  125245. * Transitioning to being in XR mode
  125246. */
  125247. ENTERING_XR = 0,
  125248. /**
  125249. * Transitioning to non XR mode
  125250. */
  125251. EXITING_XR = 1,
  125252. /**
  125253. * In XR mode and presenting
  125254. */
  125255. IN_XR = 2,
  125256. /**
  125257. * Not entered XR mode
  125258. */
  125259. NOT_IN_XR = 3
  125260. }
  125261. /**
  125262. * Abstraction of the XR render target
  125263. */
  125264. export interface WebXRRenderTarget extends IDisposable {
  125265. /**
  125266. * xrpresent context of the canvas which can be used to display/mirror xr content
  125267. */
  125268. canvasContext: WebGLRenderingContext;
  125269. /**
  125270. * xr layer for the canvas
  125271. */
  125272. xrLayer: Nullable<XRWebGLLayer>;
  125273. /**
  125274. * Initializes the xr layer for the session
  125275. * @param xrSession xr session
  125276. * @returns a promise that will resolve once the XR Layer has been created
  125277. */
  125278. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  125279. }
  125280. }
  125281. declare module BABYLON {
  125282. /**
  125283. * COnfiguration object for WebXR output canvas
  125284. */
  125285. export class WebXRManagedOutputCanvasOptions {
  125286. /**
  125287. * An optional canvas in case you wish to create it yourself and provide it here.
  125288. * If not provided, a new canvas will be created
  125289. */
  125290. canvasElement?: HTMLCanvasElement;
  125291. /**
  125292. * Options for this XR Layer output
  125293. */
  125294. canvasOptions?: XRWebGLLayerOptions;
  125295. /**
  125296. * CSS styling for a newly created canvas (if not provided)
  125297. */
  125298. newCanvasCssStyle?: string;
  125299. /**
  125300. * Get the default values of the configuration object
  125301. * @returns default values of this configuration object
  125302. */
  125303. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  125304. }
  125305. /**
  125306. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  125307. */
  125308. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  125309. private _options;
  125310. private _canvas;
  125311. private _engine;
  125312. private _originalCanvasSize;
  125313. /**
  125314. * Rendering context of the canvas which can be used to display/mirror xr content
  125315. */
  125316. canvasContext: WebGLRenderingContext;
  125317. /**
  125318. * xr layer for the canvas
  125319. */
  125320. xrLayer: Nullable<XRWebGLLayer>;
  125321. /**
  125322. * Obseervers registered here will be triggered when the xr layer was initialized
  125323. */
  125324. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  125325. /**
  125326. * Initializes the canvas to be added/removed upon entering/exiting xr
  125327. * @param _xrSessionManager The XR Session manager
  125328. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  125329. */
  125330. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  125331. /**
  125332. * Disposes of the object
  125333. */
  125334. dispose(): void;
  125335. /**
  125336. * Initializes the xr layer for the session
  125337. * @param xrSession xr session
  125338. * @returns a promise that will resolve once the XR Layer has been created
  125339. */
  125340. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  125341. private _addCanvas;
  125342. private _removeCanvas;
  125343. private _setCanvasSize;
  125344. private _setManagedOutputCanvas;
  125345. }
  125346. }
  125347. declare module BABYLON {
  125348. /**
  125349. * Manages an XRSession to work with Babylon's engine
  125350. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  125351. */
  125352. export class WebXRSessionManager implements IDisposable {
  125353. /** The scene which the session should be created for */
  125354. scene: Scene;
  125355. private _referenceSpace;
  125356. private _rttProvider;
  125357. private _sessionEnded;
  125358. private _xrNavigator;
  125359. private baseLayer;
  125360. /**
  125361. * The base reference space from which the session started. good if you want to reset your
  125362. * reference space
  125363. */
  125364. baseReferenceSpace: XRReferenceSpace;
  125365. /**
  125366. * Current XR frame
  125367. */
  125368. currentFrame: Nullable<XRFrame>;
  125369. /** WebXR timestamp updated every frame */
  125370. currentTimestamp: number;
  125371. /**
  125372. * Used just in case of a failure to initialize an immersive session.
  125373. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  125374. */
  125375. defaultHeightCompensation: number;
  125376. /**
  125377. * Fires every time a new xrFrame arrives which can be used to update the camera
  125378. */
  125379. onXRFrameObservable: Observable<XRFrame>;
  125380. /**
  125381. * Fires when the reference space changed
  125382. */
  125383. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  125384. /**
  125385. * Fires when the xr session is ended either by the device or manually done
  125386. */
  125387. onXRSessionEnded: Observable<any>;
  125388. /**
  125389. * Fires when the xr session is ended either by the device or manually done
  125390. */
  125391. onXRSessionInit: Observable<XRSession>;
  125392. /**
  125393. * Underlying xr session
  125394. */
  125395. session: XRSession;
  125396. /**
  125397. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  125398. * or get the offset the player is currently at.
  125399. */
  125400. viewerReferenceSpace: XRReferenceSpace;
  125401. /**
  125402. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  125403. * @param scene The scene which the session should be created for
  125404. */
  125405. constructor(
  125406. /** The scene which the session should be created for */
  125407. scene: Scene);
  125408. /**
  125409. * The current reference space used in this session. This reference space can constantly change!
  125410. * It is mainly used to offset the camera's position.
  125411. */
  125412. get referenceSpace(): XRReferenceSpace;
  125413. /**
  125414. * Set a new reference space and triggers the observable
  125415. */
  125416. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  125417. /**
  125418. * Disposes of the session manager
  125419. */
  125420. dispose(): void;
  125421. /**
  125422. * Stops the xrSession and restores the render loop
  125423. * @returns Promise which resolves after it exits XR
  125424. */
  125425. exitXRAsync(): Promise<void>;
  125426. /**
  125427. * Gets the correct render target texture to be rendered this frame for this eye
  125428. * @param eye the eye for which to get the render target
  125429. * @returns the render target for the specified eye
  125430. */
  125431. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  125432. /**
  125433. * Creates a WebXRRenderTarget object for the XR session
  125434. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  125435. * @param options optional options to provide when creating a new render target
  125436. * @returns a WebXR render target to which the session can render
  125437. */
  125438. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  125439. /**
  125440. * Initializes the manager
  125441. * After initialization enterXR can be called to start an XR session
  125442. * @returns Promise which resolves after it is initialized
  125443. */
  125444. initializeAsync(): Promise<void>;
  125445. /**
  125446. * Initializes an xr session
  125447. * @param xrSessionMode mode to initialize
  125448. * @param xrSessionInit defines optional and required values to pass to the session builder
  125449. * @returns a promise which will resolve once the session has been initialized
  125450. */
  125451. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  125452. /**
  125453. * Checks if a session would be supported for the creation options specified
  125454. * @param sessionMode session mode to check if supported eg. immersive-vr
  125455. * @returns A Promise that resolves to true if supported and false if not
  125456. */
  125457. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  125458. /**
  125459. * Resets the reference space to the one started the session
  125460. */
  125461. resetReferenceSpace(): void;
  125462. /**
  125463. * Starts rendering to the xr layer
  125464. */
  125465. runXRRenderLoop(): void;
  125466. /**
  125467. * Sets the reference space on the xr session
  125468. * @param referenceSpaceType space to set
  125469. * @returns a promise that will resolve once the reference space has been set
  125470. */
  125471. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  125472. /**
  125473. * Updates the render state of the session
  125474. * @param state state to set
  125475. * @returns a promise that resolves once the render state has been updated
  125476. */
  125477. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  125478. /**
  125479. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  125480. * @param sessionMode defines the session to test
  125481. * @returns a promise with boolean as final value
  125482. */
  125483. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  125484. private _createRenderTargetTexture;
  125485. }
  125486. }
  125487. declare module BABYLON {
  125488. /**
  125489. * WebXR Camera which holds the views for the xrSession
  125490. * @see https://doc.babylonjs.com/how_to/webxr_camera
  125491. */
  125492. export class WebXRCamera extends FreeCamera {
  125493. private _xrSessionManager;
  125494. private _firstFrame;
  125495. private _referenceQuaternion;
  125496. private _referencedPosition;
  125497. private _xrInvPositionCache;
  125498. private _xrInvQuaternionCache;
  125499. /**
  125500. * Should position compensation execute on first frame.
  125501. * This is used when copying the position from a native (non XR) camera
  125502. */
  125503. compensateOnFirstFrame: boolean;
  125504. /**
  125505. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  125506. * @param name the name of the camera
  125507. * @param scene the scene to add the camera to
  125508. * @param _xrSessionManager a constructed xr session manager
  125509. */
  125510. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  125511. /**
  125512. * Return the user's height, unrelated to the current ground.
  125513. * This will be the y position of this camera, when ground level is 0.
  125514. */
  125515. get realWorldHeight(): number;
  125516. /** @hidden */
  125517. _updateForDualEyeDebugging(): void;
  125518. /**
  125519. * Sets this camera's transformation based on a non-vr camera
  125520. * @param otherCamera the non-vr camera to copy the transformation from
  125521. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  125522. */
  125523. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  125524. /**
  125525. * Gets the current instance class name ("WebXRCamera").
  125526. * @returns the class name
  125527. */
  125528. getClassName(): string;
  125529. private _rotate180;
  125530. private _updateFromXRSession;
  125531. private _updateNumberOfRigCameras;
  125532. private _updateReferenceSpace;
  125533. private _updateReferenceSpaceOffset;
  125534. }
  125535. }
  125536. declare module BABYLON {
  125537. /**
  125538. * Defining the interface required for a (webxr) feature
  125539. */
  125540. export interface IWebXRFeature extends IDisposable {
  125541. /**
  125542. * Is this feature attached
  125543. */
  125544. attached: boolean;
  125545. /**
  125546. * Should auto-attach be disabled?
  125547. */
  125548. disableAutoAttach: boolean;
  125549. /**
  125550. * Attach the feature to the session
  125551. * Will usually be called by the features manager
  125552. *
  125553. * @param force should attachment be forced (even when already attached)
  125554. * @returns true if successful.
  125555. */
  125556. attach(force?: boolean): boolean;
  125557. /**
  125558. * Detach the feature from the session
  125559. * Will usually be called by the features manager
  125560. *
  125561. * @returns true if successful.
  125562. */
  125563. detach(): boolean;
  125564. /**
  125565. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  125566. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  125567. *
  125568. * @returns whether or not the feature is compatible in this environment
  125569. */
  125570. isCompatible(): boolean;
  125571. /**
  125572. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  125573. */
  125574. xrNativeFeatureName?: string;
  125575. }
  125576. /**
  125577. * A list of the currently available features without referencing them
  125578. */
  125579. export class WebXRFeatureName {
  125580. /**
  125581. * The name of the anchor system feature
  125582. */
  125583. static ANCHOR_SYSTEM: string;
  125584. /**
  125585. * The name of the background remover feature
  125586. */
  125587. static BACKGROUND_REMOVER: string;
  125588. /**
  125589. * The name of the hit test feature
  125590. */
  125591. static HIT_TEST: string;
  125592. /**
  125593. * physics impostors for xr controllers feature
  125594. */
  125595. static PHYSICS_CONTROLLERS: string;
  125596. /**
  125597. * The name of the plane detection feature
  125598. */
  125599. static PLANE_DETECTION: string;
  125600. /**
  125601. * The name of the pointer selection feature
  125602. */
  125603. static POINTER_SELECTION: string;
  125604. /**
  125605. * The name of the teleportation feature
  125606. */
  125607. static TELEPORTATION: string;
  125608. }
  125609. /**
  125610. * Defining the constructor of a feature. Used to register the modules.
  125611. */
  125612. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  125613. /**
  125614. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  125615. * It is mainly used in AR sessions.
  125616. *
  125617. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  125618. */
  125619. export class WebXRFeaturesManager implements IDisposable {
  125620. private _xrSessionManager;
  125621. private static readonly _AvailableFeatures;
  125622. private _features;
  125623. /**
  125624. * constructs a new features manages.
  125625. *
  125626. * @param _xrSessionManager an instance of WebXRSessionManager
  125627. */
  125628. constructor(_xrSessionManager: WebXRSessionManager);
  125629. /**
  125630. * Used to register a module. After calling this function a developer can use this feature in the scene.
  125631. * Mainly used internally.
  125632. *
  125633. * @param featureName the name of the feature to register
  125634. * @param constructorFunction the function used to construct the module
  125635. * @param version the (babylon) version of the module
  125636. * @param stable is that a stable version of this module
  125637. */
  125638. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  125639. /**
  125640. * Returns a constructor of a specific feature.
  125641. *
  125642. * @param featureName the name of the feature to construct
  125643. * @param version the version of the feature to load
  125644. * @param xrSessionManager the xrSessionManager. Used to construct the module
  125645. * @param options optional options provided to the module.
  125646. * @returns a function that, when called, will return a new instance of this feature
  125647. */
  125648. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  125649. /**
  125650. * Can be used to return the list of features currently registered
  125651. *
  125652. * @returns an Array of available features
  125653. */
  125654. static GetAvailableFeatures(): string[];
  125655. /**
  125656. * Gets the versions available for a specific feature
  125657. * @param featureName the name of the feature
  125658. * @returns an array with the available versions
  125659. */
  125660. static GetAvailableVersions(featureName: string): string[];
  125661. /**
  125662. * Return the latest unstable version of this feature
  125663. * @param featureName the name of the feature to search
  125664. * @returns the version number. if not found will return -1
  125665. */
  125666. static GetLatestVersionOfFeature(featureName: string): number;
  125667. /**
  125668. * Return the latest stable version of this feature
  125669. * @param featureName the name of the feature to search
  125670. * @returns the version number. if not found will return -1
  125671. */
  125672. static GetStableVersionOfFeature(featureName: string): number;
  125673. /**
  125674. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  125675. * Can be used during a session to start a feature
  125676. * @param featureName the name of feature to attach
  125677. */
  125678. attachFeature(featureName: string): void;
  125679. /**
  125680. * Can be used inside a session or when the session ends to detach a specific feature
  125681. * @param featureName the name of the feature to detach
  125682. */
  125683. detachFeature(featureName: string): void;
  125684. /**
  125685. * Used to disable an already-enabled feature
  125686. * The feature will be disposed and will be recreated once enabled.
  125687. * @param featureName the feature to disable
  125688. * @returns true if disable was successful
  125689. */
  125690. disableFeature(featureName: string | {
  125691. Name: string;
  125692. }): boolean;
  125693. /**
  125694. * dispose this features manager
  125695. */
  125696. dispose(): void;
  125697. /**
  125698. * 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.
  125699. * 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.
  125700. *
  125701. * @param featureName the name of the feature to load or the class of the feature
  125702. * @param version optional version to load. if not provided the latest version will be enabled
  125703. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  125704. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  125705. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  125706. * @returns a new constructed feature or throws an error if feature not found.
  125707. */
  125708. enableFeature(featureName: string | {
  125709. Name: string;
  125710. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  125711. /**
  125712. * get the implementation of an enabled feature.
  125713. * @param featureName the name of the feature to load
  125714. * @returns the feature class, if found
  125715. */
  125716. getEnabledFeature(featureName: string): IWebXRFeature;
  125717. /**
  125718. * Get the list of enabled features
  125719. * @returns an array of enabled features
  125720. */
  125721. getEnabledFeatures(): string[];
  125722. /**
  125723. * This function will exten the session creation configuration object with enabled features.
  125724. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  125725. * according to the defined "required" variable, provided during enableFeature call
  125726. * @param xrSessionInit the xr Session init object to extend
  125727. *
  125728. * @returns an extended XRSessionInit object
  125729. */
  125730. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  125731. }
  125732. }
  125733. declare module BABYLON {
  125734. /**
  125735. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  125736. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  125737. */
  125738. export class WebXRExperienceHelper implements IDisposable {
  125739. private scene;
  125740. private _nonVRCamera;
  125741. private _originalSceneAutoClear;
  125742. private _supported;
  125743. /**
  125744. * Camera used to render xr content
  125745. */
  125746. camera: WebXRCamera;
  125747. /** A features manager for this xr session */
  125748. featuresManager: WebXRFeaturesManager;
  125749. /**
  125750. * Observers registered here will be triggered after the camera's initial transformation is set
  125751. * This can be used to set a different ground level or an extra rotation.
  125752. *
  125753. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  125754. * to the position set after this observable is done executing.
  125755. */
  125756. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  125757. /**
  125758. * Fires when the state of the experience helper has changed
  125759. */
  125760. onStateChangedObservable: Observable<WebXRState>;
  125761. /** Session manager used to keep track of xr session */
  125762. sessionManager: WebXRSessionManager;
  125763. /**
  125764. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  125765. */
  125766. state: WebXRState;
  125767. /**
  125768. * Creates a WebXRExperienceHelper
  125769. * @param scene The scene the helper should be created in
  125770. */
  125771. private constructor();
  125772. /**
  125773. * Creates the experience helper
  125774. * @param scene the scene to attach the experience helper to
  125775. * @returns a promise for the experience helper
  125776. */
  125777. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  125778. /**
  125779. * Disposes of the experience helper
  125780. */
  125781. dispose(): void;
  125782. /**
  125783. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  125784. * @param sessionMode options for the XR session
  125785. * @param referenceSpaceType frame of reference of the XR session
  125786. * @param renderTarget the output canvas that will be used to enter XR mode
  125787. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  125788. * @returns promise that resolves after xr mode has entered
  125789. */
  125790. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  125791. /**
  125792. * Exits XR mode and returns the scene to its original state
  125793. * @returns promise that resolves after xr mode has exited
  125794. */
  125795. exitXRAsync(): Promise<void>;
  125796. private _nonXRToXRCamera;
  125797. private _setState;
  125798. }
  125799. }
  125800. declare module BABYLON {
  125801. /**
  125802. * X-Y values for axes in WebXR
  125803. */
  125804. export interface IWebXRMotionControllerAxesValue {
  125805. /**
  125806. * The value of the x axis
  125807. */
  125808. x: number;
  125809. /**
  125810. * The value of the y-axis
  125811. */
  125812. y: number;
  125813. }
  125814. /**
  125815. * changed / previous values for the values of this component
  125816. */
  125817. export interface IWebXRMotionControllerComponentChangesValues<T> {
  125818. /**
  125819. * current (this frame) value
  125820. */
  125821. current: T;
  125822. /**
  125823. * previous (last change) value
  125824. */
  125825. previous: T;
  125826. }
  125827. /**
  125828. * Represents changes in the component between current frame and last values recorded
  125829. */
  125830. export interface IWebXRMotionControllerComponentChanges {
  125831. /**
  125832. * will be populated with previous and current values if axes changed
  125833. */
  125834. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  125835. /**
  125836. * will be populated with previous and current values if pressed changed
  125837. */
  125838. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  125839. /**
  125840. * will be populated with previous and current values if touched changed
  125841. */
  125842. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  125843. /**
  125844. * will be populated with previous and current values if value changed
  125845. */
  125846. value?: IWebXRMotionControllerComponentChangesValues<number>;
  125847. }
  125848. /**
  125849. * This class represents a single component (for example button or thumbstick) of a motion controller
  125850. */
  125851. export class WebXRControllerComponent implements IDisposable {
  125852. /**
  125853. * the id of this component
  125854. */
  125855. id: string;
  125856. /**
  125857. * the type of the component
  125858. */
  125859. type: MotionControllerComponentType;
  125860. private _buttonIndex;
  125861. private _axesIndices;
  125862. private _axes;
  125863. private _changes;
  125864. private _currentValue;
  125865. private _hasChanges;
  125866. private _pressed;
  125867. private _touched;
  125868. /**
  125869. * button component type
  125870. */
  125871. static BUTTON_TYPE: MotionControllerComponentType;
  125872. /**
  125873. * squeeze component type
  125874. */
  125875. static SQUEEZE_TYPE: MotionControllerComponentType;
  125876. /**
  125877. * Thumbstick component type
  125878. */
  125879. static THUMBSTICK_TYPE: MotionControllerComponentType;
  125880. /**
  125881. * Touchpad component type
  125882. */
  125883. static TOUCHPAD_TYPE: MotionControllerComponentType;
  125884. /**
  125885. * trigger component type
  125886. */
  125887. static TRIGGER_TYPE: MotionControllerComponentType;
  125888. /**
  125889. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  125890. * the axes data changes
  125891. */
  125892. onAxisValueChangedObservable: Observable<{
  125893. x: number;
  125894. y: number;
  125895. }>;
  125896. /**
  125897. * Observers registered here will be triggered when the state of a button changes
  125898. * State change is either pressed / touched / value
  125899. */
  125900. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  125901. /**
  125902. * Creates a new component for a motion controller.
  125903. * It is created by the motion controller itself
  125904. *
  125905. * @param id the id of this component
  125906. * @param type the type of the component
  125907. * @param _buttonIndex index in the buttons array of the gamepad
  125908. * @param _axesIndices indices of the values in the axes array of the gamepad
  125909. */
  125910. constructor(
  125911. /**
  125912. * the id of this component
  125913. */
  125914. id: string,
  125915. /**
  125916. * the type of the component
  125917. */
  125918. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  125919. /**
  125920. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  125921. */
  125922. get axes(): IWebXRMotionControllerAxesValue;
  125923. /**
  125924. * Get the changes. Elements will be populated only if they changed with their previous and current value
  125925. */
  125926. get changes(): IWebXRMotionControllerComponentChanges;
  125927. /**
  125928. * Return whether or not the component changed the last frame
  125929. */
  125930. get hasChanges(): boolean;
  125931. /**
  125932. * is the button currently pressed
  125933. */
  125934. get pressed(): boolean;
  125935. /**
  125936. * is the button currently touched
  125937. */
  125938. get touched(): boolean;
  125939. /**
  125940. * Get the current value of this component
  125941. */
  125942. get value(): number;
  125943. /**
  125944. * Dispose this component
  125945. */
  125946. dispose(): void;
  125947. /**
  125948. * Are there axes correlating to this component
  125949. * @return true is axes data is available
  125950. */
  125951. isAxes(): boolean;
  125952. /**
  125953. * Is this component a button (hence - pressable)
  125954. * @returns true if can be pressed
  125955. */
  125956. isButton(): boolean;
  125957. /**
  125958. * update this component using the gamepad object it is in. Called on every frame
  125959. * @param nativeController the native gamepad controller object
  125960. */
  125961. update(nativeController: IMinimalMotionControllerObject): void;
  125962. }
  125963. }
  125964. declare module BABYLON {
  125965. /**
  125966. * Interface used to represent data loading progression
  125967. */
  125968. export interface ISceneLoaderProgressEvent {
  125969. /**
  125970. * Defines if data length to load can be evaluated
  125971. */
  125972. readonly lengthComputable: boolean;
  125973. /**
  125974. * Defines the loaded data length
  125975. */
  125976. readonly loaded: number;
  125977. /**
  125978. * Defines the data length to load
  125979. */
  125980. readonly total: number;
  125981. }
  125982. /**
  125983. * Interface used by SceneLoader plugins to define supported file extensions
  125984. */
  125985. export interface ISceneLoaderPluginExtensions {
  125986. /**
  125987. * Defines the list of supported extensions
  125988. */
  125989. [extension: string]: {
  125990. isBinary: boolean;
  125991. };
  125992. }
  125993. /**
  125994. * Interface used by SceneLoader plugin factory
  125995. */
  125996. export interface ISceneLoaderPluginFactory {
  125997. /**
  125998. * Defines the name of the factory
  125999. */
  126000. name: string;
  126001. /**
  126002. * Function called to create a new plugin
  126003. * @return the new plugin
  126004. */
  126005. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  126006. /**
  126007. * The callback that returns true if the data can be directly loaded.
  126008. * @param data string containing the file data
  126009. * @returns if the data can be loaded directly
  126010. */
  126011. canDirectLoad?(data: string): boolean;
  126012. }
  126013. /**
  126014. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  126015. */
  126016. export interface ISceneLoaderPluginBase {
  126017. /**
  126018. * The friendly name of this plugin.
  126019. */
  126020. name: string;
  126021. /**
  126022. * The file extensions supported by this plugin.
  126023. */
  126024. extensions: string | ISceneLoaderPluginExtensions;
  126025. /**
  126026. * The callback called when loading from a url.
  126027. * @param scene scene loading this url
  126028. * @param url url to load
  126029. * @param onSuccess callback called when the file successfully loads
  126030. * @param onProgress callback called while file is loading (if the server supports this mode)
  126031. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  126032. * @param onError callback called when the file fails to load
  126033. * @returns a file request object
  126034. */
  126035. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126036. /**
  126037. * The callback called when loading from a file object.
  126038. * @param scene scene loading this file
  126039. * @param file defines the file to load
  126040. * @param onSuccess defines the callback to call when data is loaded
  126041. * @param onProgress defines the callback to call during loading process
  126042. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  126043. * @param onError defines the callback to call when an error occurs
  126044. * @returns a file request object
  126045. */
  126046. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126047. /**
  126048. * The callback that returns true if the data can be directly loaded.
  126049. * @param data string containing the file data
  126050. * @returns if the data can be loaded directly
  126051. */
  126052. canDirectLoad?(data: string): boolean;
  126053. /**
  126054. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  126055. * @param scene scene loading this data
  126056. * @param data string containing the data
  126057. * @returns data to pass to the plugin
  126058. */
  126059. directLoad?(scene: Scene, data: string): any;
  126060. /**
  126061. * The callback that allows custom handling of the root url based on the response url.
  126062. * @param rootUrl the original root url
  126063. * @param responseURL the response url if available
  126064. * @returns the new root url
  126065. */
  126066. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  126067. }
  126068. /**
  126069. * Interface used to define a SceneLoader plugin
  126070. */
  126071. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  126072. /**
  126073. * Import meshes into a scene.
  126074. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126075. * @param scene The scene to import into
  126076. * @param data The data to import
  126077. * @param rootUrl The root url for scene and resources
  126078. * @param meshes The meshes array to import into
  126079. * @param particleSystems The particle systems array to import into
  126080. * @param skeletons The skeletons array to import into
  126081. * @param onError The callback when import fails
  126082. * @returns True if successful or false otherwise
  126083. */
  126084. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  126085. /**
  126086. * Load into a scene.
  126087. * @param scene The scene to load into
  126088. * @param data The data to import
  126089. * @param rootUrl The root url for scene and resources
  126090. * @param onError The callback when import fails
  126091. * @returns True if successful or false otherwise
  126092. */
  126093. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  126094. /**
  126095. * Load into an asset container.
  126096. * @param scene The scene to load into
  126097. * @param data The data to import
  126098. * @param rootUrl The root url for scene and resources
  126099. * @param onError The callback when import fails
  126100. * @returns The loaded asset container
  126101. */
  126102. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  126103. }
  126104. /**
  126105. * Interface used to define an async SceneLoader plugin
  126106. */
  126107. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  126108. /**
  126109. * Import meshes into a scene.
  126110. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126111. * @param scene The scene to import into
  126112. * @param data The data to import
  126113. * @param rootUrl The root url for scene and resources
  126114. * @param onProgress The callback when the load progresses
  126115. * @param fileName Defines the name of the file to load
  126116. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  126117. */
  126118. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  126119. meshes: AbstractMesh[];
  126120. particleSystems: IParticleSystem[];
  126121. skeletons: Skeleton[];
  126122. animationGroups: AnimationGroup[];
  126123. }>;
  126124. /**
  126125. * Load into a scene.
  126126. * @param scene The scene to load into
  126127. * @param data The data to import
  126128. * @param rootUrl The root url for scene and resources
  126129. * @param onProgress The callback when the load progresses
  126130. * @param fileName Defines the name of the file to load
  126131. * @returns Nothing
  126132. */
  126133. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  126134. /**
  126135. * Load into an asset container.
  126136. * @param scene The scene to load into
  126137. * @param data The data to import
  126138. * @param rootUrl The root url for scene and resources
  126139. * @param onProgress The callback when the load progresses
  126140. * @param fileName Defines the name of the file to load
  126141. * @returns The loaded asset container
  126142. */
  126143. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  126144. }
  126145. /**
  126146. * Mode that determines how to handle old animation groups before loading new ones.
  126147. */
  126148. export enum SceneLoaderAnimationGroupLoadingMode {
  126149. /**
  126150. * Reset all old animations to initial state then dispose them.
  126151. */
  126152. Clean = 0,
  126153. /**
  126154. * Stop all old animations.
  126155. */
  126156. Stop = 1,
  126157. /**
  126158. * Restart old animations from first frame.
  126159. */
  126160. Sync = 2,
  126161. /**
  126162. * Old animations remains untouched.
  126163. */
  126164. NoSync = 3
  126165. }
  126166. /**
  126167. * Defines a plugin registered by the SceneLoader
  126168. */
  126169. interface IRegisteredPlugin {
  126170. /**
  126171. * Defines the plugin to use
  126172. */
  126173. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  126174. /**
  126175. * Defines if the plugin supports binary data
  126176. */
  126177. isBinary: boolean;
  126178. }
  126179. /**
  126180. * Class used to load scene from various file formats using registered plugins
  126181. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  126182. */
  126183. export class SceneLoader {
  126184. /**
  126185. * No logging while loading
  126186. */
  126187. static readonly NO_LOGGING: number;
  126188. /**
  126189. * Minimal logging while loading
  126190. */
  126191. static readonly MINIMAL_LOGGING: number;
  126192. /**
  126193. * Summary logging while loading
  126194. */
  126195. static readonly SUMMARY_LOGGING: number;
  126196. /**
  126197. * Detailled logging while loading
  126198. */
  126199. static readonly DETAILED_LOGGING: number;
  126200. /**
  126201. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  126202. */
  126203. static get ForceFullSceneLoadingForIncremental(): boolean;
  126204. static set ForceFullSceneLoadingForIncremental(value: boolean);
  126205. /**
  126206. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  126207. */
  126208. static get ShowLoadingScreen(): boolean;
  126209. static set ShowLoadingScreen(value: boolean);
  126210. /**
  126211. * Defines the current logging level (while loading the scene)
  126212. * @ignorenaming
  126213. */
  126214. static get loggingLevel(): number;
  126215. static set loggingLevel(value: number);
  126216. /**
  126217. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  126218. */
  126219. static get CleanBoneMatrixWeights(): boolean;
  126220. static set CleanBoneMatrixWeights(value: boolean);
  126221. /**
  126222. * Event raised when a plugin is used to load a scene
  126223. */
  126224. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  126225. private static _registeredPlugins;
  126226. private static _showingLoadingScreen;
  126227. /**
  126228. * Gets the default plugin (used to load Babylon files)
  126229. * @returns the .babylon plugin
  126230. */
  126231. static GetDefaultPlugin(): IRegisteredPlugin;
  126232. private static _GetPluginForExtension;
  126233. private static _GetPluginForDirectLoad;
  126234. private static _GetPluginForFilename;
  126235. private static _GetDirectLoad;
  126236. private static _LoadData;
  126237. private static _GetFileInfo;
  126238. /**
  126239. * Gets a plugin that can load the given extension
  126240. * @param extension defines the extension to load
  126241. * @returns a plugin or null if none works
  126242. */
  126243. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  126244. /**
  126245. * Gets a boolean indicating that the given extension can be loaded
  126246. * @param extension defines the extension to load
  126247. * @returns true if the extension is supported
  126248. */
  126249. static IsPluginForExtensionAvailable(extension: string): boolean;
  126250. /**
  126251. * Adds a new plugin to the list of registered plugins
  126252. * @param plugin defines the plugin to add
  126253. */
  126254. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  126255. /**
  126256. * Import meshes into a scene
  126257. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126258. * @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)
  126259. * @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)
  126260. * @param scene the instance of BABYLON.Scene to append to
  126261. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  126262. * @param onProgress a callback with a progress event for each file being loaded
  126263. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126264. * @param pluginExtension the extension used to determine the plugin
  126265. * @returns The loaded plugin
  126266. */
  126267. 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>;
  126268. /**
  126269. * Import meshes into a scene
  126270. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126271. * @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)
  126272. * @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)
  126273. * @param scene the instance of BABYLON.Scene to append to
  126274. * @param onProgress a callback with a progress event for each file being loaded
  126275. * @param pluginExtension the extension used to determine the plugin
  126276. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  126277. */
  126278. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  126279. meshes: AbstractMesh[];
  126280. particleSystems: IParticleSystem[];
  126281. skeletons: Skeleton[];
  126282. animationGroups: AnimationGroup[];
  126283. }>;
  126284. /**
  126285. * Load a scene
  126286. * @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)
  126287. * @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)
  126288. * @param engine is the instance of BABYLON.Engine to use to create the scene
  126289. * @param onSuccess a callback with the scene when import succeeds
  126290. * @param onProgress a callback with a progress event for each file being loaded
  126291. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126292. * @param pluginExtension the extension used to determine the plugin
  126293. * @returns The loaded plugin
  126294. */
  126295. 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>;
  126296. /**
  126297. * Load a scene
  126298. * @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)
  126299. * @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)
  126300. * @param engine is the instance of BABYLON.Engine to use to create the scene
  126301. * @param onProgress a callback with a progress event for each file being loaded
  126302. * @param pluginExtension the extension used to determine the plugin
  126303. * @returns The loaded scene
  126304. */
  126305. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  126306. /**
  126307. * Append a scene
  126308. * @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)
  126309. * @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)
  126310. * @param scene is the instance of BABYLON.Scene to append to
  126311. * @param onSuccess a callback with the scene when import succeeds
  126312. * @param onProgress a callback with a progress event for each file being loaded
  126313. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126314. * @param pluginExtension the extension used to determine the plugin
  126315. * @returns The loaded plugin
  126316. */
  126317. 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>;
  126318. /**
  126319. * Append a scene
  126320. * @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)
  126321. * @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)
  126322. * @param scene is the instance of BABYLON.Scene to append to
  126323. * @param onProgress a callback with a progress event for each file being loaded
  126324. * @param pluginExtension the extension used to determine the plugin
  126325. * @returns The given scene
  126326. */
  126327. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  126328. /**
  126329. * Load a scene into an asset container
  126330. * @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)
  126331. * @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)
  126332. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126333. * @param onSuccess a callback with the scene when import succeeds
  126334. * @param onProgress a callback with a progress event for each file being loaded
  126335. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126336. * @param pluginExtension the extension used to determine the plugin
  126337. * @returns The loaded plugin
  126338. */
  126339. 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>;
  126340. /**
  126341. * Load a scene into an asset container
  126342. * @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)
  126343. * @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)
  126344. * @param scene is the instance of Scene to append to
  126345. * @param onProgress a callback with a progress event for each file being loaded
  126346. * @param pluginExtension the extension used to determine the plugin
  126347. * @returns The loaded asset container
  126348. */
  126349. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  126350. /**
  126351. * Import animations from a file into a scene
  126352. * @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)
  126353. * @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)
  126354. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126355. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  126356. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  126357. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  126358. * @param onSuccess a callback with the scene when import succeeds
  126359. * @param onProgress a callback with a progress event for each file being loaded
  126360. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126361. * @param pluginExtension the extension used to determine the plugin
  126362. */
  126363. 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;
  126364. /**
  126365. * Import animations from a file into a scene
  126366. * @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)
  126367. * @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)
  126368. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126369. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  126370. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  126371. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  126372. * @param onSuccess a callback with the scene when import succeeds
  126373. * @param onProgress a callback with a progress event for each file being loaded
  126374. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126375. * @param pluginExtension the extension used to determine the plugin
  126376. * @returns the updated scene with imported animations
  126377. */
  126378. 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>;
  126379. }
  126380. }
  126381. declare module BABYLON {
  126382. /**
  126383. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  126384. */
  126385. export type MotionControllerHandedness = "none" | "left" | "right";
  126386. /**
  126387. * The type of components available in motion controllers.
  126388. * This is not the name of the component.
  126389. */
  126390. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  126391. /**
  126392. * The state of a controller component
  126393. */
  126394. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  126395. /**
  126396. * The schema of motion controller layout.
  126397. * No object will be initialized using this interface
  126398. * This is used just to define the profile.
  126399. */
  126400. export interface IMotionControllerLayout {
  126401. /**
  126402. * Path to load the assets. Usually relative to the base path
  126403. */
  126404. assetPath: string;
  126405. /**
  126406. * Available components (unsorted)
  126407. */
  126408. components: {
  126409. /**
  126410. * A map of component Ids
  126411. */
  126412. [componentId: string]: {
  126413. /**
  126414. * The type of input the component outputs
  126415. */
  126416. type: MotionControllerComponentType;
  126417. /**
  126418. * The indices of this component in the gamepad object
  126419. */
  126420. gamepadIndices: {
  126421. /**
  126422. * Index of button
  126423. */
  126424. button?: number;
  126425. /**
  126426. * If available, index of x-axis
  126427. */
  126428. xAxis?: number;
  126429. /**
  126430. * If available, index of y-axis
  126431. */
  126432. yAxis?: number;
  126433. };
  126434. /**
  126435. * The mesh's root node name
  126436. */
  126437. rootNodeName: string;
  126438. /**
  126439. * Animation definitions for this model
  126440. */
  126441. visualResponses: {
  126442. [stateKey: string]: {
  126443. /**
  126444. * What property will be animated
  126445. */
  126446. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  126447. /**
  126448. * What states influence this visual response
  126449. */
  126450. states: MotionControllerComponentStateType[];
  126451. /**
  126452. * Type of animation - movement or visibility
  126453. */
  126454. valueNodeProperty: "transform" | "visibility";
  126455. /**
  126456. * Base node name to move. Its position will be calculated according to the min and max nodes
  126457. */
  126458. valueNodeName?: string;
  126459. /**
  126460. * Minimum movement node
  126461. */
  126462. minNodeName?: string;
  126463. /**
  126464. * Max movement node
  126465. */
  126466. maxNodeName?: string;
  126467. };
  126468. };
  126469. /**
  126470. * If touch enabled, what is the name of node to display user feedback
  126471. */
  126472. touchPointNodeName?: string;
  126473. };
  126474. };
  126475. /**
  126476. * Is it xr standard mapping or not
  126477. */
  126478. gamepadMapping: "" | "xr-standard";
  126479. /**
  126480. * Base root node of this entire model
  126481. */
  126482. rootNodeName: string;
  126483. /**
  126484. * Defines the main button component id
  126485. */
  126486. selectComponentId: string;
  126487. }
  126488. /**
  126489. * A definition for the layout map in the input profile
  126490. */
  126491. export interface IMotionControllerLayoutMap {
  126492. /**
  126493. * Layouts with handedness type as a key
  126494. */
  126495. [handedness: string]: IMotionControllerLayout;
  126496. }
  126497. /**
  126498. * The XR Input profile schema
  126499. * Profiles can be found here:
  126500. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  126501. */
  126502. export interface IMotionControllerProfile {
  126503. /**
  126504. * fallback profiles for this profileId
  126505. */
  126506. fallbackProfileIds: string[];
  126507. /**
  126508. * The layout map, with handedness as key
  126509. */
  126510. layouts: IMotionControllerLayoutMap;
  126511. /**
  126512. * The id of this profile
  126513. * correlates to the profile(s) in the xrInput.profiles array
  126514. */
  126515. profileId: string;
  126516. }
  126517. /**
  126518. * A helper-interface for the 3 meshes needed for controller button animation
  126519. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  126520. */
  126521. export interface IMotionControllerButtonMeshMap {
  126522. /**
  126523. * the mesh that defines the pressed value mesh position.
  126524. * This is used to find the max-position of this button
  126525. */
  126526. pressedMesh: AbstractMesh;
  126527. /**
  126528. * the mesh that defines the unpressed value mesh position.
  126529. * This is used to find the min (or initial) position of this button
  126530. */
  126531. unpressedMesh: AbstractMesh;
  126532. /**
  126533. * The mesh that will be changed when value changes
  126534. */
  126535. valueMesh: AbstractMesh;
  126536. }
  126537. /**
  126538. * A helper-interface for the 3 meshes needed for controller axis animation.
  126539. * This will be expanded when touchpad animations are fully supported
  126540. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  126541. */
  126542. export interface IMotionControllerMeshMap {
  126543. /**
  126544. * the mesh that defines the maximum value mesh position.
  126545. */
  126546. maxMesh?: AbstractMesh;
  126547. /**
  126548. * the mesh that defines the minimum value mesh position.
  126549. */
  126550. minMesh?: AbstractMesh;
  126551. /**
  126552. * The mesh that will be changed when axis value changes
  126553. */
  126554. valueMesh: AbstractMesh;
  126555. }
  126556. /**
  126557. * The elements needed for change-detection of the gamepad objects in motion controllers
  126558. */
  126559. export interface IMinimalMotionControllerObject {
  126560. /**
  126561. * Available axes of this controller
  126562. */
  126563. axes: number[];
  126564. /**
  126565. * An array of available buttons
  126566. */
  126567. buttons: Array<{
  126568. /**
  126569. * Value of the button/trigger
  126570. */
  126571. value: number;
  126572. /**
  126573. * If the button/trigger is currently touched
  126574. */
  126575. touched: boolean;
  126576. /**
  126577. * If the button/trigger is currently pressed
  126578. */
  126579. pressed: boolean;
  126580. }>;
  126581. /**
  126582. * EXPERIMENTAL haptic support.
  126583. */
  126584. hapticActuators?: Array<{
  126585. pulse: (value: number, duration: number) => Promise<boolean>;
  126586. }>;
  126587. }
  126588. /**
  126589. * An Abstract Motion controller
  126590. * This class receives an xrInput and a profile layout and uses those to initialize the components
  126591. * Each component has an observable to check for changes in value and state
  126592. */
  126593. export abstract class WebXRAbstractMotionController implements IDisposable {
  126594. protected scene: Scene;
  126595. protected layout: IMotionControllerLayout;
  126596. /**
  126597. * The gamepad object correlating to this controller
  126598. */
  126599. gamepadObject: IMinimalMotionControllerObject;
  126600. /**
  126601. * handedness (left/right/none) of this controller
  126602. */
  126603. handedness: MotionControllerHandedness;
  126604. private _initComponent;
  126605. private _modelReady;
  126606. /**
  126607. * A map of components (WebXRControllerComponent) in this motion controller
  126608. * Components have a ComponentType and can also have both button and axis definitions
  126609. */
  126610. readonly components: {
  126611. [id: string]: WebXRControllerComponent;
  126612. };
  126613. /**
  126614. * Disable the model's animation. Can be set at any time.
  126615. */
  126616. disableAnimation: boolean;
  126617. /**
  126618. * Observers registered here will be triggered when the model of this controller is done loading
  126619. */
  126620. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  126621. /**
  126622. * The profile id of this motion controller
  126623. */
  126624. abstract profileId: string;
  126625. /**
  126626. * The root mesh of the model. It is null if the model was not yet initialized
  126627. */
  126628. rootMesh: Nullable<AbstractMesh>;
  126629. /**
  126630. * constructs a new abstract motion controller
  126631. * @param scene the scene to which the model of the controller will be added
  126632. * @param layout The profile layout to load
  126633. * @param gamepadObject The gamepad object correlating to this controller
  126634. * @param handedness handedness (left/right/none) of this controller
  126635. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  126636. */
  126637. constructor(scene: Scene, layout: IMotionControllerLayout,
  126638. /**
  126639. * The gamepad object correlating to this controller
  126640. */
  126641. gamepadObject: IMinimalMotionControllerObject,
  126642. /**
  126643. * handedness (left/right/none) of this controller
  126644. */
  126645. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  126646. /**
  126647. * Dispose this controller, the model mesh and all its components
  126648. */
  126649. dispose(): void;
  126650. /**
  126651. * Returns all components of specific type
  126652. * @param type the type to search for
  126653. * @return an array of components with this type
  126654. */
  126655. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  126656. /**
  126657. * get a component based an its component id as defined in layout.components
  126658. * @param id the id of the component
  126659. * @returns the component correlates to the id or undefined if not found
  126660. */
  126661. getComponent(id: string): WebXRControllerComponent;
  126662. /**
  126663. * Get the list of components available in this motion controller
  126664. * @returns an array of strings correlating to available components
  126665. */
  126666. getComponentIds(): string[];
  126667. /**
  126668. * Get the first component of specific type
  126669. * @param type type of component to find
  126670. * @return a controller component or null if not found
  126671. */
  126672. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  126673. /**
  126674. * Get the main (Select) component of this controller as defined in the layout
  126675. * @returns the main component of this controller
  126676. */
  126677. getMainComponent(): WebXRControllerComponent;
  126678. /**
  126679. * Loads the model correlating to this controller
  126680. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  126681. * @returns A promise fulfilled with the result of the model loading
  126682. */
  126683. loadModel(): Promise<boolean>;
  126684. /**
  126685. * Update this model using the current XRFrame
  126686. * @param xrFrame the current xr frame to use and update the model
  126687. */
  126688. updateFromXRFrame(xrFrame: XRFrame): void;
  126689. /**
  126690. * Backwards compatibility due to a deeply-integrated typo
  126691. */
  126692. get handness(): XREye;
  126693. /**
  126694. * Pulse (vibrate) this controller
  126695. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  126696. * Consecutive calls to this function will cancel the last pulse call
  126697. *
  126698. * @param value the strength of the pulse in 0.0...1.0 range
  126699. * @param duration Duration of the pulse in milliseconds
  126700. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  126701. * @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
  126702. */
  126703. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  126704. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  126705. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  126706. /**
  126707. * Moves the axis on the controller mesh based on its current state
  126708. * @param axis the index of the axis
  126709. * @param axisValue the value of the axis which determines the meshes new position
  126710. * @hidden
  126711. */
  126712. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  126713. /**
  126714. * Update the model itself with the current frame data
  126715. * @param xrFrame the frame to use for updating the model mesh
  126716. */
  126717. protected updateModel(xrFrame: XRFrame): void;
  126718. /**
  126719. * Get the filename and path for this controller's model
  126720. * @returns a map of filename and path
  126721. */
  126722. protected abstract _getFilenameAndPath(): {
  126723. filename: string;
  126724. path: string;
  126725. };
  126726. /**
  126727. * This function is called before the mesh is loaded. It checks for loading constraints.
  126728. * For example, this function can check if the GLB loader is available
  126729. * If this function returns false, the generic controller will be loaded instead
  126730. * @returns Is the client ready to load the mesh
  126731. */
  126732. protected abstract _getModelLoadingConstraints(): boolean;
  126733. /**
  126734. * This function will be called after the model was successfully loaded and can be used
  126735. * for mesh transformations before it is available for the user
  126736. * @param meshes the loaded meshes
  126737. */
  126738. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  126739. /**
  126740. * Set the root mesh for this controller. Important for the WebXR controller class
  126741. * @param meshes the loaded meshes
  126742. */
  126743. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  126744. /**
  126745. * A function executed each frame that updates the mesh (if needed)
  126746. * @param xrFrame the current xrFrame
  126747. */
  126748. protected abstract _updateModel(xrFrame: XRFrame): void;
  126749. private _getGenericFilenameAndPath;
  126750. private _getGenericParentMesh;
  126751. }
  126752. }
  126753. declare module BABYLON {
  126754. /**
  126755. * A generic trigger-only motion controller for WebXR
  126756. */
  126757. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  126758. /**
  126759. * Static version of the profile id of this controller
  126760. */
  126761. static ProfileId: string;
  126762. profileId: string;
  126763. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  126764. protected _getFilenameAndPath(): {
  126765. filename: string;
  126766. path: string;
  126767. };
  126768. protected _getModelLoadingConstraints(): boolean;
  126769. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  126770. protected _setRootMesh(meshes: AbstractMesh[]): void;
  126771. protected _updateModel(): void;
  126772. }
  126773. }
  126774. declare module BABYLON {
  126775. /**
  126776. * Class containing static functions to help procedurally build meshes
  126777. */
  126778. export class SphereBuilder {
  126779. /**
  126780. * Creates a sphere mesh
  126781. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  126782. * * 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`)
  126783. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  126784. * * 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
  126785. * * 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)
  126786. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126787. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126788. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126789. * @param name defines the name of the mesh
  126790. * @param options defines the options used to create the mesh
  126791. * @param scene defines the hosting scene
  126792. * @returns the sphere mesh
  126793. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  126794. */
  126795. static CreateSphere(name: string, options: {
  126796. segments?: number;
  126797. diameter?: number;
  126798. diameterX?: number;
  126799. diameterY?: number;
  126800. diameterZ?: number;
  126801. arc?: number;
  126802. slice?: number;
  126803. sideOrientation?: number;
  126804. frontUVs?: Vector4;
  126805. backUVs?: Vector4;
  126806. updatable?: boolean;
  126807. }, scene?: Nullable<Scene>): Mesh;
  126808. }
  126809. }
  126810. declare module BABYLON {
  126811. /**
  126812. * A profiled motion controller has its profile loaded from an online repository.
  126813. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  126814. */
  126815. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  126816. private _repositoryUrl;
  126817. private _buttonMeshMapping;
  126818. private _touchDots;
  126819. /**
  126820. * The profile ID of this controller. Will be populated when the controller initializes.
  126821. */
  126822. profileId: string;
  126823. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  126824. dispose(): void;
  126825. protected _getFilenameAndPath(): {
  126826. filename: string;
  126827. path: string;
  126828. };
  126829. protected _getModelLoadingConstraints(): boolean;
  126830. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  126831. protected _setRootMesh(meshes: AbstractMesh[]): void;
  126832. protected _updateModel(_xrFrame: XRFrame): void;
  126833. }
  126834. }
  126835. declare module BABYLON {
  126836. /**
  126837. * A construction function type to create a new controller based on an xrInput object
  126838. */
  126839. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  126840. /**
  126841. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  126842. *
  126843. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  126844. * it should be replaced with auto-loaded controllers.
  126845. *
  126846. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  126847. */
  126848. export class WebXRMotionControllerManager {
  126849. private static _AvailableControllers;
  126850. private static _Fallbacks;
  126851. private static _ProfileLoadingPromises;
  126852. private static _ProfilesList;
  126853. /**
  126854. * The base URL of the online controller repository. Can be changed at any time.
  126855. */
  126856. static BaseRepositoryUrl: string;
  126857. /**
  126858. * Which repository gets priority - local or online
  126859. */
  126860. static PrioritizeOnlineRepository: boolean;
  126861. /**
  126862. * Use the online repository, or use only locally-defined controllers
  126863. */
  126864. static UseOnlineRepository: boolean;
  126865. /**
  126866. * Clear the cache used for profile loading and reload when requested again
  126867. */
  126868. static ClearProfilesCache(): void;
  126869. /**
  126870. * Register the default fallbacks.
  126871. * This function is called automatically when this file is imported.
  126872. */
  126873. static DefaultFallbacks(): void;
  126874. /**
  126875. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  126876. * @param profileId the profile to which a fallback needs to be found
  126877. * @return an array with corresponding fallback profiles
  126878. */
  126879. static FindFallbackWithProfileId(profileId: string): string[];
  126880. /**
  126881. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  126882. * The order of search:
  126883. *
  126884. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  126885. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  126886. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  126887. * 4) return the generic trigger controller if none were found
  126888. *
  126889. * @param xrInput the xrInput to which a new controller is initialized
  126890. * @param scene the scene to which the model will be added
  126891. * @param forceProfile force a certain profile for this controller
  126892. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  126893. */
  126894. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  126895. /**
  126896. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  126897. *
  126898. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  126899. *
  126900. * @param type the profile type to register
  126901. * @param constructFunction the function to be called when loading this profile
  126902. */
  126903. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  126904. /**
  126905. * Register a fallback to a specific profile.
  126906. * @param profileId the profileId that will receive the fallbacks
  126907. * @param fallbacks A list of fallback profiles
  126908. */
  126909. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  126910. /**
  126911. * Will update the list of profiles available in the repository
  126912. * @return a promise that resolves to a map of profiles available online
  126913. */
  126914. static UpdateProfilesList(): Promise<{
  126915. [profile: string]: string;
  126916. }>;
  126917. private static _LoadProfileFromRepository;
  126918. private static _LoadProfilesFromAvailableControllers;
  126919. }
  126920. }
  126921. declare module BABYLON {
  126922. /**
  126923. * Configuration options for the WebXR controller creation
  126924. */
  126925. export interface IWebXRControllerOptions {
  126926. /**
  126927. * Should the controller mesh be animated when a user interacts with it
  126928. * The pressed buttons / thumbstick and touchpad animations will be disabled
  126929. */
  126930. disableMotionControllerAnimation?: boolean;
  126931. /**
  126932. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  126933. */
  126934. doNotLoadControllerMesh?: boolean;
  126935. /**
  126936. * Force a specific controller type for this controller.
  126937. * This can be used when creating your own profile or when testing different controllers
  126938. */
  126939. forceControllerProfile?: string;
  126940. /**
  126941. * Defines a rendering group ID for meshes that will be loaded.
  126942. * This is for the default controllers only.
  126943. */
  126944. renderingGroupId?: number;
  126945. }
  126946. /**
  126947. * Represents an XR controller
  126948. */
  126949. export class WebXRInputSource {
  126950. private _scene;
  126951. /** The underlying input source for the controller */
  126952. inputSource: XRInputSource;
  126953. private _options;
  126954. private _tmpVector;
  126955. private _uniqueId;
  126956. /**
  126957. * 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
  126958. */
  126959. grip?: AbstractMesh;
  126960. /**
  126961. * If available, this is the gamepad object related to this controller.
  126962. * Using this object it is possible to get click events and trackpad changes of the
  126963. * webxr controller that is currently being used.
  126964. */
  126965. motionController?: WebXRAbstractMotionController;
  126966. /**
  126967. * Event that fires when the controller is removed/disposed.
  126968. * The object provided as event data is this controller, after associated assets were disposed.
  126969. * uniqueId is still available.
  126970. */
  126971. onDisposeObservable: Observable<WebXRInputSource>;
  126972. /**
  126973. * Will be triggered when the mesh associated with the motion controller is done loading.
  126974. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  126975. * A shortened version of controller -> motion controller -> on mesh loaded.
  126976. */
  126977. onMeshLoadedObservable: Observable<AbstractMesh>;
  126978. /**
  126979. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  126980. */
  126981. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  126982. /**
  126983. * Pointer which can be used to select objects or attach a visible laser to
  126984. */
  126985. pointer: AbstractMesh;
  126986. /**
  126987. * Creates the input source object
  126988. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  126989. * @param _scene the scene which the controller should be associated to
  126990. * @param inputSource the underlying input source for the controller
  126991. * @param _options options for this controller creation
  126992. */
  126993. constructor(_scene: Scene,
  126994. /** The underlying input source for the controller */
  126995. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  126996. /**
  126997. * Get this controllers unique id
  126998. */
  126999. get uniqueId(): string;
  127000. /**
  127001. * Disposes of the object
  127002. */
  127003. dispose(): void;
  127004. /**
  127005. * Gets a world space ray coming from the pointer or grip
  127006. * @param result the resulting ray
  127007. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  127008. */
  127009. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  127010. /**
  127011. * Updates the controller pose based on the given XRFrame
  127012. * @param xrFrame xr frame to update the pose with
  127013. * @param referenceSpace reference space to use
  127014. */
  127015. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  127016. }
  127017. }
  127018. declare module BABYLON {
  127019. /**
  127020. * The schema for initialization options of the XR Input class
  127021. */
  127022. export interface IWebXRInputOptions {
  127023. /**
  127024. * If set to true no model will be automatically loaded
  127025. */
  127026. doNotLoadControllerMeshes?: boolean;
  127027. /**
  127028. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  127029. * If not found, the xr input profile data will be used.
  127030. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  127031. */
  127032. forceInputProfile?: string;
  127033. /**
  127034. * Do not send a request to the controller repository to load the profile.
  127035. *
  127036. * Instead, use the controllers available in babylon itself.
  127037. */
  127038. disableOnlineControllerRepository?: boolean;
  127039. /**
  127040. * A custom URL for the controllers repository
  127041. */
  127042. customControllersRepositoryURL?: string;
  127043. /**
  127044. * Should the controller model's components not move according to the user input
  127045. */
  127046. disableControllerAnimation?: boolean;
  127047. /**
  127048. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  127049. */
  127050. controllerOptions?: IWebXRControllerOptions;
  127051. }
  127052. /**
  127053. * XR input used to track XR inputs such as controllers/rays
  127054. */
  127055. export class WebXRInput implements IDisposable {
  127056. /**
  127057. * the xr session manager for this session
  127058. */
  127059. xrSessionManager: WebXRSessionManager;
  127060. /**
  127061. * the WebXR camera for this session. Mainly used for teleportation
  127062. */
  127063. xrCamera: WebXRCamera;
  127064. private readonly options;
  127065. /**
  127066. * XR controllers being tracked
  127067. */
  127068. controllers: Array<WebXRInputSource>;
  127069. private _frameObserver;
  127070. private _sessionEndedObserver;
  127071. private _sessionInitObserver;
  127072. /**
  127073. * Event when a controller has been connected/added
  127074. */
  127075. onControllerAddedObservable: Observable<WebXRInputSource>;
  127076. /**
  127077. * Event when a controller has been removed/disconnected
  127078. */
  127079. onControllerRemovedObservable: Observable<WebXRInputSource>;
  127080. /**
  127081. * Initializes the WebXRInput
  127082. * @param xrSessionManager the xr session manager for this session
  127083. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  127084. * @param options = initialization options for this xr input
  127085. */
  127086. constructor(
  127087. /**
  127088. * the xr session manager for this session
  127089. */
  127090. xrSessionManager: WebXRSessionManager,
  127091. /**
  127092. * the WebXR camera for this session. Mainly used for teleportation
  127093. */
  127094. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  127095. private _onInputSourcesChange;
  127096. private _addAndRemoveControllers;
  127097. /**
  127098. * Disposes of the object
  127099. */
  127100. dispose(): void;
  127101. }
  127102. }
  127103. declare module BABYLON {
  127104. /**
  127105. * This is the base class for all WebXR features.
  127106. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  127107. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  127108. */
  127109. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  127110. protected _xrSessionManager: WebXRSessionManager;
  127111. private _attached;
  127112. private _removeOnDetach;
  127113. /**
  127114. * Should auto-attach be disabled?
  127115. */
  127116. disableAutoAttach: boolean;
  127117. /**
  127118. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  127119. */
  127120. xrNativeFeatureName: string;
  127121. /**
  127122. * Construct a new (abstract) WebXR feature
  127123. * @param _xrSessionManager the xr session manager for this feature
  127124. */
  127125. constructor(_xrSessionManager: WebXRSessionManager);
  127126. /**
  127127. * Is this feature attached
  127128. */
  127129. get attached(): boolean;
  127130. /**
  127131. * attach this feature
  127132. *
  127133. * @param force should attachment be forced (even when already attached)
  127134. * @returns true if successful, false is failed or already attached
  127135. */
  127136. attach(force?: boolean): boolean;
  127137. /**
  127138. * detach this feature.
  127139. *
  127140. * @returns true if successful, false if failed or already detached
  127141. */
  127142. detach(): boolean;
  127143. /**
  127144. * Dispose this feature and all of the resources attached
  127145. */
  127146. dispose(): void;
  127147. /**
  127148. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  127149. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  127150. *
  127151. * @returns whether or not the feature is compatible in this environment
  127152. */
  127153. isCompatible(): boolean;
  127154. /**
  127155. * This is used to register callbacks that will automatically be removed when detach is called.
  127156. * @param observable the observable to which the observer will be attached
  127157. * @param callback the callback to register
  127158. */
  127159. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  127160. /**
  127161. * Code in this function will be executed on each xrFrame received from the browser.
  127162. * This function will not execute after the feature is detached.
  127163. * @param _xrFrame the current frame
  127164. */
  127165. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  127166. }
  127167. }
  127168. declare module BABYLON {
  127169. /**
  127170. * Renders a layer on top of an existing scene
  127171. */
  127172. export class UtilityLayerRenderer implements IDisposable {
  127173. /** the original scene that will be rendered on top of */
  127174. originalScene: Scene;
  127175. private _pointerCaptures;
  127176. private _lastPointerEvents;
  127177. private static _DefaultUtilityLayer;
  127178. private static _DefaultKeepDepthUtilityLayer;
  127179. private _sharedGizmoLight;
  127180. private _renderCamera;
  127181. /**
  127182. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  127183. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  127184. * @returns the camera that is used when rendering the utility layer
  127185. */
  127186. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  127187. /**
  127188. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  127189. * @param cam the camera that should be used when rendering the utility layer
  127190. */
  127191. setRenderCamera(cam: Nullable<Camera>): void;
  127192. /**
  127193. * @hidden
  127194. * Light which used by gizmos to get light shading
  127195. */
  127196. _getSharedGizmoLight(): HemisphericLight;
  127197. /**
  127198. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  127199. */
  127200. pickUtilitySceneFirst: boolean;
  127201. /**
  127202. * 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)
  127203. */
  127204. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  127205. /**
  127206. * 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)
  127207. */
  127208. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  127209. /**
  127210. * The scene that is rendered on top of the original scene
  127211. */
  127212. utilityLayerScene: Scene;
  127213. /**
  127214. * If the utility layer should automatically be rendered on top of existing scene
  127215. */
  127216. shouldRender: boolean;
  127217. /**
  127218. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  127219. */
  127220. onlyCheckPointerDownEvents: boolean;
  127221. /**
  127222. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  127223. */
  127224. processAllEvents: boolean;
  127225. /**
  127226. * Observable raised when the pointer move from the utility layer scene to the main scene
  127227. */
  127228. onPointerOutObservable: Observable<number>;
  127229. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  127230. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  127231. private _afterRenderObserver;
  127232. private _sceneDisposeObserver;
  127233. private _originalPointerObserver;
  127234. /**
  127235. * Instantiates a UtilityLayerRenderer
  127236. * @param originalScene the original scene that will be rendered on top of
  127237. * @param handleEvents boolean indicating if the utility layer should handle events
  127238. */
  127239. constructor(
  127240. /** the original scene that will be rendered on top of */
  127241. originalScene: Scene, handleEvents?: boolean);
  127242. private _notifyObservers;
  127243. /**
  127244. * Renders the utility layers scene on top of the original scene
  127245. */
  127246. render(): void;
  127247. /**
  127248. * Disposes of the renderer
  127249. */
  127250. dispose(): void;
  127251. private _updateCamera;
  127252. }
  127253. }
  127254. declare module BABYLON {
  127255. /**
  127256. * Options interface for the pointer selection module
  127257. */
  127258. export interface IWebXRControllerPointerSelectionOptions {
  127259. /**
  127260. * if provided, this scene will be used to render meshes.
  127261. */
  127262. customUtilityLayerScene?: Scene;
  127263. /**
  127264. * 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)
  127265. * If not disabled, the last picked point will be used to execute a pointer up event
  127266. * If disabled, pointer up event will be triggered right after the pointer down event.
  127267. * Used in screen and gaze target ray mode only
  127268. */
  127269. disablePointerUpOnTouchOut: boolean;
  127270. /**
  127271. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  127272. */
  127273. forceGazeMode: boolean;
  127274. /**
  127275. * 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
  127276. * to start a new countdown to the pointer down event.
  127277. * Defaults to 1.
  127278. */
  127279. gazeModePointerMovedFactor?: number;
  127280. /**
  127281. * Different button type to use instead of the main component
  127282. */
  127283. overrideButtonId?: string;
  127284. /**
  127285. * use this rendering group id for the meshes (optional)
  127286. */
  127287. renderingGroupId?: number;
  127288. /**
  127289. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  127290. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  127291. * 3000 means 3 seconds between pointing at something and selecting it
  127292. */
  127293. timeToSelect?: number;
  127294. /**
  127295. * Should meshes created here be added to a utility layer or the main scene
  127296. */
  127297. useUtilityLayer?: boolean;
  127298. /**
  127299. * Optional WebXR camera to be used for gaze selection
  127300. */
  127301. gazeCamera?: WebXRCamera;
  127302. /**
  127303. * the xr input to use with this pointer selection
  127304. */
  127305. xrInput: WebXRInput;
  127306. }
  127307. /**
  127308. * A module that will enable pointer selection for motion controllers of XR Input Sources
  127309. */
  127310. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  127311. private readonly _options;
  127312. private static _idCounter;
  127313. private _attachController;
  127314. private _controllers;
  127315. private _scene;
  127316. private _tmpVectorForPickCompare;
  127317. /**
  127318. * The module's name
  127319. */
  127320. static readonly Name: string;
  127321. /**
  127322. * The (Babylon) version of this module.
  127323. * This is an integer representing the implementation version.
  127324. * This number does not correspond to the WebXR specs version
  127325. */
  127326. static readonly Version: number;
  127327. /**
  127328. * Disable lighting on the laser pointer (so it will always be visible)
  127329. */
  127330. disablePointerLighting: boolean;
  127331. /**
  127332. * Disable lighting on the selection mesh (so it will always be visible)
  127333. */
  127334. disableSelectionMeshLighting: boolean;
  127335. /**
  127336. * Should the laser pointer be displayed
  127337. */
  127338. displayLaserPointer: boolean;
  127339. /**
  127340. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  127341. */
  127342. displaySelectionMesh: boolean;
  127343. /**
  127344. * This color will be set to the laser pointer when selection is triggered
  127345. */
  127346. laserPointerPickedColor: Color3;
  127347. /**
  127348. * Default color of the laser pointer
  127349. */
  127350. laserPointerDefaultColor: Color3;
  127351. /**
  127352. * default color of the selection ring
  127353. */
  127354. selectionMeshDefaultColor: Color3;
  127355. /**
  127356. * This color will be applied to the selection ring when selection is triggered
  127357. */
  127358. selectionMeshPickedColor: Color3;
  127359. /**
  127360. * Optional filter to be used for ray selection. This predicate shares behavior with
  127361. * scene.pointerMovePredicate which takes priority if it is also assigned.
  127362. */
  127363. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  127364. /**
  127365. * constructs a new background remover module
  127366. * @param _xrSessionManager the session manager for this module
  127367. * @param _options read-only options to be used in this module
  127368. */
  127369. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  127370. /**
  127371. * attach this feature
  127372. * Will usually be called by the features manager
  127373. *
  127374. * @returns true if successful.
  127375. */
  127376. attach(): boolean;
  127377. /**
  127378. * detach this feature.
  127379. * Will usually be called by the features manager
  127380. *
  127381. * @returns true if successful.
  127382. */
  127383. detach(): boolean;
  127384. /**
  127385. * Will get the mesh under a specific pointer.
  127386. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  127387. * @param controllerId the controllerId to check
  127388. * @returns The mesh under pointer or null if no mesh is under the pointer
  127389. */
  127390. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  127391. /**
  127392. * Get the xr controller that correlates to the pointer id in the pointer event
  127393. *
  127394. * @param id the pointer id to search for
  127395. * @returns the controller that correlates to this id or null if not found
  127396. */
  127397. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  127398. protected _onXRFrame(_xrFrame: XRFrame): void;
  127399. private _attachGazeMode;
  127400. private _attachScreenRayMode;
  127401. private _attachTrackedPointerRayMode;
  127402. private _convertNormalToDirectionOfRay;
  127403. private _detachController;
  127404. private _generateNewMeshPair;
  127405. private _pickingMoved;
  127406. private _updatePointerDistance;
  127407. /** @hidden */
  127408. get lasterPointerDefaultColor(): Color3;
  127409. }
  127410. }
  127411. declare module BABYLON {
  127412. /**
  127413. * Button which can be used to enter a different mode of XR
  127414. */
  127415. export class WebXREnterExitUIButton {
  127416. /** button element */
  127417. element: HTMLElement;
  127418. /** XR initialization options for the button */
  127419. sessionMode: XRSessionMode;
  127420. /** Reference space type */
  127421. referenceSpaceType: XRReferenceSpaceType;
  127422. /**
  127423. * Creates a WebXREnterExitUIButton
  127424. * @param element button element
  127425. * @param sessionMode XR initialization session mode
  127426. * @param referenceSpaceType the type of reference space to be used
  127427. */
  127428. constructor(
  127429. /** button element */
  127430. element: HTMLElement,
  127431. /** XR initialization options for the button */
  127432. sessionMode: XRSessionMode,
  127433. /** Reference space type */
  127434. referenceSpaceType: XRReferenceSpaceType);
  127435. /**
  127436. * Extendable function which can be used to update the button's visuals when the state changes
  127437. * @param activeButton the current active button in the UI
  127438. */
  127439. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  127440. }
  127441. /**
  127442. * Options to create the webXR UI
  127443. */
  127444. export class WebXREnterExitUIOptions {
  127445. /**
  127446. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  127447. */
  127448. customButtons?: Array<WebXREnterExitUIButton>;
  127449. /**
  127450. * A reference space type to use when creating the default button.
  127451. * Default is local-floor
  127452. */
  127453. referenceSpaceType?: XRReferenceSpaceType;
  127454. /**
  127455. * Context to enter xr with
  127456. */
  127457. renderTarget?: Nullable<WebXRRenderTarget>;
  127458. /**
  127459. * A session mode to use when creating the default button.
  127460. * Default is immersive-vr
  127461. */
  127462. sessionMode?: XRSessionMode;
  127463. /**
  127464. * A list of optional features to init the session with
  127465. */
  127466. optionalFeatures?: string[];
  127467. /**
  127468. * A list of optional features to init the session with
  127469. */
  127470. requiredFeatures?: string[];
  127471. }
  127472. /**
  127473. * UI to allow the user to enter/exit XR mode
  127474. */
  127475. export class WebXREnterExitUI implements IDisposable {
  127476. private scene;
  127477. /** version of the options passed to this UI */
  127478. options: WebXREnterExitUIOptions;
  127479. private _activeButton;
  127480. private _buttons;
  127481. private _overlay;
  127482. /**
  127483. * Fired every time the active button is changed.
  127484. *
  127485. * When xr is entered via a button that launches xr that button will be the callback parameter
  127486. *
  127487. * When exiting xr the callback parameter will be null)
  127488. */
  127489. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  127490. /**
  127491. *
  127492. * @param scene babylon scene object to use
  127493. * @param options (read-only) version of the options passed to this UI
  127494. */
  127495. private constructor();
  127496. /**
  127497. * Creates UI to allow the user to enter/exit XR mode
  127498. * @param scene the scene to add the ui to
  127499. * @param helper the xr experience helper to enter/exit xr with
  127500. * @param options options to configure the UI
  127501. * @returns the created ui
  127502. */
  127503. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  127504. /**
  127505. * Disposes of the XR UI component
  127506. */
  127507. dispose(): void;
  127508. private _updateButtons;
  127509. }
  127510. }
  127511. declare module BABYLON {
  127512. /**
  127513. * Class containing static functions to help procedurally build meshes
  127514. */
  127515. export class LinesBuilder {
  127516. /**
  127517. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  127518. * * 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
  127519. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  127520. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  127521. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  127522. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  127523. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  127524. * * 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
  127525. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  127526. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127527. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  127528. * @param name defines the name of the new line system
  127529. * @param options defines the options used to create the line system
  127530. * @param scene defines the hosting scene
  127531. * @returns a new line system mesh
  127532. */
  127533. static CreateLineSystem(name: string, options: {
  127534. lines: Vector3[][];
  127535. updatable?: boolean;
  127536. instance?: Nullable<LinesMesh>;
  127537. colors?: Nullable<Color4[][]>;
  127538. useVertexAlpha?: boolean;
  127539. }, scene: Nullable<Scene>): LinesMesh;
  127540. /**
  127541. * Creates a line mesh
  127542. * 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
  127543. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  127544. * * The parameter `points` is an array successive Vector3
  127545. * * 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
  127546. * * The optional parameter `colors` is an array of successive Color4, one per line point
  127547. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  127548. * * When updating an instance, remember that only point positions can change, not the number of points
  127549. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127550. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  127551. * @param name defines the name of the new line system
  127552. * @param options defines the options used to create the line system
  127553. * @param scene defines the hosting scene
  127554. * @returns a new line mesh
  127555. */
  127556. static CreateLines(name: string, options: {
  127557. points: Vector3[];
  127558. updatable?: boolean;
  127559. instance?: Nullable<LinesMesh>;
  127560. colors?: Color4[];
  127561. useVertexAlpha?: boolean;
  127562. }, scene?: Nullable<Scene>): LinesMesh;
  127563. /**
  127564. * Creates a dashed line mesh
  127565. * * 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
  127566. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  127567. * * The parameter `points` is an array successive Vector3
  127568. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  127569. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  127570. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  127571. * * 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
  127572. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  127573. * * When updating an instance, remember that only point positions can change, not the number of points
  127574. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127575. * @param name defines the name of the mesh
  127576. * @param options defines the options used to create the mesh
  127577. * @param scene defines the hosting scene
  127578. * @returns the dashed line mesh
  127579. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  127580. */
  127581. static CreateDashedLines(name: string, options: {
  127582. points: Vector3[];
  127583. dashSize?: number;
  127584. gapSize?: number;
  127585. dashNb?: number;
  127586. updatable?: boolean;
  127587. instance?: LinesMesh;
  127588. useVertexAlpha?: boolean;
  127589. }, scene?: Nullable<Scene>): LinesMesh;
  127590. }
  127591. }
  127592. declare module BABYLON {
  127593. /**
  127594. * Construction options for a timer
  127595. */
  127596. export interface ITimerOptions<T> {
  127597. /**
  127598. * Time-to-end
  127599. */
  127600. timeout: number;
  127601. /**
  127602. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  127603. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  127604. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  127605. */
  127606. contextObservable: Observable<T>;
  127607. /**
  127608. * Optional parameters when adding an observer to the observable
  127609. */
  127610. observableParameters?: {
  127611. mask?: number;
  127612. insertFirst?: boolean;
  127613. scope?: any;
  127614. };
  127615. /**
  127616. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  127617. */
  127618. breakCondition?: (data?: ITimerData<T>) => boolean;
  127619. /**
  127620. * Will be triggered when the time condition has met
  127621. */
  127622. onEnded?: (data: ITimerData<any>) => void;
  127623. /**
  127624. * Will be triggered when the break condition has met (prematurely ended)
  127625. */
  127626. onAborted?: (data: ITimerData<any>) => void;
  127627. /**
  127628. * Optional function to execute on each tick (or count)
  127629. */
  127630. onTick?: (data: ITimerData<any>) => void;
  127631. }
  127632. /**
  127633. * An interface defining the data sent by the timer
  127634. */
  127635. export interface ITimerData<T> {
  127636. /**
  127637. * When did it start
  127638. */
  127639. startTime: number;
  127640. /**
  127641. * Time now
  127642. */
  127643. currentTime: number;
  127644. /**
  127645. * Time passed since started
  127646. */
  127647. deltaTime: number;
  127648. /**
  127649. * How much is completed, in [0.0...1.0].
  127650. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  127651. */
  127652. completeRate: number;
  127653. /**
  127654. * What the registered observable sent in the last count
  127655. */
  127656. payload: T;
  127657. }
  127658. /**
  127659. * The current state of the timer
  127660. */
  127661. export enum TimerState {
  127662. /**
  127663. * Timer initialized, not yet started
  127664. */
  127665. INIT = 0,
  127666. /**
  127667. * Timer started and counting
  127668. */
  127669. STARTED = 1,
  127670. /**
  127671. * Timer ended (whether aborted or time reached)
  127672. */
  127673. ENDED = 2
  127674. }
  127675. /**
  127676. * A simple version of the timer. Will take options and start the timer immediately after calling it
  127677. *
  127678. * @param options options with which to initialize this timer
  127679. */
  127680. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  127681. /**
  127682. * An advanced implementation of a timer class
  127683. */
  127684. export class AdvancedTimer<T = any> implements IDisposable {
  127685. /**
  127686. * Will notify each time the timer calculates the remaining time
  127687. */
  127688. onEachCountObservable: Observable<ITimerData<T>>;
  127689. /**
  127690. * Will trigger when the timer was aborted due to the break condition
  127691. */
  127692. onTimerAbortedObservable: Observable<ITimerData<T>>;
  127693. /**
  127694. * Will trigger when the timer ended successfully
  127695. */
  127696. onTimerEndedObservable: Observable<ITimerData<T>>;
  127697. /**
  127698. * Will trigger when the timer state has changed
  127699. */
  127700. onStateChangedObservable: Observable<TimerState>;
  127701. private _observer;
  127702. private _contextObservable;
  127703. private _observableParameters;
  127704. private _startTime;
  127705. private _timer;
  127706. private _state;
  127707. private _breakCondition;
  127708. private _timeToEnd;
  127709. private _breakOnNextTick;
  127710. /**
  127711. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  127712. * @param options construction options for this advanced timer
  127713. */
  127714. constructor(options: ITimerOptions<T>);
  127715. /**
  127716. * set a breaking condition for this timer. Default is to never break during count
  127717. * @param predicate the new break condition. Returns true to break, false otherwise
  127718. */
  127719. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  127720. /**
  127721. * Reset ALL associated observables in this advanced timer
  127722. */
  127723. clearObservables(): void;
  127724. /**
  127725. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  127726. *
  127727. * @param timeToEnd how much time to measure until timer ended
  127728. */
  127729. start(timeToEnd?: number): void;
  127730. /**
  127731. * Will force a stop on the next tick.
  127732. */
  127733. stop(): void;
  127734. /**
  127735. * Dispose this timer, clearing all resources
  127736. */
  127737. dispose(): void;
  127738. private _setState;
  127739. private _tick;
  127740. private _stop;
  127741. }
  127742. }
  127743. declare module BABYLON {
  127744. /**
  127745. * The options container for the teleportation module
  127746. */
  127747. export interface IWebXRTeleportationOptions {
  127748. /**
  127749. * if provided, this scene will be used to render meshes.
  127750. */
  127751. customUtilityLayerScene?: Scene;
  127752. /**
  127753. * Values to configure the default target mesh
  127754. */
  127755. defaultTargetMeshOptions?: {
  127756. /**
  127757. * Fill color of the teleportation area
  127758. */
  127759. teleportationFillColor?: string;
  127760. /**
  127761. * Border color for the teleportation area
  127762. */
  127763. teleportationBorderColor?: string;
  127764. /**
  127765. * Disable the mesh's animation sequence
  127766. */
  127767. disableAnimation?: boolean;
  127768. /**
  127769. * Disable lighting on the material or the ring and arrow
  127770. */
  127771. disableLighting?: boolean;
  127772. /**
  127773. * Override the default material of the torus and arrow
  127774. */
  127775. torusArrowMaterial?: Material;
  127776. };
  127777. /**
  127778. * A list of meshes to use as floor meshes.
  127779. * Meshes can be added and removed after initializing the feature using the
  127780. * addFloorMesh and removeFloorMesh functions
  127781. * If empty, rotation will still work
  127782. */
  127783. floorMeshes?: AbstractMesh[];
  127784. /**
  127785. * use this rendering group id for the meshes (optional)
  127786. */
  127787. renderingGroupId?: number;
  127788. /**
  127789. * Should teleportation move only to snap points
  127790. */
  127791. snapPointsOnly?: boolean;
  127792. /**
  127793. * An array of points to which the teleportation will snap to.
  127794. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  127795. */
  127796. snapPositions?: Vector3[];
  127797. /**
  127798. * How close should the teleportation ray be in order to snap to position.
  127799. * Default to 0.8 units (meters)
  127800. */
  127801. snapToPositionRadius?: number;
  127802. /**
  127803. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  127804. * If you want to support rotation, make sure your mesh has a direction indicator.
  127805. *
  127806. * When left untouched, the default mesh will be initialized.
  127807. */
  127808. teleportationTargetMesh?: AbstractMesh;
  127809. /**
  127810. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  127811. */
  127812. timeToTeleport?: number;
  127813. /**
  127814. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  127815. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  127816. */
  127817. useMainComponentOnly?: boolean;
  127818. /**
  127819. * Should meshes created here be added to a utility layer or the main scene
  127820. */
  127821. useUtilityLayer?: boolean;
  127822. /**
  127823. * Babylon XR Input class for controller
  127824. */
  127825. xrInput: WebXRInput;
  127826. }
  127827. /**
  127828. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  127829. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  127830. * the input of the attached controllers.
  127831. */
  127832. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  127833. private _options;
  127834. private _controllers;
  127835. private _currentTeleportationControllerId;
  127836. private _floorMeshes;
  127837. private _quadraticBezierCurve;
  127838. private _selectionFeature;
  127839. private _snapToPositions;
  127840. private _snappedToPoint;
  127841. private _teleportationRingMaterial?;
  127842. private _tmpRay;
  127843. private _tmpVector;
  127844. /**
  127845. * The module's name
  127846. */
  127847. static readonly Name: string;
  127848. /**
  127849. * The (Babylon) version of this module.
  127850. * This is an integer representing the implementation version.
  127851. * This number does not correspond to the webxr specs version
  127852. */
  127853. static readonly Version: number;
  127854. /**
  127855. * Is movement backwards enabled
  127856. */
  127857. backwardsMovementEnabled: boolean;
  127858. /**
  127859. * Distance to travel when moving backwards
  127860. */
  127861. backwardsTeleportationDistance: number;
  127862. /**
  127863. * The distance from the user to the inspection point in the direction of the controller
  127864. * A higher number will allow the user to move further
  127865. * defaults to 5 (meters, in xr units)
  127866. */
  127867. parabolicCheckRadius: number;
  127868. /**
  127869. * Should the module support parabolic ray on top of direct ray
  127870. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  127871. * Very helpful when moving between floors / different heights
  127872. */
  127873. parabolicRayEnabled: boolean;
  127874. /**
  127875. * How much rotation should be applied when rotating right and left
  127876. */
  127877. rotationAngle: number;
  127878. /**
  127879. * Is rotation enabled when moving forward?
  127880. * Disabling this feature will prevent the user from deciding the direction when teleporting
  127881. */
  127882. rotationEnabled: boolean;
  127883. /**
  127884. * constructs a new anchor system
  127885. * @param _xrSessionManager an instance of WebXRSessionManager
  127886. * @param _options configuration object for this feature
  127887. */
  127888. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  127889. /**
  127890. * Get the snapPointsOnly flag
  127891. */
  127892. get snapPointsOnly(): boolean;
  127893. /**
  127894. * Sets the snapPointsOnly flag
  127895. * @param snapToPoints should teleportation be exclusively to snap points
  127896. */
  127897. set snapPointsOnly(snapToPoints: boolean);
  127898. /**
  127899. * Add a new mesh to the floor meshes array
  127900. * @param mesh the mesh to use as floor mesh
  127901. */
  127902. addFloorMesh(mesh: AbstractMesh): void;
  127903. /**
  127904. * Add a new snap-to point to fix teleportation to this position
  127905. * @param newSnapPoint The new Snap-To point
  127906. */
  127907. addSnapPoint(newSnapPoint: Vector3): void;
  127908. attach(): boolean;
  127909. detach(): boolean;
  127910. dispose(): void;
  127911. /**
  127912. * Remove a mesh from the floor meshes array
  127913. * @param mesh the mesh to remove
  127914. */
  127915. removeFloorMesh(mesh: AbstractMesh): void;
  127916. /**
  127917. * Remove a mesh from the floor meshes array using its name
  127918. * @param name the mesh name to remove
  127919. */
  127920. removeFloorMeshByName(name: string): void;
  127921. /**
  127922. * 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
  127923. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  127924. * @returns was the point found and removed or not
  127925. */
  127926. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  127927. /**
  127928. * This function sets a selection feature that will be disabled when
  127929. * the forward ray is shown and will be reattached when hidden.
  127930. * This is used to remove the selection rays when moving.
  127931. * @param selectionFeature the feature to disable when forward movement is enabled
  127932. */
  127933. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  127934. protected _onXRFrame(_xrFrame: XRFrame): void;
  127935. private _attachController;
  127936. private _createDefaultTargetMesh;
  127937. private _detachController;
  127938. private _findClosestSnapPointWithRadius;
  127939. private _setTargetMeshPosition;
  127940. private _setTargetMeshVisibility;
  127941. private _showParabolicPath;
  127942. private _teleportForward;
  127943. }
  127944. }
  127945. declare module BABYLON {
  127946. /**
  127947. * Options for the default xr helper
  127948. */
  127949. export class WebXRDefaultExperienceOptions {
  127950. /**
  127951. * Enable or disable default UI to enter XR
  127952. */
  127953. disableDefaultUI?: boolean;
  127954. /**
  127955. * Should teleportation not initialize. defaults to false.
  127956. */
  127957. disableTeleportation?: boolean;
  127958. /**
  127959. * Floor meshes that will be used for teleport
  127960. */
  127961. floorMeshes?: Array<AbstractMesh>;
  127962. /**
  127963. * If set to true, the first frame will not be used to reset position
  127964. * The first frame is mainly used when copying transformation from the old camera
  127965. * Mainly used in AR
  127966. */
  127967. ignoreNativeCameraTransformation?: boolean;
  127968. /**
  127969. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  127970. */
  127971. inputOptions?: IWebXRInputOptions;
  127972. /**
  127973. * optional configuration for the output canvas
  127974. */
  127975. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  127976. /**
  127977. * optional UI options. This can be used among other to change session mode and reference space type
  127978. */
  127979. uiOptions?: WebXREnterExitUIOptions;
  127980. /**
  127981. * When loading teleportation and pointer select, use stable versions instead of latest.
  127982. */
  127983. useStablePlugins?: boolean;
  127984. /**
  127985. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  127986. */
  127987. renderingGroupId?: number;
  127988. /**
  127989. * A list of optional features to init the session with
  127990. * If set to true, all features we support will be added
  127991. */
  127992. optionalFeatures?: boolean | string[];
  127993. }
  127994. /**
  127995. * Default experience which provides a similar setup to the previous webVRExperience
  127996. */
  127997. export class WebXRDefaultExperience {
  127998. /**
  127999. * Base experience
  128000. */
  128001. baseExperience: WebXRExperienceHelper;
  128002. /**
  128003. * Enables ui for entering/exiting xr
  128004. */
  128005. enterExitUI: WebXREnterExitUI;
  128006. /**
  128007. * Input experience extension
  128008. */
  128009. input: WebXRInput;
  128010. /**
  128011. * Enables laser pointer and selection
  128012. */
  128013. pointerSelection: WebXRControllerPointerSelection;
  128014. /**
  128015. * Default target xr should render to
  128016. */
  128017. renderTarget: WebXRRenderTarget;
  128018. /**
  128019. * Enables teleportation
  128020. */
  128021. teleportation: WebXRMotionControllerTeleportation;
  128022. private constructor();
  128023. /**
  128024. * Creates the default xr experience
  128025. * @param scene scene
  128026. * @param options options for basic configuration
  128027. * @returns resulting WebXRDefaultExperience
  128028. */
  128029. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  128030. /**
  128031. * DIsposes of the experience helper
  128032. */
  128033. dispose(): void;
  128034. }
  128035. }
  128036. declare module BABYLON {
  128037. /**
  128038. * Options to modify the vr teleportation behavior.
  128039. */
  128040. export interface VRTeleportationOptions {
  128041. /**
  128042. * The name of the mesh which should be used as the teleportation floor. (default: null)
  128043. */
  128044. floorMeshName?: string;
  128045. /**
  128046. * A list of meshes to be used as the teleportation floor. (default: empty)
  128047. */
  128048. floorMeshes?: Mesh[];
  128049. /**
  128050. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  128051. */
  128052. teleportationMode?: number;
  128053. /**
  128054. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  128055. */
  128056. teleportationTime?: number;
  128057. /**
  128058. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  128059. */
  128060. teleportationSpeed?: number;
  128061. /**
  128062. * The easing function used in the animation or null for Linear. (default CircleEase)
  128063. */
  128064. easingFunction?: EasingFunction;
  128065. }
  128066. /**
  128067. * Options to modify the vr experience helper's behavior.
  128068. */
  128069. export interface VRExperienceHelperOptions extends WebVROptions {
  128070. /**
  128071. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  128072. */
  128073. createDeviceOrientationCamera?: boolean;
  128074. /**
  128075. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  128076. */
  128077. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  128078. /**
  128079. * Uses the main button on the controller to toggle the laser casted. (default: true)
  128080. */
  128081. laserToggle?: boolean;
  128082. /**
  128083. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  128084. */
  128085. floorMeshes?: Mesh[];
  128086. /**
  128087. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  128088. */
  128089. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  128090. /**
  128091. * Defines if WebXR should be used instead of WebVR (if available)
  128092. */
  128093. useXR?: boolean;
  128094. }
  128095. /**
  128096. * Event containing information after VR has been entered
  128097. */
  128098. export class OnAfterEnteringVRObservableEvent {
  128099. /**
  128100. * If entering vr was successful
  128101. */
  128102. success: boolean;
  128103. }
  128104. /**
  128105. * Helps to quickly add VR support to an existing scene.
  128106. * See https://doc.babylonjs.com/how_to/webvr_helper
  128107. */
  128108. export class VRExperienceHelper {
  128109. /** Options to modify the vr experience helper's behavior. */
  128110. webVROptions: VRExperienceHelperOptions;
  128111. private _scene;
  128112. private _position;
  128113. private _btnVR;
  128114. private _btnVRDisplayed;
  128115. private _webVRsupported;
  128116. private _webVRready;
  128117. private _webVRrequesting;
  128118. private _webVRpresenting;
  128119. private _hasEnteredVR;
  128120. private _fullscreenVRpresenting;
  128121. private _inputElement;
  128122. private _webVRCamera;
  128123. private _vrDeviceOrientationCamera;
  128124. private _deviceOrientationCamera;
  128125. private _existingCamera;
  128126. private _onKeyDown;
  128127. private _onVrDisplayPresentChange;
  128128. private _onVRDisplayChanged;
  128129. private _onVRRequestPresentStart;
  128130. private _onVRRequestPresentComplete;
  128131. /**
  128132. * 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)
  128133. */
  128134. enableGazeEvenWhenNoPointerLock: boolean;
  128135. /**
  128136. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  128137. */
  128138. exitVROnDoubleTap: boolean;
  128139. /**
  128140. * Observable raised right before entering VR.
  128141. */
  128142. onEnteringVRObservable: Observable<VRExperienceHelper>;
  128143. /**
  128144. * Observable raised when entering VR has completed.
  128145. */
  128146. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  128147. /**
  128148. * Observable raised when exiting VR.
  128149. */
  128150. onExitingVRObservable: Observable<VRExperienceHelper>;
  128151. /**
  128152. * Observable raised when controller mesh is loaded.
  128153. */
  128154. onControllerMeshLoadedObservable: Observable<WebVRController>;
  128155. /** Return this.onEnteringVRObservable
  128156. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  128157. */
  128158. get onEnteringVR(): Observable<VRExperienceHelper>;
  128159. /** Return this.onExitingVRObservable
  128160. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  128161. */
  128162. get onExitingVR(): Observable<VRExperienceHelper>;
  128163. /** Return this.onControllerMeshLoadedObservable
  128164. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  128165. */
  128166. get onControllerMeshLoaded(): Observable<WebVRController>;
  128167. private _rayLength;
  128168. private _useCustomVRButton;
  128169. private _teleportationRequested;
  128170. private _teleportActive;
  128171. private _floorMeshName;
  128172. private _floorMeshesCollection;
  128173. private _teleportationMode;
  128174. private _teleportationTime;
  128175. private _teleportationSpeed;
  128176. private _teleportationEasing;
  128177. private _rotationAllowed;
  128178. private _teleportBackwardsVector;
  128179. private _teleportationTarget;
  128180. private _isDefaultTeleportationTarget;
  128181. private _postProcessMove;
  128182. private _teleportationFillColor;
  128183. private _teleportationBorderColor;
  128184. private _rotationAngle;
  128185. private _haloCenter;
  128186. private _cameraGazer;
  128187. private _padSensibilityUp;
  128188. private _padSensibilityDown;
  128189. private _leftController;
  128190. private _rightController;
  128191. private _gazeColor;
  128192. private _laserColor;
  128193. private _pickedLaserColor;
  128194. private _pickedGazeColor;
  128195. /**
  128196. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  128197. */
  128198. onNewMeshSelected: Observable<AbstractMesh>;
  128199. /**
  128200. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  128201. * This observable will provide the mesh and the controller used to select the mesh
  128202. */
  128203. onMeshSelectedWithController: Observable<{
  128204. mesh: AbstractMesh;
  128205. controller: WebVRController;
  128206. }>;
  128207. /**
  128208. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  128209. */
  128210. onNewMeshPicked: Observable<PickingInfo>;
  128211. private _circleEase;
  128212. /**
  128213. * Observable raised before camera teleportation
  128214. */
  128215. onBeforeCameraTeleport: Observable<Vector3>;
  128216. /**
  128217. * Observable raised after camera teleportation
  128218. */
  128219. onAfterCameraTeleport: Observable<Vector3>;
  128220. /**
  128221. * Observable raised when current selected mesh gets unselected
  128222. */
  128223. onSelectedMeshUnselected: Observable<AbstractMesh>;
  128224. private _raySelectionPredicate;
  128225. /**
  128226. * To be optionaly changed by user to define custom ray selection
  128227. */
  128228. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128229. /**
  128230. * To be optionaly changed by user to define custom selection logic (after ray selection)
  128231. */
  128232. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  128233. /**
  128234. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  128235. */
  128236. teleportationEnabled: boolean;
  128237. private _defaultHeight;
  128238. private _teleportationInitialized;
  128239. private _interactionsEnabled;
  128240. private _interactionsRequested;
  128241. private _displayGaze;
  128242. private _displayLaserPointer;
  128243. /**
  128244. * The mesh used to display where the user is going to teleport.
  128245. */
  128246. get teleportationTarget(): Mesh;
  128247. /**
  128248. * Sets the mesh to be used to display where the user is going to teleport.
  128249. */
  128250. set teleportationTarget(value: Mesh);
  128251. /**
  128252. * 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
  128253. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  128254. * See https://doc.babylonjs.com/resources/baking_transformations
  128255. */
  128256. get gazeTrackerMesh(): Mesh;
  128257. set gazeTrackerMesh(value: Mesh);
  128258. /**
  128259. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  128260. */
  128261. updateGazeTrackerScale: boolean;
  128262. /**
  128263. * If the gaze trackers color should be updated when selecting meshes
  128264. */
  128265. updateGazeTrackerColor: boolean;
  128266. /**
  128267. * If the controller laser color should be updated when selecting meshes
  128268. */
  128269. updateControllerLaserColor: boolean;
  128270. /**
  128271. * The gaze tracking mesh corresponding to the left controller
  128272. */
  128273. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  128274. /**
  128275. * The gaze tracking mesh corresponding to the right controller
  128276. */
  128277. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  128278. /**
  128279. * If the ray of the gaze should be displayed.
  128280. */
  128281. get displayGaze(): boolean;
  128282. /**
  128283. * Sets if the ray of the gaze should be displayed.
  128284. */
  128285. set displayGaze(value: boolean);
  128286. /**
  128287. * If the ray of the LaserPointer should be displayed.
  128288. */
  128289. get displayLaserPointer(): boolean;
  128290. /**
  128291. * Sets if the ray of the LaserPointer should be displayed.
  128292. */
  128293. set displayLaserPointer(value: boolean);
  128294. /**
  128295. * The deviceOrientationCamera used as the camera when not in VR.
  128296. */
  128297. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  128298. /**
  128299. * Based on the current WebVR support, returns the current VR camera used.
  128300. */
  128301. get currentVRCamera(): Nullable<Camera>;
  128302. /**
  128303. * The webVRCamera which is used when in VR.
  128304. */
  128305. get webVRCamera(): WebVRFreeCamera;
  128306. /**
  128307. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  128308. */
  128309. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  128310. /**
  128311. * The html button that is used to trigger entering into VR.
  128312. */
  128313. get vrButton(): Nullable<HTMLButtonElement>;
  128314. private get _teleportationRequestInitiated();
  128315. /**
  128316. * Defines whether or not Pointer lock should be requested when switching to
  128317. * full screen.
  128318. */
  128319. requestPointerLockOnFullScreen: boolean;
  128320. /**
  128321. * If asking to force XR, this will be populated with the default xr experience
  128322. */
  128323. xr: WebXRDefaultExperience;
  128324. /**
  128325. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  128326. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  128327. */
  128328. xrTestDone: boolean;
  128329. /**
  128330. * Instantiates a VRExperienceHelper.
  128331. * Helps to quickly add VR support to an existing scene.
  128332. * @param scene The scene the VRExperienceHelper belongs to.
  128333. * @param webVROptions Options to modify the vr experience helper's behavior.
  128334. */
  128335. constructor(scene: Scene,
  128336. /** Options to modify the vr experience helper's behavior. */
  128337. webVROptions?: VRExperienceHelperOptions);
  128338. private completeVRInit;
  128339. private _onDefaultMeshLoaded;
  128340. private _onResize;
  128341. private _onFullscreenChange;
  128342. /**
  128343. * Gets a value indicating if we are currently in VR mode.
  128344. */
  128345. get isInVRMode(): boolean;
  128346. private onVrDisplayPresentChange;
  128347. private onVRDisplayChanged;
  128348. private moveButtonToBottomRight;
  128349. private displayVRButton;
  128350. private updateButtonVisibility;
  128351. private _cachedAngularSensibility;
  128352. /**
  128353. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  128354. * Otherwise, will use the fullscreen API.
  128355. */
  128356. enterVR(): void;
  128357. /**
  128358. * Attempt to exit VR, or fullscreen.
  128359. */
  128360. exitVR(): void;
  128361. /**
  128362. * The position of the vr experience helper.
  128363. */
  128364. get position(): Vector3;
  128365. /**
  128366. * Sets the position of the vr experience helper.
  128367. */
  128368. set position(value: Vector3);
  128369. /**
  128370. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  128371. */
  128372. enableInteractions(): void;
  128373. private get _noControllerIsActive();
  128374. private beforeRender;
  128375. private _isTeleportationFloor;
  128376. /**
  128377. * Adds a floor mesh to be used for teleportation.
  128378. * @param floorMesh the mesh to be used for teleportation.
  128379. */
  128380. addFloorMesh(floorMesh: Mesh): void;
  128381. /**
  128382. * Removes a floor mesh from being used for teleportation.
  128383. * @param floorMesh the mesh to be removed.
  128384. */
  128385. removeFloorMesh(floorMesh: Mesh): void;
  128386. /**
  128387. * Enables interactions and teleportation using the VR controllers and gaze.
  128388. * @param vrTeleportationOptions options to modify teleportation behavior.
  128389. */
  128390. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  128391. private _onNewGamepadConnected;
  128392. private _tryEnableInteractionOnController;
  128393. private _onNewGamepadDisconnected;
  128394. private _enableInteractionOnController;
  128395. private _checkTeleportWithRay;
  128396. private _checkRotate;
  128397. private _checkTeleportBackwards;
  128398. private _enableTeleportationOnController;
  128399. private _createTeleportationCircles;
  128400. private _displayTeleportationTarget;
  128401. private _hideTeleportationTarget;
  128402. private _rotateCamera;
  128403. private _moveTeleportationSelectorTo;
  128404. private _workingVector;
  128405. private _workingQuaternion;
  128406. private _workingMatrix;
  128407. /**
  128408. * Time Constant Teleportation Mode
  128409. */
  128410. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  128411. /**
  128412. * Speed Constant Teleportation Mode
  128413. */
  128414. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  128415. /**
  128416. * Teleports the users feet to the desired location
  128417. * @param location The location where the user's feet should be placed
  128418. */
  128419. teleportCamera(location: Vector3): void;
  128420. private _convertNormalToDirectionOfRay;
  128421. private _castRayAndSelectObject;
  128422. private _notifySelectedMeshUnselected;
  128423. /**
  128424. * Permanently set new colors for the laser pointer
  128425. * @param color the new laser color
  128426. * @param pickedColor the new laser color when picked mesh detected
  128427. */
  128428. setLaserColor(color: Color3, pickedColor?: Color3): void;
  128429. /**
  128430. * Set lighting enabled / disabled on the laser pointer of both controllers
  128431. * @param enabled should the lighting be enabled on the laser pointer
  128432. */
  128433. setLaserLightingState(enabled?: boolean): void;
  128434. /**
  128435. * Permanently set new colors for the gaze pointer
  128436. * @param color the new gaze color
  128437. * @param pickedColor the new gaze color when picked mesh detected
  128438. */
  128439. setGazeColor(color: Color3, pickedColor?: Color3): void;
  128440. /**
  128441. * Sets the color of the laser ray from the vr controllers.
  128442. * @param color new color for the ray.
  128443. */
  128444. changeLaserColor(color: Color3): void;
  128445. /**
  128446. * Sets the color of the ray from the vr headsets gaze.
  128447. * @param color new color for the ray.
  128448. */
  128449. changeGazeColor(color: Color3): void;
  128450. /**
  128451. * Exits VR and disposes of the vr experience helper
  128452. */
  128453. dispose(): void;
  128454. /**
  128455. * Gets the name of the VRExperienceHelper class
  128456. * @returns "VRExperienceHelper"
  128457. */
  128458. getClassName(): string;
  128459. }
  128460. }
  128461. declare module BABYLON {
  128462. /**
  128463. * Contains an array of blocks representing the octree
  128464. */
  128465. export interface IOctreeContainer<T> {
  128466. /**
  128467. * Blocks within the octree
  128468. */
  128469. blocks: Array<OctreeBlock<T>>;
  128470. }
  128471. /**
  128472. * Class used to store a cell in an octree
  128473. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128474. */
  128475. export class OctreeBlock<T> {
  128476. /**
  128477. * Gets the content of the current block
  128478. */
  128479. entries: T[];
  128480. /**
  128481. * Gets the list of block children
  128482. */
  128483. blocks: Array<OctreeBlock<T>>;
  128484. private _depth;
  128485. private _maxDepth;
  128486. private _capacity;
  128487. private _minPoint;
  128488. private _maxPoint;
  128489. private _boundingVectors;
  128490. private _creationFunc;
  128491. /**
  128492. * Creates a new block
  128493. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  128494. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  128495. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  128496. * @param depth defines the current depth of this block in the octree
  128497. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  128498. * @param creationFunc defines a callback to call when an element is added to the block
  128499. */
  128500. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  128501. /**
  128502. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  128503. */
  128504. get capacity(): number;
  128505. /**
  128506. * Gets the minimum vector (in world space) of the block's bounding box
  128507. */
  128508. get minPoint(): Vector3;
  128509. /**
  128510. * Gets the maximum vector (in world space) of the block's bounding box
  128511. */
  128512. get maxPoint(): Vector3;
  128513. /**
  128514. * Add a new element to this block
  128515. * @param entry defines the element to add
  128516. */
  128517. addEntry(entry: T): void;
  128518. /**
  128519. * Remove an element from this block
  128520. * @param entry defines the element to remove
  128521. */
  128522. removeEntry(entry: T): void;
  128523. /**
  128524. * Add an array of elements to this block
  128525. * @param entries defines the array of elements to add
  128526. */
  128527. addEntries(entries: T[]): void;
  128528. /**
  128529. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  128530. * @param frustumPlanes defines the frustum planes to test
  128531. * @param selection defines the array to store current content if selection is positive
  128532. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128533. */
  128534. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  128535. /**
  128536. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  128537. * @param sphereCenter defines the bounding sphere center
  128538. * @param sphereRadius defines the bounding sphere radius
  128539. * @param selection defines the array to store current content if selection is positive
  128540. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128541. */
  128542. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  128543. /**
  128544. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  128545. * @param ray defines the ray to test with
  128546. * @param selection defines the array to store current content if selection is positive
  128547. */
  128548. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  128549. /**
  128550. * Subdivide the content into child blocks (this block will then be empty)
  128551. */
  128552. createInnerBlocks(): void;
  128553. /**
  128554. * @hidden
  128555. */
  128556. 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;
  128557. }
  128558. }
  128559. declare module BABYLON {
  128560. /**
  128561. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  128562. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128563. */
  128564. export class Octree<T> {
  128565. /** 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.) */
  128566. maxDepth: number;
  128567. /**
  128568. * Blocks within the octree containing objects
  128569. */
  128570. blocks: Array<OctreeBlock<T>>;
  128571. /**
  128572. * Content stored in the octree
  128573. */
  128574. dynamicContent: T[];
  128575. private _maxBlockCapacity;
  128576. private _selectionContent;
  128577. private _creationFunc;
  128578. /**
  128579. * Creates a octree
  128580. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128581. * @param creationFunc function to be used to instatiate the octree
  128582. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  128583. * @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.)
  128584. */
  128585. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  128586. /** 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.) */
  128587. maxDepth?: number);
  128588. /**
  128589. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  128590. * @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);
  128591. * @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);
  128592. * @param entries meshes to be added to the octree blocks
  128593. */
  128594. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  128595. /**
  128596. * Adds a mesh to the octree
  128597. * @param entry Mesh to add to the octree
  128598. */
  128599. addMesh(entry: T): void;
  128600. /**
  128601. * Remove an element from the octree
  128602. * @param entry defines the element to remove
  128603. */
  128604. removeMesh(entry: T): void;
  128605. /**
  128606. * Selects an array of meshes within the frustum
  128607. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  128608. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  128609. * @returns array of meshes within the frustum
  128610. */
  128611. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  128612. /**
  128613. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  128614. * @param sphereCenter defines the bounding sphere center
  128615. * @param sphereRadius defines the bounding sphere radius
  128616. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128617. * @returns an array of objects that intersect the sphere
  128618. */
  128619. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  128620. /**
  128621. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  128622. * @param ray defines the ray to test with
  128623. * @returns array of intersected objects
  128624. */
  128625. intersectsRay(ray: Ray): SmartArray<T>;
  128626. /**
  128627. * Adds a mesh into the octree block if it intersects the block
  128628. */
  128629. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  128630. /**
  128631. * Adds a submesh into the octree block if it intersects the block
  128632. */
  128633. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  128634. }
  128635. }
  128636. declare module BABYLON {
  128637. interface Scene {
  128638. /**
  128639. * @hidden
  128640. * Backing Filed
  128641. */
  128642. _selectionOctree: Octree<AbstractMesh>;
  128643. /**
  128644. * Gets the octree used to boost mesh selection (picking)
  128645. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128646. */
  128647. selectionOctree: Octree<AbstractMesh>;
  128648. /**
  128649. * Creates or updates the octree used to boost selection (picking)
  128650. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128651. * @param maxCapacity defines the maximum capacity per leaf
  128652. * @param maxDepth defines the maximum depth of the octree
  128653. * @returns an octree of AbstractMesh
  128654. */
  128655. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  128656. }
  128657. interface AbstractMesh {
  128658. /**
  128659. * @hidden
  128660. * Backing Field
  128661. */
  128662. _submeshesOctree: Octree<SubMesh>;
  128663. /**
  128664. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  128665. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  128666. * @param maxCapacity defines the maximum size of each block (64 by default)
  128667. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  128668. * @returns the new octree
  128669. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  128670. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128671. */
  128672. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  128673. }
  128674. /**
  128675. * Defines the octree scene component responsible to manage any octrees
  128676. * in a given scene.
  128677. */
  128678. export class OctreeSceneComponent {
  128679. /**
  128680. * The component name help to identify the component in the list of scene components.
  128681. */
  128682. readonly name: string;
  128683. /**
  128684. * The scene the component belongs to.
  128685. */
  128686. scene: Scene;
  128687. /**
  128688. * Indicates if the meshes have been checked to make sure they are isEnabled()
  128689. */
  128690. readonly checksIsEnabled: boolean;
  128691. /**
  128692. * Creates a new instance of the component for the given scene
  128693. * @param scene Defines the scene to register the component in
  128694. */
  128695. constructor(scene: Scene);
  128696. /**
  128697. * Registers the component in a given scene
  128698. */
  128699. register(): void;
  128700. /**
  128701. * Return the list of active meshes
  128702. * @returns the list of active meshes
  128703. */
  128704. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  128705. /**
  128706. * Return the list of active sub meshes
  128707. * @param mesh The mesh to get the candidates sub meshes from
  128708. * @returns the list of active sub meshes
  128709. */
  128710. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  128711. private _tempRay;
  128712. /**
  128713. * Return the list of sub meshes intersecting with a given local ray
  128714. * @param mesh defines the mesh to find the submesh for
  128715. * @param localRay defines the ray in local space
  128716. * @returns the list of intersecting sub meshes
  128717. */
  128718. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  128719. /**
  128720. * Return the list of sub meshes colliding with a collider
  128721. * @param mesh defines the mesh to find the submesh for
  128722. * @param collider defines the collider to evaluate the collision against
  128723. * @returns the list of colliding sub meshes
  128724. */
  128725. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  128726. /**
  128727. * Rebuilds the elements related to this component in case of
  128728. * context lost for instance.
  128729. */
  128730. rebuild(): void;
  128731. /**
  128732. * Disposes the component and the associated ressources.
  128733. */
  128734. dispose(): void;
  128735. }
  128736. }
  128737. declare module BABYLON {
  128738. /**
  128739. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  128740. */
  128741. export class Gizmo implements IDisposable {
  128742. /** The utility layer the gizmo will be added to */
  128743. gizmoLayer: UtilityLayerRenderer;
  128744. /**
  128745. * The root mesh of the gizmo
  128746. */
  128747. _rootMesh: Mesh;
  128748. private _attachedMesh;
  128749. private _attachedNode;
  128750. /**
  128751. * Ratio for the scale of the gizmo (Default: 1)
  128752. */
  128753. scaleRatio: number;
  128754. /**
  128755. * If a custom mesh has been set (Default: false)
  128756. */
  128757. protected _customMeshSet: boolean;
  128758. /**
  128759. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  128760. * * When set, interactions will be enabled
  128761. */
  128762. get attachedMesh(): Nullable<AbstractMesh>;
  128763. set attachedMesh(value: Nullable<AbstractMesh>);
  128764. /**
  128765. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  128766. * * When set, interactions will be enabled
  128767. */
  128768. get attachedNode(): Nullable<Node>;
  128769. set attachedNode(value: Nullable<Node>);
  128770. /**
  128771. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  128772. * @param mesh The mesh to replace the default mesh of the gizmo
  128773. */
  128774. setCustomMesh(mesh: Mesh): void;
  128775. /**
  128776. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  128777. */
  128778. updateGizmoRotationToMatchAttachedMesh: boolean;
  128779. /**
  128780. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  128781. */
  128782. updateGizmoPositionToMatchAttachedMesh: boolean;
  128783. /**
  128784. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  128785. */
  128786. updateScale: boolean;
  128787. protected _interactionsEnabled: boolean;
  128788. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128789. private _beforeRenderObserver;
  128790. private _tempVector;
  128791. /**
  128792. * Creates a gizmo
  128793. * @param gizmoLayer The utility layer the gizmo will be added to
  128794. */
  128795. constructor(
  128796. /** The utility layer the gizmo will be added to */
  128797. gizmoLayer?: UtilityLayerRenderer);
  128798. /**
  128799. * Updates the gizmo to match the attached mesh's position/rotation
  128800. */
  128801. protected _update(): void;
  128802. /**
  128803. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  128804. * @param value Node, TransformNode or mesh
  128805. */
  128806. protected _matrixChanged(): void;
  128807. /**
  128808. * Disposes of the gizmo
  128809. */
  128810. dispose(): void;
  128811. }
  128812. }
  128813. declare module BABYLON {
  128814. /**
  128815. * Single plane drag gizmo
  128816. */
  128817. export class PlaneDragGizmo extends Gizmo {
  128818. /**
  128819. * Drag behavior responsible for the gizmos dragging interactions
  128820. */
  128821. dragBehavior: PointerDragBehavior;
  128822. private _pointerObserver;
  128823. /**
  128824. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128825. */
  128826. snapDistance: number;
  128827. /**
  128828. * Event that fires each time the gizmo snaps to a new location.
  128829. * * snapDistance is the the change in distance
  128830. */
  128831. onSnapObservable: Observable<{
  128832. snapDistance: number;
  128833. }>;
  128834. private _plane;
  128835. private _coloredMaterial;
  128836. private _hoverMaterial;
  128837. private _isEnabled;
  128838. private _parent;
  128839. /** @hidden */
  128840. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  128841. /** @hidden */
  128842. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  128843. /**
  128844. * Creates a PlaneDragGizmo
  128845. * @param gizmoLayer The utility layer the gizmo will be added to
  128846. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  128847. * @param color The color of the gizmo
  128848. */
  128849. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  128850. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128851. /**
  128852. * If the gizmo is enabled
  128853. */
  128854. set isEnabled(value: boolean);
  128855. get isEnabled(): boolean;
  128856. /**
  128857. * Disposes of the gizmo
  128858. */
  128859. dispose(): void;
  128860. }
  128861. }
  128862. declare module BABYLON {
  128863. /**
  128864. * Gizmo that enables dragging a mesh along 3 axis
  128865. */
  128866. export class PositionGizmo extends Gizmo {
  128867. /**
  128868. * Internal gizmo used for interactions on the x axis
  128869. */
  128870. xGizmo: AxisDragGizmo;
  128871. /**
  128872. * Internal gizmo used for interactions on the y axis
  128873. */
  128874. yGizmo: AxisDragGizmo;
  128875. /**
  128876. * Internal gizmo used for interactions on the z axis
  128877. */
  128878. zGizmo: AxisDragGizmo;
  128879. /**
  128880. * Internal gizmo used for interactions on the yz plane
  128881. */
  128882. xPlaneGizmo: PlaneDragGizmo;
  128883. /**
  128884. * Internal gizmo used for interactions on the xz plane
  128885. */
  128886. yPlaneGizmo: PlaneDragGizmo;
  128887. /**
  128888. * Internal gizmo used for interactions on the xy plane
  128889. */
  128890. zPlaneGizmo: PlaneDragGizmo;
  128891. /**
  128892. * private variables
  128893. */
  128894. private _meshAttached;
  128895. private _nodeAttached;
  128896. private _updateGizmoRotationToMatchAttachedMesh;
  128897. private _snapDistance;
  128898. private _scaleRatio;
  128899. /** Fires an event when any of it's sub gizmos are dragged */
  128900. onDragStartObservable: Observable<unknown>;
  128901. /** Fires an event when any of it's sub gizmos are released from dragging */
  128902. onDragEndObservable: Observable<unknown>;
  128903. /**
  128904. * If set to true, planar drag is enabled
  128905. */
  128906. private _planarGizmoEnabled;
  128907. get attachedMesh(): Nullable<AbstractMesh>;
  128908. set attachedMesh(mesh: Nullable<AbstractMesh>);
  128909. get attachedNode(): Nullable<Node>;
  128910. set attachedNode(node: Nullable<Node>);
  128911. /**
  128912. * Creates a PositionGizmo
  128913. * @param gizmoLayer The utility layer the gizmo will be added to
  128914. @param thickness display gizmo axis thickness
  128915. */
  128916. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  128917. /**
  128918. * If the planar drag gizmo is enabled
  128919. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  128920. */
  128921. set planarGizmoEnabled(value: boolean);
  128922. get planarGizmoEnabled(): boolean;
  128923. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  128924. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  128925. /**
  128926. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128927. */
  128928. set snapDistance(value: number);
  128929. get snapDistance(): number;
  128930. /**
  128931. * Ratio for the scale of the gizmo (Default: 1)
  128932. */
  128933. set scaleRatio(value: number);
  128934. get scaleRatio(): number;
  128935. /**
  128936. * Disposes of the gizmo
  128937. */
  128938. dispose(): void;
  128939. /**
  128940. * CustomMeshes are not supported by this gizmo
  128941. * @param mesh The mesh to replace the default mesh of the gizmo
  128942. */
  128943. setCustomMesh(mesh: Mesh): void;
  128944. }
  128945. }
  128946. declare module BABYLON {
  128947. /**
  128948. * Single axis drag gizmo
  128949. */
  128950. export class AxisDragGizmo extends Gizmo {
  128951. /**
  128952. * Drag behavior responsible for the gizmos dragging interactions
  128953. */
  128954. dragBehavior: PointerDragBehavior;
  128955. private _pointerObserver;
  128956. /**
  128957. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128958. */
  128959. snapDistance: number;
  128960. /**
  128961. * Event that fires each time the gizmo snaps to a new location.
  128962. * * snapDistance is the the change in distance
  128963. */
  128964. onSnapObservable: Observable<{
  128965. snapDistance: number;
  128966. }>;
  128967. private _isEnabled;
  128968. private _parent;
  128969. private _arrow;
  128970. private _coloredMaterial;
  128971. private _hoverMaterial;
  128972. /** @hidden */
  128973. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  128974. /** @hidden */
  128975. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  128976. /**
  128977. * Creates an AxisDragGizmo
  128978. * @param gizmoLayer The utility layer the gizmo will be added to
  128979. * @param dragAxis The axis which the gizmo will be able to drag on
  128980. * @param color The color of the gizmo
  128981. * @param thickness display gizmo axis thickness
  128982. */
  128983. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  128984. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128985. /**
  128986. * If the gizmo is enabled
  128987. */
  128988. set isEnabled(value: boolean);
  128989. get isEnabled(): boolean;
  128990. /**
  128991. * Disposes of the gizmo
  128992. */
  128993. dispose(): void;
  128994. }
  128995. }
  128996. declare module BABYLON.Debug {
  128997. /**
  128998. * The Axes viewer will show 3 axes in a specific point in space
  128999. */
  129000. export class AxesViewer {
  129001. private _xAxis;
  129002. private _yAxis;
  129003. private _zAxis;
  129004. private _scaleLinesFactor;
  129005. private _instanced;
  129006. /**
  129007. * Gets the hosting scene
  129008. */
  129009. scene: Scene;
  129010. /**
  129011. * Gets or sets a number used to scale line length
  129012. */
  129013. scaleLines: number;
  129014. /** Gets the node hierarchy used to render x-axis */
  129015. get xAxis(): TransformNode;
  129016. /** Gets the node hierarchy used to render y-axis */
  129017. get yAxis(): TransformNode;
  129018. /** Gets the node hierarchy used to render z-axis */
  129019. get zAxis(): TransformNode;
  129020. /**
  129021. * Creates a new AxesViewer
  129022. * @param scene defines the hosting scene
  129023. * @param scaleLines defines a number used to scale line length (1 by default)
  129024. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  129025. * @param xAxis defines the node hierarchy used to render the x-axis
  129026. * @param yAxis defines the node hierarchy used to render the y-axis
  129027. * @param zAxis defines the node hierarchy used to render the z-axis
  129028. */
  129029. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  129030. /**
  129031. * Force the viewer to update
  129032. * @param position defines the position of the viewer
  129033. * @param xaxis defines the x axis of the viewer
  129034. * @param yaxis defines the y axis of the viewer
  129035. * @param zaxis defines the z axis of the viewer
  129036. */
  129037. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  129038. /**
  129039. * Creates an instance of this axes viewer.
  129040. * @returns a new axes viewer with instanced meshes
  129041. */
  129042. createInstance(): AxesViewer;
  129043. /** Releases resources */
  129044. dispose(): void;
  129045. private static _SetRenderingGroupId;
  129046. }
  129047. }
  129048. declare module BABYLON.Debug {
  129049. /**
  129050. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  129051. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  129052. */
  129053. export class BoneAxesViewer extends AxesViewer {
  129054. /**
  129055. * Gets or sets the target mesh where to display the axes viewer
  129056. */
  129057. mesh: Nullable<Mesh>;
  129058. /**
  129059. * Gets or sets the target bone where to display the axes viewer
  129060. */
  129061. bone: Nullable<Bone>;
  129062. /** Gets current position */
  129063. pos: Vector3;
  129064. /** Gets direction of X axis */
  129065. xaxis: Vector3;
  129066. /** Gets direction of Y axis */
  129067. yaxis: Vector3;
  129068. /** Gets direction of Z axis */
  129069. zaxis: Vector3;
  129070. /**
  129071. * Creates a new BoneAxesViewer
  129072. * @param scene defines the hosting scene
  129073. * @param bone defines the target bone
  129074. * @param mesh defines the target mesh
  129075. * @param scaleLines defines a scaling factor for line length (1 by default)
  129076. */
  129077. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  129078. /**
  129079. * Force the viewer to update
  129080. */
  129081. update(): void;
  129082. /** Releases resources */
  129083. dispose(): void;
  129084. }
  129085. }
  129086. declare module BABYLON {
  129087. /**
  129088. * Interface used to define scene explorer extensibility option
  129089. */
  129090. export interface IExplorerExtensibilityOption {
  129091. /**
  129092. * Define the option label
  129093. */
  129094. label: string;
  129095. /**
  129096. * Defines the action to execute on click
  129097. */
  129098. action: (entity: any) => void;
  129099. }
  129100. /**
  129101. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  129102. */
  129103. export interface IExplorerExtensibilityGroup {
  129104. /**
  129105. * Defines a predicate to test if a given type mut be extended
  129106. */
  129107. predicate: (entity: any) => boolean;
  129108. /**
  129109. * Gets the list of options added to a type
  129110. */
  129111. entries: IExplorerExtensibilityOption[];
  129112. }
  129113. /**
  129114. * Interface used to define the options to use to create the Inspector
  129115. */
  129116. export interface IInspectorOptions {
  129117. /**
  129118. * Display in overlay mode (default: false)
  129119. */
  129120. overlay?: boolean;
  129121. /**
  129122. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  129123. */
  129124. globalRoot?: HTMLElement;
  129125. /**
  129126. * Display the Scene explorer
  129127. */
  129128. showExplorer?: boolean;
  129129. /**
  129130. * Display the property inspector
  129131. */
  129132. showInspector?: boolean;
  129133. /**
  129134. * Display in embed mode (both panes on the right)
  129135. */
  129136. embedMode?: boolean;
  129137. /**
  129138. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  129139. */
  129140. handleResize?: boolean;
  129141. /**
  129142. * Allow the panes to popup (default: true)
  129143. */
  129144. enablePopup?: boolean;
  129145. /**
  129146. * Allow the panes to be closed by users (default: true)
  129147. */
  129148. enableClose?: boolean;
  129149. /**
  129150. * Optional list of extensibility entries
  129151. */
  129152. explorerExtensibility?: IExplorerExtensibilityGroup[];
  129153. /**
  129154. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  129155. */
  129156. inspectorURL?: string;
  129157. /**
  129158. * Optional initial tab (default to DebugLayerTab.Properties)
  129159. */
  129160. initialTab?: DebugLayerTab;
  129161. }
  129162. interface Scene {
  129163. /**
  129164. * @hidden
  129165. * Backing field
  129166. */
  129167. _debugLayer: DebugLayer;
  129168. /**
  129169. * Gets the debug layer (aka Inspector) associated with the scene
  129170. * @see https://doc.babylonjs.com/features/playground_debuglayer
  129171. */
  129172. debugLayer: DebugLayer;
  129173. }
  129174. /**
  129175. * Enum of inspector action tab
  129176. */
  129177. export enum DebugLayerTab {
  129178. /**
  129179. * Properties tag (default)
  129180. */
  129181. Properties = 0,
  129182. /**
  129183. * Debug tab
  129184. */
  129185. Debug = 1,
  129186. /**
  129187. * Statistics tab
  129188. */
  129189. Statistics = 2,
  129190. /**
  129191. * Tools tab
  129192. */
  129193. Tools = 3,
  129194. /**
  129195. * Settings tab
  129196. */
  129197. Settings = 4
  129198. }
  129199. /**
  129200. * The debug layer (aka Inspector) is the go to tool in order to better understand
  129201. * what is happening in your scene
  129202. * @see https://doc.babylonjs.com/features/playground_debuglayer
  129203. */
  129204. export class DebugLayer {
  129205. /**
  129206. * Define the url to get the inspector script from.
  129207. * By default it uses the babylonjs CDN.
  129208. * @ignoreNaming
  129209. */
  129210. static InspectorURL: string;
  129211. private _scene;
  129212. private BJSINSPECTOR;
  129213. private _onPropertyChangedObservable?;
  129214. /**
  129215. * Observable triggered when a property is changed through the inspector.
  129216. */
  129217. get onPropertyChangedObservable(): any;
  129218. /**
  129219. * Instantiates a new debug layer.
  129220. * The debug layer (aka Inspector) is the go to tool in order to better understand
  129221. * what is happening in your scene
  129222. * @see https://doc.babylonjs.com/features/playground_debuglayer
  129223. * @param scene Defines the scene to inspect
  129224. */
  129225. constructor(scene: Scene);
  129226. /** Creates the inspector window. */
  129227. private _createInspector;
  129228. /**
  129229. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  129230. * @param entity defines the entity to select
  129231. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  129232. */
  129233. select(entity: any, lineContainerTitles?: string | string[]): void;
  129234. /** Get the inspector from bundle or global */
  129235. private _getGlobalInspector;
  129236. /**
  129237. * Get if the inspector is visible or not.
  129238. * @returns true if visible otherwise, false
  129239. */
  129240. isVisible(): boolean;
  129241. /**
  129242. * Hide the inspector and close its window.
  129243. */
  129244. hide(): void;
  129245. /**
  129246. * Update the scene in the inspector
  129247. */
  129248. setAsActiveScene(): void;
  129249. /**
  129250. * Launch the debugLayer.
  129251. * @param config Define the configuration of the inspector
  129252. * @return a promise fulfilled when the debug layer is visible
  129253. */
  129254. show(config?: IInspectorOptions): Promise<DebugLayer>;
  129255. }
  129256. }
  129257. declare module BABYLON {
  129258. /**
  129259. * Class containing static functions to help procedurally build meshes
  129260. */
  129261. export class BoxBuilder {
  129262. /**
  129263. * Creates a box mesh
  129264. * * The parameter `size` sets the size (float) of each box side (default 1)
  129265. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  129266. * * 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)
  129267. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  129268. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  129269. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  129270. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129271. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  129272. * @param name defines the name of the mesh
  129273. * @param options defines the options used to create the mesh
  129274. * @param scene defines the hosting scene
  129275. * @returns the box mesh
  129276. */
  129277. static CreateBox(name: string, options: {
  129278. size?: number;
  129279. width?: number;
  129280. height?: number;
  129281. depth?: number;
  129282. faceUV?: Vector4[];
  129283. faceColors?: Color4[];
  129284. sideOrientation?: number;
  129285. frontUVs?: Vector4;
  129286. backUVs?: Vector4;
  129287. wrap?: boolean;
  129288. topBaseAt?: number;
  129289. bottomBaseAt?: number;
  129290. updatable?: boolean;
  129291. }, scene?: Nullable<Scene>): Mesh;
  129292. }
  129293. }
  129294. declare module BABYLON.Debug {
  129295. /**
  129296. * Used to show the physics impostor around the specific mesh
  129297. */
  129298. export class PhysicsViewer {
  129299. /** @hidden */
  129300. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  129301. /** @hidden */
  129302. protected _meshes: Array<Nullable<AbstractMesh>>;
  129303. /** @hidden */
  129304. protected _scene: Nullable<Scene>;
  129305. /** @hidden */
  129306. protected _numMeshes: number;
  129307. /** @hidden */
  129308. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  129309. private _renderFunction;
  129310. private _utilityLayer;
  129311. private _debugBoxMesh;
  129312. private _debugSphereMesh;
  129313. private _debugCylinderMesh;
  129314. private _debugMaterial;
  129315. private _debugMeshMeshes;
  129316. /**
  129317. * Creates a new PhysicsViewer
  129318. * @param scene defines the hosting scene
  129319. */
  129320. constructor(scene: Scene);
  129321. /** @hidden */
  129322. protected _updateDebugMeshes(): void;
  129323. /**
  129324. * Renders a specified physic impostor
  129325. * @param impostor defines the impostor to render
  129326. * @param targetMesh defines the mesh represented by the impostor
  129327. * @returns the new debug mesh used to render the impostor
  129328. */
  129329. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  129330. /**
  129331. * Hides a specified physic impostor
  129332. * @param impostor defines the impostor to hide
  129333. */
  129334. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  129335. private _getDebugMaterial;
  129336. private _getDebugBoxMesh;
  129337. private _getDebugSphereMesh;
  129338. private _getDebugCylinderMesh;
  129339. private _getDebugMeshMesh;
  129340. private _getDebugMesh;
  129341. /** Releases all resources */
  129342. dispose(): void;
  129343. }
  129344. }
  129345. declare module BABYLON {
  129346. /**
  129347. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  129348. * in order to better appreciate the issue one might have.
  129349. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  129350. */
  129351. export class RayHelper {
  129352. /**
  129353. * Defines the ray we are currently tryin to visualize.
  129354. */
  129355. ray: Nullable<Ray>;
  129356. private _renderPoints;
  129357. private _renderLine;
  129358. private _renderFunction;
  129359. private _scene;
  129360. private _updateToMeshFunction;
  129361. private _attachedToMesh;
  129362. private _meshSpaceDirection;
  129363. private _meshSpaceOrigin;
  129364. /**
  129365. * Helper function to create a colored helper in a scene in one line.
  129366. * @param ray Defines the ray we are currently tryin to visualize
  129367. * @param scene Defines the scene the ray is used in
  129368. * @param color Defines the color we want to see the ray in
  129369. * @returns The newly created ray helper.
  129370. */
  129371. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  129372. /**
  129373. * Instantiate a new ray helper.
  129374. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  129375. * in order to better appreciate the issue one might have.
  129376. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  129377. * @param ray Defines the ray we are currently tryin to visualize
  129378. */
  129379. constructor(ray: Ray);
  129380. /**
  129381. * Shows the ray we are willing to debug.
  129382. * @param scene Defines the scene the ray needs to be rendered in
  129383. * @param color Defines the color the ray needs to be rendered in
  129384. */
  129385. show(scene: Scene, color?: Color3): void;
  129386. /**
  129387. * Hides the ray we are debugging.
  129388. */
  129389. hide(): void;
  129390. private _render;
  129391. /**
  129392. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  129393. * @param mesh Defines the mesh we want the helper attached to
  129394. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  129395. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  129396. * @param length Defines the length of the ray
  129397. */
  129398. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  129399. /**
  129400. * Detach the ray helper from the mesh it has previously been attached to.
  129401. */
  129402. detachFromMesh(): void;
  129403. private _updateToMesh;
  129404. /**
  129405. * Dispose the helper and release its associated resources.
  129406. */
  129407. dispose(): void;
  129408. }
  129409. }
  129410. declare module BABYLON.Debug {
  129411. /**
  129412. * Class used to render a debug view of a given skeleton
  129413. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  129414. */
  129415. export class SkeletonViewer {
  129416. /** defines the skeleton to render */
  129417. skeleton: Skeleton;
  129418. /** defines the mesh attached to the skeleton */
  129419. mesh: AbstractMesh;
  129420. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  129421. autoUpdateBonesMatrices: boolean;
  129422. /** defines the rendering group id to use with the viewer */
  129423. renderingGroupId: number;
  129424. /** Gets or sets the color used to render the skeleton */
  129425. color: Color3;
  129426. private _scene;
  129427. private _debugLines;
  129428. private _debugMesh;
  129429. private _isEnabled;
  129430. private _renderFunction;
  129431. private _utilityLayer;
  129432. /**
  129433. * Returns the mesh used to render the bones
  129434. */
  129435. get debugMesh(): Nullable<LinesMesh>;
  129436. /**
  129437. * Creates a new SkeletonViewer
  129438. * @param skeleton defines the skeleton to render
  129439. * @param mesh defines the mesh attached to the skeleton
  129440. * @param scene defines the hosting scene
  129441. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  129442. * @param renderingGroupId defines the rendering group id to use with the viewer
  129443. */
  129444. constructor(
  129445. /** defines the skeleton to render */
  129446. skeleton: Skeleton,
  129447. /** defines the mesh attached to the skeleton */
  129448. mesh: AbstractMesh, scene: Scene,
  129449. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  129450. autoUpdateBonesMatrices?: boolean,
  129451. /** defines the rendering group id to use with the viewer */
  129452. renderingGroupId?: number);
  129453. /** Gets or sets a boolean indicating if the viewer is enabled */
  129454. set isEnabled(value: boolean);
  129455. get isEnabled(): boolean;
  129456. private _getBonePosition;
  129457. private _getLinesForBonesWithLength;
  129458. private _getLinesForBonesNoLength;
  129459. /** Update the viewer to sync with current skeleton state */
  129460. update(): void;
  129461. /** Release associated resources */
  129462. dispose(): void;
  129463. }
  129464. }
  129465. declare module BABYLON {
  129466. /**
  129467. * Enum for Device Types
  129468. */
  129469. export enum DeviceType {
  129470. /** Generic */
  129471. Generic = 0,
  129472. /** Keyboard */
  129473. Keyboard = 1,
  129474. /** Mouse */
  129475. Mouse = 2,
  129476. /** Touch Pointers */
  129477. Touch = 3,
  129478. /** PS4 Dual Shock */
  129479. DualShock = 4,
  129480. /** Xbox */
  129481. Xbox = 5,
  129482. /** Switch Controller */
  129483. Switch = 6
  129484. }
  129485. /**
  129486. * Enum for All Pointers (Touch/Mouse)
  129487. */
  129488. export enum PointerInput {
  129489. /** Horizontal Axis */
  129490. Horizontal = 0,
  129491. /** Vertical Axis */
  129492. Vertical = 1,
  129493. /** Left Click or Touch */
  129494. LeftClick = 2,
  129495. /** Middle Click */
  129496. MiddleClick = 3,
  129497. /** Right Click */
  129498. RightClick = 4,
  129499. /** Browser Back */
  129500. BrowserBack = 5,
  129501. /** Browser Forward */
  129502. BrowserForward = 6
  129503. }
  129504. /**
  129505. * Enum for Dual Shock Gamepad
  129506. */
  129507. export enum DualShockInput {
  129508. /** Cross */
  129509. Cross = 0,
  129510. /** Circle */
  129511. Circle = 1,
  129512. /** Square */
  129513. Square = 2,
  129514. /** Triangle */
  129515. Triangle = 3,
  129516. /** L1 */
  129517. L1 = 4,
  129518. /** R1 */
  129519. R1 = 5,
  129520. /** L2 */
  129521. L2 = 6,
  129522. /** R2 */
  129523. R2 = 7,
  129524. /** Share */
  129525. Share = 8,
  129526. /** Options */
  129527. Options = 9,
  129528. /** L3 */
  129529. L3 = 10,
  129530. /** R3 */
  129531. R3 = 11,
  129532. /** DPadUp */
  129533. DPadUp = 12,
  129534. /** DPadDown */
  129535. DPadDown = 13,
  129536. /** DPadLeft */
  129537. DPadLeft = 14,
  129538. /** DRight */
  129539. DPadRight = 15,
  129540. /** Home */
  129541. Home = 16,
  129542. /** TouchPad */
  129543. TouchPad = 17,
  129544. /** LStickXAxis */
  129545. LStickXAxis = 18,
  129546. /** LStickYAxis */
  129547. LStickYAxis = 19,
  129548. /** RStickXAxis */
  129549. RStickXAxis = 20,
  129550. /** RStickYAxis */
  129551. RStickYAxis = 21
  129552. }
  129553. /**
  129554. * Enum for Xbox Gamepad
  129555. */
  129556. export enum XboxInput {
  129557. /** A */
  129558. A = 0,
  129559. /** B */
  129560. B = 1,
  129561. /** X */
  129562. X = 2,
  129563. /** Y */
  129564. Y = 3,
  129565. /** LB */
  129566. LB = 4,
  129567. /** RB */
  129568. RB = 5,
  129569. /** LT */
  129570. LT = 6,
  129571. /** RT */
  129572. RT = 7,
  129573. /** Back */
  129574. Back = 8,
  129575. /** Start */
  129576. Start = 9,
  129577. /** LS */
  129578. LS = 10,
  129579. /** RS */
  129580. RS = 11,
  129581. /** DPadUp */
  129582. DPadUp = 12,
  129583. /** DPadDown */
  129584. DPadDown = 13,
  129585. /** DPadLeft */
  129586. DPadLeft = 14,
  129587. /** DRight */
  129588. DPadRight = 15,
  129589. /** Home */
  129590. Home = 16,
  129591. /** LStickXAxis */
  129592. LStickXAxis = 17,
  129593. /** LStickYAxis */
  129594. LStickYAxis = 18,
  129595. /** RStickXAxis */
  129596. RStickXAxis = 19,
  129597. /** RStickYAxis */
  129598. RStickYAxis = 20
  129599. }
  129600. /**
  129601. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  129602. */
  129603. export enum SwitchInput {
  129604. /** B */
  129605. B = 0,
  129606. /** A */
  129607. A = 1,
  129608. /** Y */
  129609. Y = 2,
  129610. /** X */
  129611. X = 3,
  129612. /** L */
  129613. L = 4,
  129614. /** R */
  129615. R = 5,
  129616. /** ZL */
  129617. ZL = 6,
  129618. /** ZR */
  129619. ZR = 7,
  129620. /** Minus */
  129621. Minus = 8,
  129622. /** Plus */
  129623. Plus = 9,
  129624. /** LS */
  129625. LS = 10,
  129626. /** RS */
  129627. RS = 11,
  129628. /** DPadUp */
  129629. DPadUp = 12,
  129630. /** DPadDown */
  129631. DPadDown = 13,
  129632. /** DPadLeft */
  129633. DPadLeft = 14,
  129634. /** DRight */
  129635. DPadRight = 15,
  129636. /** Home */
  129637. Home = 16,
  129638. /** Capture */
  129639. Capture = 17,
  129640. /** LStickXAxis */
  129641. LStickXAxis = 18,
  129642. /** LStickYAxis */
  129643. LStickYAxis = 19,
  129644. /** RStickXAxis */
  129645. RStickXAxis = 20,
  129646. /** RStickYAxis */
  129647. RStickYAxis = 21
  129648. }
  129649. }
  129650. declare module BABYLON {
  129651. /**
  129652. * This class will take all inputs from Keyboard, Pointer, and
  129653. * any Gamepads and provide a polling system that all devices
  129654. * will use. This class assumes that there will only be one
  129655. * pointer device and one keyboard.
  129656. */
  129657. export class DeviceInputSystem implements IDisposable {
  129658. /**
  129659. * Callback to be triggered when a device is connected
  129660. */
  129661. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  129662. /**
  129663. * Callback to be triggered when a device is disconnected
  129664. */
  129665. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  129666. /**
  129667. * Callback to be triggered when event driven input is updated
  129668. */
  129669. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  129670. private _inputs;
  129671. private _gamepads;
  129672. private _keyboardActive;
  129673. private _pointerActive;
  129674. private _elementToAttachTo;
  129675. private _keyboardDownEvent;
  129676. private _keyboardUpEvent;
  129677. private _pointerMoveEvent;
  129678. private _pointerDownEvent;
  129679. private _pointerUpEvent;
  129680. private _gamepadConnectedEvent;
  129681. private _gamepadDisconnectedEvent;
  129682. private static _MAX_KEYCODES;
  129683. private static _MAX_POINTER_INPUTS;
  129684. private constructor();
  129685. /**
  129686. * Creates a new DeviceInputSystem instance
  129687. * @param engine Engine to pull input element from
  129688. * @returns The new instance
  129689. */
  129690. static Create(engine: Engine): DeviceInputSystem;
  129691. /**
  129692. * Checks for current device input value, given an id and input index
  129693. * @param deviceName Id of connected device
  129694. * @param inputIndex Index of device input
  129695. * @returns Current value of input
  129696. */
  129697. /**
  129698. * Checks for current device input value, given an id and input index
  129699. * @param deviceType Enum specifiying device type
  129700. * @param deviceSlot "Slot" or index that device is referenced in
  129701. * @param inputIndex Id of input to be checked
  129702. * @returns Current value of input
  129703. */
  129704. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  129705. /**
  129706. * Dispose of all the eventlisteners
  129707. */
  129708. dispose(): void;
  129709. /**
  129710. * Add device and inputs to device array
  129711. * @param deviceType Enum specifiying device type
  129712. * @param deviceSlot "Slot" or index that device is referenced in
  129713. * @param numberOfInputs Number of input entries to create for given device
  129714. */
  129715. private _registerDevice;
  129716. /**
  129717. * Given a specific device name, remove that device from the device map
  129718. * @param deviceType Enum specifiying device type
  129719. * @param deviceSlot "Slot" or index that device is referenced in
  129720. */
  129721. private _unregisterDevice;
  129722. /**
  129723. * Handle all actions that come from keyboard interaction
  129724. */
  129725. private _handleKeyActions;
  129726. /**
  129727. * Handle all actions that come from pointer interaction
  129728. */
  129729. private _handlePointerActions;
  129730. /**
  129731. * Handle all actions that come from gamepad interaction
  129732. */
  129733. private _handleGamepadActions;
  129734. /**
  129735. * Update all non-event based devices with each frame
  129736. * @param deviceType Enum specifiying device type
  129737. * @param deviceSlot "Slot" or index that device is referenced in
  129738. * @param inputIndex Id of input to be checked
  129739. */
  129740. private _updateDevice;
  129741. /**
  129742. * Gets DeviceType from the device name
  129743. * @param deviceName Name of Device from DeviceInputSystem
  129744. * @returns DeviceType enum value
  129745. */
  129746. private _getGamepadDeviceType;
  129747. }
  129748. }
  129749. declare module BABYLON {
  129750. /**
  129751. * Type to handle enforcement of inputs
  129752. */
  129753. 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;
  129754. }
  129755. declare module BABYLON {
  129756. /**
  129757. * Class that handles all input for a specific device
  129758. */
  129759. export class DeviceSource<T extends DeviceType> {
  129760. /** Type of device */
  129761. readonly deviceType: DeviceType;
  129762. /** "Slot" or index that device is referenced in */
  129763. readonly deviceSlot: number;
  129764. /**
  129765. * Observable to handle device input changes per device
  129766. */
  129767. readonly onInputChangedObservable: Observable<{
  129768. inputIndex: DeviceInput<T>;
  129769. previousState: Nullable<number>;
  129770. currentState: Nullable<number>;
  129771. }>;
  129772. private readonly _deviceInputSystem;
  129773. /**
  129774. * Default Constructor
  129775. * @param deviceInputSystem Reference to DeviceInputSystem
  129776. * @param deviceType Type of device
  129777. * @param deviceSlot "Slot" or index that device is referenced in
  129778. */
  129779. constructor(deviceInputSystem: DeviceInputSystem,
  129780. /** Type of device */
  129781. deviceType: DeviceType,
  129782. /** "Slot" or index that device is referenced in */
  129783. deviceSlot?: number);
  129784. /**
  129785. * Get input for specific input
  129786. * @param inputIndex index of specific input on device
  129787. * @returns Input value from DeviceInputSystem
  129788. */
  129789. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  129790. }
  129791. /**
  129792. * Class to keep track of devices
  129793. */
  129794. export class DeviceSourceManager implements IDisposable {
  129795. /**
  129796. * Observable to be triggered when before a device is connected
  129797. */
  129798. readonly onBeforeDeviceConnectedObservable: Observable<{
  129799. deviceType: DeviceType;
  129800. deviceSlot: number;
  129801. }>;
  129802. /**
  129803. * Observable to be triggered when before a device is disconnected
  129804. */
  129805. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  129806. deviceType: DeviceType;
  129807. deviceSlot: number;
  129808. }>;
  129809. /**
  129810. * Observable to be triggered when after a device is connected
  129811. */
  129812. readonly onAfterDeviceConnectedObservable: Observable<{
  129813. deviceType: DeviceType;
  129814. deviceSlot: number;
  129815. }>;
  129816. /**
  129817. * Observable to be triggered when after a device is disconnected
  129818. */
  129819. readonly onAfterDeviceDisconnectedObservable: Observable<{
  129820. deviceType: DeviceType;
  129821. deviceSlot: number;
  129822. }>;
  129823. private readonly _devices;
  129824. private readonly _firstDevice;
  129825. private readonly _deviceInputSystem;
  129826. /**
  129827. * Default Constructor
  129828. * @param engine engine to pull input element from
  129829. */
  129830. constructor(engine: Engine);
  129831. /**
  129832. * Gets a DeviceSource, given a type and slot
  129833. * @param deviceType Enum specifying device type
  129834. * @param deviceSlot "Slot" or index that device is referenced in
  129835. * @returns DeviceSource object
  129836. */
  129837. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  129838. /**
  129839. * Gets an array of DeviceSource objects for a given device type
  129840. * @param deviceType Enum specifying device type
  129841. * @returns Array of DeviceSource objects
  129842. */
  129843. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  129844. /**
  129845. * Dispose of DeviceInputSystem and other parts
  129846. */
  129847. dispose(): void;
  129848. /**
  129849. * Function to add device name to device list
  129850. * @param deviceType Enum specifying device type
  129851. * @param deviceSlot "Slot" or index that device is referenced in
  129852. */
  129853. private _addDevice;
  129854. /**
  129855. * Function to remove device name to device list
  129856. * @param deviceType Enum specifying device type
  129857. * @param deviceSlot "Slot" or index that device is referenced in
  129858. */
  129859. private _removeDevice;
  129860. /**
  129861. * Updates array storing first connected device of each type
  129862. * @param type Type of Device
  129863. */
  129864. private _updateFirstDevices;
  129865. }
  129866. }
  129867. declare module BABYLON {
  129868. /**
  129869. * Options to create the null engine
  129870. */
  129871. export class NullEngineOptions {
  129872. /**
  129873. * Render width (Default: 512)
  129874. */
  129875. renderWidth: number;
  129876. /**
  129877. * Render height (Default: 256)
  129878. */
  129879. renderHeight: number;
  129880. /**
  129881. * Texture size (Default: 512)
  129882. */
  129883. textureSize: number;
  129884. /**
  129885. * If delta time between frames should be constant
  129886. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129887. */
  129888. deterministicLockstep: boolean;
  129889. /**
  129890. * Maximum about of steps between frames (Default: 4)
  129891. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129892. */
  129893. lockstepMaxSteps: number;
  129894. /**
  129895. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  129896. */
  129897. useHighPrecisionMatrix?: boolean;
  129898. }
  129899. /**
  129900. * The null engine class provides support for headless version of babylon.js.
  129901. * This can be used in server side scenario or for testing purposes
  129902. */
  129903. export class NullEngine extends Engine {
  129904. private _options;
  129905. /**
  129906. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  129907. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129908. * @returns true if engine is in deterministic lock step mode
  129909. */
  129910. isDeterministicLockStep(): boolean;
  129911. /**
  129912. * Gets the max steps when engine is running in deterministic lock step
  129913. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129914. * @returns the max steps
  129915. */
  129916. getLockstepMaxSteps(): number;
  129917. /**
  129918. * Gets the current hardware scaling level.
  129919. * By default the hardware scaling level is computed from the window device ratio.
  129920. * 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.
  129921. * @returns a number indicating the current hardware scaling level
  129922. */
  129923. getHardwareScalingLevel(): number;
  129924. constructor(options?: NullEngineOptions);
  129925. /**
  129926. * Creates a vertex buffer
  129927. * @param vertices the data for the vertex buffer
  129928. * @returns the new WebGL static buffer
  129929. */
  129930. createVertexBuffer(vertices: FloatArray): DataBuffer;
  129931. /**
  129932. * Creates a new index buffer
  129933. * @param indices defines the content of the index buffer
  129934. * @param updatable defines if the index buffer must be updatable
  129935. * @returns a new webGL buffer
  129936. */
  129937. createIndexBuffer(indices: IndicesArray): DataBuffer;
  129938. /**
  129939. * Clear the current render buffer or the current render target (if any is set up)
  129940. * @param color defines the color to use
  129941. * @param backBuffer defines if the back buffer must be cleared
  129942. * @param depth defines if the depth buffer must be cleared
  129943. * @param stencil defines if the stencil buffer must be cleared
  129944. */
  129945. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  129946. /**
  129947. * Gets the current render width
  129948. * @param useScreen defines if screen size must be used (or the current render target if any)
  129949. * @returns a number defining the current render width
  129950. */
  129951. getRenderWidth(useScreen?: boolean): number;
  129952. /**
  129953. * Gets the current render height
  129954. * @param useScreen defines if screen size must be used (or the current render target if any)
  129955. * @returns a number defining the current render height
  129956. */
  129957. getRenderHeight(useScreen?: boolean): number;
  129958. /**
  129959. * Set the WebGL's viewport
  129960. * @param viewport defines the viewport element to be used
  129961. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  129962. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  129963. */
  129964. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  129965. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  129966. /**
  129967. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  129968. * @param pipelineContext defines the pipeline context to use
  129969. * @param uniformsNames defines the list of uniform names
  129970. * @returns an array of webGL uniform locations
  129971. */
  129972. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  129973. /**
  129974. * Gets the lsit of active attributes for a given webGL program
  129975. * @param pipelineContext defines the pipeline context to use
  129976. * @param attributesNames defines the list of attribute names to get
  129977. * @returns an array of indices indicating the offset of each attribute
  129978. */
  129979. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  129980. /**
  129981. * Binds an effect to the webGL context
  129982. * @param effect defines the effect to bind
  129983. */
  129984. bindSamplers(effect: Effect): void;
  129985. /**
  129986. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  129987. * @param effect defines the effect to activate
  129988. */
  129989. enableEffect(effect: Effect): void;
  129990. /**
  129991. * Set various states to the webGL context
  129992. * @param culling defines backface culling state
  129993. * @param zOffset defines the value to apply to zOffset (0 by default)
  129994. * @param force defines if states must be applied even if cache is up to date
  129995. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  129996. */
  129997. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  129998. /**
  129999. * Set the value of an uniform to an array of int32
  130000. * @param uniform defines the webGL uniform location where to store the value
  130001. * @param array defines the array of int32 to store
  130002. */
  130003. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  130004. /**
  130005. * Set the value of an uniform to an array of int32 (stored as vec2)
  130006. * @param uniform defines the webGL uniform location where to store the value
  130007. * @param array defines the array of int32 to store
  130008. */
  130009. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  130010. /**
  130011. * Set the value of an uniform to an array of int32 (stored as vec3)
  130012. * @param uniform defines the webGL uniform location where to store the value
  130013. * @param array defines the array of int32 to store
  130014. */
  130015. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  130016. /**
  130017. * Set the value of an uniform to an array of int32 (stored as vec4)
  130018. * @param uniform defines the webGL uniform location where to store the value
  130019. * @param array defines the array of int32 to store
  130020. */
  130021. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  130022. /**
  130023. * Set the value of an uniform to an array of float32
  130024. * @param uniform defines the webGL uniform location where to store the value
  130025. * @param array defines the array of float32 to store
  130026. */
  130027. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  130028. /**
  130029. * Set the value of an uniform to an array of float32 (stored as vec2)
  130030. * @param uniform defines the webGL uniform location where to store the value
  130031. * @param array defines the array of float32 to store
  130032. */
  130033. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  130034. /**
  130035. * Set the value of an uniform to an array of float32 (stored as vec3)
  130036. * @param uniform defines the webGL uniform location where to store the value
  130037. * @param array defines the array of float32 to store
  130038. */
  130039. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  130040. /**
  130041. * Set the value of an uniform to an array of float32 (stored as vec4)
  130042. * @param uniform defines the webGL uniform location where to store the value
  130043. * @param array defines the array of float32 to store
  130044. */
  130045. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  130046. /**
  130047. * Set the value of an uniform to an array of number
  130048. * @param uniform defines the webGL uniform location where to store the value
  130049. * @param array defines the array of number to store
  130050. */
  130051. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  130052. /**
  130053. * Set the value of an uniform to an array of number (stored as vec2)
  130054. * @param uniform defines the webGL uniform location where to store the value
  130055. * @param array defines the array of number to store
  130056. */
  130057. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  130058. /**
  130059. * Set the value of an uniform to an array of number (stored as vec3)
  130060. * @param uniform defines the webGL uniform location where to store the value
  130061. * @param array defines the array of number to store
  130062. */
  130063. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  130064. /**
  130065. * Set the value of an uniform to an array of number (stored as vec4)
  130066. * @param uniform defines the webGL uniform location where to store the value
  130067. * @param array defines the array of number to store
  130068. */
  130069. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  130070. /**
  130071. * Set the value of an uniform to an array of float32 (stored as matrices)
  130072. * @param uniform defines the webGL uniform location where to store the value
  130073. * @param matrices defines the array of float32 to store
  130074. */
  130075. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  130076. /**
  130077. * Set the value of an uniform to a matrix (3x3)
  130078. * @param uniform defines the webGL uniform location where to store the value
  130079. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  130080. */
  130081. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130082. /**
  130083. * Set the value of an uniform to a matrix (2x2)
  130084. * @param uniform defines the webGL uniform location where to store the value
  130085. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  130086. */
  130087. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130088. /**
  130089. * Set the value of an uniform to a number (float)
  130090. * @param uniform defines the webGL uniform location where to store the value
  130091. * @param value defines the float number to store
  130092. */
  130093. setFloat(uniform: WebGLUniformLocation, value: number): void;
  130094. /**
  130095. * Set the value of an uniform to a vec2
  130096. * @param uniform defines the webGL uniform location where to store the value
  130097. * @param x defines the 1st component of the value
  130098. * @param y defines the 2nd component of the value
  130099. */
  130100. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  130101. /**
  130102. * Set the value of an uniform to a vec3
  130103. * @param uniform defines the webGL uniform location where to store the value
  130104. * @param x defines the 1st component of the value
  130105. * @param y defines the 2nd component of the value
  130106. * @param z defines the 3rd component of the value
  130107. */
  130108. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  130109. /**
  130110. * Set the value of an uniform to a boolean
  130111. * @param uniform defines the webGL uniform location where to store the value
  130112. * @param bool defines the boolean to store
  130113. */
  130114. setBool(uniform: WebGLUniformLocation, bool: number): void;
  130115. /**
  130116. * Set the value of an uniform to a vec4
  130117. * @param uniform defines the webGL uniform location where to store the value
  130118. * @param x defines the 1st component of the value
  130119. * @param y defines the 2nd component of the value
  130120. * @param z defines the 3rd component of the value
  130121. * @param w defines the 4th component of the value
  130122. */
  130123. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  130124. /**
  130125. * Sets the current alpha mode
  130126. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  130127. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  130128. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  130129. */
  130130. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  130131. /**
  130132. * Bind webGl buffers directly to the webGL context
  130133. * @param vertexBuffers defines the vertex buffer to bind
  130134. * @param indexBuffer defines the index buffer to bind
  130135. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  130136. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  130137. * @param effect defines the effect associated with the vertex buffer
  130138. */
  130139. bindBuffers(vertexBuffers: {
  130140. [key: string]: VertexBuffer;
  130141. }, indexBuffer: DataBuffer, effect: Effect): void;
  130142. /**
  130143. * Force the entire cache to be cleared
  130144. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  130145. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  130146. */
  130147. wipeCaches(bruteForce?: boolean): void;
  130148. /**
  130149. * Send a draw order
  130150. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  130151. * @param indexStart defines the starting index
  130152. * @param indexCount defines the number of index to draw
  130153. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130154. */
  130155. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  130156. /**
  130157. * Draw a list of indexed primitives
  130158. * @param fillMode defines the primitive to use
  130159. * @param indexStart defines the starting index
  130160. * @param indexCount defines the number of index to draw
  130161. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130162. */
  130163. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  130164. /**
  130165. * Draw a list of unindexed primitives
  130166. * @param fillMode defines the primitive to use
  130167. * @param verticesStart defines the index of first vertex to draw
  130168. * @param verticesCount defines the count of vertices to draw
  130169. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130170. */
  130171. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  130172. /** @hidden */
  130173. _createTexture(): WebGLTexture;
  130174. /** @hidden */
  130175. _releaseTexture(texture: InternalTexture): void;
  130176. /**
  130177. * Usually called from Texture.ts.
  130178. * Passed information to create a WebGLTexture
  130179. * @param urlArg defines a value which contains one of the following:
  130180. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  130181. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  130182. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  130183. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  130184. * @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)
  130185. * @param scene needed for loading to the correct scene
  130186. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  130187. * @param onLoad optional callback to be called upon successful completion
  130188. * @param onError optional callback to be called upon failure
  130189. * @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
  130190. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  130191. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  130192. * @param forcedExtension defines the extension to use to pick the right loader
  130193. * @param mimeType defines an optional mime type
  130194. * @returns a InternalTexture for assignment back into BABYLON.Texture
  130195. */
  130196. 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;
  130197. /**
  130198. * Creates a new render target texture
  130199. * @param size defines the size of the texture
  130200. * @param options defines the options used to create the texture
  130201. * @returns a new render target texture stored in an InternalTexture
  130202. */
  130203. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  130204. /**
  130205. * Update the sampling mode of a given texture
  130206. * @param samplingMode defines the required sampling mode
  130207. * @param texture defines the texture to update
  130208. */
  130209. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  130210. /**
  130211. * Binds the frame buffer to the specified texture.
  130212. * @param texture The texture to render to or null for the default canvas
  130213. * @param faceIndex The face of the texture to render to in case of cube texture
  130214. * @param requiredWidth The width of the target to render to
  130215. * @param requiredHeight The height of the target to render to
  130216. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  130217. * @param lodLevel defines le lod level to bind to the frame buffer
  130218. */
  130219. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  130220. /**
  130221. * Unbind the current render target texture from the webGL context
  130222. * @param texture defines the render target texture to unbind
  130223. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  130224. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  130225. */
  130226. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  130227. /**
  130228. * Creates a dynamic vertex buffer
  130229. * @param vertices the data for the dynamic vertex buffer
  130230. * @returns the new WebGL dynamic buffer
  130231. */
  130232. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  130233. /**
  130234. * Update the content of a dynamic texture
  130235. * @param texture defines the texture to update
  130236. * @param canvas defines the canvas containing the source
  130237. * @param invertY defines if data must be stored with Y axis inverted
  130238. * @param premulAlpha defines if alpha is stored as premultiplied
  130239. * @param format defines the format of the data
  130240. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  130241. */
  130242. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  130243. /**
  130244. * Gets a boolean indicating if all created effects are ready
  130245. * @returns true if all effects are ready
  130246. */
  130247. areAllEffectsReady(): boolean;
  130248. /**
  130249. * @hidden
  130250. * Get the current error code of the webGL context
  130251. * @returns the error code
  130252. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  130253. */
  130254. getError(): number;
  130255. /** @hidden */
  130256. _getUnpackAlignement(): number;
  130257. /** @hidden */
  130258. _unpackFlipY(value: boolean): void;
  130259. /**
  130260. * Update a dynamic index buffer
  130261. * @param indexBuffer defines the target index buffer
  130262. * @param indices defines the data to update
  130263. * @param offset defines the offset in the target index buffer where update should start
  130264. */
  130265. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  130266. /**
  130267. * Updates a dynamic vertex buffer.
  130268. * @param vertexBuffer the vertex buffer to update
  130269. * @param vertices the data used to update the vertex buffer
  130270. * @param byteOffset the byte offset of the data (optional)
  130271. * @param byteLength the byte length of the data (optional)
  130272. */
  130273. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  130274. /** @hidden */
  130275. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  130276. /** @hidden */
  130277. _bindTexture(channel: number, texture: InternalTexture): void;
  130278. protected _deleteBuffer(buffer: WebGLBuffer): void;
  130279. /**
  130280. * 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
  130281. */
  130282. releaseEffects(): void;
  130283. displayLoadingUI(): void;
  130284. hideLoadingUI(): void;
  130285. /** @hidden */
  130286. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130287. /** @hidden */
  130288. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130289. /** @hidden */
  130290. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130291. /** @hidden */
  130292. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  130293. }
  130294. }
  130295. declare module BABYLON {
  130296. /**
  130297. * @hidden
  130298. **/
  130299. export class _TimeToken {
  130300. _startTimeQuery: Nullable<WebGLQuery>;
  130301. _endTimeQuery: Nullable<WebGLQuery>;
  130302. _timeElapsedQuery: Nullable<WebGLQuery>;
  130303. _timeElapsedQueryEnded: boolean;
  130304. }
  130305. }
  130306. declare module BABYLON {
  130307. /** @hidden */
  130308. export class _OcclusionDataStorage {
  130309. /** @hidden */
  130310. occlusionInternalRetryCounter: number;
  130311. /** @hidden */
  130312. isOcclusionQueryInProgress: boolean;
  130313. /** @hidden */
  130314. isOccluded: boolean;
  130315. /** @hidden */
  130316. occlusionRetryCount: number;
  130317. /** @hidden */
  130318. occlusionType: number;
  130319. /** @hidden */
  130320. occlusionQueryAlgorithmType: number;
  130321. }
  130322. interface Engine {
  130323. /**
  130324. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  130325. * @return the new query
  130326. */
  130327. createQuery(): WebGLQuery;
  130328. /**
  130329. * Delete and release a webGL query
  130330. * @param query defines the query to delete
  130331. * @return the current engine
  130332. */
  130333. deleteQuery(query: WebGLQuery): Engine;
  130334. /**
  130335. * Check if a given query has resolved and got its value
  130336. * @param query defines the query to check
  130337. * @returns true if the query got its value
  130338. */
  130339. isQueryResultAvailable(query: WebGLQuery): boolean;
  130340. /**
  130341. * Gets the value of a given query
  130342. * @param query defines the query to check
  130343. * @returns the value of the query
  130344. */
  130345. getQueryResult(query: WebGLQuery): number;
  130346. /**
  130347. * Initiates an occlusion query
  130348. * @param algorithmType defines the algorithm to use
  130349. * @param query defines the query to use
  130350. * @returns the current engine
  130351. * @see https://doc.babylonjs.com/features/occlusionquery
  130352. */
  130353. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  130354. /**
  130355. * Ends an occlusion query
  130356. * @see https://doc.babylonjs.com/features/occlusionquery
  130357. * @param algorithmType defines the algorithm to use
  130358. * @returns the current engine
  130359. */
  130360. endOcclusionQuery(algorithmType: number): Engine;
  130361. /**
  130362. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  130363. * Please note that only one query can be issued at a time
  130364. * @returns a time token used to track the time span
  130365. */
  130366. startTimeQuery(): Nullable<_TimeToken>;
  130367. /**
  130368. * Ends a time query
  130369. * @param token defines the token used to measure the time span
  130370. * @returns the time spent (in ns)
  130371. */
  130372. endTimeQuery(token: _TimeToken): int;
  130373. /** @hidden */
  130374. _currentNonTimestampToken: Nullable<_TimeToken>;
  130375. /** @hidden */
  130376. _createTimeQuery(): WebGLQuery;
  130377. /** @hidden */
  130378. _deleteTimeQuery(query: WebGLQuery): void;
  130379. /** @hidden */
  130380. _getGlAlgorithmType(algorithmType: number): number;
  130381. /** @hidden */
  130382. _getTimeQueryResult(query: WebGLQuery): any;
  130383. /** @hidden */
  130384. _getTimeQueryAvailability(query: WebGLQuery): any;
  130385. }
  130386. interface AbstractMesh {
  130387. /**
  130388. * Backing filed
  130389. * @hidden
  130390. */
  130391. __occlusionDataStorage: _OcclusionDataStorage;
  130392. /**
  130393. * Access property
  130394. * @hidden
  130395. */
  130396. _occlusionDataStorage: _OcclusionDataStorage;
  130397. /**
  130398. * 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.
  130399. * The default value is -1 which means don't break the query and wait till the result
  130400. * @see https://doc.babylonjs.com/features/occlusionquery
  130401. */
  130402. occlusionRetryCount: number;
  130403. /**
  130404. * 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:
  130405. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  130406. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  130407. * * 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.
  130408. * @see https://doc.babylonjs.com/features/occlusionquery
  130409. */
  130410. occlusionType: number;
  130411. /**
  130412. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  130413. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  130414. * * 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.
  130415. * @see https://doc.babylonjs.com/features/occlusionquery
  130416. */
  130417. occlusionQueryAlgorithmType: number;
  130418. /**
  130419. * 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
  130420. * @see https://doc.babylonjs.com/features/occlusionquery
  130421. */
  130422. isOccluded: boolean;
  130423. /**
  130424. * Flag to check the progress status of the query
  130425. * @see https://doc.babylonjs.com/features/occlusionquery
  130426. */
  130427. isOcclusionQueryInProgress: boolean;
  130428. }
  130429. }
  130430. declare module BABYLON {
  130431. /** @hidden */
  130432. export var _forceTransformFeedbackToBundle: boolean;
  130433. interface Engine {
  130434. /**
  130435. * Creates a webGL transform feedback object
  130436. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  130437. * @returns the webGL transform feedback object
  130438. */
  130439. createTransformFeedback(): WebGLTransformFeedback;
  130440. /**
  130441. * Delete a webGL transform feedback object
  130442. * @param value defines the webGL transform feedback object to delete
  130443. */
  130444. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  130445. /**
  130446. * Bind a webGL transform feedback object to the webgl context
  130447. * @param value defines the webGL transform feedback object to bind
  130448. */
  130449. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  130450. /**
  130451. * Begins a transform feedback operation
  130452. * @param usePoints defines if points or triangles must be used
  130453. */
  130454. beginTransformFeedback(usePoints: boolean): void;
  130455. /**
  130456. * Ends a transform feedback operation
  130457. */
  130458. endTransformFeedback(): void;
  130459. /**
  130460. * Specify the varyings to use with transform feedback
  130461. * @param program defines the associated webGL program
  130462. * @param value defines the list of strings representing the varying names
  130463. */
  130464. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  130465. /**
  130466. * Bind a webGL buffer for a transform feedback operation
  130467. * @param value defines the webGL buffer to bind
  130468. */
  130469. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  130470. }
  130471. }
  130472. declare module BABYLON {
  130473. /**
  130474. * Class used to define an additional view for the engine
  130475. * @see https://doc.babylonjs.com/how_to/multi_canvases
  130476. */
  130477. export class EngineView {
  130478. /** Defines the canvas where to render the view */
  130479. target: HTMLCanvasElement;
  130480. /** Defines an optional camera used to render the view (will use active camera else) */
  130481. camera?: Camera;
  130482. }
  130483. interface Engine {
  130484. /**
  130485. * Gets or sets the HTML element to use for attaching events
  130486. */
  130487. inputElement: Nullable<HTMLElement>;
  130488. /**
  130489. * Gets the current engine view
  130490. * @see https://doc.babylonjs.com/how_to/multi_canvases
  130491. */
  130492. activeView: Nullable<EngineView>;
  130493. /** Gets or sets the list of views */
  130494. views: EngineView[];
  130495. /**
  130496. * Register a new child canvas
  130497. * @param canvas defines the canvas to register
  130498. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  130499. * @returns the associated view
  130500. */
  130501. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  130502. /**
  130503. * Remove a registered child canvas
  130504. * @param canvas defines the canvas to remove
  130505. * @returns the current engine
  130506. */
  130507. unRegisterView(canvas: HTMLCanvasElement): Engine;
  130508. }
  130509. }
  130510. declare module BABYLON {
  130511. interface Engine {
  130512. /** @hidden */
  130513. _excludedCompressedTextures: string[];
  130514. /** @hidden */
  130515. _textureFormatInUse: string;
  130516. /**
  130517. * Gets the list of texture formats supported
  130518. */
  130519. readonly texturesSupported: Array<string>;
  130520. /**
  130521. * Gets the texture format in use
  130522. */
  130523. readonly textureFormatInUse: Nullable<string>;
  130524. /**
  130525. * Set the compressed texture extensions or file names to skip.
  130526. *
  130527. * @param skippedFiles defines the list of those texture files you want to skip
  130528. * Example: [".dds", ".env", "myfile.png"]
  130529. */
  130530. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  130531. /**
  130532. * Set the compressed texture format to use, based on the formats you have, and the formats
  130533. * supported by the hardware / browser.
  130534. *
  130535. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  130536. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  130537. * to API arguments needed to compressed textures. This puts the burden on the container
  130538. * generator to house the arcane code for determining these for current & future formats.
  130539. *
  130540. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  130541. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  130542. *
  130543. * Note: The result of this call is not taken into account when a texture is base64.
  130544. *
  130545. * @param formatsAvailable defines the list of those format families you have created
  130546. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  130547. *
  130548. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  130549. * @returns The extension selected.
  130550. */
  130551. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  130552. }
  130553. }
  130554. declare module BABYLON {
  130555. /**
  130556. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  130557. */
  130558. export interface CubeMapInfo {
  130559. /**
  130560. * The pixel array for the front face.
  130561. * This is stored in format, left to right, up to down format.
  130562. */
  130563. front: Nullable<ArrayBufferView>;
  130564. /**
  130565. * The pixel array for the back face.
  130566. * This is stored in format, left to right, up to down format.
  130567. */
  130568. back: Nullable<ArrayBufferView>;
  130569. /**
  130570. * The pixel array for the left face.
  130571. * This is stored in format, left to right, up to down format.
  130572. */
  130573. left: Nullable<ArrayBufferView>;
  130574. /**
  130575. * The pixel array for the right face.
  130576. * This is stored in format, left to right, up to down format.
  130577. */
  130578. right: Nullable<ArrayBufferView>;
  130579. /**
  130580. * The pixel array for the up face.
  130581. * This is stored in format, left to right, up to down format.
  130582. */
  130583. up: Nullable<ArrayBufferView>;
  130584. /**
  130585. * The pixel array for the down face.
  130586. * This is stored in format, left to right, up to down format.
  130587. */
  130588. down: Nullable<ArrayBufferView>;
  130589. /**
  130590. * The size of the cubemap stored.
  130591. *
  130592. * Each faces will be size * size pixels.
  130593. */
  130594. size: number;
  130595. /**
  130596. * The format of the texture.
  130597. *
  130598. * RGBA, RGB.
  130599. */
  130600. format: number;
  130601. /**
  130602. * The type of the texture data.
  130603. *
  130604. * UNSIGNED_INT, FLOAT.
  130605. */
  130606. type: number;
  130607. /**
  130608. * Specifies whether the texture is in gamma space.
  130609. */
  130610. gammaSpace: boolean;
  130611. }
  130612. /**
  130613. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  130614. */
  130615. export class PanoramaToCubeMapTools {
  130616. private static FACE_LEFT;
  130617. private static FACE_RIGHT;
  130618. private static FACE_FRONT;
  130619. private static FACE_BACK;
  130620. private static FACE_DOWN;
  130621. private static FACE_UP;
  130622. /**
  130623. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  130624. *
  130625. * @param float32Array The source data.
  130626. * @param inputWidth The width of the input panorama.
  130627. * @param inputHeight The height of the input panorama.
  130628. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  130629. * @return The cubemap data
  130630. */
  130631. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  130632. private static CreateCubemapTexture;
  130633. private static CalcProjectionSpherical;
  130634. }
  130635. }
  130636. declare module BABYLON {
  130637. /**
  130638. * Helper class dealing with the extraction of spherical polynomial dataArray
  130639. * from a cube map.
  130640. */
  130641. export class CubeMapToSphericalPolynomialTools {
  130642. private static FileFaces;
  130643. /**
  130644. * Converts a texture to the according Spherical Polynomial data.
  130645. * This extracts the first 3 orders only as they are the only one used in the lighting.
  130646. *
  130647. * @param texture The texture to extract the information from.
  130648. * @return The Spherical Polynomial data.
  130649. */
  130650. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  130651. /**
  130652. * Converts a cubemap to the according Spherical Polynomial data.
  130653. * This extracts the first 3 orders only as they are the only one used in the lighting.
  130654. *
  130655. * @param cubeInfo The Cube map to extract the information from.
  130656. * @return The Spherical Polynomial data.
  130657. */
  130658. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  130659. }
  130660. }
  130661. declare module BABYLON {
  130662. interface BaseTexture {
  130663. /**
  130664. * Get the polynomial representation of the texture data.
  130665. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  130666. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  130667. */
  130668. sphericalPolynomial: Nullable<SphericalPolynomial>;
  130669. }
  130670. }
  130671. declare module BABYLON {
  130672. /** @hidden */
  130673. export var rgbdEncodePixelShader: {
  130674. name: string;
  130675. shader: string;
  130676. };
  130677. }
  130678. declare module BABYLON {
  130679. /** @hidden */
  130680. export var rgbdDecodePixelShader: {
  130681. name: string;
  130682. shader: string;
  130683. };
  130684. }
  130685. declare module BABYLON {
  130686. /**
  130687. * Raw texture data and descriptor sufficient for WebGL texture upload
  130688. */
  130689. export interface EnvironmentTextureInfo {
  130690. /**
  130691. * Version of the environment map
  130692. */
  130693. version: number;
  130694. /**
  130695. * Width of image
  130696. */
  130697. width: number;
  130698. /**
  130699. * Irradiance information stored in the file.
  130700. */
  130701. irradiance: any;
  130702. /**
  130703. * Specular information stored in the file.
  130704. */
  130705. specular: any;
  130706. }
  130707. /**
  130708. * Defines One Image in the file. It requires only the position in the file
  130709. * as well as the length.
  130710. */
  130711. interface BufferImageData {
  130712. /**
  130713. * Length of the image data.
  130714. */
  130715. length: number;
  130716. /**
  130717. * Position of the data from the null terminator delimiting the end of the JSON.
  130718. */
  130719. position: number;
  130720. }
  130721. /**
  130722. * Defines the specular data enclosed in the file.
  130723. * This corresponds to the version 1 of the data.
  130724. */
  130725. export interface EnvironmentTextureSpecularInfoV1 {
  130726. /**
  130727. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  130728. */
  130729. specularDataPosition?: number;
  130730. /**
  130731. * This contains all the images data needed to reconstruct the cubemap.
  130732. */
  130733. mipmaps: Array<BufferImageData>;
  130734. /**
  130735. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  130736. */
  130737. lodGenerationScale: number;
  130738. }
  130739. /**
  130740. * Sets of helpers addressing the serialization and deserialization of environment texture
  130741. * stored in a BabylonJS env file.
  130742. * Those files are usually stored as .env files.
  130743. */
  130744. export class EnvironmentTextureTools {
  130745. /**
  130746. * Magic number identifying the env file.
  130747. */
  130748. private static _MagicBytes;
  130749. /**
  130750. * Gets the environment info from an env file.
  130751. * @param data The array buffer containing the .env bytes.
  130752. * @returns the environment file info (the json header) if successfully parsed.
  130753. */
  130754. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  130755. /**
  130756. * Creates an environment texture from a loaded cube texture.
  130757. * @param texture defines the cube texture to convert in env file
  130758. * @return a promise containing the environment data if succesfull.
  130759. */
  130760. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  130761. /**
  130762. * Creates a JSON representation of the spherical data.
  130763. * @param texture defines the texture containing the polynomials
  130764. * @return the JSON representation of the spherical info
  130765. */
  130766. private static _CreateEnvTextureIrradiance;
  130767. /**
  130768. * Creates the ArrayBufferViews used for initializing environment texture image data.
  130769. * @param data the image data
  130770. * @param info parameters that determine what views will be created for accessing the underlying buffer
  130771. * @return the views described by info providing access to the underlying buffer
  130772. */
  130773. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  130774. /**
  130775. * Uploads the texture info contained in the env file to the GPU.
  130776. * @param texture defines the internal texture to upload to
  130777. * @param data defines the data to load
  130778. * @param info defines the texture info retrieved through the GetEnvInfo method
  130779. * @returns a promise
  130780. */
  130781. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  130782. private static _OnImageReadyAsync;
  130783. /**
  130784. * Uploads the levels of image data to the GPU.
  130785. * @param texture defines the internal texture to upload to
  130786. * @param imageData defines the array buffer views of image data [mipmap][face]
  130787. * @returns a promise
  130788. */
  130789. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  130790. /**
  130791. * Uploads spherical polynomials information to the texture.
  130792. * @param texture defines the texture we are trying to upload the information to
  130793. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  130794. */
  130795. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  130796. /** @hidden */
  130797. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  130798. }
  130799. }
  130800. declare module BABYLON {
  130801. /**
  130802. * Class used to inline functions in shader code
  130803. */
  130804. export class ShaderCodeInliner {
  130805. private static readonly _RegexpFindFunctionNameAndType;
  130806. private _sourceCode;
  130807. private _functionDescr;
  130808. private _numMaxIterations;
  130809. /** Gets or sets the token used to mark the functions to inline */
  130810. inlineToken: string;
  130811. /** Gets or sets the debug mode */
  130812. debug: boolean;
  130813. /** Gets the code after the inlining process */
  130814. get code(): string;
  130815. /**
  130816. * Initializes the inliner
  130817. * @param sourceCode shader code source to inline
  130818. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  130819. */
  130820. constructor(sourceCode: string, numMaxIterations?: number);
  130821. /**
  130822. * Start the processing of the shader code
  130823. */
  130824. processCode(): void;
  130825. private _collectFunctions;
  130826. private _processInlining;
  130827. private _extractBetweenMarkers;
  130828. private _skipWhitespaces;
  130829. private _removeComments;
  130830. private _replaceFunctionCallsByCode;
  130831. private _findBackward;
  130832. private _escapeRegExp;
  130833. private _replaceNames;
  130834. }
  130835. }
  130836. declare module BABYLON {
  130837. /**
  130838. * Container for accessors for natively-stored mesh data buffers.
  130839. */
  130840. class NativeDataBuffer extends DataBuffer {
  130841. /**
  130842. * Accessor value used to identify/retrieve a natively-stored index buffer.
  130843. */
  130844. nativeIndexBuffer?: any;
  130845. /**
  130846. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  130847. */
  130848. nativeVertexBuffer?: any;
  130849. }
  130850. /** @hidden */
  130851. class NativeTexture extends InternalTexture {
  130852. getInternalTexture(): InternalTexture;
  130853. getViewCount(): number;
  130854. }
  130855. /** @hidden */
  130856. export class NativeEngine extends Engine {
  130857. private readonly _native;
  130858. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  130859. private readonly INVALID_HANDLE;
  130860. getHardwareScalingLevel(): number;
  130861. constructor();
  130862. dispose(): void;
  130863. /**
  130864. * Can be used to override the current requestAnimationFrame requester.
  130865. * @hidden
  130866. */
  130867. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  130868. /**
  130869. * Override default engine behavior.
  130870. * @param color
  130871. * @param backBuffer
  130872. * @param depth
  130873. * @param stencil
  130874. */
  130875. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  130876. /**
  130877. * Gets host document
  130878. * @returns the host document object
  130879. */
  130880. getHostDocument(): Nullable<Document>;
  130881. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  130882. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  130883. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  130884. recordVertexArrayObject(vertexBuffers: {
  130885. [key: string]: VertexBuffer;
  130886. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  130887. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  130888. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  130889. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  130890. /**
  130891. * Draw a list of indexed primitives
  130892. * @param fillMode defines the primitive to use
  130893. * @param indexStart defines the starting index
  130894. * @param indexCount defines the number of index to draw
  130895. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130896. */
  130897. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  130898. /**
  130899. * Draw a list of unindexed primitives
  130900. * @param fillMode defines the primitive to use
  130901. * @param verticesStart defines the index of first vertex to draw
  130902. * @param verticesCount defines the count of vertices to draw
  130903. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130904. */
  130905. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  130906. createPipelineContext(): IPipelineContext;
  130907. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  130908. /** @hidden */
  130909. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  130910. /** @hidden */
  130911. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  130912. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  130913. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  130914. protected _setProgram(program: WebGLProgram): void;
  130915. _releaseEffect(effect: Effect): void;
  130916. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  130917. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  130918. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  130919. bindSamplers(effect: Effect): void;
  130920. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  130921. getRenderWidth(useScreen?: boolean): number;
  130922. getRenderHeight(useScreen?: boolean): number;
  130923. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  130924. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  130925. /**
  130926. * Set the z offset to apply to current rendering
  130927. * @param value defines the offset to apply
  130928. */
  130929. setZOffset(value: number): void;
  130930. /**
  130931. * Gets the current value of the zOffset
  130932. * @returns the current zOffset state
  130933. */
  130934. getZOffset(): number;
  130935. /**
  130936. * Enable or disable depth buffering
  130937. * @param enable defines the state to set
  130938. */
  130939. setDepthBuffer(enable: boolean): void;
  130940. /**
  130941. * Gets a boolean indicating if depth writing is enabled
  130942. * @returns the current depth writing state
  130943. */
  130944. getDepthWrite(): boolean;
  130945. /**
  130946. * Enable or disable depth writing
  130947. * @param enable defines the state to set
  130948. */
  130949. setDepthWrite(enable: boolean): void;
  130950. /**
  130951. * Enable or disable color writing
  130952. * @param enable defines the state to set
  130953. */
  130954. setColorWrite(enable: boolean): void;
  130955. /**
  130956. * Gets a boolean indicating if color writing is enabled
  130957. * @returns the current color writing state
  130958. */
  130959. getColorWrite(): boolean;
  130960. /**
  130961. * Sets alpha constants used by some alpha blending modes
  130962. * @param r defines the red component
  130963. * @param g defines the green component
  130964. * @param b defines the blue component
  130965. * @param a defines the alpha component
  130966. */
  130967. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  130968. /**
  130969. * Sets the current alpha mode
  130970. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  130971. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  130972. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  130973. */
  130974. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  130975. /**
  130976. * Gets the current alpha mode
  130977. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  130978. * @returns the current alpha mode
  130979. */
  130980. getAlphaMode(): number;
  130981. setInt(uniform: WebGLUniformLocation, int: number): void;
  130982. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  130983. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  130984. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  130985. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  130986. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  130987. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  130988. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  130989. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  130990. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  130991. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  130992. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  130993. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  130994. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  130995. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130996. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130997. setFloat(uniform: WebGLUniformLocation, value: number): void;
  130998. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  130999. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131000. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131001. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  131002. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  131003. wipeCaches(bruteForce?: boolean): void;
  131004. _createTexture(): WebGLTexture;
  131005. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  131006. /**
  131007. * Usually called from Texture.ts.
  131008. * Passed information to create a WebGLTexture
  131009. * @param url defines a value which contains one of the following:
  131010. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131011. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131012. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131013. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131014. * @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)
  131015. * @param scene needed for loading to the correct scene
  131016. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131017. * @param onLoad optional callback to be called upon successful completion
  131018. * @param onError optional callback to be called upon failure
  131019. * @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
  131020. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131021. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131022. * @param forcedExtension defines the extension to use to pick the right loader
  131023. * @param mimeType defines an optional mime type
  131024. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131025. */
  131026. 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;
  131027. /**
  131028. * Creates a cube texture
  131029. * @param rootUrl defines the url where the files to load is located
  131030. * @param scene defines the current scene
  131031. * @param files defines the list of files to load (1 per face)
  131032. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  131033. * @param onLoad defines an optional callback raised when the texture is loaded
  131034. * @param onError defines an optional callback raised if there is an issue to load the texture
  131035. * @param format defines the format of the data
  131036. * @param forcedExtension defines the extension to use to pick the right loader
  131037. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  131038. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  131039. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  131040. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  131041. * @returns the cube texture as an InternalTexture
  131042. */
  131043. 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;
  131044. private _getSamplingFilter;
  131045. private static _GetNativeTextureFormat;
  131046. createRenderTargetTexture(size: number | {
  131047. width: number;
  131048. height: number;
  131049. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  131050. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131051. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131052. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131053. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  131054. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  131055. /**
  131056. * Updates a dynamic vertex buffer.
  131057. * @param vertexBuffer the vertex buffer to update
  131058. * @param data the data used to update the vertex buffer
  131059. * @param byteOffset the byte offset of the data (optional)
  131060. * @param byteLength the byte length of the data (optional)
  131061. */
  131062. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  131063. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  131064. private _updateAnisotropicLevel;
  131065. private _getAddressMode;
  131066. /** @hidden */
  131067. _bindTexture(channel: number, texture: InternalTexture): void;
  131068. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  131069. releaseEffects(): void;
  131070. /** @hidden */
  131071. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131072. /** @hidden */
  131073. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131074. /** @hidden */
  131075. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131076. /** @hidden */
  131077. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131078. }
  131079. }
  131080. declare module BABYLON {
  131081. /**
  131082. * Gather the list of clipboard event types as constants.
  131083. */
  131084. export class ClipboardEventTypes {
  131085. /**
  131086. * The clipboard event is fired when a copy command is active (pressed).
  131087. */
  131088. static readonly COPY: number;
  131089. /**
  131090. * The clipboard event is fired when a cut command is active (pressed).
  131091. */
  131092. static readonly CUT: number;
  131093. /**
  131094. * The clipboard event is fired when a paste command is active (pressed).
  131095. */
  131096. static readonly PASTE: number;
  131097. }
  131098. /**
  131099. * This class is used to store clipboard related info for the onClipboardObservable event.
  131100. */
  131101. export class ClipboardInfo {
  131102. /**
  131103. * Defines the type of event (BABYLON.ClipboardEventTypes)
  131104. */
  131105. type: number;
  131106. /**
  131107. * Defines the related dom event
  131108. */
  131109. event: ClipboardEvent;
  131110. /**
  131111. *Creates an instance of ClipboardInfo.
  131112. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  131113. * @param event Defines the related dom event
  131114. */
  131115. constructor(
  131116. /**
  131117. * Defines the type of event (BABYLON.ClipboardEventTypes)
  131118. */
  131119. type: number,
  131120. /**
  131121. * Defines the related dom event
  131122. */
  131123. event: ClipboardEvent);
  131124. /**
  131125. * Get the clipboard event's type from the keycode.
  131126. * @param keyCode Defines the keyCode for the current keyboard event.
  131127. * @return {number}
  131128. */
  131129. static GetTypeFromCharacter(keyCode: number): number;
  131130. }
  131131. }
  131132. declare module BABYLON {
  131133. /**
  131134. * Google Daydream controller
  131135. */
  131136. export class DaydreamController extends WebVRController {
  131137. /**
  131138. * Base Url for the controller model.
  131139. */
  131140. static MODEL_BASE_URL: string;
  131141. /**
  131142. * File name for the controller model.
  131143. */
  131144. static MODEL_FILENAME: string;
  131145. /**
  131146. * Gamepad Id prefix used to identify Daydream Controller.
  131147. */
  131148. static readonly GAMEPAD_ID_PREFIX: string;
  131149. /**
  131150. * Creates a new DaydreamController from a gamepad
  131151. * @param vrGamepad the gamepad that the controller should be created from
  131152. */
  131153. constructor(vrGamepad: any);
  131154. /**
  131155. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131156. * @param scene scene in which to add meshes
  131157. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131158. */
  131159. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131160. /**
  131161. * Called once for each button that changed state since the last frame
  131162. * @param buttonIdx Which button index changed
  131163. * @param state New state of the button
  131164. * @param changes Which properties on the state changed since last frame
  131165. */
  131166. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131167. }
  131168. }
  131169. declare module BABYLON {
  131170. /**
  131171. * Gear VR Controller
  131172. */
  131173. export class GearVRController extends WebVRController {
  131174. /**
  131175. * Base Url for the controller model.
  131176. */
  131177. static MODEL_BASE_URL: string;
  131178. /**
  131179. * File name for the controller model.
  131180. */
  131181. static MODEL_FILENAME: string;
  131182. /**
  131183. * Gamepad Id prefix used to identify this controller.
  131184. */
  131185. static readonly GAMEPAD_ID_PREFIX: string;
  131186. private readonly _buttonIndexToObservableNameMap;
  131187. /**
  131188. * Creates a new GearVRController from a gamepad
  131189. * @param vrGamepad the gamepad that the controller should be created from
  131190. */
  131191. constructor(vrGamepad: any);
  131192. /**
  131193. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131194. * @param scene scene in which to add meshes
  131195. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131196. */
  131197. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131198. /**
  131199. * Called once for each button that changed state since the last frame
  131200. * @param buttonIdx Which button index changed
  131201. * @param state New state of the button
  131202. * @param changes Which properties on the state changed since last frame
  131203. */
  131204. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131205. }
  131206. }
  131207. declare module BABYLON {
  131208. /**
  131209. * Generic Controller
  131210. */
  131211. export class GenericController extends WebVRController {
  131212. /**
  131213. * Base Url for the controller model.
  131214. */
  131215. static readonly MODEL_BASE_URL: string;
  131216. /**
  131217. * File name for the controller model.
  131218. */
  131219. static readonly MODEL_FILENAME: string;
  131220. /**
  131221. * Creates a new GenericController from a gamepad
  131222. * @param vrGamepad the gamepad that the controller should be created from
  131223. */
  131224. constructor(vrGamepad: any);
  131225. /**
  131226. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131227. * @param scene scene in which to add meshes
  131228. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131229. */
  131230. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131231. /**
  131232. * Called once for each button that changed state since the last frame
  131233. * @param buttonIdx Which button index changed
  131234. * @param state New state of the button
  131235. * @param changes Which properties on the state changed since last frame
  131236. */
  131237. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131238. }
  131239. }
  131240. declare module BABYLON {
  131241. /**
  131242. * Oculus Touch Controller
  131243. */
  131244. export class OculusTouchController extends WebVRController {
  131245. /**
  131246. * Base Url for the controller model.
  131247. */
  131248. static MODEL_BASE_URL: string;
  131249. /**
  131250. * File name for the left controller model.
  131251. */
  131252. static MODEL_LEFT_FILENAME: string;
  131253. /**
  131254. * File name for the right controller model.
  131255. */
  131256. static MODEL_RIGHT_FILENAME: string;
  131257. /**
  131258. * Base Url for the Quest controller model.
  131259. */
  131260. static QUEST_MODEL_BASE_URL: string;
  131261. /**
  131262. * @hidden
  131263. * If the controllers are running on a device that needs the updated Quest controller models
  131264. */
  131265. static _IsQuest: boolean;
  131266. /**
  131267. * Fired when the secondary trigger on this controller is modified
  131268. */
  131269. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  131270. /**
  131271. * Fired when the thumb rest on this controller is modified
  131272. */
  131273. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  131274. /**
  131275. * Creates a new OculusTouchController from a gamepad
  131276. * @param vrGamepad the gamepad that the controller should be created from
  131277. */
  131278. constructor(vrGamepad: any);
  131279. /**
  131280. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131281. * @param scene scene in which to add meshes
  131282. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131283. */
  131284. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131285. /**
  131286. * Fired when the A button on this controller is modified
  131287. */
  131288. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131289. /**
  131290. * Fired when the B button on this controller is modified
  131291. */
  131292. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131293. /**
  131294. * Fired when the X button on this controller is modified
  131295. */
  131296. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131297. /**
  131298. * Fired when the Y button on this controller is modified
  131299. */
  131300. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131301. /**
  131302. * Called once for each button that changed state since the last frame
  131303. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  131304. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  131305. * 2) secondary trigger (same)
  131306. * 3) A (right) X (left), touch, pressed = value
  131307. * 4) B / Y
  131308. * 5) thumb rest
  131309. * @param buttonIdx Which button index changed
  131310. * @param state New state of the button
  131311. * @param changes Which properties on the state changed since last frame
  131312. */
  131313. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131314. }
  131315. }
  131316. declare module BABYLON {
  131317. /**
  131318. * Vive Controller
  131319. */
  131320. export class ViveController extends WebVRController {
  131321. /**
  131322. * Base Url for the controller model.
  131323. */
  131324. static MODEL_BASE_URL: string;
  131325. /**
  131326. * File name for the controller model.
  131327. */
  131328. static MODEL_FILENAME: string;
  131329. /**
  131330. * Creates a new ViveController from a gamepad
  131331. * @param vrGamepad the gamepad that the controller should be created from
  131332. */
  131333. constructor(vrGamepad: any);
  131334. /**
  131335. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131336. * @param scene scene in which to add meshes
  131337. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131338. */
  131339. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131340. /**
  131341. * Fired when the left button on this controller is modified
  131342. */
  131343. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131344. /**
  131345. * Fired when the right button on this controller is modified
  131346. */
  131347. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131348. /**
  131349. * Fired when the menu button on this controller is modified
  131350. */
  131351. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131352. /**
  131353. * Called once for each button that changed state since the last frame
  131354. * Vive mapping:
  131355. * 0: touchpad
  131356. * 1: trigger
  131357. * 2: left AND right buttons
  131358. * 3: menu button
  131359. * @param buttonIdx Which button index changed
  131360. * @param state New state of the button
  131361. * @param changes Which properties on the state changed since last frame
  131362. */
  131363. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131364. }
  131365. }
  131366. declare module BABYLON {
  131367. /**
  131368. * Defines the WindowsMotionController object that the state of the windows motion controller
  131369. */
  131370. export class WindowsMotionController extends WebVRController {
  131371. /**
  131372. * The base url used to load the left and right controller models
  131373. */
  131374. static MODEL_BASE_URL: string;
  131375. /**
  131376. * The name of the left controller model file
  131377. */
  131378. static MODEL_LEFT_FILENAME: string;
  131379. /**
  131380. * The name of the right controller model file
  131381. */
  131382. static MODEL_RIGHT_FILENAME: string;
  131383. /**
  131384. * The controller name prefix for this controller type
  131385. */
  131386. static readonly GAMEPAD_ID_PREFIX: string;
  131387. /**
  131388. * The controller id pattern for this controller type
  131389. */
  131390. private static readonly GAMEPAD_ID_PATTERN;
  131391. private _loadedMeshInfo;
  131392. protected readonly _mapping: {
  131393. buttons: string[];
  131394. buttonMeshNames: {
  131395. trigger: string;
  131396. menu: string;
  131397. grip: string;
  131398. thumbstick: string;
  131399. trackpad: string;
  131400. };
  131401. buttonObservableNames: {
  131402. trigger: string;
  131403. menu: string;
  131404. grip: string;
  131405. thumbstick: string;
  131406. trackpad: string;
  131407. };
  131408. axisMeshNames: string[];
  131409. pointingPoseMeshName: string;
  131410. };
  131411. /**
  131412. * Fired when the trackpad on this controller is clicked
  131413. */
  131414. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  131415. /**
  131416. * Fired when the trackpad on this controller is modified
  131417. */
  131418. onTrackpadValuesChangedObservable: Observable<StickValues>;
  131419. /**
  131420. * The current x and y values of this controller's trackpad
  131421. */
  131422. trackpad: StickValues;
  131423. /**
  131424. * Creates a new WindowsMotionController from a gamepad
  131425. * @param vrGamepad the gamepad that the controller should be created from
  131426. */
  131427. constructor(vrGamepad: any);
  131428. /**
  131429. * Fired when the trigger on this controller is modified
  131430. */
  131431. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131432. /**
  131433. * Fired when the menu button on this controller is modified
  131434. */
  131435. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131436. /**
  131437. * Fired when the grip button on this controller is modified
  131438. */
  131439. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131440. /**
  131441. * Fired when the thumbstick button on this controller is modified
  131442. */
  131443. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131444. /**
  131445. * Fired when the touchpad button on this controller is modified
  131446. */
  131447. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131448. /**
  131449. * Fired when the touchpad values on this controller are modified
  131450. */
  131451. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  131452. protected _updateTrackpad(): void;
  131453. /**
  131454. * Called once per frame by the engine.
  131455. */
  131456. update(): void;
  131457. /**
  131458. * Called once for each button that changed state since the last frame
  131459. * @param buttonIdx Which button index changed
  131460. * @param state New state of the button
  131461. * @param changes Which properties on the state changed since last frame
  131462. */
  131463. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131464. /**
  131465. * Moves the buttons on the controller mesh based on their current state
  131466. * @param buttonName the name of the button to move
  131467. * @param buttonValue the value of the button which determines the buttons new position
  131468. */
  131469. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  131470. /**
  131471. * Moves the axis on the controller mesh based on its current state
  131472. * @param axis the index of the axis
  131473. * @param axisValue the value of the axis which determines the meshes new position
  131474. * @hidden
  131475. */
  131476. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  131477. /**
  131478. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131479. * @param scene scene in which to add meshes
  131480. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131481. */
  131482. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  131483. /**
  131484. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  131485. * can be transformed by button presses and axes values, based on this._mapping.
  131486. *
  131487. * @param scene scene in which the meshes exist
  131488. * @param meshes list of meshes that make up the controller model to process
  131489. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  131490. */
  131491. private processModel;
  131492. private createMeshInfo;
  131493. /**
  131494. * Gets the ray of the controller in the direction the controller is pointing
  131495. * @param length the length the resulting ray should be
  131496. * @returns a ray in the direction the controller is pointing
  131497. */
  131498. getForwardRay(length?: number): Ray;
  131499. /**
  131500. * Disposes of the controller
  131501. */
  131502. dispose(): void;
  131503. }
  131504. /**
  131505. * This class represents a new windows motion controller in XR.
  131506. */
  131507. export class XRWindowsMotionController extends WindowsMotionController {
  131508. /**
  131509. * Changing the original WIndowsMotionController mapping to fir the new mapping
  131510. */
  131511. protected readonly _mapping: {
  131512. buttons: string[];
  131513. buttonMeshNames: {
  131514. trigger: string;
  131515. menu: string;
  131516. grip: string;
  131517. thumbstick: string;
  131518. trackpad: string;
  131519. };
  131520. buttonObservableNames: {
  131521. trigger: string;
  131522. menu: string;
  131523. grip: string;
  131524. thumbstick: string;
  131525. trackpad: string;
  131526. };
  131527. axisMeshNames: string[];
  131528. pointingPoseMeshName: string;
  131529. };
  131530. /**
  131531. * Construct a new XR-Based windows motion controller
  131532. *
  131533. * @param gamepadInfo the gamepad object from the browser
  131534. */
  131535. constructor(gamepadInfo: any);
  131536. /**
  131537. * holds the thumbstick values (X,Y)
  131538. */
  131539. thumbstickValues: StickValues;
  131540. /**
  131541. * Fired when the thumbstick on this controller is clicked
  131542. */
  131543. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  131544. /**
  131545. * Fired when the thumbstick on this controller is modified
  131546. */
  131547. onThumbstickValuesChangedObservable: Observable<StickValues>;
  131548. /**
  131549. * Fired when the touchpad button on this controller is modified
  131550. */
  131551. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  131552. /**
  131553. * Fired when the touchpad values on this controller are modified
  131554. */
  131555. onTrackpadValuesChangedObservable: Observable<StickValues>;
  131556. /**
  131557. * Fired when the thumbstick button on this controller is modified
  131558. * here to prevent breaking changes
  131559. */
  131560. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131561. /**
  131562. * updating the thumbstick(!) and not the trackpad.
  131563. * This is named this way due to the difference between WebVR and XR and to avoid
  131564. * changing the parent class.
  131565. */
  131566. protected _updateTrackpad(): void;
  131567. /**
  131568. * Disposes the class with joy
  131569. */
  131570. dispose(): void;
  131571. }
  131572. }
  131573. declare module BABYLON {
  131574. /**
  131575. * Class containing static functions to help procedurally build meshes
  131576. */
  131577. export class PolyhedronBuilder {
  131578. /**
  131579. * Creates a polyhedron mesh
  131580. * * 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
  131581. * * The parameter `size` (positive float, default 1) sets the polygon size
  131582. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  131583. * * 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`
  131584. * * 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
  131585. * * 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)`)
  131586. * * 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
  131587. * * 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
  131588. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131589. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131590. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131591. * @param name defines the name of the mesh
  131592. * @param options defines the options used to create the mesh
  131593. * @param scene defines the hosting scene
  131594. * @returns the polyhedron mesh
  131595. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  131596. */
  131597. static CreatePolyhedron(name: string, options: {
  131598. type?: number;
  131599. size?: number;
  131600. sizeX?: number;
  131601. sizeY?: number;
  131602. sizeZ?: number;
  131603. custom?: any;
  131604. faceUV?: Vector4[];
  131605. faceColors?: Color4[];
  131606. flat?: boolean;
  131607. updatable?: boolean;
  131608. sideOrientation?: number;
  131609. frontUVs?: Vector4;
  131610. backUVs?: Vector4;
  131611. }, scene?: Nullable<Scene>): Mesh;
  131612. }
  131613. }
  131614. declare module BABYLON {
  131615. /**
  131616. * Gizmo that enables scaling a mesh along 3 axis
  131617. */
  131618. export class ScaleGizmo extends Gizmo {
  131619. /**
  131620. * Internal gizmo used for interactions on the x axis
  131621. */
  131622. xGizmo: AxisScaleGizmo;
  131623. /**
  131624. * Internal gizmo used for interactions on the y axis
  131625. */
  131626. yGizmo: AxisScaleGizmo;
  131627. /**
  131628. * Internal gizmo used for interactions on the z axis
  131629. */
  131630. zGizmo: AxisScaleGizmo;
  131631. /**
  131632. * Internal gizmo used to scale all axis equally
  131633. */
  131634. uniformScaleGizmo: AxisScaleGizmo;
  131635. private _meshAttached;
  131636. private _nodeAttached;
  131637. private _updateGizmoRotationToMatchAttachedMesh;
  131638. private _snapDistance;
  131639. private _scaleRatio;
  131640. private _uniformScalingMesh;
  131641. private _octahedron;
  131642. private _sensitivity;
  131643. /** Fires an event when any of it's sub gizmos are dragged */
  131644. onDragStartObservable: Observable<unknown>;
  131645. /** Fires an event when any of it's sub gizmos are released from dragging */
  131646. onDragEndObservable: Observable<unknown>;
  131647. get attachedMesh(): Nullable<AbstractMesh>;
  131648. set attachedMesh(mesh: Nullable<AbstractMesh>);
  131649. get attachedNode(): Nullable<Node>;
  131650. set attachedNode(node: Nullable<Node>);
  131651. /**
  131652. * Creates a ScaleGizmo
  131653. * @param gizmoLayer The utility layer the gizmo will be added to
  131654. * @param thickness display gizmo axis thickness
  131655. */
  131656. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  131657. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  131658. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  131659. /**
  131660. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131661. */
  131662. set snapDistance(value: number);
  131663. get snapDistance(): number;
  131664. /**
  131665. * Ratio for the scale of the gizmo (Default: 1)
  131666. */
  131667. set scaleRatio(value: number);
  131668. get scaleRatio(): number;
  131669. /**
  131670. * Sensitivity factor for dragging (Default: 1)
  131671. */
  131672. set sensitivity(value: number);
  131673. get sensitivity(): number;
  131674. /**
  131675. * Disposes of the gizmo
  131676. */
  131677. dispose(): void;
  131678. }
  131679. }
  131680. declare module BABYLON {
  131681. /**
  131682. * Single axis scale gizmo
  131683. */
  131684. export class AxisScaleGizmo extends Gizmo {
  131685. /**
  131686. * Drag behavior responsible for the gizmos dragging interactions
  131687. */
  131688. dragBehavior: PointerDragBehavior;
  131689. private _pointerObserver;
  131690. /**
  131691. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131692. */
  131693. snapDistance: number;
  131694. /**
  131695. * Event that fires each time the gizmo snaps to a new location.
  131696. * * snapDistance is the the change in distance
  131697. */
  131698. onSnapObservable: Observable<{
  131699. snapDistance: number;
  131700. }>;
  131701. /**
  131702. * If the scaling operation should be done on all axis (default: false)
  131703. */
  131704. uniformScaling: boolean;
  131705. /**
  131706. * Custom sensitivity value for the drag strength
  131707. */
  131708. sensitivity: number;
  131709. private _isEnabled;
  131710. private _parent;
  131711. private _arrow;
  131712. private _coloredMaterial;
  131713. private _hoverMaterial;
  131714. /**
  131715. * Creates an AxisScaleGizmo
  131716. * @param gizmoLayer The utility layer the gizmo will be added to
  131717. * @param dragAxis The axis which the gizmo will be able to scale on
  131718. * @param color The color of the gizmo
  131719. * @param thickness display gizmo axis thickness
  131720. */
  131721. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  131722. protected _attachedNodeChanged(value: Nullable<Node>): void;
  131723. /**
  131724. * If the gizmo is enabled
  131725. */
  131726. set isEnabled(value: boolean);
  131727. get isEnabled(): boolean;
  131728. /**
  131729. * Disposes of the gizmo
  131730. */
  131731. dispose(): void;
  131732. /**
  131733. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  131734. * @param mesh The mesh to replace the default mesh of the gizmo
  131735. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  131736. */
  131737. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  131738. }
  131739. }
  131740. declare module BABYLON {
  131741. /**
  131742. * Bounding box gizmo
  131743. */
  131744. export class BoundingBoxGizmo extends Gizmo {
  131745. private _lineBoundingBox;
  131746. private _rotateSpheresParent;
  131747. private _scaleBoxesParent;
  131748. private _boundingDimensions;
  131749. private _renderObserver;
  131750. private _pointerObserver;
  131751. private _scaleDragSpeed;
  131752. private _tmpQuaternion;
  131753. private _tmpVector;
  131754. private _tmpRotationMatrix;
  131755. /**
  131756. * 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)
  131757. */
  131758. ignoreChildren: boolean;
  131759. /**
  131760. * 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)
  131761. */
  131762. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  131763. /**
  131764. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  131765. */
  131766. rotationSphereSize: number;
  131767. /**
  131768. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  131769. */
  131770. scaleBoxSize: number;
  131771. /**
  131772. * 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)
  131773. */
  131774. fixedDragMeshScreenSize: boolean;
  131775. /**
  131776. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  131777. */
  131778. fixedDragMeshScreenSizeDistanceFactor: number;
  131779. /**
  131780. * Fired when a rotation sphere or scale box is dragged
  131781. */
  131782. onDragStartObservable: Observable<{}>;
  131783. /**
  131784. * Fired when a scale box is dragged
  131785. */
  131786. onScaleBoxDragObservable: Observable<{}>;
  131787. /**
  131788. * Fired when a scale box drag is ended
  131789. */
  131790. onScaleBoxDragEndObservable: Observable<{}>;
  131791. /**
  131792. * Fired when a rotation sphere is dragged
  131793. */
  131794. onRotationSphereDragObservable: Observable<{}>;
  131795. /**
  131796. * Fired when a rotation sphere drag is ended
  131797. */
  131798. onRotationSphereDragEndObservable: Observable<{}>;
  131799. /**
  131800. * 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)
  131801. */
  131802. scalePivot: Nullable<Vector3>;
  131803. /**
  131804. * Mesh used as a pivot to rotate the attached node
  131805. */
  131806. private _anchorMesh;
  131807. private _existingMeshScale;
  131808. private _dragMesh;
  131809. private pointerDragBehavior;
  131810. private coloredMaterial;
  131811. private hoverColoredMaterial;
  131812. /**
  131813. * Sets the color of the bounding box gizmo
  131814. * @param color the color to set
  131815. */
  131816. setColor(color: Color3): void;
  131817. /**
  131818. * Creates an BoundingBoxGizmo
  131819. * @param gizmoLayer The utility layer the gizmo will be added to
  131820. * @param color The color of the gizmo
  131821. */
  131822. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  131823. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  131824. private _selectNode;
  131825. /**
  131826. * Updates the bounding box information for the Gizmo
  131827. */
  131828. updateBoundingBox(): void;
  131829. private _updateRotationSpheres;
  131830. private _updateScaleBoxes;
  131831. /**
  131832. * Enables rotation on the specified axis and disables rotation on the others
  131833. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  131834. */
  131835. setEnabledRotationAxis(axis: string): void;
  131836. /**
  131837. * Enables/disables scaling
  131838. * @param enable if scaling should be enabled
  131839. * @param homogeneousScaling defines if scaling should only be homogeneous
  131840. */
  131841. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  131842. private _updateDummy;
  131843. /**
  131844. * Enables a pointer drag behavior on the bounding box of the gizmo
  131845. */
  131846. enableDragBehavior(): void;
  131847. /**
  131848. * Disposes of the gizmo
  131849. */
  131850. dispose(): void;
  131851. /**
  131852. * 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)
  131853. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  131854. * @returns the bounding box mesh with the passed in mesh as a child
  131855. */
  131856. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  131857. /**
  131858. * CustomMeshes are not supported by this gizmo
  131859. * @param mesh The mesh to replace the default mesh of the gizmo
  131860. */
  131861. setCustomMesh(mesh: Mesh): void;
  131862. }
  131863. }
  131864. declare module BABYLON {
  131865. /**
  131866. * Single plane rotation gizmo
  131867. */
  131868. export class PlaneRotationGizmo extends Gizmo {
  131869. /**
  131870. * Drag behavior responsible for the gizmos dragging interactions
  131871. */
  131872. dragBehavior: PointerDragBehavior;
  131873. private _pointerObserver;
  131874. /**
  131875. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  131876. */
  131877. snapDistance: number;
  131878. /**
  131879. * Event that fires each time the gizmo snaps to a new location.
  131880. * * snapDistance is the the change in distance
  131881. */
  131882. onSnapObservable: Observable<{
  131883. snapDistance: number;
  131884. }>;
  131885. private _isEnabled;
  131886. private _parent;
  131887. /**
  131888. * Creates a PlaneRotationGizmo
  131889. * @param gizmoLayer The utility layer the gizmo will be added to
  131890. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  131891. * @param color The color of the gizmo
  131892. * @param tessellation Amount of tessellation to be used when creating rotation circles
  131893. * @param useEulerRotation Use and update Euler angle instead of quaternion
  131894. * @param thickness display gizmo axis thickness
  131895. */
  131896. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  131897. protected _attachedNodeChanged(value: Nullable<Node>): void;
  131898. /**
  131899. * If the gizmo is enabled
  131900. */
  131901. set isEnabled(value: boolean);
  131902. get isEnabled(): boolean;
  131903. /**
  131904. * Disposes of the gizmo
  131905. */
  131906. dispose(): void;
  131907. }
  131908. }
  131909. declare module BABYLON {
  131910. /**
  131911. * Gizmo that enables rotating a mesh along 3 axis
  131912. */
  131913. export class RotationGizmo extends Gizmo {
  131914. /**
  131915. * Internal gizmo used for interactions on the x axis
  131916. */
  131917. xGizmo: PlaneRotationGizmo;
  131918. /**
  131919. * Internal gizmo used for interactions on the y axis
  131920. */
  131921. yGizmo: PlaneRotationGizmo;
  131922. /**
  131923. * Internal gizmo used for interactions on the z axis
  131924. */
  131925. zGizmo: PlaneRotationGizmo;
  131926. /** Fires an event when any of it's sub gizmos are dragged */
  131927. onDragStartObservable: Observable<unknown>;
  131928. /** Fires an event when any of it's sub gizmos are released from dragging */
  131929. onDragEndObservable: Observable<unknown>;
  131930. private _meshAttached;
  131931. private _nodeAttached;
  131932. get attachedMesh(): Nullable<AbstractMesh>;
  131933. set attachedMesh(mesh: Nullable<AbstractMesh>);
  131934. get attachedNode(): Nullable<Node>;
  131935. set attachedNode(node: Nullable<Node>);
  131936. /**
  131937. * Creates a RotationGizmo
  131938. * @param gizmoLayer The utility layer the gizmo will be added to
  131939. * @param tessellation Amount of tessellation to be used when creating rotation circles
  131940. * @param useEulerRotation Use and update Euler angle instead of quaternion
  131941. * @param thickness display gizmo axis thickness
  131942. */
  131943. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  131944. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  131945. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  131946. /**
  131947. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131948. */
  131949. set snapDistance(value: number);
  131950. get snapDistance(): number;
  131951. /**
  131952. * Ratio for the scale of the gizmo (Default: 1)
  131953. */
  131954. set scaleRatio(value: number);
  131955. get scaleRatio(): number;
  131956. /**
  131957. * Disposes of the gizmo
  131958. */
  131959. dispose(): void;
  131960. /**
  131961. * CustomMeshes are not supported by this gizmo
  131962. * @param mesh The mesh to replace the default mesh of the gizmo
  131963. */
  131964. setCustomMesh(mesh: Mesh): void;
  131965. }
  131966. }
  131967. declare module BABYLON {
  131968. /**
  131969. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  131970. */
  131971. export class GizmoManager implements IDisposable {
  131972. private scene;
  131973. /**
  131974. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  131975. */
  131976. gizmos: {
  131977. positionGizmo: Nullable<PositionGizmo>;
  131978. rotationGizmo: Nullable<RotationGizmo>;
  131979. scaleGizmo: Nullable<ScaleGizmo>;
  131980. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  131981. };
  131982. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  131983. clearGizmoOnEmptyPointerEvent: boolean;
  131984. /** Fires an event when the manager is attached to a mesh */
  131985. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  131986. private _gizmosEnabled;
  131987. private _pointerObserver;
  131988. private _attachedMesh;
  131989. private _boundingBoxColor;
  131990. private _defaultUtilityLayer;
  131991. private _defaultKeepDepthUtilityLayer;
  131992. private _thickness;
  131993. /**
  131994. * When bounding box gizmo is enabled, this can be used to track drag/end events
  131995. */
  131996. boundingBoxDragBehavior: SixDofDragBehavior;
  131997. /**
  131998. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  131999. */
  132000. attachableMeshes: Nullable<Array<AbstractMesh>>;
  132001. /**
  132002. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  132003. */
  132004. usePointerToAttachGizmos: boolean;
  132005. /**
  132006. * Utility layer that the bounding box gizmo belongs to
  132007. */
  132008. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  132009. /**
  132010. * Utility layer that all gizmos besides bounding box belong to
  132011. */
  132012. get utilityLayer(): UtilityLayerRenderer;
  132013. /**
  132014. * Instatiates a gizmo manager
  132015. * @param scene the scene to overlay the gizmos on top of
  132016. * @param thickness display gizmo axis thickness
  132017. */
  132018. constructor(scene: Scene, thickness?: number);
  132019. /**
  132020. * Attaches a set of gizmos to the specified mesh
  132021. * @param mesh The mesh the gizmo's should be attached to
  132022. */
  132023. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  132024. /**
  132025. * If the position gizmo is enabled
  132026. */
  132027. set positionGizmoEnabled(value: boolean);
  132028. get positionGizmoEnabled(): boolean;
  132029. /**
  132030. * If the rotation gizmo is enabled
  132031. */
  132032. set rotationGizmoEnabled(value: boolean);
  132033. get rotationGizmoEnabled(): boolean;
  132034. /**
  132035. * If the scale gizmo is enabled
  132036. */
  132037. set scaleGizmoEnabled(value: boolean);
  132038. get scaleGizmoEnabled(): boolean;
  132039. /**
  132040. * If the boundingBox gizmo is enabled
  132041. */
  132042. set boundingBoxGizmoEnabled(value: boolean);
  132043. get boundingBoxGizmoEnabled(): boolean;
  132044. /**
  132045. * Disposes of the gizmo manager
  132046. */
  132047. dispose(): void;
  132048. }
  132049. }
  132050. declare module BABYLON {
  132051. /**
  132052. * A directional light is defined by a direction (what a surprise!).
  132053. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  132054. * 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.
  132055. * Documentation: https://doc.babylonjs.com/babylon101/lights
  132056. */
  132057. export class DirectionalLight extends ShadowLight {
  132058. private _shadowFrustumSize;
  132059. /**
  132060. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  132061. */
  132062. get shadowFrustumSize(): number;
  132063. /**
  132064. * Specifies a fix frustum size for the shadow generation.
  132065. */
  132066. set shadowFrustumSize(value: number);
  132067. private _shadowOrthoScale;
  132068. /**
  132069. * Gets the shadow projection scale against the optimal computed one.
  132070. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  132071. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  132072. */
  132073. get shadowOrthoScale(): number;
  132074. /**
  132075. * Sets the shadow projection scale against the optimal computed one.
  132076. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  132077. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  132078. */
  132079. set shadowOrthoScale(value: number);
  132080. /**
  132081. * Automatically compute the projection matrix to best fit (including all the casters)
  132082. * on each frame.
  132083. */
  132084. autoUpdateExtends: boolean;
  132085. /**
  132086. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  132087. * on each frame. autoUpdateExtends must be set to true for this to work
  132088. */
  132089. autoCalcShadowZBounds: boolean;
  132090. private _orthoLeft;
  132091. private _orthoRight;
  132092. private _orthoTop;
  132093. private _orthoBottom;
  132094. /**
  132095. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  132096. * The directional light is emitted from everywhere in the given direction.
  132097. * It can cast shadows.
  132098. * Documentation : https://doc.babylonjs.com/babylon101/lights
  132099. * @param name The friendly name of the light
  132100. * @param direction The direction of the light
  132101. * @param scene The scene the light belongs to
  132102. */
  132103. constructor(name: string, direction: Vector3, scene: Scene);
  132104. /**
  132105. * Returns the string "DirectionalLight".
  132106. * @return The class name
  132107. */
  132108. getClassName(): string;
  132109. /**
  132110. * Returns the integer 1.
  132111. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  132112. */
  132113. getTypeID(): number;
  132114. /**
  132115. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  132116. * Returns the DirectionalLight Shadow projection matrix.
  132117. */
  132118. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  132119. /**
  132120. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  132121. * Returns the DirectionalLight Shadow projection matrix.
  132122. */
  132123. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  132124. /**
  132125. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  132126. * Returns the DirectionalLight Shadow projection matrix.
  132127. */
  132128. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  132129. protected _buildUniformLayout(): void;
  132130. /**
  132131. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  132132. * @param effect The effect to update
  132133. * @param lightIndex The index of the light in the effect to update
  132134. * @returns The directional light
  132135. */
  132136. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  132137. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  132138. /**
  132139. * Gets the minZ used for shadow according to both the scene and the light.
  132140. *
  132141. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  132142. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  132143. * @param activeCamera The camera we are returning the min for
  132144. * @returns the depth min z
  132145. */
  132146. getDepthMinZ(activeCamera: Camera): number;
  132147. /**
  132148. * Gets the maxZ used for shadow according to both the scene and the light.
  132149. *
  132150. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  132151. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  132152. * @param activeCamera The camera we are returning the max for
  132153. * @returns the depth max z
  132154. */
  132155. getDepthMaxZ(activeCamera: Camera): number;
  132156. /**
  132157. * Prepares the list of defines specific to the light type.
  132158. * @param defines the list of defines
  132159. * @param lightIndex defines the index of the light for the effect
  132160. */
  132161. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  132162. }
  132163. }
  132164. declare module BABYLON {
  132165. /**
  132166. * Class containing static functions to help procedurally build meshes
  132167. */
  132168. export class HemisphereBuilder {
  132169. /**
  132170. * Creates a hemisphere mesh
  132171. * @param name defines the name of the mesh
  132172. * @param options defines the options used to create the mesh
  132173. * @param scene defines the hosting scene
  132174. * @returns the hemisphere mesh
  132175. */
  132176. static CreateHemisphere(name: string, options: {
  132177. segments?: number;
  132178. diameter?: number;
  132179. sideOrientation?: number;
  132180. }, scene: any): Mesh;
  132181. }
  132182. }
  132183. declare module BABYLON {
  132184. /**
  132185. * A spot light is defined by a position, a direction, an angle, and an exponent.
  132186. * These values define a cone of light starting from the position, emitting toward the direction.
  132187. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  132188. * and the exponent defines the speed of the decay of the light with distance (reach).
  132189. * Documentation: https://doc.babylonjs.com/babylon101/lights
  132190. */
  132191. export class SpotLight extends ShadowLight {
  132192. private _angle;
  132193. private _innerAngle;
  132194. private _cosHalfAngle;
  132195. private _lightAngleScale;
  132196. private _lightAngleOffset;
  132197. /**
  132198. * Gets the cone angle of the spot light in Radians.
  132199. */
  132200. get angle(): number;
  132201. /**
  132202. * Sets the cone angle of the spot light in Radians.
  132203. */
  132204. set angle(value: number);
  132205. /**
  132206. * Only used in gltf falloff mode, this defines the angle where
  132207. * the directional falloff will start before cutting at angle which could be seen
  132208. * as outer angle.
  132209. */
  132210. get innerAngle(): number;
  132211. /**
  132212. * Only used in gltf falloff mode, this defines the angle where
  132213. * the directional falloff will start before cutting at angle which could be seen
  132214. * as outer angle.
  132215. */
  132216. set innerAngle(value: number);
  132217. private _shadowAngleScale;
  132218. /**
  132219. * Allows scaling the angle of the light for shadow generation only.
  132220. */
  132221. get shadowAngleScale(): number;
  132222. /**
  132223. * Allows scaling the angle of the light for shadow generation only.
  132224. */
  132225. set shadowAngleScale(value: number);
  132226. /**
  132227. * The light decay speed with the distance from the emission spot.
  132228. */
  132229. exponent: number;
  132230. private _projectionTextureMatrix;
  132231. /**
  132232. * Allows reading the projecton texture
  132233. */
  132234. get projectionTextureMatrix(): Matrix;
  132235. protected _projectionTextureLightNear: number;
  132236. /**
  132237. * Gets the near clip of the Spotlight for texture projection.
  132238. */
  132239. get projectionTextureLightNear(): number;
  132240. /**
  132241. * Sets the near clip of the Spotlight for texture projection.
  132242. */
  132243. set projectionTextureLightNear(value: number);
  132244. protected _projectionTextureLightFar: number;
  132245. /**
  132246. * Gets the far clip of the Spotlight for texture projection.
  132247. */
  132248. get projectionTextureLightFar(): number;
  132249. /**
  132250. * Sets the far clip of the Spotlight for texture projection.
  132251. */
  132252. set projectionTextureLightFar(value: number);
  132253. protected _projectionTextureUpDirection: Vector3;
  132254. /**
  132255. * Gets the Up vector of the Spotlight for texture projection.
  132256. */
  132257. get projectionTextureUpDirection(): Vector3;
  132258. /**
  132259. * Sets the Up vector of the Spotlight for texture projection.
  132260. */
  132261. set projectionTextureUpDirection(value: Vector3);
  132262. private _projectionTexture;
  132263. /**
  132264. * Gets the projection texture of the light.
  132265. */
  132266. get projectionTexture(): Nullable<BaseTexture>;
  132267. /**
  132268. * Sets the projection texture of the light.
  132269. */
  132270. set projectionTexture(value: Nullable<BaseTexture>);
  132271. private _projectionTextureViewLightDirty;
  132272. private _projectionTextureProjectionLightDirty;
  132273. private _projectionTextureDirty;
  132274. private _projectionTextureViewTargetVector;
  132275. private _projectionTextureViewLightMatrix;
  132276. private _projectionTextureProjectionLightMatrix;
  132277. private _projectionTextureScalingMatrix;
  132278. /**
  132279. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  132280. * It can cast shadows.
  132281. * Documentation : https://doc.babylonjs.com/babylon101/lights
  132282. * @param name The light friendly name
  132283. * @param position The position of the spot light in the scene
  132284. * @param direction The direction of the light in the scene
  132285. * @param angle The cone angle of the light in Radians
  132286. * @param exponent The light decay speed with the distance from the emission spot
  132287. * @param scene The scene the lights belongs to
  132288. */
  132289. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  132290. /**
  132291. * Returns the string "SpotLight".
  132292. * @returns the class name
  132293. */
  132294. getClassName(): string;
  132295. /**
  132296. * Returns the integer 2.
  132297. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  132298. */
  132299. getTypeID(): number;
  132300. /**
  132301. * Overrides the direction setter to recompute the projection texture view light Matrix.
  132302. */
  132303. protected _setDirection(value: Vector3): void;
  132304. /**
  132305. * Overrides the position setter to recompute the projection texture view light Matrix.
  132306. */
  132307. protected _setPosition(value: Vector3): void;
  132308. /**
  132309. * 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.
  132310. * Returns the SpotLight.
  132311. */
  132312. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  132313. protected _computeProjectionTextureViewLightMatrix(): void;
  132314. protected _computeProjectionTextureProjectionLightMatrix(): void;
  132315. /**
  132316. * Main function for light texture projection matrix computing.
  132317. */
  132318. protected _computeProjectionTextureMatrix(): void;
  132319. protected _buildUniformLayout(): void;
  132320. private _computeAngleValues;
  132321. /**
  132322. * Sets the passed Effect "effect" with the Light textures.
  132323. * @param effect The effect to update
  132324. * @param lightIndex The index of the light in the effect to update
  132325. * @returns The light
  132326. */
  132327. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  132328. /**
  132329. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  132330. * @param effect The effect to update
  132331. * @param lightIndex The index of the light in the effect to update
  132332. * @returns The spot light
  132333. */
  132334. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  132335. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  132336. /**
  132337. * Disposes the light and the associated resources.
  132338. */
  132339. dispose(): void;
  132340. /**
  132341. * Prepares the list of defines specific to the light type.
  132342. * @param defines the list of defines
  132343. * @param lightIndex defines the index of the light for the effect
  132344. */
  132345. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  132346. }
  132347. }
  132348. declare module BABYLON {
  132349. /**
  132350. * Gizmo that enables viewing a light
  132351. */
  132352. export class LightGizmo extends Gizmo {
  132353. private _lightMesh;
  132354. private _material;
  132355. private _cachedPosition;
  132356. private _cachedForward;
  132357. private _attachedMeshParent;
  132358. /**
  132359. * Creates a LightGizmo
  132360. * @param gizmoLayer The utility layer the gizmo will be added to
  132361. */
  132362. constructor(gizmoLayer?: UtilityLayerRenderer);
  132363. private _light;
  132364. /**
  132365. * The light that the gizmo is attached to
  132366. */
  132367. set light(light: Nullable<Light>);
  132368. get light(): Nullable<Light>;
  132369. /**
  132370. * Gets the material used to render the light gizmo
  132371. */
  132372. get material(): StandardMaterial;
  132373. /**
  132374. * @hidden
  132375. * Updates the gizmo to match the attached mesh's position/rotation
  132376. */
  132377. protected _update(): void;
  132378. private static _Scale;
  132379. /**
  132380. * Creates the lines for a light mesh
  132381. */
  132382. private static _CreateLightLines;
  132383. /**
  132384. * Disposes of the light gizmo
  132385. */
  132386. dispose(): void;
  132387. private static _CreateHemisphericLightMesh;
  132388. private static _CreatePointLightMesh;
  132389. private static _CreateSpotLightMesh;
  132390. private static _CreateDirectionalLightMesh;
  132391. }
  132392. }
  132393. declare module BABYLON {
  132394. /** @hidden */
  132395. export var backgroundFragmentDeclaration: {
  132396. name: string;
  132397. shader: string;
  132398. };
  132399. }
  132400. declare module BABYLON {
  132401. /** @hidden */
  132402. export var backgroundUboDeclaration: {
  132403. name: string;
  132404. shader: string;
  132405. };
  132406. }
  132407. declare module BABYLON {
  132408. /** @hidden */
  132409. export var backgroundPixelShader: {
  132410. name: string;
  132411. shader: string;
  132412. };
  132413. }
  132414. declare module BABYLON {
  132415. /** @hidden */
  132416. export var backgroundVertexDeclaration: {
  132417. name: string;
  132418. shader: string;
  132419. };
  132420. }
  132421. declare module BABYLON {
  132422. /** @hidden */
  132423. export var backgroundVertexShader: {
  132424. name: string;
  132425. shader: string;
  132426. };
  132427. }
  132428. declare module BABYLON {
  132429. /**
  132430. * Background material used to create an efficient environement around your scene.
  132431. */
  132432. export class BackgroundMaterial extends PushMaterial {
  132433. /**
  132434. * Standard reflectance value at parallel view angle.
  132435. */
  132436. static StandardReflectance0: number;
  132437. /**
  132438. * Standard reflectance value at grazing angle.
  132439. */
  132440. static StandardReflectance90: number;
  132441. protected _primaryColor: Color3;
  132442. /**
  132443. * Key light Color (multiply against the environement texture)
  132444. */
  132445. primaryColor: Color3;
  132446. protected __perceptualColor: Nullable<Color3>;
  132447. /**
  132448. * Experimental Internal Use Only.
  132449. *
  132450. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  132451. * This acts as a helper to set the primary color to a more "human friendly" value.
  132452. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  132453. * output color as close as possible from the chosen value.
  132454. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  132455. * part of lighting setup.)
  132456. */
  132457. get _perceptualColor(): Nullable<Color3>;
  132458. set _perceptualColor(value: Nullable<Color3>);
  132459. protected _primaryColorShadowLevel: float;
  132460. /**
  132461. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  132462. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  132463. */
  132464. get primaryColorShadowLevel(): float;
  132465. set primaryColorShadowLevel(value: float);
  132466. protected _primaryColorHighlightLevel: float;
  132467. /**
  132468. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  132469. * The primary color is used at the level chosen to define what the white area would look.
  132470. */
  132471. get primaryColorHighlightLevel(): float;
  132472. set primaryColorHighlightLevel(value: float);
  132473. protected _reflectionTexture: Nullable<BaseTexture>;
  132474. /**
  132475. * Reflection Texture used in the material.
  132476. * Should be author in a specific way for the best result (refer to the documentation).
  132477. */
  132478. reflectionTexture: Nullable<BaseTexture>;
  132479. protected _reflectionBlur: float;
  132480. /**
  132481. * Reflection Texture level of blur.
  132482. *
  132483. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  132484. * texture twice.
  132485. */
  132486. reflectionBlur: float;
  132487. protected _diffuseTexture: Nullable<BaseTexture>;
  132488. /**
  132489. * Diffuse Texture used in the material.
  132490. * Should be author in a specific way for the best result (refer to the documentation).
  132491. */
  132492. diffuseTexture: Nullable<BaseTexture>;
  132493. protected _shadowLights: Nullable<IShadowLight[]>;
  132494. /**
  132495. * Specify the list of lights casting shadow on the material.
  132496. * All scene shadow lights will be included if null.
  132497. */
  132498. shadowLights: Nullable<IShadowLight[]>;
  132499. protected _shadowLevel: float;
  132500. /**
  132501. * Helps adjusting the shadow to a softer level if required.
  132502. * 0 means black shadows and 1 means no shadows.
  132503. */
  132504. shadowLevel: float;
  132505. protected _sceneCenter: Vector3;
  132506. /**
  132507. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  132508. * It is usually zero but might be interesting to modify according to your setup.
  132509. */
  132510. sceneCenter: Vector3;
  132511. protected _opacityFresnel: boolean;
  132512. /**
  132513. * This helps specifying that the material is falling off to the sky box at grazing angle.
  132514. * This helps ensuring a nice transition when the camera goes under the ground.
  132515. */
  132516. opacityFresnel: boolean;
  132517. protected _reflectionFresnel: boolean;
  132518. /**
  132519. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  132520. * This helps adding a mirror texture on the ground.
  132521. */
  132522. reflectionFresnel: boolean;
  132523. protected _reflectionFalloffDistance: number;
  132524. /**
  132525. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  132526. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  132527. */
  132528. reflectionFalloffDistance: number;
  132529. protected _reflectionAmount: number;
  132530. /**
  132531. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  132532. */
  132533. reflectionAmount: number;
  132534. protected _reflectionReflectance0: number;
  132535. /**
  132536. * This specifies the weight of the reflection at grazing angle.
  132537. */
  132538. reflectionReflectance0: number;
  132539. protected _reflectionReflectance90: number;
  132540. /**
  132541. * This specifies the weight of the reflection at a perpendicular point of view.
  132542. */
  132543. reflectionReflectance90: number;
  132544. /**
  132545. * Sets the reflection reflectance fresnel values according to the default standard
  132546. * empirically know to work well :-)
  132547. */
  132548. set reflectionStandardFresnelWeight(value: number);
  132549. protected _useRGBColor: boolean;
  132550. /**
  132551. * Helps to directly use the maps channels instead of their level.
  132552. */
  132553. useRGBColor: boolean;
  132554. protected _enableNoise: boolean;
  132555. /**
  132556. * This helps reducing the banding effect that could occur on the background.
  132557. */
  132558. enableNoise: boolean;
  132559. /**
  132560. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  132561. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  132562. * Recommended to be keep at 1.0 except for special cases.
  132563. */
  132564. get fovMultiplier(): number;
  132565. set fovMultiplier(value: number);
  132566. private _fovMultiplier;
  132567. /**
  132568. * Enable the FOV adjustment feature controlled by fovMultiplier.
  132569. */
  132570. useEquirectangularFOV: boolean;
  132571. private _maxSimultaneousLights;
  132572. /**
  132573. * Number of Simultaneous lights allowed on the material.
  132574. */
  132575. maxSimultaneousLights: int;
  132576. private _shadowOnly;
  132577. /**
  132578. * Make the material only render shadows
  132579. */
  132580. shadowOnly: boolean;
  132581. /**
  132582. * Default configuration related to image processing available in the Background Material.
  132583. */
  132584. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  132585. /**
  132586. * Keep track of the image processing observer to allow dispose and replace.
  132587. */
  132588. private _imageProcessingObserver;
  132589. /**
  132590. * Attaches a new image processing configuration to the PBR Material.
  132591. * @param configuration (if null the scene configuration will be use)
  132592. */
  132593. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  132594. /**
  132595. * Gets the image processing configuration used either in this material.
  132596. */
  132597. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  132598. /**
  132599. * Sets the Default image processing configuration used either in the this material.
  132600. *
  132601. * If sets to null, the scene one is in use.
  132602. */
  132603. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  132604. /**
  132605. * Gets wether the color curves effect is enabled.
  132606. */
  132607. get cameraColorCurvesEnabled(): boolean;
  132608. /**
  132609. * Sets wether the color curves effect is enabled.
  132610. */
  132611. set cameraColorCurvesEnabled(value: boolean);
  132612. /**
  132613. * Gets wether the color grading effect is enabled.
  132614. */
  132615. get cameraColorGradingEnabled(): boolean;
  132616. /**
  132617. * Gets wether the color grading effect is enabled.
  132618. */
  132619. set cameraColorGradingEnabled(value: boolean);
  132620. /**
  132621. * Gets wether tonemapping is enabled or not.
  132622. */
  132623. get cameraToneMappingEnabled(): boolean;
  132624. /**
  132625. * Sets wether tonemapping is enabled or not
  132626. */
  132627. set cameraToneMappingEnabled(value: boolean);
  132628. /**
  132629. * The camera exposure used on this material.
  132630. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  132631. * This corresponds to a photographic exposure.
  132632. */
  132633. get cameraExposure(): float;
  132634. /**
  132635. * The camera exposure used on this material.
  132636. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  132637. * This corresponds to a photographic exposure.
  132638. */
  132639. set cameraExposure(value: float);
  132640. /**
  132641. * Gets The camera contrast used on this material.
  132642. */
  132643. get cameraContrast(): float;
  132644. /**
  132645. * Sets The camera contrast used on this material.
  132646. */
  132647. set cameraContrast(value: float);
  132648. /**
  132649. * Gets the Color Grading 2D Lookup Texture.
  132650. */
  132651. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  132652. /**
  132653. * Sets the Color Grading 2D Lookup Texture.
  132654. */
  132655. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  132656. /**
  132657. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  132658. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  132659. * 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;
  132660. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  132661. */
  132662. get cameraColorCurves(): Nullable<ColorCurves>;
  132663. /**
  132664. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  132665. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  132666. * 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;
  132667. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  132668. */
  132669. set cameraColorCurves(value: Nullable<ColorCurves>);
  132670. /**
  132671. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  132672. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  132673. */
  132674. switchToBGR: boolean;
  132675. private _renderTargets;
  132676. private _reflectionControls;
  132677. private _white;
  132678. private _primaryShadowColor;
  132679. private _primaryHighlightColor;
  132680. /**
  132681. * Instantiates a Background Material in the given scene
  132682. * @param name The friendly name of the material
  132683. * @param scene The scene to add the material to
  132684. */
  132685. constructor(name: string, scene: Scene);
  132686. /**
  132687. * Gets a boolean indicating that current material needs to register RTT
  132688. */
  132689. get hasRenderTargetTextures(): boolean;
  132690. /**
  132691. * The entire material has been created in order to prevent overdraw.
  132692. * @returns false
  132693. */
  132694. needAlphaTesting(): boolean;
  132695. /**
  132696. * The entire material has been created in order to prevent overdraw.
  132697. * @returns true if blending is enable
  132698. */
  132699. needAlphaBlending(): boolean;
  132700. /**
  132701. * Checks wether the material is ready to be rendered for a given mesh.
  132702. * @param mesh The mesh to render
  132703. * @param subMesh The submesh to check against
  132704. * @param useInstances Specify wether or not the material is used with instances
  132705. * @returns true if all the dependencies are ready (Textures, Effects...)
  132706. */
  132707. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  132708. /**
  132709. * Compute the primary color according to the chosen perceptual color.
  132710. */
  132711. private _computePrimaryColorFromPerceptualColor;
  132712. /**
  132713. * Compute the highlights and shadow colors according to their chosen levels.
  132714. */
  132715. private _computePrimaryColors;
  132716. /**
  132717. * Build the uniform buffer used in the material.
  132718. */
  132719. buildUniformLayout(): void;
  132720. /**
  132721. * Unbind the material.
  132722. */
  132723. unbind(): void;
  132724. /**
  132725. * Bind only the world matrix to the material.
  132726. * @param world The world matrix to bind.
  132727. */
  132728. bindOnlyWorldMatrix(world: Matrix): void;
  132729. /**
  132730. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  132731. * @param world The world matrix to bind.
  132732. * @param subMesh The submesh to bind for.
  132733. */
  132734. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  132735. /**
  132736. * Checks to see if a texture is used in the material.
  132737. * @param texture - Base texture to use.
  132738. * @returns - Boolean specifying if a texture is used in the material.
  132739. */
  132740. hasTexture(texture: BaseTexture): boolean;
  132741. /**
  132742. * Dispose the material.
  132743. * @param forceDisposeEffect Force disposal of the associated effect.
  132744. * @param forceDisposeTextures Force disposal of the associated textures.
  132745. */
  132746. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  132747. /**
  132748. * Clones the material.
  132749. * @param name The cloned name.
  132750. * @returns The cloned material.
  132751. */
  132752. clone(name: string): BackgroundMaterial;
  132753. /**
  132754. * Serializes the current material to its JSON representation.
  132755. * @returns The JSON representation.
  132756. */
  132757. serialize(): any;
  132758. /**
  132759. * Gets the class name of the material
  132760. * @returns "BackgroundMaterial"
  132761. */
  132762. getClassName(): string;
  132763. /**
  132764. * Parse a JSON input to create back a background material.
  132765. * @param source The JSON data to parse
  132766. * @param scene The scene to create the parsed material in
  132767. * @param rootUrl The root url of the assets the material depends upon
  132768. * @returns the instantiated BackgroundMaterial.
  132769. */
  132770. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  132771. }
  132772. }
  132773. declare module BABYLON {
  132774. /**
  132775. * Represents the different options available during the creation of
  132776. * a Environment helper.
  132777. *
  132778. * This can control the default ground, skybox and image processing setup of your scene.
  132779. */
  132780. export interface IEnvironmentHelperOptions {
  132781. /**
  132782. * Specifies whether or not to create a ground.
  132783. * True by default.
  132784. */
  132785. createGround: boolean;
  132786. /**
  132787. * Specifies the ground size.
  132788. * 15 by default.
  132789. */
  132790. groundSize: number;
  132791. /**
  132792. * The texture used on the ground for the main color.
  132793. * Comes from the BabylonJS CDN by default.
  132794. *
  132795. * Remarks: Can be either a texture or a url.
  132796. */
  132797. groundTexture: string | BaseTexture;
  132798. /**
  132799. * The color mixed in the ground texture by default.
  132800. * BabylonJS clearColor by default.
  132801. */
  132802. groundColor: Color3;
  132803. /**
  132804. * Specifies the ground opacity.
  132805. * 1 by default.
  132806. */
  132807. groundOpacity: number;
  132808. /**
  132809. * Enables the ground to receive shadows.
  132810. * True by default.
  132811. */
  132812. enableGroundShadow: boolean;
  132813. /**
  132814. * Helps preventing the shadow to be fully black on the ground.
  132815. * 0.5 by default.
  132816. */
  132817. groundShadowLevel: number;
  132818. /**
  132819. * Creates a mirror texture attach to the ground.
  132820. * false by default.
  132821. */
  132822. enableGroundMirror: boolean;
  132823. /**
  132824. * Specifies the ground mirror size ratio.
  132825. * 0.3 by default as the default kernel is 64.
  132826. */
  132827. groundMirrorSizeRatio: number;
  132828. /**
  132829. * Specifies the ground mirror blur kernel size.
  132830. * 64 by default.
  132831. */
  132832. groundMirrorBlurKernel: number;
  132833. /**
  132834. * Specifies the ground mirror visibility amount.
  132835. * 1 by default
  132836. */
  132837. groundMirrorAmount: number;
  132838. /**
  132839. * Specifies the ground mirror reflectance weight.
  132840. * This uses the standard weight of the background material to setup the fresnel effect
  132841. * of the mirror.
  132842. * 1 by default.
  132843. */
  132844. groundMirrorFresnelWeight: number;
  132845. /**
  132846. * Specifies the ground mirror Falloff distance.
  132847. * This can helps reducing the size of the reflection.
  132848. * 0 by Default.
  132849. */
  132850. groundMirrorFallOffDistance: number;
  132851. /**
  132852. * Specifies the ground mirror texture type.
  132853. * Unsigned Int by Default.
  132854. */
  132855. groundMirrorTextureType: number;
  132856. /**
  132857. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  132858. * the shown objects.
  132859. */
  132860. groundYBias: number;
  132861. /**
  132862. * Specifies whether or not to create a skybox.
  132863. * True by default.
  132864. */
  132865. createSkybox: boolean;
  132866. /**
  132867. * Specifies the skybox size.
  132868. * 20 by default.
  132869. */
  132870. skyboxSize: number;
  132871. /**
  132872. * The texture used on the skybox for the main color.
  132873. * Comes from the BabylonJS CDN by default.
  132874. *
  132875. * Remarks: Can be either a texture or a url.
  132876. */
  132877. skyboxTexture: string | BaseTexture;
  132878. /**
  132879. * The color mixed in the skybox texture by default.
  132880. * BabylonJS clearColor by default.
  132881. */
  132882. skyboxColor: Color3;
  132883. /**
  132884. * The background rotation around the Y axis of the scene.
  132885. * This helps aligning the key lights of your scene with the background.
  132886. * 0 by default.
  132887. */
  132888. backgroundYRotation: number;
  132889. /**
  132890. * Compute automatically the size of the elements to best fit with the scene.
  132891. */
  132892. sizeAuto: boolean;
  132893. /**
  132894. * Default position of the rootMesh if autoSize is not true.
  132895. */
  132896. rootPosition: Vector3;
  132897. /**
  132898. * Sets up the image processing in the scene.
  132899. * true by default.
  132900. */
  132901. setupImageProcessing: boolean;
  132902. /**
  132903. * The texture used as your environment texture in the scene.
  132904. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  132905. *
  132906. * Remarks: Can be either a texture or a url.
  132907. */
  132908. environmentTexture: string | BaseTexture;
  132909. /**
  132910. * The value of the exposure to apply to the scene.
  132911. * 0.6 by default if setupImageProcessing is true.
  132912. */
  132913. cameraExposure: number;
  132914. /**
  132915. * The value of the contrast to apply to the scene.
  132916. * 1.6 by default if setupImageProcessing is true.
  132917. */
  132918. cameraContrast: number;
  132919. /**
  132920. * Specifies whether or not tonemapping should be enabled in the scene.
  132921. * true by default if setupImageProcessing is true.
  132922. */
  132923. toneMappingEnabled: boolean;
  132924. }
  132925. /**
  132926. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  132927. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  132928. * It also helps with the default setup of your imageProcessing configuration.
  132929. */
  132930. export class EnvironmentHelper {
  132931. /**
  132932. * Default ground texture URL.
  132933. */
  132934. private static _groundTextureCDNUrl;
  132935. /**
  132936. * Default skybox texture URL.
  132937. */
  132938. private static _skyboxTextureCDNUrl;
  132939. /**
  132940. * Default environment texture URL.
  132941. */
  132942. private static _environmentTextureCDNUrl;
  132943. /**
  132944. * Creates the default options for the helper.
  132945. */
  132946. private static _getDefaultOptions;
  132947. private _rootMesh;
  132948. /**
  132949. * Gets the root mesh created by the helper.
  132950. */
  132951. get rootMesh(): Mesh;
  132952. private _skybox;
  132953. /**
  132954. * Gets the skybox created by the helper.
  132955. */
  132956. get skybox(): Nullable<Mesh>;
  132957. private _skyboxTexture;
  132958. /**
  132959. * Gets the skybox texture created by the helper.
  132960. */
  132961. get skyboxTexture(): Nullable<BaseTexture>;
  132962. private _skyboxMaterial;
  132963. /**
  132964. * Gets the skybox material created by the helper.
  132965. */
  132966. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  132967. private _ground;
  132968. /**
  132969. * Gets the ground mesh created by the helper.
  132970. */
  132971. get ground(): Nullable<Mesh>;
  132972. private _groundTexture;
  132973. /**
  132974. * Gets the ground texture created by the helper.
  132975. */
  132976. get groundTexture(): Nullable<BaseTexture>;
  132977. private _groundMirror;
  132978. /**
  132979. * Gets the ground mirror created by the helper.
  132980. */
  132981. get groundMirror(): Nullable<MirrorTexture>;
  132982. /**
  132983. * Gets the ground mirror render list to helps pushing the meshes
  132984. * you wish in the ground reflection.
  132985. */
  132986. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  132987. private _groundMaterial;
  132988. /**
  132989. * Gets the ground material created by the helper.
  132990. */
  132991. get groundMaterial(): Nullable<BackgroundMaterial>;
  132992. /**
  132993. * Stores the creation options.
  132994. */
  132995. private readonly _scene;
  132996. private _options;
  132997. /**
  132998. * This observable will be notified with any error during the creation of the environment,
  132999. * mainly texture creation errors.
  133000. */
  133001. onErrorObservable: Observable<{
  133002. message?: string;
  133003. exception?: any;
  133004. }>;
  133005. /**
  133006. * constructor
  133007. * @param options Defines the options we want to customize the helper
  133008. * @param scene The scene to add the material to
  133009. */
  133010. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  133011. /**
  133012. * Updates the background according to the new options
  133013. * @param options
  133014. */
  133015. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  133016. /**
  133017. * Sets the primary color of all the available elements.
  133018. * @param color the main color to affect to the ground and the background
  133019. */
  133020. setMainColor(color: Color3): void;
  133021. /**
  133022. * Setup the image processing according to the specified options.
  133023. */
  133024. private _setupImageProcessing;
  133025. /**
  133026. * Setup the environment texture according to the specified options.
  133027. */
  133028. private _setupEnvironmentTexture;
  133029. /**
  133030. * Setup the background according to the specified options.
  133031. */
  133032. private _setupBackground;
  133033. /**
  133034. * Get the scene sizes according to the setup.
  133035. */
  133036. private _getSceneSize;
  133037. /**
  133038. * Setup the ground according to the specified options.
  133039. */
  133040. private _setupGround;
  133041. /**
  133042. * Setup the ground material according to the specified options.
  133043. */
  133044. private _setupGroundMaterial;
  133045. /**
  133046. * Setup the ground diffuse texture according to the specified options.
  133047. */
  133048. private _setupGroundDiffuseTexture;
  133049. /**
  133050. * Setup the ground mirror texture according to the specified options.
  133051. */
  133052. private _setupGroundMirrorTexture;
  133053. /**
  133054. * Setup the ground to receive the mirror texture.
  133055. */
  133056. private _setupMirrorInGroundMaterial;
  133057. /**
  133058. * Setup the skybox according to the specified options.
  133059. */
  133060. private _setupSkybox;
  133061. /**
  133062. * Setup the skybox material according to the specified options.
  133063. */
  133064. private _setupSkyboxMaterial;
  133065. /**
  133066. * Setup the skybox reflection texture according to the specified options.
  133067. */
  133068. private _setupSkyboxReflectionTexture;
  133069. private _errorHandler;
  133070. /**
  133071. * Dispose all the elements created by the Helper.
  133072. */
  133073. dispose(): void;
  133074. }
  133075. }
  133076. declare module BABYLON {
  133077. /**
  133078. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  133079. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  133080. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  133081. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  133082. */
  133083. export class PhotoDome extends TransformNode {
  133084. /**
  133085. * Define the image as a Monoscopic panoramic 360 image.
  133086. */
  133087. static readonly MODE_MONOSCOPIC: number;
  133088. /**
  133089. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  133090. */
  133091. static readonly MODE_TOPBOTTOM: number;
  133092. /**
  133093. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  133094. */
  133095. static readonly MODE_SIDEBYSIDE: number;
  133096. private _useDirectMapping;
  133097. /**
  133098. * The texture being displayed on the sphere
  133099. */
  133100. protected _photoTexture: Texture;
  133101. /**
  133102. * Gets or sets the texture being displayed on the sphere
  133103. */
  133104. get photoTexture(): Texture;
  133105. set photoTexture(value: Texture);
  133106. /**
  133107. * Observable raised when an error occured while loading the 360 image
  133108. */
  133109. onLoadErrorObservable: Observable<string>;
  133110. /**
  133111. * The skybox material
  133112. */
  133113. protected _material: BackgroundMaterial;
  133114. /**
  133115. * The surface used for the skybox
  133116. */
  133117. protected _mesh: Mesh;
  133118. /**
  133119. * Gets the mesh used for the skybox.
  133120. */
  133121. get mesh(): Mesh;
  133122. /**
  133123. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  133124. * Also see the options.resolution property.
  133125. */
  133126. get fovMultiplier(): number;
  133127. set fovMultiplier(value: number);
  133128. private _imageMode;
  133129. /**
  133130. * Gets or set the current video mode for the video. It can be:
  133131. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  133132. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  133133. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  133134. */
  133135. get imageMode(): number;
  133136. set imageMode(value: number);
  133137. /**
  133138. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  133139. * @param name Element's name, child elements will append suffixes for their own names.
  133140. * @param urlsOfPhoto defines the url of the photo to display
  133141. * @param options defines an object containing optional or exposed sub element properties
  133142. * @param onError defines a callback called when an error occured while loading the texture
  133143. */
  133144. constructor(name: string, urlOfPhoto: string, options: {
  133145. resolution?: number;
  133146. size?: number;
  133147. useDirectMapping?: boolean;
  133148. faceForward?: boolean;
  133149. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  133150. private _onBeforeCameraRenderObserver;
  133151. private _changeImageMode;
  133152. /**
  133153. * Releases resources associated with this node.
  133154. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  133155. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  133156. */
  133157. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  133158. }
  133159. }
  133160. declare module BABYLON {
  133161. /**
  133162. * Class used to host RGBD texture specific utilities
  133163. */
  133164. export class RGBDTextureTools {
  133165. /**
  133166. * Expand the RGBD Texture from RGBD to Half Float if possible.
  133167. * @param texture the texture to expand.
  133168. */
  133169. static ExpandRGBDTexture(texture: Texture): void;
  133170. }
  133171. }
  133172. declare module BABYLON {
  133173. /**
  133174. * Class used to host texture specific utilities
  133175. */
  133176. export class BRDFTextureTools {
  133177. /**
  133178. * Prevents texture cache collision
  133179. */
  133180. private static _instanceNumber;
  133181. /**
  133182. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  133183. * @param scene defines the hosting scene
  133184. * @returns the environment BRDF texture
  133185. */
  133186. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  133187. private static _environmentBRDFBase64Texture;
  133188. }
  133189. }
  133190. declare module BABYLON {
  133191. /**
  133192. * @hidden
  133193. */
  133194. export interface IMaterialClearCoatDefines {
  133195. CLEARCOAT: boolean;
  133196. CLEARCOAT_DEFAULTIOR: boolean;
  133197. CLEARCOAT_TEXTURE: boolean;
  133198. CLEARCOAT_TEXTUREDIRECTUV: number;
  133199. CLEARCOAT_BUMP: boolean;
  133200. CLEARCOAT_BUMPDIRECTUV: number;
  133201. CLEARCOAT_TINT: boolean;
  133202. CLEARCOAT_TINT_TEXTURE: boolean;
  133203. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  133204. /** @hidden */
  133205. _areTexturesDirty: boolean;
  133206. }
  133207. /**
  133208. * Define the code related to the clear coat parameters of the pbr material.
  133209. */
  133210. export class PBRClearCoatConfiguration {
  133211. /**
  133212. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  133213. * The default fits with a polyurethane material.
  133214. */
  133215. private static readonly _DefaultIndexOfRefraction;
  133216. private _isEnabled;
  133217. /**
  133218. * Defines if the clear coat is enabled in the material.
  133219. */
  133220. isEnabled: boolean;
  133221. /**
  133222. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  133223. */
  133224. intensity: number;
  133225. /**
  133226. * Defines the clear coat layer roughness.
  133227. */
  133228. roughness: number;
  133229. private _indexOfRefraction;
  133230. /**
  133231. * Defines the index of refraction of the clear coat.
  133232. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  133233. * The default fits with a polyurethane material.
  133234. * Changing the default value is more performance intensive.
  133235. */
  133236. indexOfRefraction: number;
  133237. private _texture;
  133238. /**
  133239. * Stores the clear coat values in a texture.
  133240. */
  133241. texture: Nullable<BaseTexture>;
  133242. private _bumpTexture;
  133243. /**
  133244. * Define the clear coat specific bump texture.
  133245. */
  133246. bumpTexture: Nullable<BaseTexture>;
  133247. private _isTintEnabled;
  133248. /**
  133249. * Defines if the clear coat tint is enabled in the material.
  133250. */
  133251. isTintEnabled: boolean;
  133252. /**
  133253. * Defines the clear coat tint of the material.
  133254. * This is only use if tint is enabled
  133255. */
  133256. tintColor: Color3;
  133257. /**
  133258. * Defines the distance at which the tint color should be found in the
  133259. * clear coat media.
  133260. * This is only use if tint is enabled
  133261. */
  133262. tintColorAtDistance: number;
  133263. /**
  133264. * Defines the clear coat layer thickness.
  133265. * This is only use if tint is enabled
  133266. */
  133267. tintThickness: number;
  133268. private _tintTexture;
  133269. /**
  133270. * Stores the clear tint values in a texture.
  133271. * rgb is tint
  133272. * a is a thickness factor
  133273. */
  133274. tintTexture: Nullable<BaseTexture>;
  133275. /** @hidden */
  133276. private _internalMarkAllSubMeshesAsTexturesDirty;
  133277. /** @hidden */
  133278. _markAllSubMeshesAsTexturesDirty(): void;
  133279. /**
  133280. * Instantiate a new istance of clear coat configuration.
  133281. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133282. */
  133283. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133284. /**
  133285. * Gets wehter the submesh is ready to be used or not.
  133286. * @param defines the list of "defines" to update.
  133287. * @param scene defines the scene the material belongs to.
  133288. * @param engine defines the engine the material belongs to.
  133289. * @param disableBumpMap defines wether the material disables bump or not.
  133290. * @returns - boolean indicating that the submesh is ready or not.
  133291. */
  133292. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  133293. /**
  133294. * Checks to see if a texture is used in the material.
  133295. * @param defines the list of "defines" to update.
  133296. * @param scene defines the scene to the material belongs to.
  133297. */
  133298. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  133299. /**
  133300. * Binds the material data.
  133301. * @param uniformBuffer defines the Uniform buffer to fill in.
  133302. * @param scene defines the scene the material belongs to.
  133303. * @param engine defines the engine the material belongs to.
  133304. * @param disableBumpMap defines wether the material disables bump or not.
  133305. * @param isFrozen defines wether the material is frozen or not.
  133306. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  133307. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  133308. */
  133309. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  133310. /**
  133311. * Checks to see if a texture is used in the material.
  133312. * @param texture - Base texture to use.
  133313. * @returns - Boolean specifying if a texture is used in the material.
  133314. */
  133315. hasTexture(texture: BaseTexture): boolean;
  133316. /**
  133317. * Returns an array of the actively used textures.
  133318. * @param activeTextures Array of BaseTextures
  133319. */
  133320. getActiveTextures(activeTextures: BaseTexture[]): void;
  133321. /**
  133322. * Returns the animatable textures.
  133323. * @param animatables Array of animatable textures.
  133324. */
  133325. getAnimatables(animatables: IAnimatable[]): void;
  133326. /**
  133327. * Disposes the resources of the material.
  133328. * @param forceDisposeTextures - Forces the disposal of all textures.
  133329. */
  133330. dispose(forceDisposeTextures?: boolean): void;
  133331. /**
  133332. * Get the current class name of the texture useful for serialization or dynamic coding.
  133333. * @returns "PBRClearCoatConfiguration"
  133334. */
  133335. getClassName(): string;
  133336. /**
  133337. * Add fallbacks to the effect fallbacks list.
  133338. * @param defines defines the Base texture to use.
  133339. * @param fallbacks defines the current fallback list.
  133340. * @param currentRank defines the current fallback rank.
  133341. * @returns the new fallback rank.
  133342. */
  133343. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133344. /**
  133345. * Add the required uniforms to the current list.
  133346. * @param uniforms defines the current uniform list.
  133347. */
  133348. static AddUniforms(uniforms: string[]): void;
  133349. /**
  133350. * Add the required samplers to the current list.
  133351. * @param samplers defines the current sampler list.
  133352. */
  133353. static AddSamplers(samplers: string[]): void;
  133354. /**
  133355. * Add the required uniforms to the current buffer.
  133356. * @param uniformBuffer defines the current uniform buffer.
  133357. */
  133358. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133359. /**
  133360. * Makes a duplicate of the current configuration into another one.
  133361. * @param clearCoatConfiguration define the config where to copy the info
  133362. */
  133363. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  133364. /**
  133365. * Serializes this clear coat configuration.
  133366. * @returns - An object with the serialized config.
  133367. */
  133368. serialize(): any;
  133369. /**
  133370. * Parses a anisotropy Configuration from a serialized object.
  133371. * @param source - Serialized object.
  133372. * @param scene Defines the scene we are parsing for
  133373. * @param rootUrl Defines the rootUrl to load from
  133374. */
  133375. parse(source: any, scene: Scene, rootUrl: string): void;
  133376. }
  133377. }
  133378. declare module BABYLON {
  133379. /**
  133380. * @hidden
  133381. */
  133382. export interface IMaterialAnisotropicDefines {
  133383. ANISOTROPIC: boolean;
  133384. ANISOTROPIC_TEXTURE: boolean;
  133385. ANISOTROPIC_TEXTUREDIRECTUV: number;
  133386. MAINUV1: boolean;
  133387. _areTexturesDirty: boolean;
  133388. _needUVs: boolean;
  133389. }
  133390. /**
  133391. * Define the code related to the anisotropic parameters of the pbr material.
  133392. */
  133393. export class PBRAnisotropicConfiguration {
  133394. private _isEnabled;
  133395. /**
  133396. * Defines if the anisotropy is enabled in the material.
  133397. */
  133398. isEnabled: boolean;
  133399. /**
  133400. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  133401. */
  133402. intensity: number;
  133403. /**
  133404. * Defines if the effect is along the tangents, bitangents or in between.
  133405. * By default, the effect is "strectching" the highlights along the tangents.
  133406. */
  133407. direction: Vector2;
  133408. private _texture;
  133409. /**
  133410. * Stores the anisotropy values in a texture.
  133411. * rg is direction (like normal from -1 to 1)
  133412. * b is a intensity
  133413. */
  133414. texture: Nullable<BaseTexture>;
  133415. /** @hidden */
  133416. private _internalMarkAllSubMeshesAsTexturesDirty;
  133417. /** @hidden */
  133418. _markAllSubMeshesAsTexturesDirty(): void;
  133419. /**
  133420. * Instantiate a new istance of anisotropy configuration.
  133421. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133422. */
  133423. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133424. /**
  133425. * Specifies that the submesh is ready to be used.
  133426. * @param defines the list of "defines" to update.
  133427. * @param scene defines the scene the material belongs to.
  133428. * @returns - boolean indicating that the submesh is ready or not.
  133429. */
  133430. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  133431. /**
  133432. * Checks to see if a texture is used in the material.
  133433. * @param defines the list of "defines" to update.
  133434. * @param mesh the mesh we are preparing the defines for.
  133435. * @param scene defines the scene the material belongs to.
  133436. */
  133437. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  133438. /**
  133439. * Binds the material data.
  133440. * @param uniformBuffer defines the Uniform buffer to fill in.
  133441. * @param scene defines the scene the material belongs to.
  133442. * @param isFrozen defines wether the material is frozen or not.
  133443. */
  133444. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  133445. /**
  133446. * Checks to see if a texture is used in the material.
  133447. * @param texture - Base texture to use.
  133448. * @returns - Boolean specifying if a texture is used in the material.
  133449. */
  133450. hasTexture(texture: BaseTexture): boolean;
  133451. /**
  133452. * Returns an array of the actively used textures.
  133453. * @param activeTextures Array of BaseTextures
  133454. */
  133455. getActiveTextures(activeTextures: BaseTexture[]): void;
  133456. /**
  133457. * Returns the animatable textures.
  133458. * @param animatables Array of animatable textures.
  133459. */
  133460. getAnimatables(animatables: IAnimatable[]): void;
  133461. /**
  133462. * Disposes the resources of the material.
  133463. * @param forceDisposeTextures - Forces the disposal of all textures.
  133464. */
  133465. dispose(forceDisposeTextures?: boolean): void;
  133466. /**
  133467. * Get the current class name of the texture useful for serialization or dynamic coding.
  133468. * @returns "PBRAnisotropicConfiguration"
  133469. */
  133470. getClassName(): string;
  133471. /**
  133472. * Add fallbacks to the effect fallbacks list.
  133473. * @param defines defines the Base texture to use.
  133474. * @param fallbacks defines the current fallback list.
  133475. * @param currentRank defines the current fallback rank.
  133476. * @returns the new fallback rank.
  133477. */
  133478. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133479. /**
  133480. * Add the required uniforms to the current list.
  133481. * @param uniforms defines the current uniform list.
  133482. */
  133483. static AddUniforms(uniforms: string[]): void;
  133484. /**
  133485. * Add the required uniforms to the current buffer.
  133486. * @param uniformBuffer defines the current uniform buffer.
  133487. */
  133488. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133489. /**
  133490. * Add the required samplers to the current list.
  133491. * @param samplers defines the current sampler list.
  133492. */
  133493. static AddSamplers(samplers: string[]): void;
  133494. /**
  133495. * Makes a duplicate of the current configuration into another one.
  133496. * @param anisotropicConfiguration define the config where to copy the info
  133497. */
  133498. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  133499. /**
  133500. * Serializes this anisotropy configuration.
  133501. * @returns - An object with the serialized config.
  133502. */
  133503. serialize(): any;
  133504. /**
  133505. * Parses a anisotropy Configuration from a serialized object.
  133506. * @param source - Serialized object.
  133507. * @param scene Defines the scene we are parsing for
  133508. * @param rootUrl Defines the rootUrl to load from
  133509. */
  133510. parse(source: any, scene: Scene, rootUrl: string): void;
  133511. }
  133512. }
  133513. declare module BABYLON {
  133514. /**
  133515. * @hidden
  133516. */
  133517. export interface IMaterialBRDFDefines {
  133518. BRDF_V_HEIGHT_CORRELATED: boolean;
  133519. MS_BRDF_ENERGY_CONSERVATION: boolean;
  133520. SPHERICAL_HARMONICS: boolean;
  133521. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  133522. /** @hidden */
  133523. _areMiscDirty: boolean;
  133524. }
  133525. /**
  133526. * Define the code related to the BRDF parameters of the pbr material.
  133527. */
  133528. export class PBRBRDFConfiguration {
  133529. /**
  133530. * Default value used for the energy conservation.
  133531. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  133532. */
  133533. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  133534. /**
  133535. * Default value used for the Smith Visibility Height Correlated mode.
  133536. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  133537. */
  133538. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  133539. /**
  133540. * Default value used for the IBL diffuse part.
  133541. * This can help switching back to the polynomials mode globally which is a tiny bit
  133542. * less GPU intensive at the drawback of a lower quality.
  133543. */
  133544. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  133545. /**
  133546. * Default value used for activating energy conservation for the specular workflow.
  133547. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  133548. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  133549. */
  133550. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  133551. private _useEnergyConservation;
  133552. /**
  133553. * Defines if the material uses energy conservation.
  133554. */
  133555. useEnergyConservation: boolean;
  133556. private _useSmithVisibilityHeightCorrelated;
  133557. /**
  133558. * LEGACY Mode set to false
  133559. * Defines if the material uses height smith correlated visibility term.
  133560. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  133561. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  133562. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  133563. * Not relying on height correlated will also disable energy conservation.
  133564. */
  133565. useSmithVisibilityHeightCorrelated: boolean;
  133566. private _useSphericalHarmonics;
  133567. /**
  133568. * LEGACY Mode set to false
  133569. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  133570. * diffuse part of the IBL.
  133571. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  133572. * to the ground truth.
  133573. */
  133574. useSphericalHarmonics: boolean;
  133575. private _useSpecularGlossinessInputEnergyConservation;
  133576. /**
  133577. * Defines if the material uses energy conservation, when the specular workflow is active.
  133578. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  133579. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  133580. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  133581. */
  133582. useSpecularGlossinessInputEnergyConservation: boolean;
  133583. /** @hidden */
  133584. private _internalMarkAllSubMeshesAsMiscDirty;
  133585. /** @hidden */
  133586. _markAllSubMeshesAsMiscDirty(): void;
  133587. /**
  133588. * Instantiate a new istance of clear coat configuration.
  133589. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  133590. */
  133591. constructor(markAllSubMeshesAsMiscDirty: () => void);
  133592. /**
  133593. * Checks to see if a texture is used in the material.
  133594. * @param defines the list of "defines" to update.
  133595. */
  133596. prepareDefines(defines: IMaterialBRDFDefines): void;
  133597. /**
  133598. * Get the current class name of the texture useful for serialization or dynamic coding.
  133599. * @returns "PBRClearCoatConfiguration"
  133600. */
  133601. getClassName(): string;
  133602. /**
  133603. * Makes a duplicate of the current configuration into another one.
  133604. * @param brdfConfiguration define the config where to copy the info
  133605. */
  133606. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  133607. /**
  133608. * Serializes this BRDF configuration.
  133609. * @returns - An object with the serialized config.
  133610. */
  133611. serialize(): any;
  133612. /**
  133613. * Parses a anisotropy Configuration from a serialized object.
  133614. * @param source - Serialized object.
  133615. * @param scene Defines the scene we are parsing for
  133616. * @param rootUrl Defines the rootUrl to load from
  133617. */
  133618. parse(source: any, scene: Scene, rootUrl: string): void;
  133619. }
  133620. }
  133621. declare module BABYLON {
  133622. /**
  133623. * @hidden
  133624. */
  133625. export interface IMaterialSheenDefines {
  133626. SHEEN: boolean;
  133627. SHEEN_TEXTURE: boolean;
  133628. SHEEN_TEXTUREDIRECTUV: number;
  133629. SHEEN_LINKWITHALBEDO: boolean;
  133630. SHEEN_ROUGHNESS: boolean;
  133631. SHEEN_ALBEDOSCALING: boolean;
  133632. /** @hidden */
  133633. _areTexturesDirty: boolean;
  133634. }
  133635. /**
  133636. * Define the code related to the Sheen parameters of the pbr material.
  133637. */
  133638. export class PBRSheenConfiguration {
  133639. private _isEnabled;
  133640. /**
  133641. * Defines if the material uses sheen.
  133642. */
  133643. isEnabled: boolean;
  133644. private _linkSheenWithAlbedo;
  133645. /**
  133646. * Defines if the sheen is linked to the sheen color.
  133647. */
  133648. linkSheenWithAlbedo: boolean;
  133649. /**
  133650. * Defines the sheen intensity.
  133651. */
  133652. intensity: number;
  133653. /**
  133654. * Defines the sheen color.
  133655. */
  133656. color: Color3;
  133657. private _texture;
  133658. /**
  133659. * Stores the sheen tint values in a texture.
  133660. * rgb is tint
  133661. * a is a intensity or roughness if roughness has been defined
  133662. */
  133663. texture: Nullable<BaseTexture>;
  133664. private _roughness;
  133665. /**
  133666. * Defines the sheen roughness.
  133667. * It is not taken into account if linkSheenWithAlbedo is true.
  133668. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  133669. */
  133670. roughness: Nullable<number>;
  133671. private _albedoScaling;
  133672. /**
  133673. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  133674. * It allows the strength of the sheen effect to not depend on the base color of the material,
  133675. * making it easier to setup and tweak the effect
  133676. */
  133677. albedoScaling: boolean;
  133678. /** @hidden */
  133679. private _internalMarkAllSubMeshesAsTexturesDirty;
  133680. /** @hidden */
  133681. _markAllSubMeshesAsTexturesDirty(): void;
  133682. /**
  133683. * Instantiate a new istance of clear coat configuration.
  133684. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133685. */
  133686. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133687. /**
  133688. * Specifies that the submesh is ready to be used.
  133689. * @param defines the list of "defines" to update.
  133690. * @param scene defines the scene the material belongs to.
  133691. * @returns - boolean indicating that the submesh is ready or not.
  133692. */
  133693. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  133694. /**
  133695. * Checks to see if a texture is used in the material.
  133696. * @param defines the list of "defines" to update.
  133697. * @param scene defines the scene the material belongs to.
  133698. */
  133699. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  133700. /**
  133701. * Binds the material data.
  133702. * @param uniformBuffer defines the Uniform buffer to fill in.
  133703. * @param scene defines the scene the material belongs to.
  133704. * @param isFrozen defines wether the material is frozen or not.
  133705. */
  133706. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  133707. /**
  133708. * Checks to see if a texture is used in the material.
  133709. * @param texture - Base texture to use.
  133710. * @returns - Boolean specifying if a texture is used in the material.
  133711. */
  133712. hasTexture(texture: BaseTexture): boolean;
  133713. /**
  133714. * Returns an array of the actively used textures.
  133715. * @param activeTextures Array of BaseTextures
  133716. */
  133717. getActiveTextures(activeTextures: BaseTexture[]): void;
  133718. /**
  133719. * Returns the animatable textures.
  133720. * @param animatables Array of animatable textures.
  133721. */
  133722. getAnimatables(animatables: IAnimatable[]): void;
  133723. /**
  133724. * Disposes the resources of the material.
  133725. * @param forceDisposeTextures - Forces the disposal of all textures.
  133726. */
  133727. dispose(forceDisposeTextures?: boolean): void;
  133728. /**
  133729. * Get the current class name of the texture useful for serialization or dynamic coding.
  133730. * @returns "PBRSheenConfiguration"
  133731. */
  133732. getClassName(): string;
  133733. /**
  133734. * Add fallbacks to the effect fallbacks list.
  133735. * @param defines defines the Base texture to use.
  133736. * @param fallbacks defines the current fallback list.
  133737. * @param currentRank defines the current fallback rank.
  133738. * @returns the new fallback rank.
  133739. */
  133740. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133741. /**
  133742. * Add the required uniforms to the current list.
  133743. * @param uniforms defines the current uniform list.
  133744. */
  133745. static AddUniforms(uniforms: string[]): void;
  133746. /**
  133747. * Add the required uniforms to the current buffer.
  133748. * @param uniformBuffer defines the current uniform buffer.
  133749. */
  133750. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133751. /**
  133752. * Add the required samplers to the current list.
  133753. * @param samplers defines the current sampler list.
  133754. */
  133755. static AddSamplers(samplers: string[]): void;
  133756. /**
  133757. * Makes a duplicate of the current configuration into another one.
  133758. * @param sheenConfiguration define the config where to copy the info
  133759. */
  133760. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  133761. /**
  133762. * Serializes this BRDF configuration.
  133763. * @returns - An object with the serialized config.
  133764. */
  133765. serialize(): any;
  133766. /**
  133767. * Parses a anisotropy Configuration from a serialized object.
  133768. * @param source - Serialized object.
  133769. * @param scene Defines the scene we are parsing for
  133770. * @param rootUrl Defines the rootUrl to load from
  133771. */
  133772. parse(source: any, scene: Scene, rootUrl: string): void;
  133773. }
  133774. }
  133775. declare module BABYLON {
  133776. /**
  133777. * @hidden
  133778. */
  133779. export interface IMaterialSubSurfaceDefines {
  133780. SUBSURFACE: boolean;
  133781. SS_REFRACTION: boolean;
  133782. SS_TRANSLUCENCY: boolean;
  133783. SS_SCATTERING: boolean;
  133784. SS_THICKNESSANDMASK_TEXTURE: boolean;
  133785. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  133786. SS_REFRACTIONMAP_3D: boolean;
  133787. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  133788. SS_LODINREFRACTIONALPHA: boolean;
  133789. SS_GAMMAREFRACTION: boolean;
  133790. SS_RGBDREFRACTION: boolean;
  133791. SS_LINEARSPECULARREFRACTION: boolean;
  133792. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  133793. SS_ALBEDOFORREFRACTIONTINT: boolean;
  133794. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  133795. /** @hidden */
  133796. _areTexturesDirty: boolean;
  133797. }
  133798. /**
  133799. * Define the code related to the sub surface parameters of the pbr material.
  133800. */
  133801. export class PBRSubSurfaceConfiguration {
  133802. private _isRefractionEnabled;
  133803. /**
  133804. * Defines if the refraction is enabled in the material.
  133805. */
  133806. isRefractionEnabled: boolean;
  133807. private _isTranslucencyEnabled;
  133808. /**
  133809. * Defines if the translucency is enabled in the material.
  133810. */
  133811. isTranslucencyEnabled: boolean;
  133812. private _isScatteringEnabled;
  133813. /**
  133814. * Defines if the sub surface scattering is enabled in the material.
  133815. */
  133816. isScatteringEnabled: boolean;
  133817. private _scatteringDiffusionProfileIndex;
  133818. /**
  133819. * Diffusion profile for subsurface scattering.
  133820. * Useful for better scattering in the skins or foliages.
  133821. */
  133822. get scatteringDiffusionProfile(): Nullable<Color3>;
  133823. set scatteringDiffusionProfile(c: Nullable<Color3>);
  133824. /**
  133825. * Defines the refraction intensity of the material.
  133826. * The refraction when enabled replaces the Diffuse part of the material.
  133827. * The intensity helps transitionning between diffuse and refraction.
  133828. */
  133829. refractionIntensity: number;
  133830. /**
  133831. * Defines the translucency intensity of the material.
  133832. * When translucency has been enabled, this defines how much of the "translucency"
  133833. * is addded to the diffuse part of the material.
  133834. */
  133835. translucencyIntensity: number;
  133836. /**
  133837. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  133838. */
  133839. useAlbedoToTintRefraction: boolean;
  133840. private _thicknessTexture;
  133841. /**
  133842. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  133843. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  133844. * 0 would mean minimumThickness
  133845. * 1 would mean maximumThickness
  133846. * The other channels might be use as a mask to vary the different effects intensity.
  133847. */
  133848. thicknessTexture: Nullable<BaseTexture>;
  133849. private _refractionTexture;
  133850. /**
  133851. * Defines the texture to use for refraction.
  133852. */
  133853. refractionTexture: Nullable<BaseTexture>;
  133854. private _indexOfRefraction;
  133855. /**
  133856. * Index of refraction of the material base layer.
  133857. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  133858. *
  133859. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  133860. *
  133861. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  133862. */
  133863. indexOfRefraction: number;
  133864. private _volumeIndexOfRefraction;
  133865. /**
  133866. * Index of refraction of the material's volume.
  133867. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  133868. *
  133869. * This ONLY impacts refraction. If not provided or given a non-valid value,
  133870. * the volume will use the same IOR as the surface.
  133871. */
  133872. get volumeIndexOfRefraction(): number;
  133873. set volumeIndexOfRefraction(value: number);
  133874. private _invertRefractionY;
  133875. /**
  133876. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  133877. */
  133878. invertRefractionY: boolean;
  133879. private _linkRefractionWithTransparency;
  133880. /**
  133881. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  133882. * Materials half opaque for instance using refraction could benefit from this control.
  133883. */
  133884. linkRefractionWithTransparency: boolean;
  133885. /**
  133886. * Defines the minimum thickness stored in the thickness map.
  133887. * If no thickness map is defined, this value will be used to simulate thickness.
  133888. */
  133889. minimumThickness: number;
  133890. /**
  133891. * Defines the maximum thickness stored in the thickness map.
  133892. */
  133893. maximumThickness: number;
  133894. /**
  133895. * Defines the volume tint of the material.
  133896. * This is used for both translucency and scattering.
  133897. */
  133898. tintColor: Color3;
  133899. /**
  133900. * Defines the distance at which the tint color should be found in the media.
  133901. * This is used for refraction only.
  133902. */
  133903. tintColorAtDistance: number;
  133904. /**
  133905. * Defines how far each channel transmit through the media.
  133906. * It is defined as a color to simplify it selection.
  133907. */
  133908. diffusionDistance: Color3;
  133909. private _useMaskFromThicknessTexture;
  133910. /**
  133911. * Stores the intensity of the different subsurface effects in the thickness texture.
  133912. * * the green channel is the translucency intensity.
  133913. * * the blue channel is the scattering intensity.
  133914. * * the alpha channel is the refraction intensity.
  133915. */
  133916. useMaskFromThicknessTexture: boolean;
  133917. private _scene;
  133918. /** @hidden */
  133919. private _internalMarkAllSubMeshesAsTexturesDirty;
  133920. private _internalMarkScenePrePassDirty;
  133921. /** @hidden */
  133922. _markAllSubMeshesAsTexturesDirty(): void;
  133923. /** @hidden */
  133924. _markScenePrePassDirty(): void;
  133925. /**
  133926. * Instantiate a new istance of sub surface configuration.
  133927. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133928. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  133929. * @param scene The scene
  133930. */
  133931. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  133932. /**
  133933. * Gets wehter the submesh is ready to be used or not.
  133934. * @param defines the list of "defines" to update.
  133935. * @param scene defines the scene the material belongs to.
  133936. * @returns - boolean indicating that the submesh is ready or not.
  133937. */
  133938. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  133939. /**
  133940. * Checks to see if a texture is used in the material.
  133941. * @param defines the list of "defines" to update.
  133942. * @param scene defines the scene to the material belongs to.
  133943. */
  133944. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  133945. /**
  133946. * Binds the material data.
  133947. * @param uniformBuffer defines the Uniform buffer to fill in.
  133948. * @param scene defines the scene the material belongs to.
  133949. * @param engine defines the engine the material belongs to.
  133950. * @param isFrozen defines whether the material is frozen or not.
  133951. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  133952. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  133953. */
  133954. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  133955. /**
  133956. * Unbinds the material from the mesh.
  133957. * @param activeEffect defines the effect that should be unbound from.
  133958. * @returns true if unbound, otherwise false
  133959. */
  133960. unbind(activeEffect: Effect): boolean;
  133961. /**
  133962. * Returns the texture used for refraction or null if none is used.
  133963. * @param scene defines the scene the material belongs to.
  133964. * @returns - Refraction texture if present. If no refraction texture and refraction
  133965. * is linked with transparency, returns environment texture. Otherwise, returns null.
  133966. */
  133967. private _getRefractionTexture;
  133968. /**
  133969. * Returns true if alpha blending should be disabled.
  133970. */
  133971. get disableAlphaBlending(): boolean;
  133972. /**
  133973. * Fills the list of render target textures.
  133974. * @param renderTargets the list of render targets to update
  133975. */
  133976. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  133977. /**
  133978. * Checks to see if a texture is used in the material.
  133979. * @param texture - Base texture to use.
  133980. * @returns - Boolean specifying if a texture is used in the material.
  133981. */
  133982. hasTexture(texture: BaseTexture): boolean;
  133983. /**
  133984. * Gets a boolean indicating that current material needs to register RTT
  133985. * @returns true if this uses a render target otherwise false.
  133986. */
  133987. hasRenderTargetTextures(): boolean;
  133988. /**
  133989. * Returns an array of the actively used textures.
  133990. * @param activeTextures Array of BaseTextures
  133991. */
  133992. getActiveTextures(activeTextures: BaseTexture[]): void;
  133993. /**
  133994. * Returns the animatable textures.
  133995. * @param animatables Array of animatable textures.
  133996. */
  133997. getAnimatables(animatables: IAnimatable[]): void;
  133998. /**
  133999. * Disposes the resources of the material.
  134000. * @param forceDisposeTextures - Forces the disposal of all textures.
  134001. */
  134002. dispose(forceDisposeTextures?: boolean): void;
  134003. /**
  134004. * Get the current class name of the texture useful for serialization or dynamic coding.
  134005. * @returns "PBRSubSurfaceConfiguration"
  134006. */
  134007. getClassName(): string;
  134008. /**
  134009. * Add fallbacks to the effect fallbacks list.
  134010. * @param defines defines the Base texture to use.
  134011. * @param fallbacks defines the current fallback list.
  134012. * @param currentRank defines the current fallback rank.
  134013. * @returns the new fallback rank.
  134014. */
  134015. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134016. /**
  134017. * Add the required uniforms to the current list.
  134018. * @param uniforms defines the current uniform list.
  134019. */
  134020. static AddUniforms(uniforms: string[]): void;
  134021. /**
  134022. * Add the required samplers to the current list.
  134023. * @param samplers defines the current sampler list.
  134024. */
  134025. static AddSamplers(samplers: string[]): void;
  134026. /**
  134027. * Add the required uniforms to the current buffer.
  134028. * @param uniformBuffer defines the current uniform buffer.
  134029. */
  134030. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134031. /**
  134032. * Makes a duplicate of the current configuration into another one.
  134033. * @param configuration define the config where to copy the info
  134034. */
  134035. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  134036. /**
  134037. * Serializes this Sub Surface configuration.
  134038. * @returns - An object with the serialized config.
  134039. */
  134040. serialize(): any;
  134041. /**
  134042. * Parses a anisotropy Configuration from a serialized object.
  134043. * @param source - Serialized object.
  134044. * @param scene Defines the scene we are parsing for
  134045. * @param rootUrl Defines the rootUrl to load from
  134046. */
  134047. parse(source: any, scene: Scene, rootUrl: string): void;
  134048. }
  134049. }
  134050. declare module BABYLON {
  134051. /** @hidden */
  134052. export var pbrFragmentDeclaration: {
  134053. name: string;
  134054. shader: string;
  134055. };
  134056. }
  134057. declare module BABYLON {
  134058. /** @hidden */
  134059. export var pbrUboDeclaration: {
  134060. name: string;
  134061. shader: string;
  134062. };
  134063. }
  134064. declare module BABYLON {
  134065. /** @hidden */
  134066. export var pbrFragmentExtraDeclaration: {
  134067. name: string;
  134068. shader: string;
  134069. };
  134070. }
  134071. declare module BABYLON {
  134072. /** @hidden */
  134073. export var pbrFragmentSamplersDeclaration: {
  134074. name: string;
  134075. shader: string;
  134076. };
  134077. }
  134078. declare module BABYLON {
  134079. /** @hidden */
  134080. export var importanceSampling: {
  134081. name: string;
  134082. shader: string;
  134083. };
  134084. }
  134085. declare module BABYLON {
  134086. /** @hidden */
  134087. export var pbrHelperFunctions: {
  134088. name: string;
  134089. shader: string;
  134090. };
  134091. }
  134092. declare module BABYLON {
  134093. /** @hidden */
  134094. export var harmonicsFunctions: {
  134095. name: string;
  134096. shader: string;
  134097. };
  134098. }
  134099. declare module BABYLON {
  134100. /** @hidden */
  134101. export var pbrDirectLightingSetupFunctions: {
  134102. name: string;
  134103. shader: string;
  134104. };
  134105. }
  134106. declare module BABYLON {
  134107. /** @hidden */
  134108. export var pbrDirectLightingFalloffFunctions: {
  134109. name: string;
  134110. shader: string;
  134111. };
  134112. }
  134113. declare module BABYLON {
  134114. /** @hidden */
  134115. export var pbrBRDFFunctions: {
  134116. name: string;
  134117. shader: string;
  134118. };
  134119. }
  134120. declare module BABYLON {
  134121. /** @hidden */
  134122. export var hdrFilteringFunctions: {
  134123. name: string;
  134124. shader: string;
  134125. };
  134126. }
  134127. declare module BABYLON {
  134128. /** @hidden */
  134129. export var pbrDirectLightingFunctions: {
  134130. name: string;
  134131. shader: string;
  134132. };
  134133. }
  134134. declare module BABYLON {
  134135. /** @hidden */
  134136. export var pbrIBLFunctions: {
  134137. name: string;
  134138. shader: string;
  134139. };
  134140. }
  134141. declare module BABYLON {
  134142. /** @hidden */
  134143. export var pbrBlockAlbedoOpacity: {
  134144. name: string;
  134145. shader: string;
  134146. };
  134147. }
  134148. declare module BABYLON {
  134149. /** @hidden */
  134150. export var pbrBlockReflectivity: {
  134151. name: string;
  134152. shader: string;
  134153. };
  134154. }
  134155. declare module BABYLON {
  134156. /** @hidden */
  134157. export var pbrBlockAmbientOcclusion: {
  134158. name: string;
  134159. shader: string;
  134160. };
  134161. }
  134162. declare module BABYLON {
  134163. /** @hidden */
  134164. export var pbrBlockAlphaFresnel: {
  134165. name: string;
  134166. shader: string;
  134167. };
  134168. }
  134169. declare module BABYLON {
  134170. /** @hidden */
  134171. export var pbrBlockAnisotropic: {
  134172. name: string;
  134173. shader: string;
  134174. };
  134175. }
  134176. declare module BABYLON {
  134177. /** @hidden */
  134178. export var pbrBlockReflection: {
  134179. name: string;
  134180. shader: string;
  134181. };
  134182. }
  134183. declare module BABYLON {
  134184. /** @hidden */
  134185. export var pbrBlockSheen: {
  134186. name: string;
  134187. shader: string;
  134188. };
  134189. }
  134190. declare module BABYLON {
  134191. /** @hidden */
  134192. export var pbrBlockClearcoat: {
  134193. name: string;
  134194. shader: string;
  134195. };
  134196. }
  134197. declare module BABYLON {
  134198. /** @hidden */
  134199. export var pbrBlockSubSurface: {
  134200. name: string;
  134201. shader: string;
  134202. };
  134203. }
  134204. declare module BABYLON {
  134205. /** @hidden */
  134206. export var pbrBlockNormalGeometric: {
  134207. name: string;
  134208. shader: string;
  134209. };
  134210. }
  134211. declare module BABYLON {
  134212. /** @hidden */
  134213. export var pbrBlockNormalFinal: {
  134214. name: string;
  134215. shader: string;
  134216. };
  134217. }
  134218. declare module BABYLON {
  134219. /** @hidden */
  134220. export var pbrBlockLightmapInit: {
  134221. name: string;
  134222. shader: string;
  134223. };
  134224. }
  134225. declare module BABYLON {
  134226. /** @hidden */
  134227. export var pbrBlockGeometryInfo: {
  134228. name: string;
  134229. shader: string;
  134230. };
  134231. }
  134232. declare module BABYLON {
  134233. /** @hidden */
  134234. export var pbrBlockReflectance0: {
  134235. name: string;
  134236. shader: string;
  134237. };
  134238. }
  134239. declare module BABYLON {
  134240. /** @hidden */
  134241. export var pbrBlockReflectance: {
  134242. name: string;
  134243. shader: string;
  134244. };
  134245. }
  134246. declare module BABYLON {
  134247. /** @hidden */
  134248. export var pbrBlockDirectLighting: {
  134249. name: string;
  134250. shader: string;
  134251. };
  134252. }
  134253. declare module BABYLON {
  134254. /** @hidden */
  134255. export var pbrBlockFinalLitComponents: {
  134256. name: string;
  134257. shader: string;
  134258. };
  134259. }
  134260. declare module BABYLON {
  134261. /** @hidden */
  134262. export var pbrBlockFinalUnlitComponents: {
  134263. name: string;
  134264. shader: string;
  134265. };
  134266. }
  134267. declare module BABYLON {
  134268. /** @hidden */
  134269. export var pbrBlockFinalColorComposition: {
  134270. name: string;
  134271. shader: string;
  134272. };
  134273. }
  134274. declare module BABYLON {
  134275. /** @hidden */
  134276. export var pbrBlockImageProcessing: {
  134277. name: string;
  134278. shader: string;
  134279. };
  134280. }
  134281. declare module BABYLON {
  134282. /** @hidden */
  134283. export var pbrDebug: {
  134284. name: string;
  134285. shader: string;
  134286. };
  134287. }
  134288. declare module BABYLON {
  134289. /** @hidden */
  134290. export var pbrPixelShader: {
  134291. name: string;
  134292. shader: string;
  134293. };
  134294. }
  134295. declare module BABYLON {
  134296. /** @hidden */
  134297. export var pbrVertexDeclaration: {
  134298. name: string;
  134299. shader: string;
  134300. };
  134301. }
  134302. declare module BABYLON {
  134303. /** @hidden */
  134304. export var pbrVertexShader: {
  134305. name: string;
  134306. shader: string;
  134307. };
  134308. }
  134309. declare module BABYLON {
  134310. /**
  134311. * Manages the defines for the PBR Material.
  134312. * @hidden
  134313. */
  134314. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  134315. PBR: boolean;
  134316. NUM_SAMPLES: string;
  134317. REALTIME_FILTERING: boolean;
  134318. MAINUV1: boolean;
  134319. MAINUV2: boolean;
  134320. UV1: boolean;
  134321. UV2: boolean;
  134322. ALBEDO: boolean;
  134323. GAMMAALBEDO: boolean;
  134324. ALBEDODIRECTUV: number;
  134325. VERTEXCOLOR: boolean;
  134326. DETAIL: boolean;
  134327. DETAILDIRECTUV: number;
  134328. DETAIL_NORMALBLENDMETHOD: number;
  134329. AMBIENT: boolean;
  134330. AMBIENTDIRECTUV: number;
  134331. AMBIENTINGRAYSCALE: boolean;
  134332. OPACITY: boolean;
  134333. VERTEXALPHA: boolean;
  134334. OPACITYDIRECTUV: number;
  134335. OPACITYRGB: boolean;
  134336. ALPHATEST: boolean;
  134337. DEPTHPREPASS: boolean;
  134338. ALPHABLEND: boolean;
  134339. ALPHAFROMALBEDO: boolean;
  134340. ALPHATESTVALUE: string;
  134341. SPECULAROVERALPHA: boolean;
  134342. RADIANCEOVERALPHA: boolean;
  134343. ALPHAFRESNEL: boolean;
  134344. LINEARALPHAFRESNEL: boolean;
  134345. PREMULTIPLYALPHA: boolean;
  134346. EMISSIVE: boolean;
  134347. EMISSIVEDIRECTUV: number;
  134348. REFLECTIVITY: boolean;
  134349. REFLECTIVITYDIRECTUV: number;
  134350. SPECULARTERM: boolean;
  134351. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  134352. MICROSURFACEAUTOMATIC: boolean;
  134353. LODBASEDMICROSFURACE: boolean;
  134354. MICROSURFACEMAP: boolean;
  134355. MICROSURFACEMAPDIRECTUV: number;
  134356. METALLICWORKFLOW: boolean;
  134357. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  134358. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  134359. METALLNESSSTOREINMETALMAPBLUE: boolean;
  134360. AOSTOREINMETALMAPRED: boolean;
  134361. METALLIC_REFLECTANCE: boolean;
  134362. METALLIC_REFLECTANCEDIRECTUV: number;
  134363. ENVIRONMENTBRDF: boolean;
  134364. ENVIRONMENTBRDF_RGBD: boolean;
  134365. NORMAL: boolean;
  134366. TANGENT: boolean;
  134367. BUMP: boolean;
  134368. BUMPDIRECTUV: number;
  134369. OBJECTSPACE_NORMALMAP: boolean;
  134370. PARALLAX: boolean;
  134371. PARALLAXOCCLUSION: boolean;
  134372. NORMALXYSCALE: boolean;
  134373. LIGHTMAP: boolean;
  134374. LIGHTMAPDIRECTUV: number;
  134375. USELIGHTMAPASSHADOWMAP: boolean;
  134376. GAMMALIGHTMAP: boolean;
  134377. RGBDLIGHTMAP: boolean;
  134378. REFLECTION: boolean;
  134379. REFLECTIONMAP_3D: boolean;
  134380. REFLECTIONMAP_SPHERICAL: boolean;
  134381. REFLECTIONMAP_PLANAR: boolean;
  134382. REFLECTIONMAP_CUBIC: boolean;
  134383. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  134384. REFLECTIONMAP_PROJECTION: boolean;
  134385. REFLECTIONMAP_SKYBOX: boolean;
  134386. REFLECTIONMAP_EXPLICIT: boolean;
  134387. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  134388. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  134389. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  134390. INVERTCUBICMAP: boolean;
  134391. USESPHERICALFROMREFLECTIONMAP: boolean;
  134392. USEIRRADIANCEMAP: boolean;
  134393. SPHERICAL_HARMONICS: boolean;
  134394. USESPHERICALINVERTEX: boolean;
  134395. REFLECTIONMAP_OPPOSITEZ: boolean;
  134396. LODINREFLECTIONALPHA: boolean;
  134397. GAMMAREFLECTION: boolean;
  134398. RGBDREFLECTION: boolean;
  134399. LINEARSPECULARREFLECTION: boolean;
  134400. RADIANCEOCCLUSION: boolean;
  134401. HORIZONOCCLUSION: boolean;
  134402. INSTANCES: boolean;
  134403. THIN_INSTANCES: boolean;
  134404. PREPASS: boolean;
  134405. SCENE_MRT_COUNT: number;
  134406. NUM_BONE_INFLUENCERS: number;
  134407. BonesPerMesh: number;
  134408. BONETEXTURE: boolean;
  134409. NONUNIFORMSCALING: boolean;
  134410. MORPHTARGETS: boolean;
  134411. MORPHTARGETS_NORMAL: boolean;
  134412. MORPHTARGETS_TANGENT: boolean;
  134413. MORPHTARGETS_UV: boolean;
  134414. NUM_MORPH_INFLUENCERS: number;
  134415. IMAGEPROCESSING: boolean;
  134416. VIGNETTE: boolean;
  134417. VIGNETTEBLENDMODEMULTIPLY: boolean;
  134418. VIGNETTEBLENDMODEOPAQUE: boolean;
  134419. TONEMAPPING: boolean;
  134420. TONEMAPPING_ACES: boolean;
  134421. CONTRAST: boolean;
  134422. COLORCURVES: boolean;
  134423. COLORGRADING: boolean;
  134424. COLORGRADING3D: boolean;
  134425. SAMPLER3DGREENDEPTH: boolean;
  134426. SAMPLER3DBGRMAP: boolean;
  134427. IMAGEPROCESSINGPOSTPROCESS: boolean;
  134428. EXPOSURE: boolean;
  134429. MULTIVIEW: boolean;
  134430. USEPHYSICALLIGHTFALLOFF: boolean;
  134431. USEGLTFLIGHTFALLOFF: boolean;
  134432. TWOSIDEDLIGHTING: boolean;
  134433. SHADOWFLOAT: boolean;
  134434. CLIPPLANE: boolean;
  134435. CLIPPLANE2: boolean;
  134436. CLIPPLANE3: boolean;
  134437. CLIPPLANE4: boolean;
  134438. CLIPPLANE5: boolean;
  134439. CLIPPLANE6: boolean;
  134440. POINTSIZE: boolean;
  134441. FOG: boolean;
  134442. LOGARITHMICDEPTH: boolean;
  134443. FORCENORMALFORWARD: boolean;
  134444. SPECULARAA: boolean;
  134445. CLEARCOAT: boolean;
  134446. CLEARCOAT_DEFAULTIOR: boolean;
  134447. CLEARCOAT_TEXTURE: boolean;
  134448. CLEARCOAT_TEXTUREDIRECTUV: number;
  134449. CLEARCOAT_BUMP: boolean;
  134450. CLEARCOAT_BUMPDIRECTUV: number;
  134451. CLEARCOAT_TINT: boolean;
  134452. CLEARCOAT_TINT_TEXTURE: boolean;
  134453. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134454. ANISOTROPIC: boolean;
  134455. ANISOTROPIC_TEXTURE: boolean;
  134456. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134457. BRDF_V_HEIGHT_CORRELATED: boolean;
  134458. MS_BRDF_ENERGY_CONSERVATION: boolean;
  134459. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  134460. SHEEN: boolean;
  134461. SHEEN_TEXTURE: boolean;
  134462. SHEEN_TEXTUREDIRECTUV: number;
  134463. SHEEN_LINKWITHALBEDO: boolean;
  134464. SHEEN_ROUGHNESS: boolean;
  134465. SHEEN_ALBEDOSCALING: boolean;
  134466. SUBSURFACE: boolean;
  134467. SS_REFRACTION: boolean;
  134468. SS_TRANSLUCENCY: boolean;
  134469. SS_SCATTERING: boolean;
  134470. SS_THICKNESSANDMASK_TEXTURE: boolean;
  134471. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  134472. SS_REFRACTIONMAP_3D: boolean;
  134473. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  134474. SS_LODINREFRACTIONALPHA: boolean;
  134475. SS_GAMMAREFRACTION: boolean;
  134476. SS_RGBDREFRACTION: boolean;
  134477. SS_LINEARSPECULARREFRACTION: boolean;
  134478. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  134479. SS_ALBEDOFORREFRACTIONTINT: boolean;
  134480. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  134481. UNLIT: boolean;
  134482. DEBUGMODE: number;
  134483. /**
  134484. * Initializes the PBR Material defines.
  134485. */
  134486. constructor();
  134487. /**
  134488. * Resets the PBR Material defines.
  134489. */
  134490. reset(): void;
  134491. }
  134492. /**
  134493. * The Physically based material base class of BJS.
  134494. *
  134495. * This offers the main features of a standard PBR material.
  134496. * For more information, please refer to the documentation :
  134497. * https://doc.babylonjs.com/how_to/physically_based_rendering
  134498. */
  134499. export abstract class PBRBaseMaterial extends PushMaterial {
  134500. /**
  134501. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  134502. */
  134503. static readonly PBRMATERIAL_OPAQUE: number;
  134504. /**
  134505. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  134506. */
  134507. static readonly PBRMATERIAL_ALPHATEST: number;
  134508. /**
  134509. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134510. */
  134511. static readonly PBRMATERIAL_ALPHABLEND: number;
  134512. /**
  134513. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134514. * They are also discarded below the alpha cutoff threshold to improve performances.
  134515. */
  134516. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  134517. /**
  134518. * Defines the default value of how much AO map is occluding the analytical lights
  134519. * (point spot...).
  134520. */
  134521. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  134522. /**
  134523. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  134524. */
  134525. static readonly LIGHTFALLOFF_PHYSICAL: number;
  134526. /**
  134527. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  134528. * to enhance interoperability with other engines.
  134529. */
  134530. static readonly LIGHTFALLOFF_GLTF: number;
  134531. /**
  134532. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  134533. * to enhance interoperability with other materials.
  134534. */
  134535. static readonly LIGHTFALLOFF_STANDARD: number;
  134536. /**
  134537. * Intensity of the direct lights e.g. the four lights available in your scene.
  134538. * This impacts both the direct diffuse and specular highlights.
  134539. */
  134540. protected _directIntensity: number;
  134541. /**
  134542. * Intensity of the emissive part of the material.
  134543. * This helps controlling the emissive effect without modifying the emissive color.
  134544. */
  134545. protected _emissiveIntensity: number;
  134546. /**
  134547. * Intensity of the environment e.g. how much the environment will light the object
  134548. * either through harmonics for rough material or through the refelction for shiny ones.
  134549. */
  134550. protected _environmentIntensity: number;
  134551. /**
  134552. * This is a special control allowing the reduction of the specular highlights coming from the
  134553. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  134554. */
  134555. protected _specularIntensity: number;
  134556. /**
  134557. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  134558. */
  134559. private _lightingInfos;
  134560. /**
  134561. * Debug Control allowing disabling the bump map on this material.
  134562. */
  134563. protected _disableBumpMap: boolean;
  134564. /**
  134565. * AKA Diffuse Texture in standard nomenclature.
  134566. */
  134567. protected _albedoTexture: Nullable<BaseTexture>;
  134568. /**
  134569. * AKA Occlusion Texture in other nomenclature.
  134570. */
  134571. protected _ambientTexture: Nullable<BaseTexture>;
  134572. /**
  134573. * AKA Occlusion Texture Intensity in other nomenclature.
  134574. */
  134575. protected _ambientTextureStrength: number;
  134576. /**
  134577. * Defines how much the AO map is occluding the analytical lights (point spot...).
  134578. * 1 means it completely occludes it
  134579. * 0 mean it has no impact
  134580. */
  134581. protected _ambientTextureImpactOnAnalyticalLights: number;
  134582. /**
  134583. * Stores the alpha values in a texture.
  134584. */
  134585. protected _opacityTexture: Nullable<BaseTexture>;
  134586. /**
  134587. * Stores the reflection values in a texture.
  134588. */
  134589. protected _reflectionTexture: Nullable<BaseTexture>;
  134590. /**
  134591. * Stores the emissive values in a texture.
  134592. */
  134593. protected _emissiveTexture: Nullable<BaseTexture>;
  134594. /**
  134595. * AKA Specular texture in other nomenclature.
  134596. */
  134597. protected _reflectivityTexture: Nullable<BaseTexture>;
  134598. /**
  134599. * Used to switch from specular/glossiness to metallic/roughness workflow.
  134600. */
  134601. protected _metallicTexture: Nullable<BaseTexture>;
  134602. /**
  134603. * Specifies the metallic scalar of the metallic/roughness workflow.
  134604. * Can also be used to scale the metalness values of the metallic texture.
  134605. */
  134606. protected _metallic: Nullable<number>;
  134607. /**
  134608. * Specifies the roughness scalar of the metallic/roughness workflow.
  134609. * Can also be used to scale the roughness values of the metallic texture.
  134610. */
  134611. protected _roughness: Nullable<number>;
  134612. /**
  134613. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  134614. * By default the indexOfrefraction is used to compute F0;
  134615. *
  134616. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  134617. *
  134618. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  134619. * F90 = metallicReflectanceColor;
  134620. */
  134621. protected _metallicF0Factor: number;
  134622. /**
  134623. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  134624. * By default the F90 is always 1;
  134625. *
  134626. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  134627. *
  134628. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  134629. * F90 = metallicReflectanceColor;
  134630. */
  134631. protected _metallicReflectanceColor: Color3;
  134632. /**
  134633. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  134634. * This is multiply against the scalar values defined in the material.
  134635. */
  134636. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  134637. /**
  134638. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  134639. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  134640. */
  134641. protected _microSurfaceTexture: Nullable<BaseTexture>;
  134642. /**
  134643. * Stores surface normal data used to displace a mesh in a texture.
  134644. */
  134645. protected _bumpTexture: Nullable<BaseTexture>;
  134646. /**
  134647. * Stores the pre-calculated light information of a mesh in a texture.
  134648. */
  134649. protected _lightmapTexture: Nullable<BaseTexture>;
  134650. /**
  134651. * The color of a material in ambient lighting.
  134652. */
  134653. protected _ambientColor: Color3;
  134654. /**
  134655. * AKA Diffuse Color in other nomenclature.
  134656. */
  134657. protected _albedoColor: Color3;
  134658. /**
  134659. * AKA Specular Color in other nomenclature.
  134660. */
  134661. protected _reflectivityColor: Color3;
  134662. /**
  134663. * The color applied when light is reflected from a material.
  134664. */
  134665. protected _reflectionColor: Color3;
  134666. /**
  134667. * The color applied when light is emitted from a material.
  134668. */
  134669. protected _emissiveColor: Color3;
  134670. /**
  134671. * AKA Glossiness in other nomenclature.
  134672. */
  134673. protected _microSurface: number;
  134674. /**
  134675. * Specifies that the material will use the light map as a show map.
  134676. */
  134677. protected _useLightmapAsShadowmap: boolean;
  134678. /**
  134679. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  134680. * makes the reflect vector face the model (under horizon).
  134681. */
  134682. protected _useHorizonOcclusion: boolean;
  134683. /**
  134684. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  134685. * too much the area relying on ambient texture to define their ambient occlusion.
  134686. */
  134687. protected _useRadianceOcclusion: boolean;
  134688. /**
  134689. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  134690. */
  134691. protected _useAlphaFromAlbedoTexture: boolean;
  134692. /**
  134693. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  134694. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  134695. */
  134696. protected _useSpecularOverAlpha: boolean;
  134697. /**
  134698. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  134699. */
  134700. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  134701. /**
  134702. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  134703. */
  134704. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  134705. /**
  134706. * Specifies if the metallic texture contains the roughness information in its green channel.
  134707. */
  134708. protected _useRoughnessFromMetallicTextureGreen: boolean;
  134709. /**
  134710. * Specifies if the metallic texture contains the metallness information in its blue channel.
  134711. */
  134712. protected _useMetallnessFromMetallicTextureBlue: boolean;
  134713. /**
  134714. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  134715. */
  134716. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  134717. /**
  134718. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  134719. */
  134720. protected _useAmbientInGrayScale: boolean;
  134721. /**
  134722. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  134723. * The material will try to infer what glossiness each pixel should be.
  134724. */
  134725. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  134726. /**
  134727. * Defines the falloff type used in this material.
  134728. * It by default is Physical.
  134729. */
  134730. protected _lightFalloff: number;
  134731. /**
  134732. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  134733. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  134734. */
  134735. protected _useRadianceOverAlpha: boolean;
  134736. /**
  134737. * Allows using an object space normal map (instead of tangent space).
  134738. */
  134739. protected _useObjectSpaceNormalMap: boolean;
  134740. /**
  134741. * Allows using the bump map in parallax mode.
  134742. */
  134743. protected _useParallax: boolean;
  134744. /**
  134745. * Allows using the bump map in parallax occlusion mode.
  134746. */
  134747. protected _useParallaxOcclusion: boolean;
  134748. /**
  134749. * Controls the scale bias of the parallax mode.
  134750. */
  134751. protected _parallaxScaleBias: number;
  134752. /**
  134753. * If sets to true, disables all the lights affecting the material.
  134754. */
  134755. protected _disableLighting: boolean;
  134756. /**
  134757. * Number of Simultaneous lights allowed on the material.
  134758. */
  134759. protected _maxSimultaneousLights: number;
  134760. /**
  134761. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134762. */
  134763. protected _invertNormalMapX: boolean;
  134764. /**
  134765. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134766. */
  134767. protected _invertNormalMapY: boolean;
  134768. /**
  134769. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  134770. */
  134771. protected _twoSidedLighting: boolean;
  134772. /**
  134773. * Defines the alpha limits in alpha test mode.
  134774. */
  134775. protected _alphaCutOff: number;
  134776. /**
  134777. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  134778. */
  134779. protected _forceAlphaTest: boolean;
  134780. /**
  134781. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  134782. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  134783. */
  134784. protected _useAlphaFresnel: boolean;
  134785. /**
  134786. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  134787. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  134788. */
  134789. protected _useLinearAlphaFresnel: boolean;
  134790. /**
  134791. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  134792. * from cos thetav and roughness:
  134793. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  134794. */
  134795. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  134796. /**
  134797. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  134798. */
  134799. protected _forceIrradianceInFragment: boolean;
  134800. private _realTimeFiltering;
  134801. /**
  134802. * Enables realtime filtering on the texture.
  134803. */
  134804. get realTimeFiltering(): boolean;
  134805. set realTimeFiltering(b: boolean);
  134806. private _realTimeFilteringQuality;
  134807. /**
  134808. * Quality switch for realtime filtering
  134809. */
  134810. get realTimeFilteringQuality(): number;
  134811. set realTimeFilteringQuality(n: number);
  134812. /**
  134813. * Can this material render to several textures at once
  134814. */
  134815. get canRenderToMRT(): boolean;
  134816. /**
  134817. * Force normal to face away from face.
  134818. */
  134819. protected _forceNormalForward: boolean;
  134820. /**
  134821. * Enables specular anti aliasing in the PBR shader.
  134822. * It will both interacts on the Geometry for analytical and IBL lighting.
  134823. * It also prefilter the roughness map based on the bump values.
  134824. */
  134825. protected _enableSpecularAntiAliasing: boolean;
  134826. /**
  134827. * Default configuration related to image processing available in the PBR Material.
  134828. */
  134829. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134830. /**
  134831. * Keep track of the image processing observer to allow dispose and replace.
  134832. */
  134833. private _imageProcessingObserver;
  134834. /**
  134835. * Attaches a new image processing configuration to the PBR Material.
  134836. * @param configuration
  134837. */
  134838. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134839. /**
  134840. * Stores the available render targets.
  134841. */
  134842. private _renderTargets;
  134843. /**
  134844. * Sets the global ambient color for the material used in lighting calculations.
  134845. */
  134846. private _globalAmbientColor;
  134847. /**
  134848. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  134849. */
  134850. private _useLogarithmicDepth;
  134851. /**
  134852. * If set to true, no lighting calculations will be applied.
  134853. */
  134854. private _unlit;
  134855. private _debugMode;
  134856. /**
  134857. * @hidden
  134858. * This is reserved for the inspector.
  134859. * Defines the material debug mode.
  134860. * It helps seeing only some components of the material while troubleshooting.
  134861. */
  134862. debugMode: number;
  134863. /**
  134864. * @hidden
  134865. * This is reserved for the inspector.
  134866. * Specify from where on screen the debug mode should start.
  134867. * The value goes from -1 (full screen) to 1 (not visible)
  134868. * It helps with side by side comparison against the final render
  134869. * This defaults to -1
  134870. */
  134871. private debugLimit;
  134872. /**
  134873. * @hidden
  134874. * This is reserved for the inspector.
  134875. * As the default viewing range might not be enough (if the ambient is really small for instance)
  134876. * You can use the factor to better multiply the final value.
  134877. */
  134878. private debugFactor;
  134879. /**
  134880. * Defines the clear coat layer parameters for the material.
  134881. */
  134882. readonly clearCoat: PBRClearCoatConfiguration;
  134883. /**
  134884. * Defines the anisotropic parameters for the material.
  134885. */
  134886. readonly anisotropy: PBRAnisotropicConfiguration;
  134887. /**
  134888. * Defines the BRDF parameters for the material.
  134889. */
  134890. readonly brdf: PBRBRDFConfiguration;
  134891. /**
  134892. * Defines the Sheen parameters for the material.
  134893. */
  134894. readonly sheen: PBRSheenConfiguration;
  134895. /**
  134896. * Defines the SubSurface parameters for the material.
  134897. */
  134898. readonly subSurface: PBRSubSurfaceConfiguration;
  134899. /**
  134900. * Defines the detail map parameters for the material.
  134901. */
  134902. readonly detailMap: DetailMapConfiguration;
  134903. protected _rebuildInParallel: boolean;
  134904. /**
  134905. * Instantiates a new PBRMaterial instance.
  134906. *
  134907. * @param name The material name
  134908. * @param scene The scene the material will be use in.
  134909. */
  134910. constructor(name: string, scene: Scene);
  134911. /**
  134912. * Gets a boolean indicating that current material needs to register RTT
  134913. */
  134914. get hasRenderTargetTextures(): boolean;
  134915. /**
  134916. * Gets the name of the material class.
  134917. */
  134918. getClassName(): string;
  134919. /**
  134920. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  134921. */
  134922. get useLogarithmicDepth(): boolean;
  134923. /**
  134924. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  134925. */
  134926. set useLogarithmicDepth(value: boolean);
  134927. /**
  134928. * Returns true if alpha blending should be disabled.
  134929. */
  134930. protected get _disableAlphaBlending(): boolean;
  134931. /**
  134932. * Specifies whether or not this material should be rendered in alpha blend mode.
  134933. */
  134934. needAlphaBlending(): boolean;
  134935. /**
  134936. * Specifies whether or not this material should be rendered in alpha test mode.
  134937. */
  134938. needAlphaTesting(): boolean;
  134939. /**
  134940. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  134941. */
  134942. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  134943. /**
  134944. * Gets the texture used for the alpha test.
  134945. */
  134946. getAlphaTestTexture(): Nullable<BaseTexture>;
  134947. /**
  134948. * Specifies that the submesh is ready to be used.
  134949. * @param mesh - BJS mesh.
  134950. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  134951. * @param useInstances - Specifies that instances should be used.
  134952. * @returns - boolean indicating that the submesh is ready or not.
  134953. */
  134954. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134955. /**
  134956. * Specifies if the material uses metallic roughness workflow.
  134957. * @returns boolean specifiying if the material uses metallic roughness workflow.
  134958. */
  134959. isMetallicWorkflow(): boolean;
  134960. private _prepareEffect;
  134961. private _prepareDefines;
  134962. /**
  134963. * Force shader compilation
  134964. */
  134965. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  134966. /**
  134967. * Initializes the uniform buffer layout for the shader.
  134968. */
  134969. buildUniformLayout(): void;
  134970. /**
  134971. * Unbinds the material from the mesh
  134972. */
  134973. unbind(): void;
  134974. /**
  134975. * Binds the submesh data.
  134976. * @param world - The world matrix.
  134977. * @param mesh - The BJS mesh.
  134978. * @param subMesh - A submesh of the BJS mesh.
  134979. */
  134980. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134981. /**
  134982. * Returns the animatable textures.
  134983. * @returns - Array of animatable textures.
  134984. */
  134985. getAnimatables(): IAnimatable[];
  134986. /**
  134987. * Returns the texture used for reflections.
  134988. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  134989. */
  134990. private _getReflectionTexture;
  134991. /**
  134992. * Returns an array of the actively used textures.
  134993. * @returns - Array of BaseTextures
  134994. */
  134995. getActiveTextures(): BaseTexture[];
  134996. /**
  134997. * Checks to see if a texture is used in the material.
  134998. * @param texture - Base texture to use.
  134999. * @returns - Boolean specifying if a texture is used in the material.
  135000. */
  135001. hasTexture(texture: BaseTexture): boolean;
  135002. /**
  135003. * Sets the required values to the prepass renderer.
  135004. * @param prePassRenderer defines the prepass renderer to setup
  135005. */
  135006. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  135007. /**
  135008. * Disposes the resources of the material.
  135009. * @param forceDisposeEffect - Forces the disposal of effects.
  135010. * @param forceDisposeTextures - Forces the disposal of all textures.
  135011. */
  135012. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  135013. }
  135014. }
  135015. declare module BABYLON {
  135016. /**
  135017. * The Physically based material of BJS.
  135018. *
  135019. * This offers the main features of a standard PBR material.
  135020. * For more information, please refer to the documentation :
  135021. * https://doc.babylonjs.com/how_to/physically_based_rendering
  135022. */
  135023. export class PBRMaterial extends PBRBaseMaterial {
  135024. /**
  135025. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  135026. */
  135027. static readonly PBRMATERIAL_OPAQUE: number;
  135028. /**
  135029. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  135030. */
  135031. static readonly PBRMATERIAL_ALPHATEST: number;
  135032. /**
  135033. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135034. */
  135035. static readonly PBRMATERIAL_ALPHABLEND: number;
  135036. /**
  135037. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135038. * They are also discarded below the alpha cutoff threshold to improve performances.
  135039. */
  135040. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  135041. /**
  135042. * Defines the default value of how much AO map is occluding the analytical lights
  135043. * (point spot...).
  135044. */
  135045. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  135046. /**
  135047. * Intensity of the direct lights e.g. the four lights available in your scene.
  135048. * This impacts both the direct diffuse and specular highlights.
  135049. */
  135050. directIntensity: number;
  135051. /**
  135052. * Intensity of the emissive part of the material.
  135053. * This helps controlling the emissive effect without modifying the emissive color.
  135054. */
  135055. emissiveIntensity: number;
  135056. /**
  135057. * Intensity of the environment e.g. how much the environment will light the object
  135058. * either through harmonics for rough material or through the refelction for shiny ones.
  135059. */
  135060. environmentIntensity: number;
  135061. /**
  135062. * This is a special control allowing the reduction of the specular highlights coming from the
  135063. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  135064. */
  135065. specularIntensity: number;
  135066. /**
  135067. * Debug Control allowing disabling the bump map on this material.
  135068. */
  135069. disableBumpMap: boolean;
  135070. /**
  135071. * AKA Diffuse Texture in standard nomenclature.
  135072. */
  135073. albedoTexture: BaseTexture;
  135074. /**
  135075. * AKA Occlusion Texture in other nomenclature.
  135076. */
  135077. ambientTexture: BaseTexture;
  135078. /**
  135079. * AKA Occlusion Texture Intensity in other nomenclature.
  135080. */
  135081. ambientTextureStrength: number;
  135082. /**
  135083. * Defines how much the AO map is occluding the analytical lights (point spot...).
  135084. * 1 means it completely occludes it
  135085. * 0 mean it has no impact
  135086. */
  135087. ambientTextureImpactOnAnalyticalLights: number;
  135088. /**
  135089. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  135090. */
  135091. opacityTexture: BaseTexture;
  135092. /**
  135093. * Stores the reflection values in a texture.
  135094. */
  135095. reflectionTexture: Nullable<BaseTexture>;
  135096. /**
  135097. * Stores the emissive values in a texture.
  135098. */
  135099. emissiveTexture: BaseTexture;
  135100. /**
  135101. * AKA Specular texture in other nomenclature.
  135102. */
  135103. reflectivityTexture: BaseTexture;
  135104. /**
  135105. * Used to switch from specular/glossiness to metallic/roughness workflow.
  135106. */
  135107. metallicTexture: BaseTexture;
  135108. /**
  135109. * Specifies the metallic scalar of the metallic/roughness workflow.
  135110. * Can also be used to scale the metalness values of the metallic texture.
  135111. */
  135112. metallic: Nullable<number>;
  135113. /**
  135114. * Specifies the roughness scalar of the metallic/roughness workflow.
  135115. * Can also be used to scale the roughness values of the metallic texture.
  135116. */
  135117. roughness: Nullable<number>;
  135118. /**
  135119. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  135120. * By default the indexOfrefraction is used to compute F0;
  135121. *
  135122. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  135123. *
  135124. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  135125. * F90 = metallicReflectanceColor;
  135126. */
  135127. metallicF0Factor: number;
  135128. /**
  135129. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  135130. * By default the F90 is always 1;
  135131. *
  135132. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  135133. *
  135134. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  135135. * F90 = metallicReflectanceColor;
  135136. */
  135137. metallicReflectanceColor: Color3;
  135138. /**
  135139. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  135140. * This is multiply against the scalar values defined in the material.
  135141. */
  135142. metallicReflectanceTexture: Nullable<BaseTexture>;
  135143. /**
  135144. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  135145. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  135146. */
  135147. microSurfaceTexture: BaseTexture;
  135148. /**
  135149. * Stores surface normal data used to displace a mesh in a texture.
  135150. */
  135151. bumpTexture: BaseTexture;
  135152. /**
  135153. * Stores the pre-calculated light information of a mesh in a texture.
  135154. */
  135155. lightmapTexture: BaseTexture;
  135156. /**
  135157. * Stores the refracted light information in a texture.
  135158. */
  135159. get refractionTexture(): Nullable<BaseTexture>;
  135160. set refractionTexture(value: Nullable<BaseTexture>);
  135161. /**
  135162. * The color of a material in ambient lighting.
  135163. */
  135164. ambientColor: Color3;
  135165. /**
  135166. * AKA Diffuse Color in other nomenclature.
  135167. */
  135168. albedoColor: Color3;
  135169. /**
  135170. * AKA Specular Color in other nomenclature.
  135171. */
  135172. reflectivityColor: Color3;
  135173. /**
  135174. * The color reflected from the material.
  135175. */
  135176. reflectionColor: Color3;
  135177. /**
  135178. * The color emitted from the material.
  135179. */
  135180. emissiveColor: Color3;
  135181. /**
  135182. * AKA Glossiness in other nomenclature.
  135183. */
  135184. microSurface: number;
  135185. /**
  135186. * Index of refraction of the material base layer.
  135187. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135188. *
  135189. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135190. *
  135191. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135192. */
  135193. get indexOfRefraction(): number;
  135194. set indexOfRefraction(value: number);
  135195. /**
  135196. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135197. */
  135198. get invertRefractionY(): boolean;
  135199. set invertRefractionY(value: boolean);
  135200. /**
  135201. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135202. * Materials half opaque for instance using refraction could benefit from this control.
  135203. */
  135204. get linkRefractionWithTransparency(): boolean;
  135205. set linkRefractionWithTransparency(value: boolean);
  135206. /**
  135207. * If true, the light map contains occlusion information instead of lighting info.
  135208. */
  135209. useLightmapAsShadowmap: boolean;
  135210. /**
  135211. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  135212. */
  135213. useAlphaFromAlbedoTexture: boolean;
  135214. /**
  135215. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  135216. */
  135217. forceAlphaTest: boolean;
  135218. /**
  135219. * Defines the alpha limits in alpha test mode.
  135220. */
  135221. alphaCutOff: number;
  135222. /**
  135223. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  135224. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  135225. */
  135226. useSpecularOverAlpha: boolean;
  135227. /**
  135228. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  135229. */
  135230. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  135231. /**
  135232. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  135233. */
  135234. useRoughnessFromMetallicTextureAlpha: boolean;
  135235. /**
  135236. * Specifies if the metallic texture contains the roughness information in its green channel.
  135237. */
  135238. useRoughnessFromMetallicTextureGreen: boolean;
  135239. /**
  135240. * Specifies if the metallic texture contains the metallness information in its blue channel.
  135241. */
  135242. useMetallnessFromMetallicTextureBlue: boolean;
  135243. /**
  135244. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  135245. */
  135246. useAmbientOcclusionFromMetallicTextureRed: boolean;
  135247. /**
  135248. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  135249. */
  135250. useAmbientInGrayScale: boolean;
  135251. /**
  135252. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  135253. * The material will try to infer what glossiness each pixel should be.
  135254. */
  135255. useAutoMicroSurfaceFromReflectivityMap: boolean;
  135256. /**
  135257. * BJS is using an harcoded light falloff based on a manually sets up range.
  135258. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  135259. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  135260. */
  135261. get usePhysicalLightFalloff(): boolean;
  135262. /**
  135263. * BJS is using an harcoded light falloff based on a manually sets up range.
  135264. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  135265. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  135266. */
  135267. set usePhysicalLightFalloff(value: boolean);
  135268. /**
  135269. * In order to support the falloff compatibility with gltf, a special mode has been added
  135270. * to reproduce the gltf light falloff.
  135271. */
  135272. get useGLTFLightFalloff(): boolean;
  135273. /**
  135274. * In order to support the falloff compatibility with gltf, a special mode has been added
  135275. * to reproduce the gltf light falloff.
  135276. */
  135277. set useGLTFLightFalloff(value: boolean);
  135278. /**
  135279. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  135280. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  135281. */
  135282. useRadianceOverAlpha: boolean;
  135283. /**
  135284. * Allows using an object space normal map (instead of tangent space).
  135285. */
  135286. useObjectSpaceNormalMap: boolean;
  135287. /**
  135288. * Allows using the bump map in parallax mode.
  135289. */
  135290. useParallax: boolean;
  135291. /**
  135292. * Allows using the bump map in parallax occlusion mode.
  135293. */
  135294. useParallaxOcclusion: boolean;
  135295. /**
  135296. * Controls the scale bias of the parallax mode.
  135297. */
  135298. parallaxScaleBias: number;
  135299. /**
  135300. * If sets to true, disables all the lights affecting the material.
  135301. */
  135302. disableLighting: boolean;
  135303. /**
  135304. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  135305. */
  135306. forceIrradianceInFragment: boolean;
  135307. /**
  135308. * Number of Simultaneous lights allowed on the material.
  135309. */
  135310. maxSimultaneousLights: number;
  135311. /**
  135312. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  135313. */
  135314. invertNormalMapX: boolean;
  135315. /**
  135316. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  135317. */
  135318. invertNormalMapY: boolean;
  135319. /**
  135320. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  135321. */
  135322. twoSidedLighting: boolean;
  135323. /**
  135324. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135325. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  135326. */
  135327. useAlphaFresnel: boolean;
  135328. /**
  135329. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135330. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  135331. */
  135332. useLinearAlphaFresnel: boolean;
  135333. /**
  135334. * Let user defines the brdf lookup texture used for IBL.
  135335. * A default 8bit version is embedded but you could point at :
  135336. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  135337. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  135338. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  135339. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  135340. */
  135341. environmentBRDFTexture: Nullable<BaseTexture>;
  135342. /**
  135343. * Force normal to face away from face.
  135344. */
  135345. forceNormalForward: boolean;
  135346. /**
  135347. * Enables specular anti aliasing in the PBR shader.
  135348. * It will both interacts on the Geometry for analytical and IBL lighting.
  135349. * It also prefilter the roughness map based on the bump values.
  135350. */
  135351. enableSpecularAntiAliasing: boolean;
  135352. /**
  135353. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  135354. * makes the reflect vector face the model (under horizon).
  135355. */
  135356. useHorizonOcclusion: boolean;
  135357. /**
  135358. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  135359. * too much the area relying on ambient texture to define their ambient occlusion.
  135360. */
  135361. useRadianceOcclusion: boolean;
  135362. /**
  135363. * If set to true, no lighting calculations will be applied.
  135364. */
  135365. unlit: boolean;
  135366. /**
  135367. * Gets the image processing configuration used either in this material.
  135368. */
  135369. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  135370. /**
  135371. * Sets the Default image processing configuration used either in the this material.
  135372. *
  135373. * If sets to null, the scene one is in use.
  135374. */
  135375. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  135376. /**
  135377. * Gets wether the color curves effect is enabled.
  135378. */
  135379. get cameraColorCurvesEnabled(): boolean;
  135380. /**
  135381. * Sets wether the color curves effect is enabled.
  135382. */
  135383. set cameraColorCurvesEnabled(value: boolean);
  135384. /**
  135385. * Gets wether the color grading effect is enabled.
  135386. */
  135387. get cameraColorGradingEnabled(): boolean;
  135388. /**
  135389. * Gets wether the color grading effect is enabled.
  135390. */
  135391. set cameraColorGradingEnabled(value: boolean);
  135392. /**
  135393. * Gets wether tonemapping is enabled or not.
  135394. */
  135395. get cameraToneMappingEnabled(): boolean;
  135396. /**
  135397. * Sets wether tonemapping is enabled or not
  135398. */
  135399. set cameraToneMappingEnabled(value: boolean);
  135400. /**
  135401. * The camera exposure used on this material.
  135402. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135403. * This corresponds to a photographic exposure.
  135404. */
  135405. get cameraExposure(): number;
  135406. /**
  135407. * The camera exposure used on this material.
  135408. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135409. * This corresponds to a photographic exposure.
  135410. */
  135411. set cameraExposure(value: number);
  135412. /**
  135413. * Gets The camera contrast used on this material.
  135414. */
  135415. get cameraContrast(): number;
  135416. /**
  135417. * Sets The camera contrast used on this material.
  135418. */
  135419. set cameraContrast(value: number);
  135420. /**
  135421. * Gets the Color Grading 2D Lookup Texture.
  135422. */
  135423. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  135424. /**
  135425. * Sets the Color Grading 2D Lookup Texture.
  135426. */
  135427. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  135428. /**
  135429. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135430. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135431. * 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;
  135432. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135433. */
  135434. get cameraColorCurves(): Nullable<ColorCurves>;
  135435. /**
  135436. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135437. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135438. * 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;
  135439. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135440. */
  135441. set cameraColorCurves(value: Nullable<ColorCurves>);
  135442. /**
  135443. * Instantiates a new PBRMaterial instance.
  135444. *
  135445. * @param name The material name
  135446. * @param scene The scene the material will be use in.
  135447. */
  135448. constructor(name: string, scene: Scene);
  135449. /**
  135450. * Returns the name of this material class.
  135451. */
  135452. getClassName(): string;
  135453. /**
  135454. * Makes a duplicate of the current material.
  135455. * @param name - name to use for the new material.
  135456. */
  135457. clone(name: string): PBRMaterial;
  135458. /**
  135459. * Serializes this PBR Material.
  135460. * @returns - An object with the serialized material.
  135461. */
  135462. serialize(): any;
  135463. /**
  135464. * Parses a PBR Material from a serialized object.
  135465. * @param source - Serialized object.
  135466. * @param scene - BJS scene instance.
  135467. * @param rootUrl - url for the scene object
  135468. * @returns - PBRMaterial
  135469. */
  135470. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  135471. }
  135472. }
  135473. declare module BABYLON {
  135474. /**
  135475. * Direct draw surface info
  135476. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  135477. */
  135478. export interface DDSInfo {
  135479. /**
  135480. * Width of the texture
  135481. */
  135482. width: number;
  135483. /**
  135484. * Width of the texture
  135485. */
  135486. height: number;
  135487. /**
  135488. * Number of Mipmaps for the texture
  135489. * @see https://en.wikipedia.org/wiki/Mipmap
  135490. */
  135491. mipmapCount: number;
  135492. /**
  135493. * If the textures format is a known fourCC format
  135494. * @see https://www.fourcc.org/
  135495. */
  135496. isFourCC: boolean;
  135497. /**
  135498. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  135499. */
  135500. isRGB: boolean;
  135501. /**
  135502. * If the texture is a lumincance format
  135503. */
  135504. isLuminance: boolean;
  135505. /**
  135506. * If this is a cube texture
  135507. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  135508. */
  135509. isCube: boolean;
  135510. /**
  135511. * If the texture is a compressed format eg. FOURCC_DXT1
  135512. */
  135513. isCompressed: boolean;
  135514. /**
  135515. * The dxgiFormat of the texture
  135516. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  135517. */
  135518. dxgiFormat: number;
  135519. /**
  135520. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  135521. */
  135522. textureType: number;
  135523. /**
  135524. * Sphericle polynomial created for the dds texture
  135525. */
  135526. sphericalPolynomial?: SphericalPolynomial;
  135527. }
  135528. /**
  135529. * Class used to provide DDS decompression tools
  135530. */
  135531. export class DDSTools {
  135532. /**
  135533. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  135534. */
  135535. static StoreLODInAlphaChannel: boolean;
  135536. /**
  135537. * Gets DDS information from an array buffer
  135538. * @param data defines the array buffer view to read data from
  135539. * @returns the DDS information
  135540. */
  135541. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  135542. private static _FloatView;
  135543. private static _Int32View;
  135544. private static _ToHalfFloat;
  135545. private static _FromHalfFloat;
  135546. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  135547. private static _GetHalfFloatRGBAArrayBuffer;
  135548. private static _GetFloatRGBAArrayBuffer;
  135549. private static _GetFloatAsUIntRGBAArrayBuffer;
  135550. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  135551. private static _GetRGBAArrayBuffer;
  135552. private static _ExtractLongWordOrder;
  135553. private static _GetRGBArrayBuffer;
  135554. private static _GetLuminanceArrayBuffer;
  135555. /**
  135556. * Uploads DDS Levels to a Babylon Texture
  135557. * @hidden
  135558. */
  135559. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  135560. }
  135561. interface ThinEngine {
  135562. /**
  135563. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  135564. * @param rootUrl defines the url where the file to load is located
  135565. * @param scene defines the current scene
  135566. * @param lodScale defines scale to apply to the mip map selection
  135567. * @param lodOffset defines offset to apply to the mip map selection
  135568. * @param onLoad defines an optional callback raised when the texture is loaded
  135569. * @param onError defines an optional callback raised if there is an issue to load the texture
  135570. * @param format defines the format of the data
  135571. * @param forcedExtension defines the extension to use to pick the right loader
  135572. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  135573. * @returns the cube texture as an InternalTexture
  135574. */
  135575. 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;
  135576. }
  135577. }
  135578. declare module BABYLON {
  135579. /**
  135580. * Implementation of the DDS Texture Loader.
  135581. * @hidden
  135582. */
  135583. export class _DDSTextureLoader implements IInternalTextureLoader {
  135584. /**
  135585. * Defines wether the loader supports cascade loading the different faces.
  135586. */
  135587. readonly supportCascades: boolean;
  135588. /**
  135589. * This returns if the loader support the current file information.
  135590. * @param extension defines the file extension of the file being loaded
  135591. * @returns true if the loader can load the specified file
  135592. */
  135593. canLoad(extension: string): boolean;
  135594. /**
  135595. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135596. * @param data contains the texture data
  135597. * @param texture defines the BabylonJS internal texture
  135598. * @param createPolynomials will be true if polynomials have been requested
  135599. * @param onLoad defines the callback to trigger once the texture is ready
  135600. * @param onError defines the callback to trigger in case of error
  135601. */
  135602. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135603. /**
  135604. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135605. * @param data contains the texture data
  135606. * @param texture defines the BabylonJS internal texture
  135607. * @param callback defines the method to call once ready to upload
  135608. */
  135609. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  135610. }
  135611. }
  135612. declare module BABYLON {
  135613. /**
  135614. * Implementation of the ENV Texture Loader.
  135615. * @hidden
  135616. */
  135617. export class _ENVTextureLoader implements IInternalTextureLoader {
  135618. /**
  135619. * Defines wether the loader supports cascade loading the different faces.
  135620. */
  135621. readonly supportCascades: boolean;
  135622. /**
  135623. * This returns if the loader support the current file information.
  135624. * @param extension defines the file extension of the file being loaded
  135625. * @returns true if the loader can load the specified file
  135626. */
  135627. canLoad(extension: string): boolean;
  135628. /**
  135629. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135630. * @param data contains the texture data
  135631. * @param texture defines the BabylonJS internal texture
  135632. * @param createPolynomials will be true if polynomials have been requested
  135633. * @param onLoad defines the callback to trigger once the texture is ready
  135634. * @param onError defines the callback to trigger in case of error
  135635. */
  135636. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135637. /**
  135638. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135639. * @param data contains the texture data
  135640. * @param texture defines the BabylonJS internal texture
  135641. * @param callback defines the method to call once ready to upload
  135642. */
  135643. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  135644. }
  135645. }
  135646. declare module BABYLON {
  135647. /**
  135648. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  135649. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  135650. */
  135651. export class KhronosTextureContainer {
  135652. /** contents of the KTX container file */
  135653. data: ArrayBufferView;
  135654. private static HEADER_LEN;
  135655. private static COMPRESSED_2D;
  135656. private static COMPRESSED_3D;
  135657. private static TEX_2D;
  135658. private static TEX_3D;
  135659. /**
  135660. * Gets the openGL type
  135661. */
  135662. glType: number;
  135663. /**
  135664. * Gets the openGL type size
  135665. */
  135666. glTypeSize: number;
  135667. /**
  135668. * Gets the openGL format
  135669. */
  135670. glFormat: number;
  135671. /**
  135672. * Gets the openGL internal format
  135673. */
  135674. glInternalFormat: number;
  135675. /**
  135676. * Gets the base internal format
  135677. */
  135678. glBaseInternalFormat: number;
  135679. /**
  135680. * Gets image width in pixel
  135681. */
  135682. pixelWidth: number;
  135683. /**
  135684. * Gets image height in pixel
  135685. */
  135686. pixelHeight: number;
  135687. /**
  135688. * Gets image depth in pixels
  135689. */
  135690. pixelDepth: number;
  135691. /**
  135692. * Gets the number of array elements
  135693. */
  135694. numberOfArrayElements: number;
  135695. /**
  135696. * Gets the number of faces
  135697. */
  135698. numberOfFaces: number;
  135699. /**
  135700. * Gets the number of mipmap levels
  135701. */
  135702. numberOfMipmapLevels: number;
  135703. /**
  135704. * Gets the bytes of key value data
  135705. */
  135706. bytesOfKeyValueData: number;
  135707. /**
  135708. * Gets the load type
  135709. */
  135710. loadType: number;
  135711. /**
  135712. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  135713. */
  135714. isInvalid: boolean;
  135715. /**
  135716. * Creates a new KhronosTextureContainer
  135717. * @param data contents of the KTX container file
  135718. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  135719. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  135720. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  135721. */
  135722. constructor(
  135723. /** contents of the KTX container file */
  135724. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  135725. /**
  135726. * Uploads KTX content to a Babylon Texture.
  135727. * It is assumed that the texture has already been created & is currently bound
  135728. * @hidden
  135729. */
  135730. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  135731. private _upload2DCompressedLevels;
  135732. /**
  135733. * Checks if the given data starts with a KTX file identifier.
  135734. * @param data the data to check
  135735. * @returns true if the data is a KTX file or false otherwise
  135736. */
  135737. static IsValid(data: ArrayBufferView): boolean;
  135738. }
  135739. }
  135740. declare module BABYLON {
  135741. /**
  135742. * Class for loading KTX2 files
  135743. * !!! Experimental Extension Subject to Changes !!!
  135744. * @hidden
  135745. */
  135746. export class KhronosTextureContainer2 {
  135747. private static _ModulePromise;
  135748. private static _TranscodeFormat;
  135749. constructor(engine: ThinEngine);
  135750. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  135751. private _determineTranscodeFormat;
  135752. /**
  135753. * Checks if the given data starts with a KTX2 file identifier.
  135754. * @param data the data to check
  135755. * @returns true if the data is a KTX2 file or false otherwise
  135756. */
  135757. static IsValid(data: ArrayBufferView): boolean;
  135758. }
  135759. }
  135760. declare module BABYLON {
  135761. /**
  135762. * Implementation of the KTX Texture Loader.
  135763. * @hidden
  135764. */
  135765. export class _KTXTextureLoader implements IInternalTextureLoader {
  135766. /**
  135767. * Defines wether the loader supports cascade loading the different faces.
  135768. */
  135769. readonly supportCascades: boolean;
  135770. /**
  135771. * This returns if the loader support the current file information.
  135772. * @param extension defines the file extension of the file being loaded
  135773. * @param mimeType defines the optional mime type of the file being loaded
  135774. * @returns true if the loader can load the specified file
  135775. */
  135776. canLoad(extension: string, mimeType?: string): boolean;
  135777. /**
  135778. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135779. * @param data contains the texture data
  135780. * @param texture defines the BabylonJS internal texture
  135781. * @param createPolynomials will be true if polynomials have been requested
  135782. * @param onLoad defines the callback to trigger once the texture is ready
  135783. * @param onError defines the callback to trigger in case of error
  135784. */
  135785. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135786. /**
  135787. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135788. * @param data contains the texture data
  135789. * @param texture defines the BabylonJS internal texture
  135790. * @param callback defines the method to call once ready to upload
  135791. */
  135792. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  135793. }
  135794. }
  135795. declare module BABYLON {
  135796. /** @hidden */
  135797. export var _forceSceneHelpersToBundle: boolean;
  135798. interface Scene {
  135799. /**
  135800. * Creates a default light for the scene.
  135801. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  135802. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  135803. */
  135804. createDefaultLight(replace?: boolean): void;
  135805. /**
  135806. * Creates a default camera for the scene.
  135807. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  135808. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  135809. * @param replace has default false, when true replaces the active camera in the scene
  135810. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  135811. */
  135812. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  135813. /**
  135814. * Creates a default camera and a default light.
  135815. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  135816. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  135817. * @param replace has the default false, when true replaces the active camera/light in the scene
  135818. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  135819. */
  135820. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  135821. /**
  135822. * Creates a new sky box
  135823. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  135824. * @param environmentTexture defines the texture to use as environment texture
  135825. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  135826. * @param scale defines the overall scale of the skybox
  135827. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  135828. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  135829. * @returns a new mesh holding the sky box
  135830. */
  135831. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  135832. /**
  135833. * Creates a new environment
  135834. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  135835. * @param options defines the options you can use to configure the environment
  135836. * @returns the new EnvironmentHelper
  135837. */
  135838. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  135839. /**
  135840. * Creates a new VREXperienceHelper
  135841. * @see https://doc.babylonjs.com/how_to/webvr_helper
  135842. * @param webVROptions defines the options used to create the new VREXperienceHelper
  135843. * @returns a new VREXperienceHelper
  135844. */
  135845. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  135846. /**
  135847. * Creates a new WebXRDefaultExperience
  135848. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  135849. * @param options experience options
  135850. * @returns a promise for a new WebXRDefaultExperience
  135851. */
  135852. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  135853. }
  135854. }
  135855. declare module BABYLON {
  135856. /**
  135857. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  135858. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  135859. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  135860. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135861. */
  135862. export class VideoDome extends TransformNode {
  135863. /**
  135864. * Define the video source as a Monoscopic panoramic 360 video.
  135865. */
  135866. static readonly MODE_MONOSCOPIC: number;
  135867. /**
  135868. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  135869. */
  135870. static readonly MODE_TOPBOTTOM: number;
  135871. /**
  135872. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  135873. */
  135874. static readonly MODE_SIDEBYSIDE: number;
  135875. private _halfDome;
  135876. private _useDirectMapping;
  135877. /**
  135878. * The video texture being displayed on the sphere
  135879. */
  135880. protected _videoTexture: VideoTexture;
  135881. /**
  135882. * Gets the video texture being displayed on the sphere
  135883. */
  135884. get videoTexture(): VideoTexture;
  135885. /**
  135886. * The skybox material
  135887. */
  135888. protected _material: BackgroundMaterial;
  135889. /**
  135890. * The surface used for the video dome
  135891. */
  135892. protected _mesh: Mesh;
  135893. /**
  135894. * Gets the mesh used for the video dome.
  135895. */
  135896. get mesh(): Mesh;
  135897. /**
  135898. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  135899. */
  135900. private _halfDomeMask;
  135901. /**
  135902. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  135903. * Also see the options.resolution property.
  135904. */
  135905. get fovMultiplier(): number;
  135906. set fovMultiplier(value: number);
  135907. private _videoMode;
  135908. /**
  135909. * Gets or set the current video mode for the video. It can be:
  135910. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  135911. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  135912. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  135913. */
  135914. get videoMode(): number;
  135915. set videoMode(value: number);
  135916. /**
  135917. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  135918. *
  135919. */
  135920. get halfDome(): boolean;
  135921. /**
  135922. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  135923. */
  135924. set halfDome(enabled: boolean);
  135925. /**
  135926. * Oberserver used in Stereoscopic VR Mode.
  135927. */
  135928. private _onBeforeCameraRenderObserver;
  135929. /**
  135930. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  135931. * @param name Element's name, child elements will append suffixes for their own names.
  135932. * @param urlsOrVideo defines the url(s) or the video element to use
  135933. * @param options An object containing optional or exposed sub element properties
  135934. */
  135935. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  135936. resolution?: number;
  135937. clickToPlay?: boolean;
  135938. autoPlay?: boolean;
  135939. loop?: boolean;
  135940. size?: number;
  135941. poster?: string;
  135942. faceForward?: boolean;
  135943. useDirectMapping?: boolean;
  135944. halfDomeMode?: boolean;
  135945. }, scene: Scene);
  135946. private _changeVideoMode;
  135947. /**
  135948. * Releases resources associated with this node.
  135949. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  135950. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  135951. */
  135952. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  135953. }
  135954. }
  135955. declare module BABYLON {
  135956. /**
  135957. * This class can be used to get instrumentation data from a Babylon engine
  135958. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  135959. */
  135960. export class EngineInstrumentation implements IDisposable {
  135961. /**
  135962. * Define the instrumented engine.
  135963. */
  135964. engine: Engine;
  135965. private _captureGPUFrameTime;
  135966. private _gpuFrameTimeToken;
  135967. private _gpuFrameTime;
  135968. private _captureShaderCompilationTime;
  135969. private _shaderCompilationTime;
  135970. private _onBeginFrameObserver;
  135971. private _onEndFrameObserver;
  135972. private _onBeforeShaderCompilationObserver;
  135973. private _onAfterShaderCompilationObserver;
  135974. /**
  135975. * Gets the perf counter used for GPU frame time
  135976. */
  135977. get gpuFrameTimeCounter(): PerfCounter;
  135978. /**
  135979. * Gets the GPU frame time capture status
  135980. */
  135981. get captureGPUFrameTime(): boolean;
  135982. /**
  135983. * Enable or disable the GPU frame time capture
  135984. */
  135985. set captureGPUFrameTime(value: boolean);
  135986. /**
  135987. * Gets the perf counter used for shader compilation time
  135988. */
  135989. get shaderCompilationTimeCounter(): PerfCounter;
  135990. /**
  135991. * Gets the shader compilation time capture status
  135992. */
  135993. get captureShaderCompilationTime(): boolean;
  135994. /**
  135995. * Enable or disable the shader compilation time capture
  135996. */
  135997. set captureShaderCompilationTime(value: boolean);
  135998. /**
  135999. * Instantiates a new engine instrumentation.
  136000. * This class can be used to get instrumentation data from a Babylon engine
  136001. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  136002. * @param engine Defines the engine to instrument
  136003. */
  136004. constructor(
  136005. /**
  136006. * Define the instrumented engine.
  136007. */
  136008. engine: Engine);
  136009. /**
  136010. * Dispose and release associated resources.
  136011. */
  136012. dispose(): void;
  136013. }
  136014. }
  136015. declare module BABYLON {
  136016. /**
  136017. * This class can be used to get instrumentation data from a Babylon engine
  136018. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  136019. */
  136020. export class SceneInstrumentation implements IDisposable {
  136021. /**
  136022. * Defines the scene to instrument
  136023. */
  136024. scene: Scene;
  136025. private _captureActiveMeshesEvaluationTime;
  136026. private _activeMeshesEvaluationTime;
  136027. private _captureRenderTargetsRenderTime;
  136028. private _renderTargetsRenderTime;
  136029. private _captureFrameTime;
  136030. private _frameTime;
  136031. private _captureRenderTime;
  136032. private _renderTime;
  136033. private _captureInterFrameTime;
  136034. private _interFrameTime;
  136035. private _captureParticlesRenderTime;
  136036. private _particlesRenderTime;
  136037. private _captureSpritesRenderTime;
  136038. private _spritesRenderTime;
  136039. private _capturePhysicsTime;
  136040. private _physicsTime;
  136041. private _captureAnimationsTime;
  136042. private _animationsTime;
  136043. private _captureCameraRenderTime;
  136044. private _cameraRenderTime;
  136045. private _onBeforeActiveMeshesEvaluationObserver;
  136046. private _onAfterActiveMeshesEvaluationObserver;
  136047. private _onBeforeRenderTargetsRenderObserver;
  136048. private _onAfterRenderTargetsRenderObserver;
  136049. private _onAfterRenderObserver;
  136050. private _onBeforeDrawPhaseObserver;
  136051. private _onAfterDrawPhaseObserver;
  136052. private _onBeforeAnimationsObserver;
  136053. private _onBeforeParticlesRenderingObserver;
  136054. private _onAfterParticlesRenderingObserver;
  136055. private _onBeforeSpritesRenderingObserver;
  136056. private _onAfterSpritesRenderingObserver;
  136057. private _onBeforePhysicsObserver;
  136058. private _onAfterPhysicsObserver;
  136059. private _onAfterAnimationsObserver;
  136060. private _onBeforeCameraRenderObserver;
  136061. private _onAfterCameraRenderObserver;
  136062. /**
  136063. * Gets the perf counter used for active meshes evaluation time
  136064. */
  136065. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  136066. /**
  136067. * Gets the active meshes evaluation time capture status
  136068. */
  136069. get captureActiveMeshesEvaluationTime(): boolean;
  136070. /**
  136071. * Enable or disable the active meshes evaluation time capture
  136072. */
  136073. set captureActiveMeshesEvaluationTime(value: boolean);
  136074. /**
  136075. * Gets the perf counter used for render targets render time
  136076. */
  136077. get renderTargetsRenderTimeCounter(): PerfCounter;
  136078. /**
  136079. * Gets the render targets render time capture status
  136080. */
  136081. get captureRenderTargetsRenderTime(): boolean;
  136082. /**
  136083. * Enable or disable the render targets render time capture
  136084. */
  136085. set captureRenderTargetsRenderTime(value: boolean);
  136086. /**
  136087. * Gets the perf counter used for particles render time
  136088. */
  136089. get particlesRenderTimeCounter(): PerfCounter;
  136090. /**
  136091. * Gets the particles render time capture status
  136092. */
  136093. get captureParticlesRenderTime(): boolean;
  136094. /**
  136095. * Enable or disable the particles render time capture
  136096. */
  136097. set captureParticlesRenderTime(value: boolean);
  136098. /**
  136099. * Gets the perf counter used for sprites render time
  136100. */
  136101. get spritesRenderTimeCounter(): PerfCounter;
  136102. /**
  136103. * Gets the sprites render time capture status
  136104. */
  136105. get captureSpritesRenderTime(): boolean;
  136106. /**
  136107. * Enable or disable the sprites render time capture
  136108. */
  136109. set captureSpritesRenderTime(value: boolean);
  136110. /**
  136111. * Gets the perf counter used for physics time
  136112. */
  136113. get physicsTimeCounter(): PerfCounter;
  136114. /**
  136115. * Gets the physics time capture status
  136116. */
  136117. get capturePhysicsTime(): boolean;
  136118. /**
  136119. * Enable or disable the physics time capture
  136120. */
  136121. set capturePhysicsTime(value: boolean);
  136122. /**
  136123. * Gets the perf counter used for animations time
  136124. */
  136125. get animationsTimeCounter(): PerfCounter;
  136126. /**
  136127. * Gets the animations time capture status
  136128. */
  136129. get captureAnimationsTime(): boolean;
  136130. /**
  136131. * Enable or disable the animations time capture
  136132. */
  136133. set captureAnimationsTime(value: boolean);
  136134. /**
  136135. * Gets the perf counter used for frame time capture
  136136. */
  136137. get frameTimeCounter(): PerfCounter;
  136138. /**
  136139. * Gets the frame time capture status
  136140. */
  136141. get captureFrameTime(): boolean;
  136142. /**
  136143. * Enable or disable the frame time capture
  136144. */
  136145. set captureFrameTime(value: boolean);
  136146. /**
  136147. * Gets the perf counter used for inter-frames time capture
  136148. */
  136149. get interFrameTimeCounter(): PerfCounter;
  136150. /**
  136151. * Gets the inter-frames time capture status
  136152. */
  136153. get captureInterFrameTime(): boolean;
  136154. /**
  136155. * Enable or disable the inter-frames time capture
  136156. */
  136157. set captureInterFrameTime(value: boolean);
  136158. /**
  136159. * Gets the perf counter used for render time capture
  136160. */
  136161. get renderTimeCounter(): PerfCounter;
  136162. /**
  136163. * Gets the render time capture status
  136164. */
  136165. get captureRenderTime(): boolean;
  136166. /**
  136167. * Enable or disable the render time capture
  136168. */
  136169. set captureRenderTime(value: boolean);
  136170. /**
  136171. * Gets the perf counter used for camera render time capture
  136172. */
  136173. get cameraRenderTimeCounter(): PerfCounter;
  136174. /**
  136175. * Gets the camera render time capture status
  136176. */
  136177. get captureCameraRenderTime(): boolean;
  136178. /**
  136179. * Enable or disable the camera render time capture
  136180. */
  136181. set captureCameraRenderTime(value: boolean);
  136182. /**
  136183. * Gets the perf counter used for draw calls
  136184. */
  136185. get drawCallsCounter(): PerfCounter;
  136186. /**
  136187. * Instantiates a new scene instrumentation.
  136188. * This class can be used to get instrumentation data from a Babylon engine
  136189. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  136190. * @param scene Defines the scene to instrument
  136191. */
  136192. constructor(
  136193. /**
  136194. * Defines the scene to instrument
  136195. */
  136196. scene: Scene);
  136197. /**
  136198. * Dispose and release associated resources.
  136199. */
  136200. dispose(): void;
  136201. }
  136202. }
  136203. declare module BABYLON {
  136204. /** @hidden */
  136205. export var glowMapGenerationPixelShader: {
  136206. name: string;
  136207. shader: string;
  136208. };
  136209. }
  136210. declare module BABYLON {
  136211. /** @hidden */
  136212. export var glowMapGenerationVertexShader: {
  136213. name: string;
  136214. shader: string;
  136215. };
  136216. }
  136217. declare module BABYLON {
  136218. /**
  136219. * Effect layer options. This helps customizing the behaviour
  136220. * of the effect layer.
  136221. */
  136222. export interface IEffectLayerOptions {
  136223. /**
  136224. * Multiplication factor apply to the canvas size to compute the render target size
  136225. * used to generated the objects (the smaller the faster).
  136226. */
  136227. mainTextureRatio: number;
  136228. /**
  136229. * Enforces a fixed size texture to ensure effect stability across devices.
  136230. */
  136231. mainTextureFixedSize?: number;
  136232. /**
  136233. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  136234. */
  136235. alphaBlendingMode: number;
  136236. /**
  136237. * The camera attached to the layer.
  136238. */
  136239. camera: Nullable<Camera>;
  136240. /**
  136241. * The rendering group to draw the layer in.
  136242. */
  136243. renderingGroupId: number;
  136244. }
  136245. /**
  136246. * The effect layer Helps adding post process effect blended with the main pass.
  136247. *
  136248. * This can be for instance use to generate glow or higlight effects on the scene.
  136249. *
  136250. * The effect layer class can not be used directly and is intented to inherited from to be
  136251. * customized per effects.
  136252. */
  136253. export abstract class EffectLayer {
  136254. private _vertexBuffers;
  136255. private _indexBuffer;
  136256. private _cachedDefines;
  136257. private _effectLayerMapGenerationEffect;
  136258. private _effectLayerOptions;
  136259. private _mergeEffect;
  136260. protected _scene: Scene;
  136261. protected _engine: Engine;
  136262. protected _maxSize: number;
  136263. protected _mainTextureDesiredSize: ISize;
  136264. protected _mainTexture: RenderTargetTexture;
  136265. protected _shouldRender: boolean;
  136266. protected _postProcesses: PostProcess[];
  136267. protected _textures: BaseTexture[];
  136268. protected _emissiveTextureAndColor: {
  136269. texture: Nullable<BaseTexture>;
  136270. color: Color4;
  136271. };
  136272. /**
  136273. * The name of the layer
  136274. */
  136275. name: string;
  136276. /**
  136277. * The clear color of the texture used to generate the glow map.
  136278. */
  136279. neutralColor: Color4;
  136280. /**
  136281. * Specifies whether the highlight layer is enabled or not.
  136282. */
  136283. isEnabled: boolean;
  136284. /**
  136285. * Gets the camera attached to the layer.
  136286. */
  136287. get camera(): Nullable<Camera>;
  136288. /**
  136289. * Gets the rendering group id the layer should render in.
  136290. */
  136291. get renderingGroupId(): number;
  136292. set renderingGroupId(renderingGroupId: number);
  136293. /**
  136294. * An event triggered when the effect layer has been disposed.
  136295. */
  136296. onDisposeObservable: Observable<EffectLayer>;
  136297. /**
  136298. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  136299. */
  136300. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  136301. /**
  136302. * An event triggered when the generated texture is being merged in the scene.
  136303. */
  136304. onBeforeComposeObservable: Observable<EffectLayer>;
  136305. /**
  136306. * An event triggered when the mesh is rendered into the effect render target.
  136307. */
  136308. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  136309. /**
  136310. * An event triggered after the mesh has been rendered into the effect render target.
  136311. */
  136312. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  136313. /**
  136314. * An event triggered when the generated texture has been merged in the scene.
  136315. */
  136316. onAfterComposeObservable: Observable<EffectLayer>;
  136317. /**
  136318. * An event triggered when the efffect layer changes its size.
  136319. */
  136320. onSizeChangedObservable: Observable<EffectLayer>;
  136321. /** @hidden */
  136322. static _SceneComponentInitialization: (scene: Scene) => void;
  136323. /**
  136324. * Instantiates a new effect Layer and references it in the scene.
  136325. * @param name The name of the layer
  136326. * @param scene The scene to use the layer in
  136327. */
  136328. constructor(
  136329. /** The Friendly of the effect in the scene */
  136330. name: string, scene: Scene);
  136331. /**
  136332. * Get the effect name of the layer.
  136333. * @return The effect name
  136334. */
  136335. abstract getEffectName(): string;
  136336. /**
  136337. * Checks for the readiness of the element composing the layer.
  136338. * @param subMesh the mesh to check for
  136339. * @param useInstances specify whether or not to use instances to render the mesh
  136340. * @return true if ready otherwise, false
  136341. */
  136342. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136343. /**
  136344. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  136345. * @returns true if the effect requires stencil during the main canvas render pass.
  136346. */
  136347. abstract needStencil(): boolean;
  136348. /**
  136349. * Create the merge effect. This is the shader use to blit the information back
  136350. * to the main canvas at the end of the scene rendering.
  136351. * @returns The effect containing the shader used to merge the effect on the main canvas
  136352. */
  136353. protected abstract _createMergeEffect(): Effect;
  136354. /**
  136355. * Creates the render target textures and post processes used in the effect layer.
  136356. */
  136357. protected abstract _createTextureAndPostProcesses(): void;
  136358. /**
  136359. * Implementation specific of rendering the generating effect on the main canvas.
  136360. * @param effect The effect used to render through
  136361. */
  136362. protected abstract _internalRender(effect: Effect): void;
  136363. /**
  136364. * Sets the required values for both the emissive texture and and the main color.
  136365. */
  136366. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136367. /**
  136368. * Free any resources and references associated to a mesh.
  136369. * Internal use
  136370. * @param mesh The mesh to free.
  136371. */
  136372. abstract _disposeMesh(mesh: Mesh): void;
  136373. /**
  136374. * Serializes this layer (Glow or Highlight for example)
  136375. * @returns a serialized layer object
  136376. */
  136377. abstract serialize?(): any;
  136378. /**
  136379. * Initializes the effect layer with the required options.
  136380. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  136381. */
  136382. protected _init(options: Partial<IEffectLayerOptions>): void;
  136383. /**
  136384. * Generates the index buffer of the full screen quad blending to the main canvas.
  136385. */
  136386. private _generateIndexBuffer;
  136387. /**
  136388. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  136389. */
  136390. private _generateVertexBuffer;
  136391. /**
  136392. * Sets the main texture desired size which is the closest power of two
  136393. * of the engine canvas size.
  136394. */
  136395. private _setMainTextureSize;
  136396. /**
  136397. * Creates the main texture for the effect layer.
  136398. */
  136399. protected _createMainTexture(): void;
  136400. /**
  136401. * Adds specific effects defines.
  136402. * @param defines The defines to add specifics to.
  136403. */
  136404. protected _addCustomEffectDefines(defines: string[]): void;
  136405. /**
  136406. * Checks for the readiness of the element composing the layer.
  136407. * @param subMesh the mesh to check for
  136408. * @param useInstances specify whether or not to use instances to render the mesh
  136409. * @param emissiveTexture the associated emissive texture used to generate the glow
  136410. * @return true if ready otherwise, false
  136411. */
  136412. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  136413. /**
  136414. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  136415. */
  136416. render(): void;
  136417. /**
  136418. * Determine if a given mesh will be used in the current effect.
  136419. * @param mesh mesh to test
  136420. * @returns true if the mesh will be used
  136421. */
  136422. hasMesh(mesh: AbstractMesh): boolean;
  136423. /**
  136424. * Returns true if the layer contains information to display, otherwise false.
  136425. * @returns true if the glow layer should be rendered
  136426. */
  136427. shouldRender(): boolean;
  136428. /**
  136429. * Returns true if the mesh should render, otherwise false.
  136430. * @param mesh The mesh to render
  136431. * @returns true if it should render otherwise false
  136432. */
  136433. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  136434. /**
  136435. * Returns true if the mesh can be rendered, otherwise false.
  136436. * @param mesh The mesh to render
  136437. * @param material The material used on the mesh
  136438. * @returns true if it can be rendered otherwise false
  136439. */
  136440. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136441. /**
  136442. * Returns true if the mesh should render, otherwise false.
  136443. * @param mesh The mesh to render
  136444. * @returns true if it should render otherwise false
  136445. */
  136446. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  136447. /**
  136448. * Renders the submesh passed in parameter to the generation map.
  136449. */
  136450. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  136451. /**
  136452. * Defines whether the current material of the mesh should be use to render the effect.
  136453. * @param mesh defines the current mesh to render
  136454. */
  136455. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  136456. /**
  136457. * Rebuild the required buffers.
  136458. * @hidden Internal use only.
  136459. */
  136460. _rebuild(): void;
  136461. /**
  136462. * Dispose only the render target textures and post process.
  136463. */
  136464. private _disposeTextureAndPostProcesses;
  136465. /**
  136466. * Dispose the highlight layer and free resources.
  136467. */
  136468. dispose(): void;
  136469. /**
  136470. * Gets the class name of the effect layer
  136471. * @returns the string with the class name of the effect layer
  136472. */
  136473. getClassName(): string;
  136474. /**
  136475. * Creates an effect layer from parsed effect layer data
  136476. * @param parsedEffectLayer defines effect layer data
  136477. * @param scene defines the current scene
  136478. * @param rootUrl defines the root URL containing the effect layer information
  136479. * @returns a parsed effect Layer
  136480. */
  136481. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  136482. }
  136483. }
  136484. declare module BABYLON {
  136485. interface AbstractScene {
  136486. /**
  136487. * The list of effect layers (highlights/glow) added to the scene
  136488. * @see https://doc.babylonjs.com/how_to/highlight_layer
  136489. * @see https://doc.babylonjs.com/how_to/glow_layer
  136490. */
  136491. effectLayers: Array<EffectLayer>;
  136492. /**
  136493. * Removes the given effect layer from this scene.
  136494. * @param toRemove defines the effect layer to remove
  136495. * @returns the index of the removed effect layer
  136496. */
  136497. removeEffectLayer(toRemove: EffectLayer): number;
  136498. /**
  136499. * Adds the given effect layer to this scene
  136500. * @param newEffectLayer defines the effect layer to add
  136501. */
  136502. addEffectLayer(newEffectLayer: EffectLayer): void;
  136503. }
  136504. /**
  136505. * Defines the layer scene component responsible to manage any effect layers
  136506. * in a given scene.
  136507. */
  136508. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  136509. /**
  136510. * The component name helpfull to identify the component in the list of scene components.
  136511. */
  136512. readonly name: string;
  136513. /**
  136514. * The scene the component belongs to.
  136515. */
  136516. scene: Scene;
  136517. private _engine;
  136518. private _renderEffects;
  136519. private _needStencil;
  136520. private _previousStencilState;
  136521. /**
  136522. * Creates a new instance of the component for the given scene
  136523. * @param scene Defines the scene to register the component in
  136524. */
  136525. constructor(scene: Scene);
  136526. /**
  136527. * Registers the component in a given scene
  136528. */
  136529. register(): void;
  136530. /**
  136531. * Rebuilds the elements related to this component in case of
  136532. * context lost for instance.
  136533. */
  136534. rebuild(): void;
  136535. /**
  136536. * Serializes the component data to the specified json object
  136537. * @param serializationObject The object to serialize to
  136538. */
  136539. serialize(serializationObject: any): void;
  136540. /**
  136541. * Adds all the elements from the container to the scene
  136542. * @param container the container holding the elements
  136543. */
  136544. addFromContainer(container: AbstractScene): void;
  136545. /**
  136546. * Removes all the elements in the container from the scene
  136547. * @param container contains the elements to remove
  136548. * @param dispose if the removed element should be disposed (default: false)
  136549. */
  136550. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  136551. /**
  136552. * Disposes the component and the associated ressources.
  136553. */
  136554. dispose(): void;
  136555. private _isReadyForMesh;
  136556. private _renderMainTexture;
  136557. private _setStencil;
  136558. private _setStencilBack;
  136559. private _draw;
  136560. private _drawCamera;
  136561. private _drawRenderingGroup;
  136562. }
  136563. }
  136564. declare module BABYLON {
  136565. /** @hidden */
  136566. export var glowMapMergePixelShader: {
  136567. name: string;
  136568. shader: string;
  136569. };
  136570. }
  136571. declare module BABYLON {
  136572. /** @hidden */
  136573. export var glowMapMergeVertexShader: {
  136574. name: string;
  136575. shader: string;
  136576. };
  136577. }
  136578. declare module BABYLON {
  136579. interface AbstractScene {
  136580. /**
  136581. * Return a the first highlight layer of the scene with a given name.
  136582. * @param name The name of the highlight layer to look for.
  136583. * @return The highlight layer if found otherwise null.
  136584. */
  136585. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  136586. }
  136587. /**
  136588. * Glow layer options. This helps customizing the behaviour
  136589. * of the glow layer.
  136590. */
  136591. export interface IGlowLayerOptions {
  136592. /**
  136593. * Multiplication factor apply to the canvas size to compute the render target size
  136594. * used to generated the glowing objects (the smaller the faster).
  136595. */
  136596. mainTextureRatio: number;
  136597. /**
  136598. * Enforces a fixed size texture to ensure resize independant blur.
  136599. */
  136600. mainTextureFixedSize?: number;
  136601. /**
  136602. * How big is the kernel of the blur texture.
  136603. */
  136604. blurKernelSize: number;
  136605. /**
  136606. * The camera attached to the layer.
  136607. */
  136608. camera: Nullable<Camera>;
  136609. /**
  136610. * Enable MSAA by chosing the number of samples.
  136611. */
  136612. mainTextureSamples?: number;
  136613. /**
  136614. * The rendering group to draw the layer in.
  136615. */
  136616. renderingGroupId: number;
  136617. }
  136618. /**
  136619. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  136620. *
  136621. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  136622. *
  136623. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  136624. */
  136625. export class GlowLayer extends EffectLayer {
  136626. /**
  136627. * Effect Name of the layer.
  136628. */
  136629. static readonly EffectName: string;
  136630. /**
  136631. * The default blur kernel size used for the glow.
  136632. */
  136633. static DefaultBlurKernelSize: number;
  136634. /**
  136635. * The default texture size ratio used for the glow.
  136636. */
  136637. static DefaultTextureRatio: number;
  136638. /**
  136639. * Sets the kernel size of the blur.
  136640. */
  136641. set blurKernelSize(value: number);
  136642. /**
  136643. * Gets the kernel size of the blur.
  136644. */
  136645. get blurKernelSize(): number;
  136646. /**
  136647. * Sets the glow intensity.
  136648. */
  136649. set intensity(value: number);
  136650. /**
  136651. * Gets the glow intensity.
  136652. */
  136653. get intensity(): number;
  136654. private _options;
  136655. private _intensity;
  136656. private _horizontalBlurPostprocess1;
  136657. private _verticalBlurPostprocess1;
  136658. private _horizontalBlurPostprocess2;
  136659. private _verticalBlurPostprocess2;
  136660. private _blurTexture1;
  136661. private _blurTexture2;
  136662. private _postProcesses1;
  136663. private _postProcesses2;
  136664. private _includedOnlyMeshes;
  136665. private _excludedMeshes;
  136666. private _meshesUsingTheirOwnMaterials;
  136667. /**
  136668. * Callback used to let the user override the color selection on a per mesh basis
  136669. */
  136670. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  136671. /**
  136672. * Callback used to let the user override the texture selection on a per mesh basis
  136673. */
  136674. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  136675. /**
  136676. * Instantiates a new glow Layer and references it to the scene.
  136677. * @param name The name of the layer
  136678. * @param scene The scene to use the layer in
  136679. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  136680. */
  136681. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  136682. /**
  136683. * Get the effect name of the layer.
  136684. * @return The effect name
  136685. */
  136686. getEffectName(): string;
  136687. /**
  136688. * Create the merge effect. This is the shader use to blit the information back
  136689. * to the main canvas at the end of the scene rendering.
  136690. */
  136691. protected _createMergeEffect(): Effect;
  136692. /**
  136693. * Creates the render target textures and post processes used in the glow layer.
  136694. */
  136695. protected _createTextureAndPostProcesses(): void;
  136696. /**
  136697. * Checks for the readiness of the element composing the layer.
  136698. * @param subMesh the mesh to check for
  136699. * @param useInstances specify wether or not to use instances to render the mesh
  136700. * @param emissiveTexture the associated emissive texture used to generate the glow
  136701. * @return true if ready otherwise, false
  136702. */
  136703. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136704. /**
  136705. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  136706. */
  136707. needStencil(): boolean;
  136708. /**
  136709. * Returns true if the mesh can be rendered, otherwise false.
  136710. * @param mesh The mesh to render
  136711. * @param material The material used on the mesh
  136712. * @returns true if it can be rendered otherwise false
  136713. */
  136714. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136715. /**
  136716. * Implementation specific of rendering the generating effect on the main canvas.
  136717. * @param effect The effect used to render through
  136718. */
  136719. protected _internalRender(effect: Effect): void;
  136720. /**
  136721. * Sets the required values for both the emissive texture and and the main color.
  136722. */
  136723. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136724. /**
  136725. * Returns true if the mesh should render, otherwise false.
  136726. * @param mesh The mesh to render
  136727. * @returns true if it should render otherwise false
  136728. */
  136729. protected _shouldRenderMesh(mesh: Mesh): boolean;
  136730. /**
  136731. * Adds specific effects defines.
  136732. * @param defines The defines to add specifics to.
  136733. */
  136734. protected _addCustomEffectDefines(defines: string[]): void;
  136735. /**
  136736. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  136737. * @param mesh The mesh to exclude from the glow layer
  136738. */
  136739. addExcludedMesh(mesh: Mesh): void;
  136740. /**
  136741. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  136742. * @param mesh The mesh to remove
  136743. */
  136744. removeExcludedMesh(mesh: Mesh): void;
  136745. /**
  136746. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  136747. * @param mesh The mesh to include in the glow layer
  136748. */
  136749. addIncludedOnlyMesh(mesh: Mesh): void;
  136750. /**
  136751. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  136752. * @param mesh The mesh to remove
  136753. */
  136754. removeIncludedOnlyMesh(mesh: Mesh): void;
  136755. /**
  136756. * Determine if a given mesh will be used in the glow layer
  136757. * @param mesh The mesh to test
  136758. * @returns true if the mesh will be highlighted by the current glow layer
  136759. */
  136760. hasMesh(mesh: AbstractMesh): boolean;
  136761. /**
  136762. * Defines whether the current material of the mesh should be use to render the effect.
  136763. * @param mesh defines the current mesh to render
  136764. */
  136765. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  136766. /**
  136767. * Add a mesh to be rendered through its own material and not with emissive only.
  136768. * @param mesh The mesh for which we need to use its material
  136769. */
  136770. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  136771. /**
  136772. * Remove a mesh from being rendered through its own material and not with emissive only.
  136773. * @param mesh The mesh for which we need to not use its material
  136774. */
  136775. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  136776. /**
  136777. * Free any resources and references associated to a mesh.
  136778. * Internal use
  136779. * @param mesh The mesh to free.
  136780. * @hidden
  136781. */
  136782. _disposeMesh(mesh: Mesh): void;
  136783. /**
  136784. * Gets the class name of the effect layer
  136785. * @returns the string with the class name of the effect layer
  136786. */
  136787. getClassName(): string;
  136788. /**
  136789. * Serializes this glow layer
  136790. * @returns a serialized glow layer object
  136791. */
  136792. serialize(): any;
  136793. /**
  136794. * Creates a Glow Layer from parsed glow layer data
  136795. * @param parsedGlowLayer defines glow layer data
  136796. * @param scene defines the current scene
  136797. * @param rootUrl defines the root URL containing the glow layer information
  136798. * @returns a parsed Glow Layer
  136799. */
  136800. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  136801. }
  136802. }
  136803. declare module BABYLON {
  136804. /** @hidden */
  136805. export var glowBlurPostProcessPixelShader: {
  136806. name: string;
  136807. shader: string;
  136808. };
  136809. }
  136810. declare module BABYLON {
  136811. interface AbstractScene {
  136812. /**
  136813. * Return a the first highlight layer of the scene with a given name.
  136814. * @param name The name of the highlight layer to look for.
  136815. * @return The highlight layer if found otherwise null.
  136816. */
  136817. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  136818. }
  136819. /**
  136820. * Highlight layer options. This helps customizing the behaviour
  136821. * of the highlight layer.
  136822. */
  136823. export interface IHighlightLayerOptions {
  136824. /**
  136825. * Multiplication factor apply to the canvas size to compute the render target size
  136826. * used to generated the glowing objects (the smaller the faster).
  136827. */
  136828. mainTextureRatio: number;
  136829. /**
  136830. * Enforces a fixed size texture to ensure resize independant blur.
  136831. */
  136832. mainTextureFixedSize?: number;
  136833. /**
  136834. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  136835. * of the picture to blur (the smaller the faster).
  136836. */
  136837. blurTextureSizeRatio: number;
  136838. /**
  136839. * How big in texel of the blur texture is the vertical blur.
  136840. */
  136841. blurVerticalSize: number;
  136842. /**
  136843. * How big in texel of the blur texture is the horizontal blur.
  136844. */
  136845. blurHorizontalSize: number;
  136846. /**
  136847. * Alpha blending mode used to apply the blur. Default is combine.
  136848. */
  136849. alphaBlendingMode: number;
  136850. /**
  136851. * The camera attached to the layer.
  136852. */
  136853. camera: Nullable<Camera>;
  136854. /**
  136855. * Should we display highlight as a solid stroke?
  136856. */
  136857. isStroke?: boolean;
  136858. /**
  136859. * The rendering group to draw the layer in.
  136860. */
  136861. renderingGroupId: number;
  136862. }
  136863. /**
  136864. * The highlight layer Helps adding a glow effect around a mesh.
  136865. *
  136866. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  136867. * glowy meshes to your scene.
  136868. *
  136869. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  136870. */
  136871. export class HighlightLayer extends EffectLayer {
  136872. name: string;
  136873. /**
  136874. * Effect Name of the highlight layer.
  136875. */
  136876. static readonly EffectName: string;
  136877. /**
  136878. * The neutral color used during the preparation of the glow effect.
  136879. * This is black by default as the blend operation is a blend operation.
  136880. */
  136881. static NeutralColor: Color4;
  136882. /**
  136883. * Stencil value used for glowing meshes.
  136884. */
  136885. static GlowingMeshStencilReference: number;
  136886. /**
  136887. * Stencil value used for the other meshes in the scene.
  136888. */
  136889. static NormalMeshStencilReference: number;
  136890. /**
  136891. * Specifies whether or not the inner glow is ACTIVE in the layer.
  136892. */
  136893. innerGlow: boolean;
  136894. /**
  136895. * Specifies whether or not the outer glow is ACTIVE in the layer.
  136896. */
  136897. outerGlow: boolean;
  136898. /**
  136899. * Specifies the horizontal size of the blur.
  136900. */
  136901. set blurHorizontalSize(value: number);
  136902. /**
  136903. * Specifies the vertical size of the blur.
  136904. */
  136905. set blurVerticalSize(value: number);
  136906. /**
  136907. * Gets the horizontal size of the blur.
  136908. */
  136909. get blurHorizontalSize(): number;
  136910. /**
  136911. * Gets the vertical size of the blur.
  136912. */
  136913. get blurVerticalSize(): number;
  136914. /**
  136915. * An event triggered when the highlight layer is being blurred.
  136916. */
  136917. onBeforeBlurObservable: Observable<HighlightLayer>;
  136918. /**
  136919. * An event triggered when the highlight layer has been blurred.
  136920. */
  136921. onAfterBlurObservable: Observable<HighlightLayer>;
  136922. private _instanceGlowingMeshStencilReference;
  136923. private _options;
  136924. private _downSamplePostprocess;
  136925. private _horizontalBlurPostprocess;
  136926. private _verticalBlurPostprocess;
  136927. private _blurTexture;
  136928. private _meshes;
  136929. private _excludedMeshes;
  136930. /**
  136931. * Instantiates a new highlight Layer and references it to the scene..
  136932. * @param name The name of the layer
  136933. * @param scene The scene to use the layer in
  136934. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  136935. */
  136936. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  136937. /**
  136938. * Get the effect name of the layer.
  136939. * @return The effect name
  136940. */
  136941. getEffectName(): string;
  136942. /**
  136943. * Create the merge effect. This is the shader use to blit the information back
  136944. * to the main canvas at the end of the scene rendering.
  136945. */
  136946. protected _createMergeEffect(): Effect;
  136947. /**
  136948. * Creates the render target textures and post processes used in the highlight layer.
  136949. */
  136950. protected _createTextureAndPostProcesses(): void;
  136951. /**
  136952. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  136953. */
  136954. needStencil(): boolean;
  136955. /**
  136956. * Checks for the readiness of the element composing the layer.
  136957. * @param subMesh the mesh to check for
  136958. * @param useInstances specify wether or not to use instances to render the mesh
  136959. * @param emissiveTexture the associated emissive texture used to generate the glow
  136960. * @return true if ready otherwise, false
  136961. */
  136962. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136963. /**
  136964. * Implementation specific of rendering the generating effect on the main canvas.
  136965. * @param effect The effect used to render through
  136966. */
  136967. protected _internalRender(effect: Effect): void;
  136968. /**
  136969. * Returns true if the layer contains information to display, otherwise false.
  136970. */
  136971. shouldRender(): boolean;
  136972. /**
  136973. * Returns true if the mesh should render, otherwise false.
  136974. * @param mesh The mesh to render
  136975. * @returns true if it should render otherwise false
  136976. */
  136977. protected _shouldRenderMesh(mesh: Mesh): boolean;
  136978. /**
  136979. * Returns true if the mesh can be rendered, otherwise false.
  136980. * @param mesh The mesh to render
  136981. * @param material The material used on the mesh
  136982. * @returns true if it can be rendered otherwise false
  136983. */
  136984. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136985. /**
  136986. * Adds specific effects defines.
  136987. * @param defines The defines to add specifics to.
  136988. */
  136989. protected _addCustomEffectDefines(defines: string[]): void;
  136990. /**
  136991. * Sets the required values for both the emissive texture and and the main color.
  136992. */
  136993. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136994. /**
  136995. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  136996. * @param mesh The mesh to exclude from the highlight layer
  136997. */
  136998. addExcludedMesh(mesh: Mesh): void;
  136999. /**
  137000. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  137001. * @param mesh The mesh to highlight
  137002. */
  137003. removeExcludedMesh(mesh: Mesh): void;
  137004. /**
  137005. * Determine if a given mesh will be highlighted by the current HighlightLayer
  137006. * @param mesh mesh to test
  137007. * @returns true if the mesh will be highlighted by the current HighlightLayer
  137008. */
  137009. hasMesh(mesh: AbstractMesh): boolean;
  137010. /**
  137011. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  137012. * @param mesh The mesh to highlight
  137013. * @param color The color of the highlight
  137014. * @param glowEmissiveOnly Extract the glow from the emissive texture
  137015. */
  137016. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  137017. /**
  137018. * Remove a mesh from the highlight layer in order to make it stop glowing.
  137019. * @param mesh The mesh to highlight
  137020. */
  137021. removeMesh(mesh: Mesh): void;
  137022. /**
  137023. * Remove all the meshes currently referenced in the highlight layer
  137024. */
  137025. removeAllMeshes(): void;
  137026. /**
  137027. * Force the stencil to the normal expected value for none glowing parts
  137028. */
  137029. private _defaultStencilReference;
  137030. /**
  137031. * Free any resources and references associated to a mesh.
  137032. * Internal use
  137033. * @param mesh The mesh to free.
  137034. * @hidden
  137035. */
  137036. _disposeMesh(mesh: Mesh): void;
  137037. /**
  137038. * Dispose the highlight layer and free resources.
  137039. */
  137040. dispose(): void;
  137041. /**
  137042. * Gets the class name of the effect layer
  137043. * @returns the string with the class name of the effect layer
  137044. */
  137045. getClassName(): string;
  137046. /**
  137047. * Serializes this Highlight layer
  137048. * @returns a serialized Highlight layer object
  137049. */
  137050. serialize(): any;
  137051. /**
  137052. * Creates a Highlight layer from parsed Highlight layer data
  137053. * @param parsedHightlightLayer defines the Highlight layer data
  137054. * @param scene defines the current scene
  137055. * @param rootUrl defines the root URL containing the Highlight layer information
  137056. * @returns a parsed Highlight layer
  137057. */
  137058. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  137059. }
  137060. }
  137061. declare module BABYLON {
  137062. interface AbstractScene {
  137063. /**
  137064. * The list of layers (background and foreground) of the scene
  137065. */
  137066. layers: Array<Layer>;
  137067. }
  137068. /**
  137069. * Defines the layer scene component responsible to manage any layers
  137070. * in a given scene.
  137071. */
  137072. export class LayerSceneComponent implements ISceneComponent {
  137073. /**
  137074. * The component name helpfull to identify the component in the list of scene components.
  137075. */
  137076. readonly name: string;
  137077. /**
  137078. * The scene the component belongs to.
  137079. */
  137080. scene: Scene;
  137081. private _engine;
  137082. /**
  137083. * Creates a new instance of the component for the given scene
  137084. * @param scene Defines the scene to register the component in
  137085. */
  137086. constructor(scene: Scene);
  137087. /**
  137088. * Registers the component in a given scene
  137089. */
  137090. register(): void;
  137091. /**
  137092. * Rebuilds the elements related to this component in case of
  137093. * context lost for instance.
  137094. */
  137095. rebuild(): void;
  137096. /**
  137097. * Disposes the component and the associated ressources.
  137098. */
  137099. dispose(): void;
  137100. private _draw;
  137101. private _drawCameraPredicate;
  137102. private _drawCameraBackground;
  137103. private _drawCameraForeground;
  137104. private _drawRenderTargetPredicate;
  137105. private _drawRenderTargetBackground;
  137106. private _drawRenderTargetForeground;
  137107. /**
  137108. * Adds all the elements from the container to the scene
  137109. * @param container the container holding the elements
  137110. */
  137111. addFromContainer(container: AbstractScene): void;
  137112. /**
  137113. * Removes all the elements in the container from the scene
  137114. * @param container contains the elements to remove
  137115. * @param dispose if the removed element should be disposed (default: false)
  137116. */
  137117. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137118. }
  137119. }
  137120. declare module BABYLON {
  137121. /** @hidden */
  137122. export var layerPixelShader: {
  137123. name: string;
  137124. shader: string;
  137125. };
  137126. }
  137127. declare module BABYLON {
  137128. /** @hidden */
  137129. export var layerVertexShader: {
  137130. name: string;
  137131. shader: string;
  137132. };
  137133. }
  137134. declare module BABYLON {
  137135. /**
  137136. * This represents a full screen 2d layer.
  137137. * This can be useful to display a picture in the background of your scene for instance.
  137138. * @see https://www.babylonjs-playground.com/#08A2BS#1
  137139. */
  137140. export class Layer {
  137141. /**
  137142. * Define the name of the layer.
  137143. */
  137144. name: string;
  137145. /**
  137146. * Define the texture the layer should display.
  137147. */
  137148. texture: Nullable<Texture>;
  137149. /**
  137150. * Is the layer in background or foreground.
  137151. */
  137152. isBackground: boolean;
  137153. /**
  137154. * Define the color of the layer (instead of texture).
  137155. */
  137156. color: Color4;
  137157. /**
  137158. * Define the scale of the layer in order to zoom in out of the texture.
  137159. */
  137160. scale: Vector2;
  137161. /**
  137162. * Define an offset for the layer in order to shift the texture.
  137163. */
  137164. offset: Vector2;
  137165. /**
  137166. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  137167. */
  137168. alphaBlendingMode: number;
  137169. /**
  137170. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  137171. * Alpha test will not mix with the background color in case of transparency.
  137172. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  137173. */
  137174. alphaTest: boolean;
  137175. /**
  137176. * Define a mask to restrict the layer to only some of the scene cameras.
  137177. */
  137178. layerMask: number;
  137179. /**
  137180. * Define the list of render target the layer is visible into.
  137181. */
  137182. renderTargetTextures: RenderTargetTexture[];
  137183. /**
  137184. * Define if the layer is only used in renderTarget or if it also
  137185. * renders in the main frame buffer of the canvas.
  137186. */
  137187. renderOnlyInRenderTargetTextures: boolean;
  137188. private _scene;
  137189. private _vertexBuffers;
  137190. private _indexBuffer;
  137191. private _effect;
  137192. private _previousDefines;
  137193. /**
  137194. * An event triggered when the layer is disposed.
  137195. */
  137196. onDisposeObservable: Observable<Layer>;
  137197. private _onDisposeObserver;
  137198. /**
  137199. * Back compatibility with callback before the onDisposeObservable existed.
  137200. * The set callback will be triggered when the layer has been disposed.
  137201. */
  137202. set onDispose(callback: () => void);
  137203. /**
  137204. * An event triggered before rendering the scene
  137205. */
  137206. onBeforeRenderObservable: Observable<Layer>;
  137207. private _onBeforeRenderObserver;
  137208. /**
  137209. * Back compatibility with callback before the onBeforeRenderObservable existed.
  137210. * The set callback will be triggered just before rendering the layer.
  137211. */
  137212. set onBeforeRender(callback: () => void);
  137213. /**
  137214. * An event triggered after rendering the scene
  137215. */
  137216. onAfterRenderObservable: Observable<Layer>;
  137217. private _onAfterRenderObserver;
  137218. /**
  137219. * Back compatibility with callback before the onAfterRenderObservable existed.
  137220. * The set callback will be triggered just after rendering the layer.
  137221. */
  137222. set onAfterRender(callback: () => void);
  137223. /**
  137224. * Instantiates a new layer.
  137225. * This represents a full screen 2d layer.
  137226. * This can be useful to display a picture in the background of your scene for instance.
  137227. * @see https://www.babylonjs-playground.com/#08A2BS#1
  137228. * @param name Define the name of the layer in the scene
  137229. * @param imgUrl Define the url of the texture to display in the layer
  137230. * @param scene Define the scene the layer belongs to
  137231. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  137232. * @param color Defines a color for the layer
  137233. */
  137234. constructor(
  137235. /**
  137236. * Define the name of the layer.
  137237. */
  137238. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  137239. private _createIndexBuffer;
  137240. /** @hidden */
  137241. _rebuild(): void;
  137242. /**
  137243. * Renders the layer in the scene.
  137244. */
  137245. render(): void;
  137246. /**
  137247. * Disposes and releases the associated ressources.
  137248. */
  137249. dispose(): void;
  137250. }
  137251. }
  137252. declare module BABYLON {
  137253. /** @hidden */
  137254. export var lensFlarePixelShader: {
  137255. name: string;
  137256. shader: string;
  137257. };
  137258. }
  137259. declare module BABYLON {
  137260. /** @hidden */
  137261. export var lensFlareVertexShader: {
  137262. name: string;
  137263. shader: string;
  137264. };
  137265. }
  137266. declare module BABYLON {
  137267. /**
  137268. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  137269. * It is usually composed of several `lensFlare`.
  137270. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137271. */
  137272. export class LensFlareSystem {
  137273. /**
  137274. * Define the name of the lens flare system
  137275. */
  137276. name: string;
  137277. /**
  137278. * List of lens flares used in this system.
  137279. */
  137280. lensFlares: LensFlare[];
  137281. /**
  137282. * Define a limit from the border the lens flare can be visible.
  137283. */
  137284. borderLimit: number;
  137285. /**
  137286. * Define a viewport border we do not want to see the lens flare in.
  137287. */
  137288. viewportBorder: number;
  137289. /**
  137290. * Define a predicate which could limit the list of meshes able to occlude the effect.
  137291. */
  137292. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  137293. /**
  137294. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  137295. */
  137296. layerMask: number;
  137297. /**
  137298. * Define the id of the lens flare system in the scene.
  137299. * (equal to name by default)
  137300. */
  137301. id: string;
  137302. private _scene;
  137303. private _emitter;
  137304. private _vertexBuffers;
  137305. private _indexBuffer;
  137306. private _effect;
  137307. private _positionX;
  137308. private _positionY;
  137309. private _isEnabled;
  137310. /** @hidden */
  137311. static _SceneComponentInitialization: (scene: Scene) => void;
  137312. /**
  137313. * Instantiates a lens flare system.
  137314. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  137315. * It is usually composed of several `lensFlare`.
  137316. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137317. * @param name Define the name of the lens flare system in the scene
  137318. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  137319. * @param scene Define the scene the lens flare system belongs to
  137320. */
  137321. constructor(
  137322. /**
  137323. * Define the name of the lens flare system
  137324. */
  137325. name: string, emitter: any, scene: Scene);
  137326. /**
  137327. * Define if the lens flare system is enabled.
  137328. */
  137329. get isEnabled(): boolean;
  137330. set isEnabled(value: boolean);
  137331. /**
  137332. * Get the scene the effects belongs to.
  137333. * @returns the scene holding the lens flare system
  137334. */
  137335. getScene(): Scene;
  137336. /**
  137337. * Get the emitter of the lens flare system.
  137338. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  137339. * @returns the emitter of the lens flare system
  137340. */
  137341. getEmitter(): any;
  137342. /**
  137343. * Set the emitter of the lens flare system.
  137344. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  137345. * @param newEmitter Define the new emitter of the system
  137346. */
  137347. setEmitter(newEmitter: any): void;
  137348. /**
  137349. * Get the lens flare system emitter position.
  137350. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  137351. * @returns the position
  137352. */
  137353. getEmitterPosition(): Vector3;
  137354. /**
  137355. * @hidden
  137356. */
  137357. computeEffectivePosition(globalViewport: Viewport): boolean;
  137358. /** @hidden */
  137359. _isVisible(): boolean;
  137360. /**
  137361. * @hidden
  137362. */
  137363. render(): boolean;
  137364. /**
  137365. * Dispose and release the lens flare with its associated resources.
  137366. */
  137367. dispose(): void;
  137368. /**
  137369. * Parse a lens flare system from a JSON repressentation
  137370. * @param parsedLensFlareSystem Define the JSON to parse
  137371. * @param scene Define the scene the parsed system should be instantiated in
  137372. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  137373. * @returns the parsed system
  137374. */
  137375. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  137376. /**
  137377. * Serialize the current Lens Flare System into a JSON representation.
  137378. * @returns the serialized JSON
  137379. */
  137380. serialize(): any;
  137381. }
  137382. }
  137383. declare module BABYLON {
  137384. /**
  137385. * This represents one of the lens effect in a `lensFlareSystem`.
  137386. * It controls one of the indiviual texture used in the effect.
  137387. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137388. */
  137389. export class LensFlare {
  137390. /**
  137391. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  137392. */
  137393. size: number;
  137394. /**
  137395. * 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.
  137396. */
  137397. position: number;
  137398. /**
  137399. * Define the lens color.
  137400. */
  137401. color: Color3;
  137402. /**
  137403. * Define the lens texture.
  137404. */
  137405. texture: Nullable<Texture>;
  137406. /**
  137407. * Define the alpha mode to render this particular lens.
  137408. */
  137409. alphaMode: number;
  137410. private _system;
  137411. /**
  137412. * Creates a new Lens Flare.
  137413. * This represents one of the lens effect in a `lensFlareSystem`.
  137414. * It controls one of the indiviual texture used in the effect.
  137415. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137416. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  137417. * @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.
  137418. * @param color Define the lens color
  137419. * @param imgUrl Define the lens texture url
  137420. * @param system Define the `lensFlareSystem` this flare is part of
  137421. * @returns The newly created Lens Flare
  137422. */
  137423. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  137424. /**
  137425. * Instantiates a new Lens Flare.
  137426. * This represents one of the lens effect in a `lensFlareSystem`.
  137427. * It controls one of the indiviual texture used in the effect.
  137428. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137429. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  137430. * @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.
  137431. * @param color Define the lens color
  137432. * @param imgUrl Define the lens texture url
  137433. * @param system Define the `lensFlareSystem` this flare is part of
  137434. */
  137435. constructor(
  137436. /**
  137437. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  137438. */
  137439. size: number,
  137440. /**
  137441. * 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.
  137442. */
  137443. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  137444. /**
  137445. * Dispose and release the lens flare with its associated resources.
  137446. */
  137447. dispose(): void;
  137448. }
  137449. }
  137450. declare module BABYLON {
  137451. interface AbstractScene {
  137452. /**
  137453. * The list of lens flare system added to the scene
  137454. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137455. */
  137456. lensFlareSystems: Array<LensFlareSystem>;
  137457. /**
  137458. * Removes the given lens flare system from this scene.
  137459. * @param toRemove The lens flare system to remove
  137460. * @returns The index of the removed lens flare system
  137461. */
  137462. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  137463. /**
  137464. * Adds the given lens flare system to this scene
  137465. * @param newLensFlareSystem The lens flare system to add
  137466. */
  137467. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  137468. /**
  137469. * Gets a lens flare system using its name
  137470. * @param name defines the name to look for
  137471. * @returns the lens flare system or null if not found
  137472. */
  137473. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  137474. /**
  137475. * Gets a lens flare system using its id
  137476. * @param id defines the id to look for
  137477. * @returns the lens flare system or null if not found
  137478. */
  137479. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  137480. }
  137481. /**
  137482. * Defines the lens flare scene component responsible to manage any lens flares
  137483. * in a given scene.
  137484. */
  137485. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  137486. /**
  137487. * The component name helpfull to identify the component in the list of scene components.
  137488. */
  137489. readonly name: string;
  137490. /**
  137491. * The scene the component belongs to.
  137492. */
  137493. scene: Scene;
  137494. /**
  137495. * Creates a new instance of the component for the given scene
  137496. * @param scene Defines the scene to register the component in
  137497. */
  137498. constructor(scene: Scene);
  137499. /**
  137500. * Registers the component in a given scene
  137501. */
  137502. register(): void;
  137503. /**
  137504. * Rebuilds the elements related to this component in case of
  137505. * context lost for instance.
  137506. */
  137507. rebuild(): void;
  137508. /**
  137509. * Adds all the elements from the container to the scene
  137510. * @param container the container holding the elements
  137511. */
  137512. addFromContainer(container: AbstractScene): void;
  137513. /**
  137514. * Removes all the elements in the container from the scene
  137515. * @param container contains the elements to remove
  137516. * @param dispose if the removed element should be disposed (default: false)
  137517. */
  137518. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137519. /**
  137520. * Serializes the component data to the specified json object
  137521. * @param serializationObject The object to serialize to
  137522. */
  137523. serialize(serializationObject: any): void;
  137524. /**
  137525. * Disposes the component and the associated ressources.
  137526. */
  137527. dispose(): void;
  137528. private _draw;
  137529. }
  137530. }
  137531. declare module BABYLON {
  137532. /** @hidden */
  137533. export var depthPixelShader: {
  137534. name: string;
  137535. shader: string;
  137536. };
  137537. }
  137538. declare module BABYLON {
  137539. /** @hidden */
  137540. export var depthVertexShader: {
  137541. name: string;
  137542. shader: string;
  137543. };
  137544. }
  137545. declare module BABYLON {
  137546. /**
  137547. * This represents a depth renderer in Babylon.
  137548. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  137549. */
  137550. export class DepthRenderer {
  137551. private _scene;
  137552. private _depthMap;
  137553. private _effect;
  137554. private readonly _storeNonLinearDepth;
  137555. private readonly _clearColor;
  137556. /** Get if the depth renderer is using packed depth or not */
  137557. readonly isPacked: boolean;
  137558. private _cachedDefines;
  137559. private _camera;
  137560. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  137561. enabled: boolean;
  137562. /**
  137563. * Specifiess that the depth renderer will only be used within
  137564. * the camera it is created for.
  137565. * This can help forcing its rendering during the camera processing.
  137566. */
  137567. useOnlyInActiveCamera: boolean;
  137568. /** @hidden */
  137569. static _SceneComponentInitialization: (scene: Scene) => void;
  137570. /**
  137571. * Instantiates a depth renderer
  137572. * @param scene The scene the renderer belongs to
  137573. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  137574. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  137575. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  137576. */
  137577. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  137578. /**
  137579. * Creates the depth rendering effect and checks if the effect is ready.
  137580. * @param subMesh The submesh to be used to render the depth map of
  137581. * @param useInstances If multiple world instances should be used
  137582. * @returns if the depth renderer is ready to render the depth map
  137583. */
  137584. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137585. /**
  137586. * Gets the texture which the depth map will be written to.
  137587. * @returns The depth map texture
  137588. */
  137589. getDepthMap(): RenderTargetTexture;
  137590. /**
  137591. * Disposes of the depth renderer.
  137592. */
  137593. dispose(): void;
  137594. }
  137595. }
  137596. declare module BABYLON {
  137597. /** @hidden */
  137598. export var minmaxReduxPixelShader: {
  137599. name: string;
  137600. shader: string;
  137601. };
  137602. }
  137603. declare module BABYLON {
  137604. /**
  137605. * This class computes a min/max reduction from a texture: it means it computes the minimum
  137606. * and maximum values from all values of the texture.
  137607. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  137608. * The source values are read from the red channel of the texture.
  137609. */
  137610. export class MinMaxReducer {
  137611. /**
  137612. * Observable triggered when the computation has been performed
  137613. */
  137614. onAfterReductionPerformed: Observable<{
  137615. min: number;
  137616. max: number;
  137617. }>;
  137618. protected _camera: Camera;
  137619. protected _sourceTexture: Nullable<RenderTargetTexture>;
  137620. protected _reductionSteps: Nullable<Array<PostProcess>>;
  137621. protected _postProcessManager: PostProcessManager;
  137622. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  137623. protected _forceFullscreenViewport: boolean;
  137624. /**
  137625. * Creates a min/max reducer
  137626. * @param camera The camera to use for the post processes
  137627. */
  137628. constructor(camera: Camera);
  137629. /**
  137630. * Gets the texture used to read the values from.
  137631. */
  137632. get sourceTexture(): Nullable<RenderTargetTexture>;
  137633. /**
  137634. * Sets the source texture to read the values from.
  137635. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  137636. * because in such textures '1' value must not be taken into account to compute the maximum
  137637. * as this value is used to clear the texture.
  137638. * Note that the computation is not activated by calling this function, you must call activate() for that!
  137639. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  137640. * @param depthRedux Indicates if the texture is a depth texture or not
  137641. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  137642. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  137643. */
  137644. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  137645. /**
  137646. * Defines the refresh rate of the computation.
  137647. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  137648. */
  137649. get refreshRate(): number;
  137650. set refreshRate(value: number);
  137651. protected _activated: boolean;
  137652. /**
  137653. * Gets the activation status of the reducer
  137654. */
  137655. get activated(): boolean;
  137656. /**
  137657. * Activates the reduction computation.
  137658. * When activated, the observers registered in onAfterReductionPerformed are
  137659. * called after the compuation is performed
  137660. */
  137661. activate(): void;
  137662. /**
  137663. * Deactivates the reduction computation.
  137664. */
  137665. deactivate(): void;
  137666. /**
  137667. * Disposes the min/max reducer
  137668. * @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.
  137669. */
  137670. dispose(disposeAll?: boolean): void;
  137671. }
  137672. }
  137673. declare module BABYLON {
  137674. /**
  137675. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  137676. */
  137677. export class DepthReducer extends MinMaxReducer {
  137678. private _depthRenderer;
  137679. private _depthRendererId;
  137680. /**
  137681. * Gets the depth renderer used for the computation.
  137682. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  137683. */
  137684. get depthRenderer(): Nullable<DepthRenderer>;
  137685. /**
  137686. * Creates a depth reducer
  137687. * @param camera The camera used to render the depth texture
  137688. */
  137689. constructor(camera: Camera);
  137690. /**
  137691. * Sets the depth renderer to use to generate the depth map
  137692. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  137693. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  137694. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  137695. */
  137696. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  137697. /** @hidden */
  137698. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  137699. /**
  137700. * Activates the reduction computation.
  137701. * When activated, the observers registered in onAfterReductionPerformed are
  137702. * called after the compuation is performed
  137703. */
  137704. activate(): void;
  137705. /**
  137706. * Deactivates the reduction computation.
  137707. */
  137708. deactivate(): void;
  137709. /**
  137710. * Disposes the depth reducer
  137711. * @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.
  137712. */
  137713. dispose(disposeAll?: boolean): void;
  137714. }
  137715. }
  137716. declare module BABYLON {
  137717. /**
  137718. * A CSM implementation allowing casting shadows on large scenes.
  137719. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  137720. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  137721. */
  137722. export class CascadedShadowGenerator extends ShadowGenerator {
  137723. private static readonly frustumCornersNDCSpace;
  137724. /**
  137725. * Name of the CSM class
  137726. */
  137727. static CLASSNAME: string;
  137728. /**
  137729. * Defines the default number of cascades used by the CSM.
  137730. */
  137731. static readonly DEFAULT_CASCADES_COUNT: number;
  137732. /**
  137733. * Defines the minimum number of cascades used by the CSM.
  137734. */
  137735. static readonly MIN_CASCADES_COUNT: number;
  137736. /**
  137737. * Defines the maximum number of cascades used by the CSM.
  137738. */
  137739. static readonly MAX_CASCADES_COUNT: number;
  137740. protected _validateFilter(filter: number): number;
  137741. /**
  137742. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  137743. */
  137744. penumbraDarkness: number;
  137745. private _numCascades;
  137746. /**
  137747. * Gets or set the number of cascades used by the CSM.
  137748. */
  137749. get numCascades(): number;
  137750. set numCascades(value: number);
  137751. /**
  137752. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  137753. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  137754. */
  137755. stabilizeCascades: boolean;
  137756. private _freezeShadowCastersBoundingInfo;
  137757. private _freezeShadowCastersBoundingInfoObservable;
  137758. /**
  137759. * Enables or disables the shadow casters bounding info computation.
  137760. * If your shadow casters don't move, you can disable this feature.
  137761. * If it is enabled, the bounding box computation is done every frame.
  137762. */
  137763. get freezeShadowCastersBoundingInfo(): boolean;
  137764. set freezeShadowCastersBoundingInfo(freeze: boolean);
  137765. private _scbiMin;
  137766. private _scbiMax;
  137767. protected _computeShadowCastersBoundingInfo(): void;
  137768. protected _shadowCastersBoundingInfo: BoundingInfo;
  137769. /**
  137770. * Gets or sets the shadow casters bounding info.
  137771. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  137772. * so that the system won't overwrite the bounds you provide
  137773. */
  137774. get shadowCastersBoundingInfo(): BoundingInfo;
  137775. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  137776. protected _breaksAreDirty: boolean;
  137777. protected _minDistance: number;
  137778. protected _maxDistance: number;
  137779. /**
  137780. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  137781. *
  137782. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  137783. * If you don't know these values, simply leave them to their defaults and don't call this function.
  137784. * @param min minimal distance for the breaks (default to 0.)
  137785. * @param max maximal distance for the breaks (default to 1.)
  137786. */
  137787. setMinMaxDistance(min: number, max: number): void;
  137788. /** Gets the minimal distance used in the cascade break computation */
  137789. get minDistance(): number;
  137790. /** Gets the maximal distance used in the cascade break computation */
  137791. get maxDistance(): number;
  137792. /**
  137793. * Gets the class name of that object
  137794. * @returns "CascadedShadowGenerator"
  137795. */
  137796. getClassName(): string;
  137797. private _cascadeMinExtents;
  137798. private _cascadeMaxExtents;
  137799. /**
  137800. * Gets a cascade minimum extents
  137801. * @param cascadeIndex index of the cascade
  137802. * @returns the minimum cascade extents
  137803. */
  137804. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  137805. /**
  137806. * Gets a cascade maximum extents
  137807. * @param cascadeIndex index of the cascade
  137808. * @returns the maximum cascade extents
  137809. */
  137810. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  137811. private _cascades;
  137812. private _currentLayer;
  137813. private _viewSpaceFrustumsZ;
  137814. private _viewMatrices;
  137815. private _projectionMatrices;
  137816. private _transformMatrices;
  137817. private _transformMatricesAsArray;
  137818. private _frustumLengths;
  137819. private _lightSizeUVCorrection;
  137820. private _depthCorrection;
  137821. private _frustumCornersWorldSpace;
  137822. private _frustumCenter;
  137823. private _shadowCameraPos;
  137824. private _shadowMaxZ;
  137825. /**
  137826. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  137827. * It defaults to camera.maxZ
  137828. */
  137829. get shadowMaxZ(): number;
  137830. /**
  137831. * Sets the shadow max z distance.
  137832. */
  137833. set shadowMaxZ(value: number);
  137834. protected _debug: boolean;
  137835. /**
  137836. * Gets or sets the debug flag.
  137837. * When enabled, the cascades are materialized by different colors on the screen.
  137838. */
  137839. get debug(): boolean;
  137840. set debug(dbg: boolean);
  137841. private _depthClamp;
  137842. /**
  137843. * Gets or sets the depth clamping value.
  137844. *
  137845. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  137846. * to account for the shadow casters far away.
  137847. *
  137848. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  137849. */
  137850. get depthClamp(): boolean;
  137851. set depthClamp(value: boolean);
  137852. private _cascadeBlendPercentage;
  137853. /**
  137854. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  137855. * It defaults to 0.1 (10% blending).
  137856. */
  137857. get cascadeBlendPercentage(): number;
  137858. set cascadeBlendPercentage(value: number);
  137859. private _lambda;
  137860. /**
  137861. * Gets or set the lambda parameter.
  137862. * This parameter is used to split the camera frustum and create the cascades.
  137863. * 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.
  137864. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  137865. */
  137866. get lambda(): number;
  137867. set lambda(value: number);
  137868. /**
  137869. * Gets the view matrix corresponding to a given cascade
  137870. * @param cascadeNum cascade to retrieve the view matrix from
  137871. * @returns the cascade view matrix
  137872. */
  137873. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  137874. /**
  137875. * Gets the projection matrix corresponding to a given cascade
  137876. * @param cascadeNum cascade to retrieve the projection matrix from
  137877. * @returns the cascade projection matrix
  137878. */
  137879. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  137880. /**
  137881. * Gets the transformation matrix corresponding to a given cascade
  137882. * @param cascadeNum cascade to retrieve the transformation matrix from
  137883. * @returns the cascade transformation matrix
  137884. */
  137885. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  137886. private _depthRenderer;
  137887. /**
  137888. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  137889. *
  137890. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  137891. *
  137892. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  137893. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  137894. * @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
  137895. */
  137896. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  137897. private _depthReducer;
  137898. private _autoCalcDepthBounds;
  137899. /**
  137900. * Gets or sets the autoCalcDepthBounds property.
  137901. *
  137902. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  137903. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  137904. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  137905. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  137906. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  137907. */
  137908. get autoCalcDepthBounds(): boolean;
  137909. set autoCalcDepthBounds(value: boolean);
  137910. /**
  137911. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  137912. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  137913. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  137914. * for setting the refresh rate on the renderer yourself!
  137915. */
  137916. get autoCalcDepthBoundsRefreshRate(): number;
  137917. set autoCalcDepthBoundsRefreshRate(value: number);
  137918. /**
  137919. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  137920. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  137921. * you change the camera near/far planes!
  137922. */
  137923. splitFrustum(): void;
  137924. private _splitFrustum;
  137925. private _computeMatrices;
  137926. private _computeFrustumInWorldSpace;
  137927. private _computeCascadeFrustum;
  137928. /**
  137929. * Support test.
  137930. */
  137931. static get IsSupported(): boolean;
  137932. /** @hidden */
  137933. static _SceneComponentInitialization: (scene: Scene) => void;
  137934. /**
  137935. * Creates a Cascaded Shadow Generator object.
  137936. * A ShadowGenerator is the required tool to use the shadows.
  137937. * Each directional light casting shadows needs to use its own ShadowGenerator.
  137938. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  137939. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  137940. * @param light The directional light object generating the shadows.
  137941. * @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.
  137942. */
  137943. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  137944. protected _initializeGenerator(): void;
  137945. protected _createTargetRenderTexture(): void;
  137946. protected _initializeShadowMap(): void;
  137947. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  137948. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  137949. /**
  137950. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  137951. * @param defines Defines of the material we want to update
  137952. * @param lightIndex Index of the light in the enabled light list of the material
  137953. */
  137954. prepareDefines(defines: any, lightIndex: number): void;
  137955. /**
  137956. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  137957. * defined in the generator but impacting the effect).
  137958. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  137959. * @param effect The effect we are binfing the information for
  137960. */
  137961. bindShadowLight(lightIndex: string, effect: Effect): void;
  137962. /**
  137963. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  137964. * (eq to view projection * shadow projection matrices)
  137965. * @returns The transform matrix used to create the shadow map
  137966. */
  137967. getTransformMatrix(): Matrix;
  137968. /**
  137969. * Disposes the ShadowGenerator.
  137970. * Returns nothing.
  137971. */
  137972. dispose(): void;
  137973. /**
  137974. * Serializes the shadow generator setup to a json object.
  137975. * @returns The serialized JSON object
  137976. */
  137977. serialize(): any;
  137978. /**
  137979. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  137980. * @param parsedShadowGenerator The JSON object to parse
  137981. * @param scene The scene to create the shadow map for
  137982. * @returns The parsed shadow generator
  137983. */
  137984. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  137985. }
  137986. }
  137987. declare module BABYLON {
  137988. /**
  137989. * Defines the shadow generator component responsible to manage any shadow generators
  137990. * in a given scene.
  137991. */
  137992. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  137993. /**
  137994. * The component name helpfull to identify the component in the list of scene components.
  137995. */
  137996. readonly name: string;
  137997. /**
  137998. * The scene the component belongs to.
  137999. */
  138000. scene: Scene;
  138001. /**
  138002. * Creates a new instance of the component for the given scene
  138003. * @param scene Defines the scene to register the component in
  138004. */
  138005. constructor(scene: Scene);
  138006. /**
  138007. * Registers the component in a given scene
  138008. */
  138009. register(): void;
  138010. /**
  138011. * Rebuilds the elements related to this component in case of
  138012. * context lost for instance.
  138013. */
  138014. rebuild(): void;
  138015. /**
  138016. * Serializes the component data to the specified json object
  138017. * @param serializationObject The object to serialize to
  138018. */
  138019. serialize(serializationObject: any): void;
  138020. /**
  138021. * Adds all the elements from the container to the scene
  138022. * @param container the container holding the elements
  138023. */
  138024. addFromContainer(container: AbstractScene): void;
  138025. /**
  138026. * Removes all the elements in the container from the scene
  138027. * @param container contains the elements to remove
  138028. * @param dispose if the removed element should be disposed (default: false)
  138029. */
  138030. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138031. /**
  138032. * Rebuilds the elements related to this component in case of
  138033. * context lost for instance.
  138034. */
  138035. dispose(): void;
  138036. private _gatherRenderTargets;
  138037. }
  138038. }
  138039. declare module BABYLON {
  138040. /**
  138041. * A point light is a light defined by an unique point in world space.
  138042. * The light is emitted in every direction from this point.
  138043. * A good example of a point light is a standard light bulb.
  138044. * Documentation: https://doc.babylonjs.com/babylon101/lights
  138045. */
  138046. export class PointLight extends ShadowLight {
  138047. private _shadowAngle;
  138048. /**
  138049. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  138050. * This specifies what angle the shadow will use to be created.
  138051. *
  138052. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  138053. */
  138054. get shadowAngle(): number;
  138055. /**
  138056. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  138057. * This specifies what angle the shadow will use to be created.
  138058. *
  138059. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  138060. */
  138061. set shadowAngle(value: number);
  138062. /**
  138063. * Gets the direction if it has been set.
  138064. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  138065. */
  138066. get direction(): Vector3;
  138067. /**
  138068. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  138069. */
  138070. set direction(value: Vector3);
  138071. /**
  138072. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  138073. * A PointLight emits the light in every direction.
  138074. * It can cast shadows.
  138075. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  138076. * ```javascript
  138077. * var pointLight = new PointLight("pl", camera.position, scene);
  138078. * ```
  138079. * Documentation : https://doc.babylonjs.com/babylon101/lights
  138080. * @param name The light friendly name
  138081. * @param position The position of the point light in the scene
  138082. * @param scene The scene the lights belongs to
  138083. */
  138084. constructor(name: string, position: Vector3, scene: Scene);
  138085. /**
  138086. * Returns the string "PointLight"
  138087. * @returns the class name
  138088. */
  138089. getClassName(): string;
  138090. /**
  138091. * Returns the integer 0.
  138092. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  138093. */
  138094. getTypeID(): number;
  138095. /**
  138096. * Specifies wether or not the shadowmap should be a cube texture.
  138097. * @returns true if the shadowmap needs to be a cube texture.
  138098. */
  138099. needCube(): boolean;
  138100. /**
  138101. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  138102. * @param faceIndex The index of the face we are computed the direction to generate shadow
  138103. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  138104. */
  138105. getShadowDirection(faceIndex?: number): Vector3;
  138106. /**
  138107. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  138108. * - fov = PI / 2
  138109. * - aspect ratio : 1.0
  138110. * - z-near and far equal to the active camera minZ and maxZ.
  138111. * Returns the PointLight.
  138112. */
  138113. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  138114. protected _buildUniformLayout(): void;
  138115. /**
  138116. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  138117. * @param effect The effect to update
  138118. * @param lightIndex The index of the light in the effect to update
  138119. * @returns The point light
  138120. */
  138121. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  138122. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  138123. /**
  138124. * Prepares the list of defines specific to the light type.
  138125. * @param defines the list of defines
  138126. * @param lightIndex defines the index of the light for the effect
  138127. */
  138128. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  138129. }
  138130. }
  138131. declare module BABYLON {
  138132. /**
  138133. * Header information of HDR texture files.
  138134. */
  138135. export interface HDRInfo {
  138136. /**
  138137. * The height of the texture in pixels.
  138138. */
  138139. height: number;
  138140. /**
  138141. * The width of the texture in pixels.
  138142. */
  138143. width: number;
  138144. /**
  138145. * The index of the beginning of the data in the binary file.
  138146. */
  138147. dataPosition: number;
  138148. }
  138149. /**
  138150. * This groups tools to convert HDR texture to native colors array.
  138151. */
  138152. export class HDRTools {
  138153. private static Ldexp;
  138154. private static Rgbe2float;
  138155. private static readStringLine;
  138156. /**
  138157. * Reads header information from an RGBE texture stored in a native array.
  138158. * More information on this format are available here:
  138159. * https://en.wikipedia.org/wiki/RGBE_image_format
  138160. *
  138161. * @param uint8array The binary file stored in native array.
  138162. * @return The header information.
  138163. */
  138164. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  138165. /**
  138166. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  138167. * This RGBE texture needs to store the information as a panorama.
  138168. *
  138169. * More information on this format are available here:
  138170. * https://en.wikipedia.org/wiki/RGBE_image_format
  138171. *
  138172. * @param buffer The binary file stored in an array buffer.
  138173. * @param size The expected size of the extracted cubemap.
  138174. * @return The Cube Map information.
  138175. */
  138176. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  138177. /**
  138178. * Returns the pixels data extracted from an RGBE texture.
  138179. * This pixels will be stored left to right up to down in the R G B order in one array.
  138180. *
  138181. * More information on this format are available here:
  138182. * https://en.wikipedia.org/wiki/RGBE_image_format
  138183. *
  138184. * @param uint8array The binary file stored in an array buffer.
  138185. * @param hdrInfo The header information of the file.
  138186. * @return The pixels data in RGB right to left up to down order.
  138187. */
  138188. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  138189. private static RGBE_ReadPixels_RLE;
  138190. private static RGBE_ReadPixels_NOT_RLE;
  138191. }
  138192. }
  138193. declare module BABYLON {
  138194. /**
  138195. * Effect Render Options
  138196. */
  138197. export interface IEffectRendererOptions {
  138198. /**
  138199. * Defines the vertices positions.
  138200. */
  138201. positions?: number[];
  138202. /**
  138203. * Defines the indices.
  138204. */
  138205. indices?: number[];
  138206. }
  138207. /**
  138208. * Helper class to render one or more effects.
  138209. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  138210. */
  138211. export class EffectRenderer {
  138212. private engine;
  138213. private static _DefaultOptions;
  138214. private _vertexBuffers;
  138215. private _indexBuffer;
  138216. private _fullscreenViewport;
  138217. /**
  138218. * Creates an effect renderer
  138219. * @param engine the engine to use for rendering
  138220. * @param options defines the options of the effect renderer
  138221. */
  138222. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  138223. /**
  138224. * Sets the current viewport in normalized coordinates 0-1
  138225. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  138226. */
  138227. setViewport(viewport?: Viewport): void;
  138228. /**
  138229. * Binds the embedded attributes buffer to the effect.
  138230. * @param effect Defines the effect to bind the attributes for
  138231. */
  138232. bindBuffers(effect: Effect): void;
  138233. /**
  138234. * Sets the current effect wrapper to use during draw.
  138235. * The effect needs to be ready before calling this api.
  138236. * This also sets the default full screen position attribute.
  138237. * @param effectWrapper Defines the effect to draw with
  138238. */
  138239. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  138240. /**
  138241. * Restores engine states
  138242. */
  138243. restoreStates(): void;
  138244. /**
  138245. * Draws a full screen quad.
  138246. */
  138247. draw(): void;
  138248. private isRenderTargetTexture;
  138249. /**
  138250. * renders one or more effects to a specified texture
  138251. * @param effectWrapper the effect to renderer
  138252. * @param outputTexture texture to draw to, if null it will render to the screen.
  138253. */
  138254. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  138255. /**
  138256. * Disposes of the effect renderer
  138257. */
  138258. dispose(): void;
  138259. }
  138260. /**
  138261. * Options to create an EffectWrapper
  138262. */
  138263. interface EffectWrapperCreationOptions {
  138264. /**
  138265. * Engine to use to create the effect
  138266. */
  138267. engine: ThinEngine;
  138268. /**
  138269. * Fragment shader for the effect
  138270. */
  138271. fragmentShader: string;
  138272. /**
  138273. * Use the shader store instead of direct source code
  138274. */
  138275. useShaderStore?: boolean;
  138276. /**
  138277. * Vertex shader for the effect
  138278. */
  138279. vertexShader?: string;
  138280. /**
  138281. * Attributes to use in the shader
  138282. */
  138283. attributeNames?: Array<string>;
  138284. /**
  138285. * Uniforms to use in the shader
  138286. */
  138287. uniformNames?: Array<string>;
  138288. /**
  138289. * Texture sampler names to use in the shader
  138290. */
  138291. samplerNames?: Array<string>;
  138292. /**
  138293. * Defines to use in the shader
  138294. */
  138295. defines?: Array<string>;
  138296. /**
  138297. * Callback when effect is compiled
  138298. */
  138299. onCompiled?: Nullable<(effect: Effect) => void>;
  138300. /**
  138301. * The friendly name of the effect displayed in Spector.
  138302. */
  138303. name?: string;
  138304. }
  138305. /**
  138306. * Wraps an effect to be used for rendering
  138307. */
  138308. export class EffectWrapper {
  138309. /**
  138310. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  138311. */
  138312. onApplyObservable: Observable<{}>;
  138313. /**
  138314. * The underlying effect
  138315. */
  138316. effect: Effect;
  138317. /**
  138318. * Creates an effect to be renderer
  138319. * @param creationOptions options to create the effect
  138320. */
  138321. constructor(creationOptions: EffectWrapperCreationOptions);
  138322. /**
  138323. * Disposes of the effect wrapper
  138324. */
  138325. dispose(): void;
  138326. }
  138327. }
  138328. declare module BABYLON {
  138329. /** @hidden */
  138330. export var hdrFilteringVertexShader: {
  138331. name: string;
  138332. shader: string;
  138333. };
  138334. }
  138335. declare module BABYLON {
  138336. /** @hidden */
  138337. export var hdrFilteringPixelShader: {
  138338. name: string;
  138339. shader: string;
  138340. };
  138341. }
  138342. declare module BABYLON {
  138343. /**
  138344. * Options for texture filtering
  138345. */
  138346. interface IHDRFilteringOptions {
  138347. /**
  138348. * Scales pixel intensity for the input HDR map.
  138349. */
  138350. hdrScale?: number;
  138351. /**
  138352. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  138353. */
  138354. quality?: number;
  138355. }
  138356. /**
  138357. * Filters HDR maps to get correct renderings of PBR reflections
  138358. */
  138359. export class HDRFiltering {
  138360. private _engine;
  138361. private _effectRenderer;
  138362. private _effectWrapper;
  138363. private _lodGenerationOffset;
  138364. private _lodGenerationScale;
  138365. /**
  138366. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  138367. * you care about baking speed.
  138368. */
  138369. quality: number;
  138370. /**
  138371. * Scales pixel intensity for the input HDR map.
  138372. */
  138373. hdrScale: number;
  138374. /**
  138375. * Instantiates HDR filter for reflection maps
  138376. *
  138377. * @param engine Thin engine
  138378. * @param options Options
  138379. */
  138380. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  138381. private _createRenderTarget;
  138382. private _prefilterInternal;
  138383. private _createEffect;
  138384. /**
  138385. * Get a value indicating if the filter is ready to be used
  138386. * @param texture Texture to filter
  138387. * @returns true if the filter is ready
  138388. */
  138389. isReady(texture: BaseTexture): boolean;
  138390. /**
  138391. * Prefilters a cube texture to have mipmap levels representing roughness values.
  138392. * Prefiltering will be invoked at the end of next rendering pass.
  138393. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  138394. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  138395. * @param texture Texture to filter
  138396. * @param onFinished Callback when filtering is done
  138397. * @return Promise called when prefiltering is done
  138398. */
  138399. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  138400. }
  138401. }
  138402. declare module BABYLON {
  138403. /**
  138404. * This represents a texture coming from an HDR input.
  138405. *
  138406. * The only supported format is currently panorama picture stored in RGBE format.
  138407. * Example of such files can be found on HDRLib: http://hdrlib.com/
  138408. */
  138409. export class HDRCubeTexture extends BaseTexture {
  138410. private static _facesMapping;
  138411. private _generateHarmonics;
  138412. private _noMipmap;
  138413. private _prefilterOnLoad;
  138414. private _textureMatrix;
  138415. private _size;
  138416. private _onLoad;
  138417. private _onError;
  138418. /**
  138419. * The texture URL.
  138420. */
  138421. url: string;
  138422. /**
  138423. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  138424. */
  138425. coordinatesMode: number;
  138426. protected _isBlocking: boolean;
  138427. /**
  138428. * Sets wether or not the texture is blocking during loading.
  138429. */
  138430. set isBlocking(value: boolean);
  138431. /**
  138432. * Gets wether or not the texture is blocking during loading.
  138433. */
  138434. get isBlocking(): boolean;
  138435. protected _rotationY: number;
  138436. /**
  138437. * Sets texture matrix rotation angle around Y axis in radians.
  138438. */
  138439. set rotationY(value: number);
  138440. /**
  138441. * Gets texture matrix rotation angle around Y axis radians.
  138442. */
  138443. get rotationY(): number;
  138444. /**
  138445. * Gets or sets the center of the bounding box associated with the cube texture
  138446. * It must define where the camera used to render the texture was set
  138447. */
  138448. boundingBoxPosition: Vector3;
  138449. private _boundingBoxSize;
  138450. /**
  138451. * Gets or sets the size of the bounding box associated with the cube texture
  138452. * When defined, the cubemap will switch to local mode
  138453. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  138454. * @example https://www.babylonjs-playground.com/#RNASML
  138455. */
  138456. set boundingBoxSize(value: Vector3);
  138457. get boundingBoxSize(): Vector3;
  138458. /**
  138459. * Instantiates an HDRTexture from the following parameters.
  138460. *
  138461. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  138462. * @param sceneOrEngine The scene or engine the texture will be used in
  138463. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  138464. * @param noMipmap Forces to not generate the mipmap if true
  138465. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  138466. * @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)
  138467. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  138468. */
  138469. 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>);
  138470. /**
  138471. * Get the current class name of the texture useful for serialization or dynamic coding.
  138472. * @returns "HDRCubeTexture"
  138473. */
  138474. getClassName(): string;
  138475. /**
  138476. * Occurs when the file is raw .hdr file.
  138477. */
  138478. private loadTexture;
  138479. clone(): HDRCubeTexture;
  138480. delayLoad(): void;
  138481. /**
  138482. * Get the texture reflection matrix used to rotate/transform the reflection.
  138483. * @returns the reflection matrix
  138484. */
  138485. getReflectionTextureMatrix(): Matrix;
  138486. /**
  138487. * Set the texture reflection matrix used to rotate/transform the reflection.
  138488. * @param value Define the reflection matrix to set
  138489. */
  138490. setReflectionTextureMatrix(value: Matrix): void;
  138491. /**
  138492. * Parses a JSON representation of an HDR Texture in order to create the texture
  138493. * @param parsedTexture Define the JSON representation
  138494. * @param scene Define the scene the texture should be created in
  138495. * @param rootUrl Define the root url in case we need to load relative dependencies
  138496. * @returns the newly created texture after parsing
  138497. */
  138498. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  138499. serialize(): any;
  138500. }
  138501. }
  138502. declare module BABYLON {
  138503. /**
  138504. * Class used to control physics engine
  138505. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  138506. */
  138507. export class PhysicsEngine implements IPhysicsEngine {
  138508. private _physicsPlugin;
  138509. /**
  138510. * Global value used to control the smallest number supported by the simulation
  138511. */
  138512. static Epsilon: number;
  138513. private _impostors;
  138514. private _joints;
  138515. private _subTimeStep;
  138516. /**
  138517. * Gets the gravity vector used by the simulation
  138518. */
  138519. gravity: Vector3;
  138520. /**
  138521. * Factory used to create the default physics plugin.
  138522. * @returns The default physics plugin
  138523. */
  138524. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  138525. /**
  138526. * Creates a new Physics Engine
  138527. * @param gravity defines the gravity vector used by the simulation
  138528. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  138529. */
  138530. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  138531. /**
  138532. * Sets the gravity vector used by the simulation
  138533. * @param gravity defines the gravity vector to use
  138534. */
  138535. setGravity(gravity: Vector3): void;
  138536. /**
  138537. * Set the time step of the physics engine.
  138538. * Default is 1/60.
  138539. * To slow it down, enter 1/600 for example.
  138540. * To speed it up, 1/30
  138541. * @param newTimeStep defines the new timestep to apply to this world.
  138542. */
  138543. setTimeStep(newTimeStep?: number): void;
  138544. /**
  138545. * Get the time step of the physics engine.
  138546. * @returns the current time step
  138547. */
  138548. getTimeStep(): number;
  138549. /**
  138550. * Set the sub time step of the physics engine.
  138551. * Default is 0 meaning there is no sub steps
  138552. * To increase physics resolution precision, set a small value (like 1 ms)
  138553. * @param subTimeStep defines the new sub timestep used for physics resolution.
  138554. */
  138555. setSubTimeStep(subTimeStep?: number): void;
  138556. /**
  138557. * Get the sub time step of the physics engine.
  138558. * @returns the current sub time step
  138559. */
  138560. getSubTimeStep(): number;
  138561. /**
  138562. * Release all resources
  138563. */
  138564. dispose(): void;
  138565. /**
  138566. * Gets the name of the current physics plugin
  138567. * @returns the name of the plugin
  138568. */
  138569. getPhysicsPluginName(): string;
  138570. /**
  138571. * Adding a new impostor for the impostor tracking.
  138572. * This will be done by the impostor itself.
  138573. * @param impostor the impostor to add
  138574. */
  138575. addImpostor(impostor: PhysicsImpostor): void;
  138576. /**
  138577. * Remove an impostor from the engine.
  138578. * This impostor and its mesh will not longer be updated by the physics engine.
  138579. * @param impostor the impostor to remove
  138580. */
  138581. removeImpostor(impostor: PhysicsImpostor): void;
  138582. /**
  138583. * Add a joint to the physics engine
  138584. * @param mainImpostor defines the main impostor to which the joint is added.
  138585. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  138586. * @param joint defines the joint that will connect both impostors.
  138587. */
  138588. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  138589. /**
  138590. * Removes a joint from the simulation
  138591. * @param mainImpostor defines the impostor used with the joint
  138592. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  138593. * @param joint defines the joint to remove
  138594. */
  138595. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  138596. /**
  138597. * Called by the scene. No need to call it.
  138598. * @param delta defines the timespam between frames
  138599. */
  138600. _step(delta: number): void;
  138601. /**
  138602. * Gets the current plugin used to run the simulation
  138603. * @returns current plugin
  138604. */
  138605. getPhysicsPlugin(): IPhysicsEnginePlugin;
  138606. /**
  138607. * Gets the list of physic impostors
  138608. * @returns an array of PhysicsImpostor
  138609. */
  138610. getImpostors(): Array<PhysicsImpostor>;
  138611. /**
  138612. * Gets the impostor for a physics enabled object
  138613. * @param object defines the object impersonated by the impostor
  138614. * @returns the PhysicsImpostor or null if not found
  138615. */
  138616. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  138617. /**
  138618. * Gets the impostor for a physics body object
  138619. * @param body defines physics body used by the impostor
  138620. * @returns the PhysicsImpostor or null if not found
  138621. */
  138622. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  138623. /**
  138624. * Does a raycast in the physics world
  138625. * @param from when should the ray start?
  138626. * @param to when should the ray end?
  138627. * @returns PhysicsRaycastResult
  138628. */
  138629. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138630. }
  138631. }
  138632. declare module BABYLON {
  138633. /** @hidden */
  138634. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  138635. private _useDeltaForWorldStep;
  138636. world: any;
  138637. name: string;
  138638. private _physicsMaterials;
  138639. private _fixedTimeStep;
  138640. private _cannonRaycastResult;
  138641. private _raycastResult;
  138642. private _physicsBodysToRemoveAfterStep;
  138643. private _firstFrame;
  138644. BJSCANNON: any;
  138645. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  138646. setGravity(gravity: Vector3): void;
  138647. setTimeStep(timeStep: number): void;
  138648. getTimeStep(): number;
  138649. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138650. private _removeMarkedPhysicsBodiesFromWorld;
  138651. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138652. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138653. generatePhysicsBody(impostor: PhysicsImpostor): void;
  138654. private _processChildMeshes;
  138655. removePhysicsBody(impostor: PhysicsImpostor): void;
  138656. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  138657. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  138658. private _addMaterial;
  138659. private _checkWithEpsilon;
  138660. private _createShape;
  138661. private _createHeightmap;
  138662. private _minus90X;
  138663. private _plus90X;
  138664. private _tmpPosition;
  138665. private _tmpDeltaPosition;
  138666. private _tmpUnityRotation;
  138667. private _updatePhysicsBodyTransformation;
  138668. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  138669. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  138670. isSupported(): boolean;
  138671. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138672. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138673. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138674. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138675. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  138676. getBodyMass(impostor: PhysicsImpostor): number;
  138677. getBodyFriction(impostor: PhysicsImpostor): number;
  138678. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  138679. getBodyRestitution(impostor: PhysicsImpostor): number;
  138680. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  138681. sleepBody(impostor: PhysicsImpostor): void;
  138682. wakeUpBody(impostor: PhysicsImpostor): void;
  138683. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  138684. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  138685. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  138686. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  138687. getRadius(impostor: PhysicsImpostor): number;
  138688. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  138689. dispose(): void;
  138690. private _extendNamespace;
  138691. /**
  138692. * Does a raycast in the physics world
  138693. * @param from when should the ray start?
  138694. * @param to when should the ray end?
  138695. * @returns PhysicsRaycastResult
  138696. */
  138697. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138698. }
  138699. }
  138700. declare module BABYLON {
  138701. /** @hidden */
  138702. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  138703. private _useDeltaForWorldStep;
  138704. world: any;
  138705. name: string;
  138706. BJSOIMO: any;
  138707. private _raycastResult;
  138708. private _fixedTimeStep;
  138709. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  138710. setGravity(gravity: Vector3): void;
  138711. setTimeStep(timeStep: number): void;
  138712. getTimeStep(): number;
  138713. private _tmpImpostorsArray;
  138714. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138715. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138716. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138717. generatePhysicsBody(impostor: PhysicsImpostor): void;
  138718. private _tmpPositionVector;
  138719. removePhysicsBody(impostor: PhysicsImpostor): void;
  138720. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  138721. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  138722. isSupported(): boolean;
  138723. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  138724. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  138725. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138726. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138727. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138728. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138729. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  138730. getBodyMass(impostor: PhysicsImpostor): number;
  138731. getBodyFriction(impostor: PhysicsImpostor): number;
  138732. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  138733. getBodyRestitution(impostor: PhysicsImpostor): number;
  138734. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  138735. sleepBody(impostor: PhysicsImpostor): void;
  138736. wakeUpBody(impostor: PhysicsImpostor): void;
  138737. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  138738. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  138739. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  138740. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  138741. getRadius(impostor: PhysicsImpostor): number;
  138742. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  138743. dispose(): void;
  138744. /**
  138745. * Does a raycast in the physics world
  138746. * @param from when should the ray start?
  138747. * @param to when should the ray end?
  138748. * @returns PhysicsRaycastResult
  138749. */
  138750. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138751. }
  138752. }
  138753. declare module BABYLON {
  138754. /**
  138755. * Class containing static functions to help procedurally build meshes
  138756. */
  138757. export class RibbonBuilder {
  138758. /**
  138759. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  138760. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  138761. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  138762. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  138763. * * 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
  138764. * * 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
  138765. * * 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
  138766. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138767. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138768. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  138769. * * 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
  138770. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  138771. * * 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
  138772. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  138773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  138774. * @param name defines the name of the mesh
  138775. * @param options defines the options used to create the mesh
  138776. * @param scene defines the hosting scene
  138777. * @returns the ribbon mesh
  138778. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  138779. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138780. */
  138781. static CreateRibbon(name: string, options: {
  138782. pathArray: Vector3[][];
  138783. closeArray?: boolean;
  138784. closePath?: boolean;
  138785. offset?: number;
  138786. updatable?: boolean;
  138787. sideOrientation?: number;
  138788. frontUVs?: Vector4;
  138789. backUVs?: Vector4;
  138790. instance?: Mesh;
  138791. invertUV?: boolean;
  138792. uvs?: Vector2[];
  138793. colors?: Color4[];
  138794. }, scene?: Nullable<Scene>): Mesh;
  138795. }
  138796. }
  138797. declare module BABYLON {
  138798. /**
  138799. * Class containing static functions to help procedurally build meshes
  138800. */
  138801. export class ShapeBuilder {
  138802. /**
  138803. * 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.
  138804. * * 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.
  138805. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  138806. * * 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.
  138807. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  138808. * * 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
  138809. * * 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
  138810. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  138811. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138812. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138813. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  138814. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  138815. * @param name defines the name of the mesh
  138816. * @param options defines the options used to create the mesh
  138817. * @param scene defines the hosting scene
  138818. * @returns the extruded shape mesh
  138819. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138820. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  138821. */
  138822. static ExtrudeShape(name: string, options: {
  138823. shape: Vector3[];
  138824. path: Vector3[];
  138825. scale?: number;
  138826. rotation?: number;
  138827. cap?: number;
  138828. updatable?: boolean;
  138829. sideOrientation?: number;
  138830. frontUVs?: Vector4;
  138831. backUVs?: Vector4;
  138832. instance?: Mesh;
  138833. invertUV?: boolean;
  138834. }, scene?: Nullable<Scene>): Mesh;
  138835. /**
  138836. * Creates an custom extruded shape mesh.
  138837. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  138838. * * 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.
  138839. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  138840. * * 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
  138841. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  138842. * * 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
  138843. * * It must returns a float value that will be the scale value applied to the shape on each path point
  138844. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  138845. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  138846. * * 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
  138847. * * 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
  138848. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  138849. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138850. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138851. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  138852. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  138853. * @param name defines the name of the mesh
  138854. * @param options defines the options used to create the mesh
  138855. * @param scene defines the hosting scene
  138856. * @returns the custom extruded shape mesh
  138857. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  138858. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138859. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  138860. */
  138861. static ExtrudeShapeCustom(name: string, options: {
  138862. shape: Vector3[];
  138863. path: Vector3[];
  138864. scaleFunction?: any;
  138865. rotationFunction?: any;
  138866. ribbonCloseArray?: boolean;
  138867. ribbonClosePath?: boolean;
  138868. cap?: number;
  138869. updatable?: boolean;
  138870. sideOrientation?: number;
  138871. frontUVs?: Vector4;
  138872. backUVs?: Vector4;
  138873. instance?: Mesh;
  138874. invertUV?: boolean;
  138875. }, scene?: Nullable<Scene>): Mesh;
  138876. private static _ExtrudeShapeGeneric;
  138877. }
  138878. }
  138879. declare module BABYLON {
  138880. /**
  138881. * AmmoJS Physics plugin
  138882. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  138883. * @see https://github.com/kripken/ammo.js/
  138884. */
  138885. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  138886. private _useDeltaForWorldStep;
  138887. /**
  138888. * Reference to the Ammo library
  138889. */
  138890. bjsAMMO: any;
  138891. /**
  138892. * Created ammoJS world which physics bodies are added to
  138893. */
  138894. world: any;
  138895. /**
  138896. * Name of the plugin
  138897. */
  138898. name: string;
  138899. private _timeStep;
  138900. private _fixedTimeStep;
  138901. private _maxSteps;
  138902. private _tmpQuaternion;
  138903. private _tmpAmmoTransform;
  138904. private _tmpAmmoQuaternion;
  138905. private _tmpAmmoConcreteContactResultCallback;
  138906. private _collisionConfiguration;
  138907. private _dispatcher;
  138908. private _overlappingPairCache;
  138909. private _solver;
  138910. private _softBodySolver;
  138911. private _tmpAmmoVectorA;
  138912. private _tmpAmmoVectorB;
  138913. private _tmpAmmoVectorC;
  138914. private _tmpAmmoVectorD;
  138915. private _tmpContactCallbackResult;
  138916. private _tmpAmmoVectorRCA;
  138917. private _tmpAmmoVectorRCB;
  138918. private _raycastResult;
  138919. private static readonly DISABLE_COLLISION_FLAG;
  138920. private static readonly KINEMATIC_FLAG;
  138921. private static readonly DISABLE_DEACTIVATION_FLAG;
  138922. /**
  138923. * Initializes the ammoJS plugin
  138924. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  138925. * @param ammoInjection can be used to inject your own ammo reference
  138926. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  138927. */
  138928. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  138929. /**
  138930. * Sets the gravity of the physics world (m/(s^2))
  138931. * @param gravity Gravity to set
  138932. */
  138933. setGravity(gravity: Vector3): void;
  138934. /**
  138935. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  138936. * @param timeStep timestep to use in seconds
  138937. */
  138938. setTimeStep(timeStep: number): void;
  138939. /**
  138940. * 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)
  138941. * @param fixedTimeStep fixedTimeStep to use in seconds
  138942. */
  138943. setFixedTimeStep(fixedTimeStep: number): void;
  138944. /**
  138945. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  138946. * @param maxSteps the maximum number of steps by the physics engine per frame
  138947. */
  138948. setMaxSteps(maxSteps: number): void;
  138949. /**
  138950. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  138951. * @returns the current timestep in seconds
  138952. */
  138953. getTimeStep(): number;
  138954. /**
  138955. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  138956. */
  138957. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  138958. private _isImpostorInContact;
  138959. private _isImpostorPairInContact;
  138960. private _stepSimulation;
  138961. /**
  138962. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  138963. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  138964. * After the step the babylon meshes are set to the position of the physics imposters
  138965. * @param delta amount of time to step forward
  138966. * @param impostors array of imposters to update before/after the step
  138967. */
  138968. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138969. /**
  138970. * Update babylon mesh to match physics world object
  138971. * @param impostor imposter to match
  138972. */
  138973. private _afterSoftStep;
  138974. /**
  138975. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  138976. * @param impostor imposter to match
  138977. */
  138978. private _ropeStep;
  138979. /**
  138980. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  138981. * @param impostor imposter to match
  138982. */
  138983. private _softbodyOrClothStep;
  138984. private _tmpMatrix;
  138985. /**
  138986. * Applies an impulse on the imposter
  138987. * @param impostor imposter to apply impulse to
  138988. * @param force amount of force to be applied to the imposter
  138989. * @param contactPoint the location to apply the impulse on the imposter
  138990. */
  138991. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138992. /**
  138993. * Applies a force on the imposter
  138994. * @param impostor imposter to apply force
  138995. * @param force amount of force to be applied to the imposter
  138996. * @param contactPoint the location to apply the force on the imposter
  138997. */
  138998. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138999. /**
  139000. * Creates a physics body using the plugin
  139001. * @param impostor the imposter to create the physics body on
  139002. */
  139003. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139004. /**
  139005. * Removes the physics body from the imposter and disposes of the body's memory
  139006. * @param impostor imposter to remove the physics body from
  139007. */
  139008. removePhysicsBody(impostor: PhysicsImpostor): void;
  139009. /**
  139010. * Generates a joint
  139011. * @param impostorJoint the imposter joint to create the joint with
  139012. */
  139013. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139014. /**
  139015. * Removes a joint
  139016. * @param impostorJoint the imposter joint to remove the joint from
  139017. */
  139018. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139019. private _addMeshVerts;
  139020. /**
  139021. * Initialise the soft body vertices to match its object's (mesh) vertices
  139022. * Softbody vertices (nodes) are in world space and to match this
  139023. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  139024. * @param impostor to create the softbody for
  139025. */
  139026. private _softVertexData;
  139027. /**
  139028. * Create an impostor's soft body
  139029. * @param impostor to create the softbody for
  139030. */
  139031. private _createSoftbody;
  139032. /**
  139033. * Create cloth for an impostor
  139034. * @param impostor to create the softbody for
  139035. */
  139036. private _createCloth;
  139037. /**
  139038. * Create rope for an impostor
  139039. * @param impostor to create the softbody for
  139040. */
  139041. private _createRope;
  139042. /**
  139043. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  139044. * @param impostor to create the custom physics shape for
  139045. */
  139046. private _createCustom;
  139047. private _addHullVerts;
  139048. private _createShape;
  139049. /**
  139050. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  139051. * @param impostor imposter containing the physics body and babylon object
  139052. */
  139053. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  139054. /**
  139055. * Sets the babylon object's position/rotation from the physics body's position/rotation
  139056. * @param impostor imposter containing the physics body and babylon object
  139057. * @param newPosition new position
  139058. * @param newRotation new rotation
  139059. */
  139060. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  139061. /**
  139062. * If this plugin is supported
  139063. * @returns true if its supported
  139064. */
  139065. isSupported(): boolean;
  139066. /**
  139067. * Sets the linear velocity of the physics body
  139068. * @param impostor imposter to set the velocity on
  139069. * @param velocity velocity to set
  139070. */
  139071. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139072. /**
  139073. * Sets the angular velocity of the physics body
  139074. * @param impostor imposter to set the velocity on
  139075. * @param velocity velocity to set
  139076. */
  139077. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139078. /**
  139079. * gets the linear velocity
  139080. * @param impostor imposter to get linear velocity from
  139081. * @returns linear velocity
  139082. */
  139083. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139084. /**
  139085. * gets the angular velocity
  139086. * @param impostor imposter to get angular velocity from
  139087. * @returns angular velocity
  139088. */
  139089. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139090. /**
  139091. * Sets the mass of physics body
  139092. * @param impostor imposter to set the mass on
  139093. * @param mass mass to set
  139094. */
  139095. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  139096. /**
  139097. * Gets the mass of the physics body
  139098. * @param impostor imposter to get the mass from
  139099. * @returns mass
  139100. */
  139101. getBodyMass(impostor: PhysicsImpostor): number;
  139102. /**
  139103. * Gets friction of the impostor
  139104. * @param impostor impostor to get friction from
  139105. * @returns friction value
  139106. */
  139107. getBodyFriction(impostor: PhysicsImpostor): number;
  139108. /**
  139109. * Sets friction of the impostor
  139110. * @param impostor impostor to set friction on
  139111. * @param friction friction value
  139112. */
  139113. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  139114. /**
  139115. * Gets restitution of the impostor
  139116. * @param impostor impostor to get restitution from
  139117. * @returns restitution value
  139118. */
  139119. getBodyRestitution(impostor: PhysicsImpostor): number;
  139120. /**
  139121. * Sets resitution of the impostor
  139122. * @param impostor impostor to set resitution on
  139123. * @param restitution resitution value
  139124. */
  139125. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  139126. /**
  139127. * Gets pressure inside the impostor
  139128. * @param impostor impostor to get pressure from
  139129. * @returns pressure value
  139130. */
  139131. getBodyPressure(impostor: PhysicsImpostor): number;
  139132. /**
  139133. * Sets pressure inside a soft body impostor
  139134. * Cloth and rope must remain 0 pressure
  139135. * @param impostor impostor to set pressure on
  139136. * @param pressure pressure value
  139137. */
  139138. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  139139. /**
  139140. * Gets stiffness of the impostor
  139141. * @param impostor impostor to get stiffness from
  139142. * @returns pressure value
  139143. */
  139144. getBodyStiffness(impostor: PhysicsImpostor): number;
  139145. /**
  139146. * Sets stiffness of the impostor
  139147. * @param impostor impostor to set stiffness on
  139148. * @param stiffness stiffness value from 0 to 1
  139149. */
  139150. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  139151. /**
  139152. * Gets velocityIterations of the impostor
  139153. * @param impostor impostor to get velocity iterations from
  139154. * @returns velocityIterations value
  139155. */
  139156. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  139157. /**
  139158. * Sets velocityIterations of the impostor
  139159. * @param impostor impostor to set velocity iterations on
  139160. * @param velocityIterations velocityIterations value
  139161. */
  139162. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  139163. /**
  139164. * Gets positionIterations of the impostor
  139165. * @param impostor impostor to get position iterations from
  139166. * @returns positionIterations value
  139167. */
  139168. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  139169. /**
  139170. * Sets positionIterations of the impostor
  139171. * @param impostor impostor to set position on
  139172. * @param positionIterations positionIterations value
  139173. */
  139174. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  139175. /**
  139176. * Append an anchor to a cloth object
  139177. * @param impostor is the cloth impostor to add anchor to
  139178. * @param otherImpostor is the rigid impostor to anchor to
  139179. * @param width ratio across width from 0 to 1
  139180. * @param height ratio up height from 0 to 1
  139181. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  139182. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  139183. */
  139184. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  139185. /**
  139186. * Append an hook to a rope object
  139187. * @param impostor is the rope impostor to add hook to
  139188. * @param otherImpostor is the rigid impostor to hook to
  139189. * @param length ratio along the rope from 0 to 1
  139190. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  139191. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  139192. */
  139193. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  139194. /**
  139195. * Sleeps the physics body and stops it from being active
  139196. * @param impostor impostor to sleep
  139197. */
  139198. sleepBody(impostor: PhysicsImpostor): void;
  139199. /**
  139200. * Activates the physics body
  139201. * @param impostor impostor to activate
  139202. */
  139203. wakeUpBody(impostor: PhysicsImpostor): void;
  139204. /**
  139205. * Updates the distance parameters of the joint
  139206. * @param joint joint to update
  139207. * @param maxDistance maximum distance of the joint
  139208. * @param minDistance minimum distance of the joint
  139209. */
  139210. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  139211. /**
  139212. * Sets a motor on the joint
  139213. * @param joint joint to set motor on
  139214. * @param speed speed of the motor
  139215. * @param maxForce maximum force of the motor
  139216. * @param motorIndex index of the motor
  139217. */
  139218. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  139219. /**
  139220. * Sets the motors limit
  139221. * @param joint joint to set limit on
  139222. * @param upperLimit upper limit
  139223. * @param lowerLimit lower limit
  139224. */
  139225. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  139226. /**
  139227. * Syncs the position and rotation of a mesh with the impostor
  139228. * @param mesh mesh to sync
  139229. * @param impostor impostor to update the mesh with
  139230. */
  139231. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  139232. /**
  139233. * Gets the radius of the impostor
  139234. * @param impostor impostor to get radius from
  139235. * @returns the radius
  139236. */
  139237. getRadius(impostor: PhysicsImpostor): number;
  139238. /**
  139239. * Gets the box size of the impostor
  139240. * @param impostor impostor to get box size from
  139241. * @param result the resulting box size
  139242. */
  139243. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  139244. /**
  139245. * Disposes of the impostor
  139246. */
  139247. dispose(): void;
  139248. /**
  139249. * Does a raycast in the physics world
  139250. * @param from when should the ray start?
  139251. * @param to when should the ray end?
  139252. * @returns PhysicsRaycastResult
  139253. */
  139254. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139255. }
  139256. }
  139257. declare module BABYLON {
  139258. interface AbstractScene {
  139259. /**
  139260. * The list of reflection probes added to the scene
  139261. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  139262. */
  139263. reflectionProbes: Array<ReflectionProbe>;
  139264. /**
  139265. * Removes the given reflection probe from this scene.
  139266. * @param toRemove The reflection probe to remove
  139267. * @returns The index of the removed reflection probe
  139268. */
  139269. removeReflectionProbe(toRemove: ReflectionProbe): number;
  139270. /**
  139271. * Adds the given reflection probe to this scene.
  139272. * @param newReflectionProbe The reflection probe to add
  139273. */
  139274. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  139275. }
  139276. /**
  139277. * Class used to generate realtime reflection / refraction cube textures
  139278. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  139279. */
  139280. export class ReflectionProbe {
  139281. /** defines the name of the probe */
  139282. name: string;
  139283. private _scene;
  139284. private _renderTargetTexture;
  139285. private _projectionMatrix;
  139286. private _viewMatrix;
  139287. private _target;
  139288. private _add;
  139289. private _attachedMesh;
  139290. private _invertYAxis;
  139291. /** Gets or sets probe position (center of the cube map) */
  139292. position: Vector3;
  139293. /**
  139294. * Creates a new reflection probe
  139295. * @param name defines the name of the probe
  139296. * @param size defines the texture resolution (for each face)
  139297. * @param scene defines the hosting scene
  139298. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  139299. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  139300. */
  139301. constructor(
  139302. /** defines the name of the probe */
  139303. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  139304. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  139305. get samples(): number;
  139306. set samples(value: number);
  139307. /** Gets or sets the refresh rate to use (on every frame by default) */
  139308. get refreshRate(): number;
  139309. set refreshRate(value: number);
  139310. /**
  139311. * Gets the hosting scene
  139312. * @returns a Scene
  139313. */
  139314. getScene(): Scene;
  139315. /** Gets the internal CubeTexture used to render to */
  139316. get cubeTexture(): RenderTargetTexture;
  139317. /** Gets the list of meshes to render */
  139318. get renderList(): Nullable<AbstractMesh[]>;
  139319. /**
  139320. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  139321. * @param mesh defines the mesh to attach to
  139322. */
  139323. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  139324. /**
  139325. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  139326. * @param renderingGroupId The rendering group id corresponding to its index
  139327. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  139328. */
  139329. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  139330. /**
  139331. * Clean all associated resources
  139332. */
  139333. dispose(): void;
  139334. /**
  139335. * Converts the reflection probe information to a readable string for debug purpose.
  139336. * @param fullDetails Supports for multiple levels of logging within scene loading
  139337. * @returns the human readable reflection probe info
  139338. */
  139339. toString(fullDetails?: boolean): string;
  139340. /**
  139341. * Get the class name of the relfection probe.
  139342. * @returns "ReflectionProbe"
  139343. */
  139344. getClassName(): string;
  139345. /**
  139346. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  139347. * @returns The JSON representation of the texture
  139348. */
  139349. serialize(): any;
  139350. /**
  139351. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  139352. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  139353. * @param scene Define the scene the parsed reflection probe should be instantiated in
  139354. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  139355. * @returns The parsed reflection probe if successful
  139356. */
  139357. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  139358. }
  139359. }
  139360. declare module BABYLON {
  139361. /** @hidden */
  139362. export var _BabylonLoaderRegistered: boolean;
  139363. /**
  139364. * Helps setting up some configuration for the babylon file loader.
  139365. */
  139366. export class BabylonFileLoaderConfiguration {
  139367. /**
  139368. * The loader does not allow injecting custom physix engine into the plugins.
  139369. * Unfortunately in ES6, we need to manually inject them into the plugin.
  139370. * So you could set this variable to your engine import to make it work.
  139371. */
  139372. static LoaderInjectedPhysicsEngine: any;
  139373. }
  139374. }
  139375. declare module BABYLON {
  139376. /**
  139377. * The Physically based simple base material of BJS.
  139378. *
  139379. * This enables better naming and convention enforcements on top of the pbrMaterial.
  139380. * It is used as the base class for both the specGloss and metalRough conventions.
  139381. */
  139382. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  139383. /**
  139384. * Number of Simultaneous lights allowed on the material.
  139385. */
  139386. maxSimultaneousLights: number;
  139387. /**
  139388. * If sets to true, disables all the lights affecting the material.
  139389. */
  139390. disableLighting: boolean;
  139391. /**
  139392. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  139393. */
  139394. environmentTexture: BaseTexture;
  139395. /**
  139396. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  139397. */
  139398. invertNormalMapX: boolean;
  139399. /**
  139400. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  139401. */
  139402. invertNormalMapY: boolean;
  139403. /**
  139404. * Normal map used in the model.
  139405. */
  139406. normalTexture: BaseTexture;
  139407. /**
  139408. * Emissivie color used to self-illuminate the model.
  139409. */
  139410. emissiveColor: Color3;
  139411. /**
  139412. * Emissivie texture used to self-illuminate the model.
  139413. */
  139414. emissiveTexture: BaseTexture;
  139415. /**
  139416. * Occlusion Channel Strenght.
  139417. */
  139418. occlusionStrength: number;
  139419. /**
  139420. * Occlusion Texture of the material (adding extra occlusion effects).
  139421. */
  139422. occlusionTexture: BaseTexture;
  139423. /**
  139424. * Defines the alpha limits in alpha test mode.
  139425. */
  139426. alphaCutOff: number;
  139427. /**
  139428. * Gets the current double sided mode.
  139429. */
  139430. get doubleSided(): boolean;
  139431. /**
  139432. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  139433. */
  139434. set doubleSided(value: boolean);
  139435. /**
  139436. * Stores the pre-calculated light information of a mesh in a texture.
  139437. */
  139438. lightmapTexture: BaseTexture;
  139439. /**
  139440. * If true, the light map contains occlusion information instead of lighting info.
  139441. */
  139442. useLightmapAsShadowmap: boolean;
  139443. /**
  139444. * Instantiates a new PBRMaterial instance.
  139445. *
  139446. * @param name The material name
  139447. * @param scene The scene the material will be use in.
  139448. */
  139449. constructor(name: string, scene: Scene);
  139450. getClassName(): string;
  139451. }
  139452. }
  139453. declare module BABYLON {
  139454. /**
  139455. * The PBR material of BJS following the metal roughness convention.
  139456. *
  139457. * This fits to the PBR convention in the GLTF definition:
  139458. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  139459. */
  139460. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  139461. /**
  139462. * The base color has two different interpretations depending on the value of metalness.
  139463. * When the material is a metal, the base color is the specific measured reflectance value
  139464. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  139465. * of the material.
  139466. */
  139467. baseColor: Color3;
  139468. /**
  139469. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  139470. * well as opacity information in the alpha channel.
  139471. */
  139472. baseTexture: BaseTexture;
  139473. /**
  139474. * Specifies the metallic scalar value of the material.
  139475. * Can also be used to scale the metalness values of the metallic texture.
  139476. */
  139477. metallic: number;
  139478. /**
  139479. * Specifies the roughness scalar value of the material.
  139480. * Can also be used to scale the roughness values of the metallic texture.
  139481. */
  139482. roughness: number;
  139483. /**
  139484. * Texture containing both the metallic value in the B channel and the
  139485. * roughness value in the G channel to keep better precision.
  139486. */
  139487. metallicRoughnessTexture: BaseTexture;
  139488. /**
  139489. * Instantiates a new PBRMetalRoughnessMaterial instance.
  139490. *
  139491. * @param name The material name
  139492. * @param scene The scene the material will be use in.
  139493. */
  139494. constructor(name: string, scene: Scene);
  139495. /**
  139496. * Return the currrent class name of the material.
  139497. */
  139498. getClassName(): string;
  139499. /**
  139500. * Makes a duplicate of the current material.
  139501. * @param name - name to use for the new material.
  139502. */
  139503. clone(name: string): PBRMetallicRoughnessMaterial;
  139504. /**
  139505. * Serialize the material to a parsable JSON object.
  139506. */
  139507. serialize(): any;
  139508. /**
  139509. * Parses a JSON object correponding to the serialize function.
  139510. */
  139511. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  139512. }
  139513. }
  139514. declare module BABYLON {
  139515. /**
  139516. * The PBR material of BJS following the specular glossiness convention.
  139517. *
  139518. * This fits to the PBR convention in the GLTF definition:
  139519. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  139520. */
  139521. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  139522. /**
  139523. * Specifies the diffuse color of the material.
  139524. */
  139525. diffuseColor: Color3;
  139526. /**
  139527. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  139528. * channel.
  139529. */
  139530. diffuseTexture: BaseTexture;
  139531. /**
  139532. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  139533. */
  139534. specularColor: Color3;
  139535. /**
  139536. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  139537. */
  139538. glossiness: number;
  139539. /**
  139540. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  139541. */
  139542. specularGlossinessTexture: BaseTexture;
  139543. /**
  139544. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  139545. *
  139546. * @param name The material name
  139547. * @param scene The scene the material will be use in.
  139548. */
  139549. constructor(name: string, scene: Scene);
  139550. /**
  139551. * Return the currrent class name of the material.
  139552. */
  139553. getClassName(): string;
  139554. /**
  139555. * Makes a duplicate of the current material.
  139556. * @param name - name to use for the new material.
  139557. */
  139558. clone(name: string): PBRSpecularGlossinessMaterial;
  139559. /**
  139560. * Serialize the material to a parsable JSON object.
  139561. */
  139562. serialize(): any;
  139563. /**
  139564. * Parses a JSON object correponding to the serialize function.
  139565. */
  139566. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  139567. }
  139568. }
  139569. declare module BABYLON {
  139570. /**
  139571. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  139572. * It can help converting any input color in a desired output one. This can then be used to create effects
  139573. * from sepia, black and white to sixties or futuristic rendering...
  139574. *
  139575. * The only supported format is currently 3dl.
  139576. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  139577. */
  139578. export class ColorGradingTexture extends BaseTexture {
  139579. /**
  139580. * The texture URL.
  139581. */
  139582. url: string;
  139583. /**
  139584. * Empty line regex stored for GC.
  139585. */
  139586. private static _noneEmptyLineRegex;
  139587. private _textureMatrix;
  139588. private _onLoad;
  139589. /**
  139590. * Instantiates a ColorGradingTexture from the following parameters.
  139591. *
  139592. * @param url The location of the color gradind data (currently only supporting 3dl)
  139593. * @param sceneOrEngine The scene or engine the texture will be used in
  139594. * @param onLoad defines a callback triggered when the texture has been loaded
  139595. */
  139596. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  139597. /**
  139598. * Fires the onload event from the constructor if requested.
  139599. */
  139600. private _triggerOnLoad;
  139601. /**
  139602. * Returns the texture matrix used in most of the material.
  139603. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  139604. */
  139605. getTextureMatrix(): Matrix;
  139606. /**
  139607. * Occurs when the file being loaded is a .3dl LUT file.
  139608. */
  139609. private load3dlTexture;
  139610. /**
  139611. * Starts the loading process of the texture.
  139612. */
  139613. private loadTexture;
  139614. /**
  139615. * Clones the color gradind texture.
  139616. */
  139617. clone(): ColorGradingTexture;
  139618. /**
  139619. * Called during delayed load for textures.
  139620. */
  139621. delayLoad(): void;
  139622. /**
  139623. * Parses a color grading texture serialized by Babylon.
  139624. * @param parsedTexture The texture information being parsedTexture
  139625. * @param scene The scene to load the texture in
  139626. * @param rootUrl The root url of the data assets to load
  139627. * @return A color gradind texture
  139628. */
  139629. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  139630. /**
  139631. * Serializes the LUT texture to json format.
  139632. */
  139633. serialize(): any;
  139634. }
  139635. }
  139636. declare module BABYLON {
  139637. /**
  139638. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  139639. */
  139640. export class EquiRectangularCubeTexture extends BaseTexture {
  139641. /** The six faces of the cube. */
  139642. private static _FacesMapping;
  139643. private _noMipmap;
  139644. private _onLoad;
  139645. private _onError;
  139646. /** The size of the cubemap. */
  139647. private _size;
  139648. /** The buffer of the image. */
  139649. private _buffer;
  139650. /** The width of the input image. */
  139651. private _width;
  139652. /** The height of the input image. */
  139653. private _height;
  139654. /** The URL to the image. */
  139655. url: string;
  139656. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  139657. coordinatesMode: number;
  139658. /**
  139659. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  139660. * @param url The location of the image
  139661. * @param scene The scene the texture will be used in
  139662. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139663. * @param noMipmap Forces to not generate the mipmap if true
  139664. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  139665. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  139666. * @param onLoad — defines a callback called when texture is loaded
  139667. * @param onError — defines a callback called if there is an error
  139668. */
  139669. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  139670. /**
  139671. * Load the image data, by putting the image on a canvas and extracting its buffer.
  139672. */
  139673. private loadImage;
  139674. /**
  139675. * Convert the image buffer into a cubemap and create a CubeTexture.
  139676. */
  139677. private loadTexture;
  139678. /**
  139679. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  139680. * @param buffer The ArrayBuffer that should be converted.
  139681. * @returns The buffer as Float32Array.
  139682. */
  139683. private getFloat32ArrayFromArrayBuffer;
  139684. /**
  139685. * Get the current class name of the texture useful for serialization or dynamic coding.
  139686. * @returns "EquiRectangularCubeTexture"
  139687. */
  139688. getClassName(): string;
  139689. /**
  139690. * Create a clone of the current EquiRectangularCubeTexture and return it.
  139691. * @returns A clone of the current EquiRectangularCubeTexture.
  139692. */
  139693. clone(): EquiRectangularCubeTexture;
  139694. }
  139695. }
  139696. declare module BABYLON {
  139697. /**
  139698. * Defines the options related to the creation of an HtmlElementTexture
  139699. */
  139700. export interface IHtmlElementTextureOptions {
  139701. /**
  139702. * Defines wether mip maps should be created or not.
  139703. */
  139704. generateMipMaps?: boolean;
  139705. /**
  139706. * Defines the sampling mode of the texture.
  139707. */
  139708. samplingMode?: number;
  139709. /**
  139710. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  139711. */
  139712. engine: Nullable<ThinEngine>;
  139713. /**
  139714. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  139715. */
  139716. scene: Nullable<Scene>;
  139717. }
  139718. /**
  139719. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  139720. * To be as efficient as possible depending on your constraints nothing aside the first upload
  139721. * is automatically managed.
  139722. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  139723. * in your application.
  139724. *
  139725. * As the update is not automatic, you need to call them manually.
  139726. */
  139727. export class HtmlElementTexture extends BaseTexture {
  139728. /**
  139729. * The texture URL.
  139730. */
  139731. element: HTMLVideoElement | HTMLCanvasElement;
  139732. private static readonly DefaultOptions;
  139733. private _textureMatrix;
  139734. private _isVideo;
  139735. private _generateMipMaps;
  139736. private _samplingMode;
  139737. /**
  139738. * Instantiates a HtmlElementTexture from the following parameters.
  139739. *
  139740. * @param name Defines the name of the texture
  139741. * @param element Defines the video or canvas the texture is filled with
  139742. * @param options Defines the other none mandatory texture creation options
  139743. */
  139744. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  139745. private _createInternalTexture;
  139746. /**
  139747. * Returns the texture matrix used in most of the material.
  139748. */
  139749. getTextureMatrix(): Matrix;
  139750. /**
  139751. * Updates the content of the texture.
  139752. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  139753. */
  139754. update(invertY?: Nullable<boolean>): void;
  139755. }
  139756. }
  139757. declare module BABYLON {
  139758. /**
  139759. * Based on jsTGALoader - Javascript loader for TGA file
  139760. * By Vincent Thibault
  139761. * @see http://blog.robrowser.com/javascript-tga-loader.html
  139762. */
  139763. export class TGATools {
  139764. private static _TYPE_INDEXED;
  139765. private static _TYPE_RGB;
  139766. private static _TYPE_GREY;
  139767. private static _TYPE_RLE_INDEXED;
  139768. private static _TYPE_RLE_RGB;
  139769. private static _TYPE_RLE_GREY;
  139770. private static _ORIGIN_MASK;
  139771. private static _ORIGIN_SHIFT;
  139772. private static _ORIGIN_BL;
  139773. private static _ORIGIN_BR;
  139774. private static _ORIGIN_UL;
  139775. private static _ORIGIN_UR;
  139776. /**
  139777. * Gets the header of a TGA file
  139778. * @param data defines the TGA data
  139779. * @returns the header
  139780. */
  139781. static GetTGAHeader(data: Uint8Array): any;
  139782. /**
  139783. * Uploads TGA content to a Babylon Texture
  139784. * @hidden
  139785. */
  139786. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  139787. /** @hidden */
  139788. 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;
  139789. /** @hidden */
  139790. 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;
  139791. /** @hidden */
  139792. 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;
  139793. /** @hidden */
  139794. 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;
  139795. /** @hidden */
  139796. 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;
  139797. /** @hidden */
  139798. 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;
  139799. }
  139800. }
  139801. declare module BABYLON {
  139802. /**
  139803. * Implementation of the TGA Texture Loader.
  139804. * @hidden
  139805. */
  139806. export class _TGATextureLoader implements IInternalTextureLoader {
  139807. /**
  139808. * Defines wether the loader supports cascade loading the different faces.
  139809. */
  139810. readonly supportCascades: boolean;
  139811. /**
  139812. * This returns if the loader support the current file information.
  139813. * @param extension defines the file extension of the file being loaded
  139814. * @returns true if the loader can load the specified file
  139815. */
  139816. canLoad(extension: string): boolean;
  139817. /**
  139818. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139819. * @param data contains the texture data
  139820. * @param texture defines the BabylonJS internal texture
  139821. * @param createPolynomials will be true if polynomials have been requested
  139822. * @param onLoad defines the callback to trigger once the texture is ready
  139823. * @param onError defines the callback to trigger in case of error
  139824. */
  139825. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139826. /**
  139827. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139828. * @param data contains the texture data
  139829. * @param texture defines the BabylonJS internal texture
  139830. * @param callback defines the method to call once ready to upload
  139831. */
  139832. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139833. }
  139834. }
  139835. declare module BABYLON {
  139836. /**
  139837. * Info about the .basis files
  139838. */
  139839. class BasisFileInfo {
  139840. /**
  139841. * If the file has alpha
  139842. */
  139843. hasAlpha: boolean;
  139844. /**
  139845. * Info about each image of the basis file
  139846. */
  139847. images: Array<{
  139848. levels: Array<{
  139849. width: number;
  139850. height: number;
  139851. transcodedPixels: ArrayBufferView;
  139852. }>;
  139853. }>;
  139854. }
  139855. /**
  139856. * Result of transcoding a basis file
  139857. */
  139858. class TranscodeResult {
  139859. /**
  139860. * Info about the .basis file
  139861. */
  139862. fileInfo: BasisFileInfo;
  139863. /**
  139864. * Format to use when loading the file
  139865. */
  139866. format: number;
  139867. }
  139868. /**
  139869. * Configuration options for the Basis transcoder
  139870. */
  139871. export class BasisTranscodeConfiguration {
  139872. /**
  139873. * Supported compression formats used to determine the supported output format of the transcoder
  139874. */
  139875. supportedCompressionFormats?: {
  139876. /**
  139877. * etc1 compression format
  139878. */
  139879. etc1?: boolean;
  139880. /**
  139881. * s3tc compression format
  139882. */
  139883. s3tc?: boolean;
  139884. /**
  139885. * pvrtc compression format
  139886. */
  139887. pvrtc?: boolean;
  139888. /**
  139889. * etc2 compression format
  139890. */
  139891. etc2?: boolean;
  139892. };
  139893. /**
  139894. * If mipmap levels should be loaded for transcoded images (Default: true)
  139895. */
  139896. loadMipmapLevels?: boolean;
  139897. /**
  139898. * Index of a single image to load (Default: all images)
  139899. */
  139900. loadSingleImage?: number;
  139901. }
  139902. /**
  139903. * Used to load .Basis files
  139904. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  139905. */
  139906. export class BasisTools {
  139907. private static _IgnoreSupportedFormats;
  139908. /**
  139909. * URL to use when loading the basis transcoder
  139910. */
  139911. static JSModuleURL: string;
  139912. /**
  139913. * URL to use when loading the wasm module for the transcoder
  139914. */
  139915. static WasmModuleURL: string;
  139916. /**
  139917. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  139918. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  139919. * @returns internal format corresponding to the Basis format
  139920. */
  139921. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  139922. private static _WorkerPromise;
  139923. private static _Worker;
  139924. private static _actionId;
  139925. private static _CreateWorkerAsync;
  139926. /**
  139927. * Transcodes a loaded image file to compressed pixel data
  139928. * @param data image data to transcode
  139929. * @param config configuration options for the transcoding
  139930. * @returns a promise resulting in the transcoded image
  139931. */
  139932. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  139933. /**
  139934. * Loads a texture from the transcode result
  139935. * @param texture texture load to
  139936. * @param transcodeResult the result of transcoding the basis file to load from
  139937. */
  139938. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  139939. }
  139940. }
  139941. declare module BABYLON {
  139942. /**
  139943. * Loader for .basis file format
  139944. */
  139945. export class _BasisTextureLoader implements IInternalTextureLoader {
  139946. /**
  139947. * Defines whether the loader supports cascade loading the different faces.
  139948. */
  139949. readonly supportCascades: boolean;
  139950. /**
  139951. * This returns if the loader support the current file information.
  139952. * @param extension defines the file extension of the file being loaded
  139953. * @returns true if the loader can load the specified file
  139954. */
  139955. canLoad(extension: string): boolean;
  139956. /**
  139957. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139958. * @param data contains the texture data
  139959. * @param texture defines the BabylonJS internal texture
  139960. * @param createPolynomials will be true if polynomials have been requested
  139961. * @param onLoad defines the callback to trigger once the texture is ready
  139962. * @param onError defines the callback to trigger in case of error
  139963. */
  139964. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139965. /**
  139966. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139967. * @param data contains the texture data
  139968. * @param texture defines the BabylonJS internal texture
  139969. * @param callback defines the method to call once ready to upload
  139970. */
  139971. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139972. }
  139973. }
  139974. declare module BABYLON {
  139975. /**
  139976. * Defines the basic options interface of a TexturePacker Frame
  139977. */
  139978. export interface ITexturePackerFrame {
  139979. /**
  139980. * The frame ID
  139981. */
  139982. id: number;
  139983. /**
  139984. * The frames Scale
  139985. */
  139986. scale: Vector2;
  139987. /**
  139988. * The Frames offset
  139989. */
  139990. offset: Vector2;
  139991. }
  139992. /**
  139993. * This is a support class for frame Data on texture packer sets.
  139994. */
  139995. export class TexturePackerFrame implements ITexturePackerFrame {
  139996. /**
  139997. * The frame ID
  139998. */
  139999. id: number;
  140000. /**
  140001. * The frames Scale
  140002. */
  140003. scale: Vector2;
  140004. /**
  140005. * The Frames offset
  140006. */
  140007. offset: Vector2;
  140008. /**
  140009. * Initializes a texture package frame.
  140010. * @param id The numerical frame identifier
  140011. * @param scale Scalar Vector2 for UV frame
  140012. * @param offset Vector2 for the frame position in UV units.
  140013. * @returns TexturePackerFrame
  140014. */
  140015. constructor(id: number, scale: Vector2, offset: Vector2);
  140016. }
  140017. }
  140018. declare module BABYLON {
  140019. /**
  140020. * Defines the basic options interface of a TexturePacker
  140021. */
  140022. export interface ITexturePackerOptions {
  140023. /**
  140024. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  140025. */
  140026. map?: string[];
  140027. /**
  140028. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  140029. */
  140030. uvsIn?: string;
  140031. /**
  140032. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  140033. */
  140034. uvsOut?: string;
  140035. /**
  140036. * number representing the layout style. Defaults to LAYOUT_STRIP
  140037. */
  140038. layout?: number;
  140039. /**
  140040. * number of columns if using custom column count layout(2). This defaults to 4.
  140041. */
  140042. colnum?: number;
  140043. /**
  140044. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  140045. */
  140046. updateInputMeshes?: boolean;
  140047. /**
  140048. * boolean flag to dispose all the source textures. Defaults to true.
  140049. */
  140050. disposeSources?: boolean;
  140051. /**
  140052. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  140053. */
  140054. fillBlanks?: boolean;
  140055. /**
  140056. * string value representing the context fill style color. Defaults to 'black'.
  140057. */
  140058. customFillColor?: string;
  140059. /**
  140060. * Width and Height Value of each Frame in the TexturePacker Sets
  140061. */
  140062. frameSize?: number;
  140063. /**
  140064. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  140065. */
  140066. paddingRatio?: number;
  140067. /**
  140068. * Number that declares the fill method for the padding gutter.
  140069. */
  140070. paddingMode?: number;
  140071. /**
  140072. * If in SUBUV_COLOR padding mode what color to use.
  140073. */
  140074. paddingColor?: Color3 | Color4;
  140075. }
  140076. /**
  140077. * Defines the basic interface of a TexturePacker JSON File
  140078. */
  140079. export interface ITexturePackerJSON {
  140080. /**
  140081. * The frame ID
  140082. */
  140083. name: string;
  140084. /**
  140085. * The base64 channel data
  140086. */
  140087. sets: any;
  140088. /**
  140089. * The options of the Packer
  140090. */
  140091. options: ITexturePackerOptions;
  140092. /**
  140093. * The frame data of the Packer
  140094. */
  140095. frames: Array<number>;
  140096. }
  140097. /**
  140098. * This is a support class that generates a series of packed texture sets.
  140099. * @see https://doc.babylonjs.com/babylon101/materials
  140100. */
  140101. export class TexturePacker {
  140102. /** Packer Layout Constant 0 */
  140103. static readonly LAYOUT_STRIP: number;
  140104. /** Packer Layout Constant 1 */
  140105. static readonly LAYOUT_POWER2: number;
  140106. /** Packer Layout Constant 2 */
  140107. static readonly LAYOUT_COLNUM: number;
  140108. /** Packer Layout Constant 0 */
  140109. static readonly SUBUV_WRAP: number;
  140110. /** Packer Layout Constant 1 */
  140111. static readonly SUBUV_EXTEND: number;
  140112. /** Packer Layout Constant 2 */
  140113. static readonly SUBUV_COLOR: number;
  140114. /** The Name of the Texture Package */
  140115. name: string;
  140116. /** The scene scope of the TexturePacker */
  140117. scene: Scene;
  140118. /** The Meshes to target */
  140119. meshes: AbstractMesh[];
  140120. /** Arguments passed with the Constructor */
  140121. options: ITexturePackerOptions;
  140122. /** The promise that is started upon initialization */
  140123. promise: Nullable<Promise<TexturePacker | string>>;
  140124. /** The Container object for the channel sets that are generated */
  140125. sets: object;
  140126. /** The Container array for the frames that are generated */
  140127. frames: TexturePackerFrame[];
  140128. /** The expected number of textures the system is parsing. */
  140129. private _expecting;
  140130. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  140131. private _paddingValue;
  140132. /**
  140133. * Initializes a texture package series from an array of meshes or a single mesh.
  140134. * @param name The name of the package
  140135. * @param meshes The target meshes to compose the package from
  140136. * @param options The arguments that texture packer should follow while building.
  140137. * @param scene The scene which the textures are scoped to.
  140138. * @returns TexturePacker
  140139. */
  140140. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  140141. /**
  140142. * Starts the package process
  140143. * @param resolve The promises resolution function
  140144. * @returns TexturePacker
  140145. */
  140146. private _createFrames;
  140147. /**
  140148. * Calculates the Size of the Channel Sets
  140149. * @returns Vector2
  140150. */
  140151. private _calculateSize;
  140152. /**
  140153. * Calculates the UV data for the frames.
  140154. * @param baseSize the base frameSize
  140155. * @param padding the base frame padding
  140156. * @param dtSize size of the Dynamic Texture for that channel
  140157. * @param dtUnits is 1/dtSize
  140158. * @param update flag to update the input meshes
  140159. */
  140160. private _calculateMeshUVFrames;
  140161. /**
  140162. * Calculates the frames Offset.
  140163. * @param index of the frame
  140164. * @returns Vector2
  140165. */
  140166. private _getFrameOffset;
  140167. /**
  140168. * Updates a Mesh to the frame data
  140169. * @param mesh that is the target
  140170. * @param frameID or the frame index
  140171. */
  140172. private _updateMeshUV;
  140173. /**
  140174. * Updates a Meshes materials to use the texture packer channels
  140175. * @param m is the mesh to target
  140176. * @param force all channels on the packer to be set.
  140177. */
  140178. private _updateTextureReferences;
  140179. /**
  140180. * Public method to set a Mesh to a frame
  140181. * @param m that is the target
  140182. * @param frameID or the frame index
  140183. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  140184. */
  140185. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  140186. /**
  140187. * Starts the async promise to compile the texture packer.
  140188. * @returns Promise<void>
  140189. */
  140190. processAsync(): Promise<void>;
  140191. /**
  140192. * Disposes all textures associated with this packer
  140193. */
  140194. dispose(): void;
  140195. /**
  140196. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  140197. * @param imageType is the image type to use.
  140198. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  140199. */
  140200. download(imageType?: string, quality?: number): void;
  140201. /**
  140202. * Public method to load a texturePacker JSON file.
  140203. * @param data of the JSON file in string format.
  140204. */
  140205. updateFromJSON(data: string): void;
  140206. }
  140207. }
  140208. declare module BABYLON {
  140209. /**
  140210. * 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.
  140211. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  140212. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  140213. */
  140214. export class CustomProceduralTexture extends ProceduralTexture {
  140215. private _animate;
  140216. private _time;
  140217. private _config;
  140218. private _texturePath;
  140219. /**
  140220. * Instantiates a new Custom Procedural Texture.
  140221. * 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.
  140222. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  140223. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  140224. * @param name Define the name of the texture
  140225. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  140226. * @param size Define the size of the texture to create
  140227. * @param scene Define the scene the texture belongs to
  140228. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  140229. * @param generateMipMaps Define if the texture should creates mip maps or not
  140230. */
  140231. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  140232. private _loadJson;
  140233. /**
  140234. * Is the texture ready to be used ? (rendered at least once)
  140235. * @returns true if ready, otherwise, false.
  140236. */
  140237. isReady(): boolean;
  140238. /**
  140239. * Render the texture to its associated render target.
  140240. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  140241. */
  140242. render(useCameraPostProcess?: boolean): void;
  140243. /**
  140244. * Update the list of dependant textures samplers in the shader.
  140245. */
  140246. updateTextures(): void;
  140247. /**
  140248. * Update the uniform values of the procedural texture in the shader.
  140249. */
  140250. updateShaderUniforms(): void;
  140251. /**
  140252. * Define if the texture animates or not.
  140253. */
  140254. get animate(): boolean;
  140255. set animate(value: boolean);
  140256. }
  140257. }
  140258. declare module BABYLON {
  140259. /** @hidden */
  140260. export var noisePixelShader: {
  140261. name: string;
  140262. shader: string;
  140263. };
  140264. }
  140265. declare module BABYLON {
  140266. /**
  140267. * Class used to generate noise procedural textures
  140268. */
  140269. export class NoiseProceduralTexture extends ProceduralTexture {
  140270. private _time;
  140271. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  140272. brightness: number;
  140273. /** Defines the number of octaves to process */
  140274. octaves: number;
  140275. /** Defines the level of persistence (0.8 by default) */
  140276. persistence: number;
  140277. /** Gets or sets animation speed factor (default is 1) */
  140278. animationSpeedFactor: number;
  140279. /**
  140280. * Creates a new NoiseProceduralTexture
  140281. * @param name defines the name fo the texture
  140282. * @param size defines the size of the texture (default is 256)
  140283. * @param scene defines the hosting scene
  140284. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  140285. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  140286. */
  140287. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  140288. private _updateShaderUniforms;
  140289. protected _getDefines(): string;
  140290. /** Generate the current state of the procedural texture */
  140291. render(useCameraPostProcess?: boolean): void;
  140292. /**
  140293. * Serializes this noise procedural texture
  140294. * @returns a serialized noise procedural texture object
  140295. */
  140296. serialize(): any;
  140297. /**
  140298. * Clone the texture.
  140299. * @returns the cloned texture
  140300. */
  140301. clone(): NoiseProceduralTexture;
  140302. /**
  140303. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  140304. * @param parsedTexture defines parsed texture data
  140305. * @param scene defines the current scene
  140306. * @param rootUrl defines the root URL containing noise procedural texture information
  140307. * @returns a parsed NoiseProceduralTexture
  140308. */
  140309. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  140310. }
  140311. }
  140312. declare module BABYLON {
  140313. /**
  140314. * Raw cube texture where the raw buffers are passed in
  140315. */
  140316. export class RawCubeTexture extends CubeTexture {
  140317. /**
  140318. * Creates a cube texture where the raw buffers are passed in.
  140319. * @param scene defines the scene the texture is attached to
  140320. * @param data defines the array of data to use to create each face
  140321. * @param size defines the size of the textures
  140322. * @param format defines the format of the data
  140323. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  140324. * @param generateMipMaps defines if the engine should generate the mip levels
  140325. * @param invertY defines if data must be stored with Y axis inverted
  140326. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  140327. * @param compression defines the compression used (null by default)
  140328. */
  140329. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  140330. /**
  140331. * Updates the raw cube texture.
  140332. * @param data defines the data to store
  140333. * @param format defines the data format
  140334. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  140335. * @param invertY defines if data must be stored with Y axis inverted
  140336. * @param compression defines the compression used (null by default)
  140337. * @param level defines which level of the texture to update
  140338. */
  140339. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  140340. /**
  140341. * Updates a raw cube texture with RGBD encoded data.
  140342. * @param data defines the array of data [mipmap][face] to use to create each face
  140343. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  140344. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  140345. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  140346. * @returns a promsie that resolves when the operation is complete
  140347. */
  140348. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  140349. /**
  140350. * Clones the raw cube texture.
  140351. * @return a new cube texture
  140352. */
  140353. clone(): CubeTexture;
  140354. /** @hidden */
  140355. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  140356. }
  140357. }
  140358. declare module BABYLON {
  140359. /**
  140360. * Class used to store 2D array textures containing user data
  140361. */
  140362. export class RawTexture2DArray extends Texture {
  140363. /** Gets or sets the texture format to use */
  140364. format: number;
  140365. /**
  140366. * Create a new RawTexture2DArray
  140367. * @param data defines the data of the texture
  140368. * @param width defines the width of the texture
  140369. * @param height defines the height of the texture
  140370. * @param depth defines the number of layers of the texture
  140371. * @param format defines the texture format to use
  140372. * @param scene defines the hosting scene
  140373. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  140374. * @param invertY defines if texture must be stored with Y axis inverted
  140375. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  140376. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  140377. */
  140378. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  140379. /** Gets or sets the texture format to use */
  140380. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  140381. /**
  140382. * Update the texture with new data
  140383. * @param data defines the data to store in the texture
  140384. */
  140385. update(data: ArrayBufferView): void;
  140386. }
  140387. }
  140388. declare module BABYLON {
  140389. /**
  140390. * Class used to store 3D textures containing user data
  140391. */
  140392. export class RawTexture3D extends Texture {
  140393. /** Gets or sets the texture format to use */
  140394. format: number;
  140395. /**
  140396. * Create a new RawTexture3D
  140397. * @param data defines the data of the texture
  140398. * @param width defines the width of the texture
  140399. * @param height defines the height of the texture
  140400. * @param depth defines the depth of the texture
  140401. * @param format defines the texture format to use
  140402. * @param scene defines the hosting scene
  140403. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  140404. * @param invertY defines if texture must be stored with Y axis inverted
  140405. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  140406. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  140407. */
  140408. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  140409. /** Gets or sets the texture format to use */
  140410. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  140411. /**
  140412. * Update the texture with new data
  140413. * @param data defines the data to store in the texture
  140414. */
  140415. update(data: ArrayBufferView): void;
  140416. }
  140417. }
  140418. declare module BABYLON {
  140419. /**
  140420. * Creates a refraction texture used by refraction channel of the standard material.
  140421. * It is like a mirror but to see through a material.
  140422. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140423. */
  140424. export class RefractionTexture extends RenderTargetTexture {
  140425. /**
  140426. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  140427. * 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.
  140428. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140429. */
  140430. refractionPlane: Plane;
  140431. /**
  140432. * Define how deep under the surface we should see.
  140433. */
  140434. depth: number;
  140435. /**
  140436. * Creates a refraction texture used by refraction channel of the standard material.
  140437. * It is like a mirror but to see through a material.
  140438. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140439. * @param name Define the texture name
  140440. * @param size Define the size of the underlying texture
  140441. * @param scene Define the scene the refraction belongs to
  140442. * @param generateMipMaps Define if we need to generate mips level for the refraction
  140443. */
  140444. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  140445. /**
  140446. * Clone the refraction texture.
  140447. * @returns the cloned texture
  140448. */
  140449. clone(): RefractionTexture;
  140450. /**
  140451. * Serialize the texture to a JSON representation you could use in Parse later on
  140452. * @returns the serialized JSON representation
  140453. */
  140454. serialize(): any;
  140455. }
  140456. }
  140457. declare module BABYLON {
  140458. /**
  140459. * Block used to add support for vertex skinning (bones)
  140460. */
  140461. export class BonesBlock extends NodeMaterialBlock {
  140462. /**
  140463. * Creates a new BonesBlock
  140464. * @param name defines the block name
  140465. */
  140466. constructor(name: string);
  140467. /**
  140468. * Initialize the block and prepare the context for build
  140469. * @param state defines the state that will be used for the build
  140470. */
  140471. initialize(state: NodeMaterialBuildState): void;
  140472. /**
  140473. * Gets the current class name
  140474. * @returns the class name
  140475. */
  140476. getClassName(): string;
  140477. /**
  140478. * Gets the matrix indices input component
  140479. */
  140480. get matricesIndices(): NodeMaterialConnectionPoint;
  140481. /**
  140482. * Gets the matrix weights input component
  140483. */
  140484. get matricesWeights(): NodeMaterialConnectionPoint;
  140485. /**
  140486. * Gets the extra matrix indices input component
  140487. */
  140488. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  140489. /**
  140490. * Gets the extra matrix weights input component
  140491. */
  140492. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  140493. /**
  140494. * Gets the world input component
  140495. */
  140496. get world(): NodeMaterialConnectionPoint;
  140497. /**
  140498. * Gets the output component
  140499. */
  140500. get output(): NodeMaterialConnectionPoint;
  140501. autoConfigure(material: NodeMaterial): void;
  140502. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  140503. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140504. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140505. protected _buildBlock(state: NodeMaterialBuildState): this;
  140506. }
  140507. }
  140508. declare module BABYLON {
  140509. /**
  140510. * Block used to add support for instances
  140511. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  140512. */
  140513. export class InstancesBlock extends NodeMaterialBlock {
  140514. /**
  140515. * Creates a new InstancesBlock
  140516. * @param name defines the block name
  140517. */
  140518. constructor(name: string);
  140519. /**
  140520. * Gets the current class name
  140521. * @returns the class name
  140522. */
  140523. getClassName(): string;
  140524. /**
  140525. * Gets the first world row input component
  140526. */
  140527. get world0(): NodeMaterialConnectionPoint;
  140528. /**
  140529. * Gets the second world row input component
  140530. */
  140531. get world1(): NodeMaterialConnectionPoint;
  140532. /**
  140533. * Gets the third world row input component
  140534. */
  140535. get world2(): NodeMaterialConnectionPoint;
  140536. /**
  140537. * Gets the forth world row input component
  140538. */
  140539. get world3(): NodeMaterialConnectionPoint;
  140540. /**
  140541. * Gets the world input component
  140542. */
  140543. get world(): NodeMaterialConnectionPoint;
  140544. /**
  140545. * Gets the output component
  140546. */
  140547. get output(): NodeMaterialConnectionPoint;
  140548. /**
  140549. * Gets the isntanceID component
  140550. */
  140551. get instanceID(): NodeMaterialConnectionPoint;
  140552. autoConfigure(material: NodeMaterial): void;
  140553. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  140554. protected _buildBlock(state: NodeMaterialBuildState): this;
  140555. }
  140556. }
  140557. declare module BABYLON {
  140558. /**
  140559. * Block used to add morph targets support to vertex shader
  140560. */
  140561. export class MorphTargetsBlock extends NodeMaterialBlock {
  140562. private _repeatableContentAnchor;
  140563. /**
  140564. * Create a new MorphTargetsBlock
  140565. * @param name defines the block name
  140566. */
  140567. constructor(name: string);
  140568. /**
  140569. * Gets the current class name
  140570. * @returns the class name
  140571. */
  140572. getClassName(): string;
  140573. /**
  140574. * Gets the position input component
  140575. */
  140576. get position(): NodeMaterialConnectionPoint;
  140577. /**
  140578. * Gets the normal input component
  140579. */
  140580. get normal(): NodeMaterialConnectionPoint;
  140581. /**
  140582. * Gets the tangent input component
  140583. */
  140584. get tangent(): NodeMaterialConnectionPoint;
  140585. /**
  140586. * Gets the tangent input component
  140587. */
  140588. get uv(): NodeMaterialConnectionPoint;
  140589. /**
  140590. * Gets the position output component
  140591. */
  140592. get positionOutput(): NodeMaterialConnectionPoint;
  140593. /**
  140594. * Gets the normal output component
  140595. */
  140596. get normalOutput(): NodeMaterialConnectionPoint;
  140597. /**
  140598. * Gets the tangent output component
  140599. */
  140600. get tangentOutput(): NodeMaterialConnectionPoint;
  140601. /**
  140602. * Gets the tangent output component
  140603. */
  140604. get uvOutput(): NodeMaterialConnectionPoint;
  140605. initialize(state: NodeMaterialBuildState): void;
  140606. autoConfigure(material: NodeMaterial): void;
  140607. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140608. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140609. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  140610. protected _buildBlock(state: NodeMaterialBuildState): this;
  140611. }
  140612. }
  140613. declare module BABYLON {
  140614. /**
  140615. * Block used to get data information from a light
  140616. */
  140617. export class LightInformationBlock extends NodeMaterialBlock {
  140618. private _lightDataUniformName;
  140619. private _lightColorUniformName;
  140620. private _lightTypeDefineName;
  140621. /**
  140622. * Gets or sets the light associated with this block
  140623. */
  140624. light: Nullable<Light>;
  140625. /**
  140626. * Creates a new LightInformationBlock
  140627. * @param name defines the block name
  140628. */
  140629. constructor(name: string);
  140630. /**
  140631. * Gets the current class name
  140632. * @returns the class name
  140633. */
  140634. getClassName(): string;
  140635. /**
  140636. * Gets the world position input component
  140637. */
  140638. get worldPosition(): NodeMaterialConnectionPoint;
  140639. /**
  140640. * Gets the direction output component
  140641. */
  140642. get direction(): NodeMaterialConnectionPoint;
  140643. /**
  140644. * Gets the direction output component
  140645. */
  140646. get color(): NodeMaterialConnectionPoint;
  140647. /**
  140648. * Gets the direction output component
  140649. */
  140650. get intensity(): NodeMaterialConnectionPoint;
  140651. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140652. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140653. protected _buildBlock(state: NodeMaterialBuildState): this;
  140654. serialize(): any;
  140655. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140656. }
  140657. }
  140658. declare module BABYLON {
  140659. /**
  140660. * Block used to add image processing support to fragment shader
  140661. */
  140662. export class ImageProcessingBlock extends NodeMaterialBlock {
  140663. /**
  140664. * Create a new ImageProcessingBlock
  140665. * @param name defines the block name
  140666. */
  140667. constructor(name: string);
  140668. /**
  140669. * Gets the current class name
  140670. * @returns the class name
  140671. */
  140672. getClassName(): string;
  140673. /**
  140674. * Gets the color input component
  140675. */
  140676. get color(): NodeMaterialConnectionPoint;
  140677. /**
  140678. * Gets the output component
  140679. */
  140680. get output(): NodeMaterialConnectionPoint;
  140681. /**
  140682. * Initialize the block and prepare the context for build
  140683. * @param state defines the state that will be used for the build
  140684. */
  140685. initialize(state: NodeMaterialBuildState): void;
  140686. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  140687. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140688. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140689. protected _buildBlock(state: NodeMaterialBuildState): this;
  140690. }
  140691. }
  140692. declare module BABYLON {
  140693. /**
  140694. * Block used to pertub normals based on a normal map
  140695. */
  140696. export class PerturbNormalBlock extends NodeMaterialBlock {
  140697. private _tangentSpaceParameterName;
  140698. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  140699. invertX: boolean;
  140700. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  140701. invertY: boolean;
  140702. /**
  140703. * Create a new PerturbNormalBlock
  140704. * @param name defines the block name
  140705. */
  140706. constructor(name: string);
  140707. /**
  140708. * Gets the current class name
  140709. * @returns the class name
  140710. */
  140711. getClassName(): string;
  140712. /**
  140713. * Gets the world position input component
  140714. */
  140715. get worldPosition(): NodeMaterialConnectionPoint;
  140716. /**
  140717. * Gets the world normal input component
  140718. */
  140719. get worldNormal(): NodeMaterialConnectionPoint;
  140720. /**
  140721. * Gets the world tangent input component
  140722. */
  140723. get worldTangent(): NodeMaterialConnectionPoint;
  140724. /**
  140725. * Gets the uv input component
  140726. */
  140727. get uv(): NodeMaterialConnectionPoint;
  140728. /**
  140729. * Gets the normal map color input component
  140730. */
  140731. get normalMapColor(): NodeMaterialConnectionPoint;
  140732. /**
  140733. * Gets the strength input component
  140734. */
  140735. get strength(): NodeMaterialConnectionPoint;
  140736. /**
  140737. * Gets the output component
  140738. */
  140739. get output(): NodeMaterialConnectionPoint;
  140740. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140741. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140742. autoConfigure(material: NodeMaterial): void;
  140743. protected _buildBlock(state: NodeMaterialBuildState): this;
  140744. protected _dumpPropertiesCode(): string;
  140745. serialize(): any;
  140746. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140747. }
  140748. }
  140749. declare module BABYLON {
  140750. /**
  140751. * Block used to discard a pixel if a value is smaller than a cutoff
  140752. */
  140753. export class DiscardBlock extends NodeMaterialBlock {
  140754. /**
  140755. * Create a new DiscardBlock
  140756. * @param name defines the block name
  140757. */
  140758. constructor(name: string);
  140759. /**
  140760. * Gets the current class name
  140761. * @returns the class name
  140762. */
  140763. getClassName(): string;
  140764. /**
  140765. * Gets the color input component
  140766. */
  140767. get value(): NodeMaterialConnectionPoint;
  140768. /**
  140769. * Gets the cutoff input component
  140770. */
  140771. get cutoff(): NodeMaterialConnectionPoint;
  140772. protected _buildBlock(state: NodeMaterialBuildState): this;
  140773. }
  140774. }
  140775. declare module BABYLON {
  140776. /**
  140777. * Block used to test if the fragment shader is front facing
  140778. */
  140779. export class FrontFacingBlock extends NodeMaterialBlock {
  140780. /**
  140781. * Creates a new FrontFacingBlock
  140782. * @param name defines the block name
  140783. */
  140784. constructor(name: string);
  140785. /**
  140786. * Gets the current class name
  140787. * @returns the class name
  140788. */
  140789. getClassName(): string;
  140790. /**
  140791. * Gets the output component
  140792. */
  140793. get output(): NodeMaterialConnectionPoint;
  140794. protected _buildBlock(state: NodeMaterialBuildState): this;
  140795. }
  140796. }
  140797. declare module BABYLON {
  140798. /**
  140799. * Block used to get the derivative value on x and y of a given input
  140800. */
  140801. export class DerivativeBlock extends NodeMaterialBlock {
  140802. /**
  140803. * Create a new DerivativeBlock
  140804. * @param name defines the block name
  140805. */
  140806. constructor(name: string);
  140807. /**
  140808. * Gets the current class name
  140809. * @returns the class name
  140810. */
  140811. getClassName(): string;
  140812. /**
  140813. * Gets the input component
  140814. */
  140815. get input(): NodeMaterialConnectionPoint;
  140816. /**
  140817. * Gets the derivative output on x
  140818. */
  140819. get dx(): NodeMaterialConnectionPoint;
  140820. /**
  140821. * Gets the derivative output on y
  140822. */
  140823. get dy(): NodeMaterialConnectionPoint;
  140824. protected _buildBlock(state: NodeMaterialBuildState): this;
  140825. }
  140826. }
  140827. declare module BABYLON {
  140828. /**
  140829. * Block used to make gl_FragCoord available
  140830. */
  140831. export class FragCoordBlock extends NodeMaterialBlock {
  140832. /**
  140833. * Creates a new FragCoordBlock
  140834. * @param name defines the block name
  140835. */
  140836. constructor(name: string);
  140837. /**
  140838. * Gets the current class name
  140839. * @returns the class name
  140840. */
  140841. getClassName(): string;
  140842. /**
  140843. * Gets the xy component
  140844. */
  140845. get xy(): NodeMaterialConnectionPoint;
  140846. /**
  140847. * Gets the xyz component
  140848. */
  140849. get xyz(): NodeMaterialConnectionPoint;
  140850. /**
  140851. * Gets the xyzw component
  140852. */
  140853. get xyzw(): NodeMaterialConnectionPoint;
  140854. /**
  140855. * Gets the x component
  140856. */
  140857. get x(): NodeMaterialConnectionPoint;
  140858. /**
  140859. * Gets the y component
  140860. */
  140861. get y(): NodeMaterialConnectionPoint;
  140862. /**
  140863. * Gets the z component
  140864. */
  140865. get z(): NodeMaterialConnectionPoint;
  140866. /**
  140867. * Gets the w component
  140868. */
  140869. get output(): NodeMaterialConnectionPoint;
  140870. protected writeOutputs(state: NodeMaterialBuildState): string;
  140871. protected _buildBlock(state: NodeMaterialBuildState): this;
  140872. }
  140873. }
  140874. declare module BABYLON {
  140875. /**
  140876. * Block used to get the screen sizes
  140877. */
  140878. export class ScreenSizeBlock extends NodeMaterialBlock {
  140879. private _varName;
  140880. private _scene;
  140881. /**
  140882. * Creates a new ScreenSizeBlock
  140883. * @param name defines the block name
  140884. */
  140885. constructor(name: string);
  140886. /**
  140887. * Gets the current class name
  140888. * @returns the class name
  140889. */
  140890. getClassName(): string;
  140891. /**
  140892. * Gets the xy component
  140893. */
  140894. get xy(): NodeMaterialConnectionPoint;
  140895. /**
  140896. * Gets the x component
  140897. */
  140898. get x(): NodeMaterialConnectionPoint;
  140899. /**
  140900. * Gets the y component
  140901. */
  140902. get y(): NodeMaterialConnectionPoint;
  140903. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140904. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  140905. protected _buildBlock(state: NodeMaterialBuildState): this;
  140906. }
  140907. }
  140908. declare module BABYLON {
  140909. /**
  140910. * Block used to add support for scene fog
  140911. */
  140912. export class FogBlock extends NodeMaterialBlock {
  140913. private _fogDistanceName;
  140914. private _fogParameters;
  140915. /**
  140916. * Create a new FogBlock
  140917. * @param name defines the block name
  140918. */
  140919. constructor(name: string);
  140920. /**
  140921. * Gets the current class name
  140922. * @returns the class name
  140923. */
  140924. getClassName(): string;
  140925. /**
  140926. * Gets the world position input component
  140927. */
  140928. get worldPosition(): NodeMaterialConnectionPoint;
  140929. /**
  140930. * Gets the view input component
  140931. */
  140932. get view(): NodeMaterialConnectionPoint;
  140933. /**
  140934. * Gets the color input component
  140935. */
  140936. get input(): NodeMaterialConnectionPoint;
  140937. /**
  140938. * Gets the fog color input component
  140939. */
  140940. get fogColor(): NodeMaterialConnectionPoint;
  140941. /**
  140942. * Gets the output component
  140943. */
  140944. get output(): NodeMaterialConnectionPoint;
  140945. autoConfigure(material: NodeMaterial): void;
  140946. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140947. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140948. protected _buildBlock(state: NodeMaterialBuildState): this;
  140949. }
  140950. }
  140951. declare module BABYLON {
  140952. /**
  140953. * Block used to add light in the fragment shader
  140954. */
  140955. export class LightBlock extends NodeMaterialBlock {
  140956. private _lightId;
  140957. /**
  140958. * Gets or sets the light associated with this block
  140959. */
  140960. light: Nullable<Light>;
  140961. /**
  140962. * Create a new LightBlock
  140963. * @param name defines the block name
  140964. */
  140965. constructor(name: string);
  140966. /**
  140967. * Gets the current class name
  140968. * @returns the class name
  140969. */
  140970. getClassName(): string;
  140971. /**
  140972. * Gets the world position input component
  140973. */
  140974. get worldPosition(): NodeMaterialConnectionPoint;
  140975. /**
  140976. * Gets the world normal input component
  140977. */
  140978. get worldNormal(): NodeMaterialConnectionPoint;
  140979. /**
  140980. * Gets the camera (or eye) position component
  140981. */
  140982. get cameraPosition(): NodeMaterialConnectionPoint;
  140983. /**
  140984. * Gets the glossiness component
  140985. */
  140986. get glossiness(): NodeMaterialConnectionPoint;
  140987. /**
  140988. * Gets the glossinness power component
  140989. */
  140990. get glossPower(): NodeMaterialConnectionPoint;
  140991. /**
  140992. * Gets the diffuse color component
  140993. */
  140994. get diffuseColor(): NodeMaterialConnectionPoint;
  140995. /**
  140996. * Gets the specular color component
  140997. */
  140998. get specularColor(): NodeMaterialConnectionPoint;
  140999. /**
  141000. * Gets the diffuse output component
  141001. */
  141002. get diffuseOutput(): NodeMaterialConnectionPoint;
  141003. /**
  141004. * Gets the specular output component
  141005. */
  141006. get specularOutput(): NodeMaterialConnectionPoint;
  141007. /**
  141008. * Gets the shadow output component
  141009. */
  141010. get shadow(): NodeMaterialConnectionPoint;
  141011. autoConfigure(material: NodeMaterial): void;
  141012. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141013. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  141014. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141015. private _injectVertexCode;
  141016. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  141017. serialize(): any;
  141018. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141019. }
  141020. }
  141021. declare module BABYLON {
  141022. /**
  141023. * Block used to read a reflection texture from a sampler
  141024. */
  141025. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  141026. /**
  141027. * Create a new ReflectionTextureBlock
  141028. * @param name defines the block name
  141029. */
  141030. constructor(name: string);
  141031. /**
  141032. * Gets the current class name
  141033. * @returns the class name
  141034. */
  141035. getClassName(): string;
  141036. /**
  141037. * Gets the world position input component
  141038. */
  141039. get position(): NodeMaterialConnectionPoint;
  141040. /**
  141041. * Gets the world position input component
  141042. */
  141043. get worldPosition(): NodeMaterialConnectionPoint;
  141044. /**
  141045. * Gets the world normal input component
  141046. */
  141047. get worldNormal(): NodeMaterialConnectionPoint;
  141048. /**
  141049. * Gets the world input component
  141050. */
  141051. get world(): NodeMaterialConnectionPoint;
  141052. /**
  141053. * Gets the camera (or eye) position component
  141054. */
  141055. get cameraPosition(): NodeMaterialConnectionPoint;
  141056. /**
  141057. * Gets the view input component
  141058. */
  141059. get view(): NodeMaterialConnectionPoint;
  141060. /**
  141061. * Gets the rgb output component
  141062. */
  141063. get rgb(): NodeMaterialConnectionPoint;
  141064. /**
  141065. * Gets the rgba output component
  141066. */
  141067. get rgba(): NodeMaterialConnectionPoint;
  141068. /**
  141069. * Gets the r output component
  141070. */
  141071. get r(): NodeMaterialConnectionPoint;
  141072. /**
  141073. * Gets the g output component
  141074. */
  141075. get g(): NodeMaterialConnectionPoint;
  141076. /**
  141077. * Gets the b output component
  141078. */
  141079. get b(): NodeMaterialConnectionPoint;
  141080. /**
  141081. * Gets the a output component
  141082. */
  141083. get a(): NodeMaterialConnectionPoint;
  141084. autoConfigure(material: NodeMaterial): void;
  141085. protected _buildBlock(state: NodeMaterialBuildState): this;
  141086. }
  141087. }
  141088. declare module BABYLON {
  141089. /**
  141090. * Block used to add 2 vectors
  141091. */
  141092. export class AddBlock extends NodeMaterialBlock {
  141093. /**
  141094. * Creates a new AddBlock
  141095. * @param name defines the block name
  141096. */
  141097. constructor(name: string);
  141098. /**
  141099. * Gets the current class name
  141100. * @returns the class name
  141101. */
  141102. getClassName(): string;
  141103. /**
  141104. * Gets the left operand input component
  141105. */
  141106. get left(): NodeMaterialConnectionPoint;
  141107. /**
  141108. * Gets the right operand input component
  141109. */
  141110. get right(): NodeMaterialConnectionPoint;
  141111. /**
  141112. * Gets the output component
  141113. */
  141114. get output(): NodeMaterialConnectionPoint;
  141115. protected _buildBlock(state: NodeMaterialBuildState): this;
  141116. }
  141117. }
  141118. declare module BABYLON {
  141119. /**
  141120. * Block used to scale a vector by a float
  141121. */
  141122. export class ScaleBlock extends NodeMaterialBlock {
  141123. /**
  141124. * Creates a new ScaleBlock
  141125. * @param name defines the block name
  141126. */
  141127. constructor(name: string);
  141128. /**
  141129. * Gets the current class name
  141130. * @returns the class name
  141131. */
  141132. getClassName(): string;
  141133. /**
  141134. * Gets the input component
  141135. */
  141136. get input(): NodeMaterialConnectionPoint;
  141137. /**
  141138. * Gets the factor input component
  141139. */
  141140. get factor(): NodeMaterialConnectionPoint;
  141141. /**
  141142. * Gets the output component
  141143. */
  141144. get output(): NodeMaterialConnectionPoint;
  141145. protected _buildBlock(state: NodeMaterialBuildState): this;
  141146. }
  141147. }
  141148. declare module BABYLON {
  141149. /**
  141150. * Block used to clamp a float
  141151. */
  141152. export class ClampBlock extends NodeMaterialBlock {
  141153. /** Gets or sets the minimum range */
  141154. minimum: number;
  141155. /** Gets or sets the maximum range */
  141156. maximum: number;
  141157. /**
  141158. * Creates a new ClampBlock
  141159. * @param name defines the block name
  141160. */
  141161. constructor(name: string);
  141162. /**
  141163. * Gets the current class name
  141164. * @returns the class name
  141165. */
  141166. getClassName(): string;
  141167. /**
  141168. * Gets the value input component
  141169. */
  141170. get value(): NodeMaterialConnectionPoint;
  141171. /**
  141172. * Gets the output component
  141173. */
  141174. get output(): NodeMaterialConnectionPoint;
  141175. protected _buildBlock(state: NodeMaterialBuildState): this;
  141176. protected _dumpPropertiesCode(): string;
  141177. serialize(): any;
  141178. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141179. }
  141180. }
  141181. declare module BABYLON {
  141182. /**
  141183. * Block used to apply a cross product between 2 vectors
  141184. */
  141185. export class CrossBlock extends NodeMaterialBlock {
  141186. /**
  141187. * Creates a new CrossBlock
  141188. * @param name defines the block name
  141189. */
  141190. constructor(name: string);
  141191. /**
  141192. * Gets the current class name
  141193. * @returns the class name
  141194. */
  141195. getClassName(): string;
  141196. /**
  141197. * Gets the left operand input component
  141198. */
  141199. get left(): NodeMaterialConnectionPoint;
  141200. /**
  141201. * Gets the right operand input component
  141202. */
  141203. get right(): NodeMaterialConnectionPoint;
  141204. /**
  141205. * Gets the output component
  141206. */
  141207. get output(): NodeMaterialConnectionPoint;
  141208. protected _buildBlock(state: NodeMaterialBuildState): this;
  141209. }
  141210. }
  141211. declare module BABYLON {
  141212. /**
  141213. * Block used to apply a dot product between 2 vectors
  141214. */
  141215. export class DotBlock extends NodeMaterialBlock {
  141216. /**
  141217. * Creates a new DotBlock
  141218. * @param name defines the block name
  141219. */
  141220. constructor(name: string);
  141221. /**
  141222. * Gets the current class name
  141223. * @returns the class name
  141224. */
  141225. getClassName(): string;
  141226. /**
  141227. * Gets the left operand input component
  141228. */
  141229. get left(): NodeMaterialConnectionPoint;
  141230. /**
  141231. * Gets the right operand input component
  141232. */
  141233. get right(): NodeMaterialConnectionPoint;
  141234. /**
  141235. * Gets the output component
  141236. */
  141237. get output(): NodeMaterialConnectionPoint;
  141238. protected _buildBlock(state: NodeMaterialBuildState): this;
  141239. }
  141240. }
  141241. declare module BABYLON {
  141242. /**
  141243. * Block used to normalize a vector
  141244. */
  141245. export class NormalizeBlock extends NodeMaterialBlock {
  141246. /**
  141247. * Creates a new NormalizeBlock
  141248. * @param name defines the block name
  141249. */
  141250. constructor(name: string);
  141251. /**
  141252. * Gets the current class name
  141253. * @returns the class name
  141254. */
  141255. getClassName(): string;
  141256. /**
  141257. * Gets the input component
  141258. */
  141259. get input(): NodeMaterialConnectionPoint;
  141260. /**
  141261. * Gets the output component
  141262. */
  141263. get output(): NodeMaterialConnectionPoint;
  141264. protected _buildBlock(state: NodeMaterialBuildState): this;
  141265. }
  141266. }
  141267. declare module BABYLON {
  141268. /**
  141269. * Operations supported by the Trigonometry block
  141270. */
  141271. export enum TrigonometryBlockOperations {
  141272. /** Cos */
  141273. Cos = 0,
  141274. /** Sin */
  141275. Sin = 1,
  141276. /** Abs */
  141277. Abs = 2,
  141278. /** Exp */
  141279. Exp = 3,
  141280. /** Exp2 */
  141281. Exp2 = 4,
  141282. /** Round */
  141283. Round = 5,
  141284. /** Floor */
  141285. Floor = 6,
  141286. /** Ceiling */
  141287. Ceiling = 7,
  141288. /** Square root */
  141289. Sqrt = 8,
  141290. /** Log */
  141291. Log = 9,
  141292. /** Tangent */
  141293. Tan = 10,
  141294. /** Arc tangent */
  141295. ArcTan = 11,
  141296. /** Arc cosinus */
  141297. ArcCos = 12,
  141298. /** Arc sinus */
  141299. ArcSin = 13,
  141300. /** Fraction */
  141301. Fract = 14,
  141302. /** Sign */
  141303. Sign = 15,
  141304. /** To radians (from degrees) */
  141305. Radians = 16,
  141306. /** To degrees (from radians) */
  141307. Degrees = 17
  141308. }
  141309. /**
  141310. * Block used to apply trigonometry operation to floats
  141311. */
  141312. export class TrigonometryBlock extends NodeMaterialBlock {
  141313. /**
  141314. * Gets or sets the operation applied by the block
  141315. */
  141316. operation: TrigonometryBlockOperations;
  141317. /**
  141318. * Creates a new TrigonometryBlock
  141319. * @param name defines the block name
  141320. */
  141321. constructor(name: string);
  141322. /**
  141323. * Gets the current class name
  141324. * @returns the class name
  141325. */
  141326. getClassName(): string;
  141327. /**
  141328. * Gets the input component
  141329. */
  141330. get input(): NodeMaterialConnectionPoint;
  141331. /**
  141332. * Gets the output component
  141333. */
  141334. get output(): NodeMaterialConnectionPoint;
  141335. protected _buildBlock(state: NodeMaterialBuildState): this;
  141336. serialize(): any;
  141337. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141338. protected _dumpPropertiesCode(): string;
  141339. }
  141340. }
  141341. declare module BABYLON {
  141342. /**
  141343. * Block used to create a Color3/4 out of individual inputs (one for each component)
  141344. */
  141345. export class ColorMergerBlock extends NodeMaterialBlock {
  141346. /**
  141347. * Create a new ColorMergerBlock
  141348. * @param name defines the block name
  141349. */
  141350. constructor(name: string);
  141351. /**
  141352. * Gets the current class name
  141353. * @returns the class name
  141354. */
  141355. getClassName(): string;
  141356. /**
  141357. * Gets the rgb component (input)
  141358. */
  141359. get rgbIn(): NodeMaterialConnectionPoint;
  141360. /**
  141361. * Gets the r component (input)
  141362. */
  141363. get r(): NodeMaterialConnectionPoint;
  141364. /**
  141365. * Gets the g component (input)
  141366. */
  141367. get g(): NodeMaterialConnectionPoint;
  141368. /**
  141369. * Gets the b component (input)
  141370. */
  141371. get b(): NodeMaterialConnectionPoint;
  141372. /**
  141373. * Gets the a component (input)
  141374. */
  141375. get a(): NodeMaterialConnectionPoint;
  141376. /**
  141377. * Gets the rgba component (output)
  141378. */
  141379. get rgba(): NodeMaterialConnectionPoint;
  141380. /**
  141381. * Gets the rgb component (output)
  141382. */
  141383. get rgbOut(): NodeMaterialConnectionPoint;
  141384. /**
  141385. * Gets the rgb component (output)
  141386. * @deprecated Please use rgbOut instead.
  141387. */
  141388. get rgb(): NodeMaterialConnectionPoint;
  141389. protected _buildBlock(state: NodeMaterialBuildState): this;
  141390. }
  141391. }
  141392. declare module BABYLON {
  141393. /**
  141394. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  141395. */
  141396. export class VectorSplitterBlock extends NodeMaterialBlock {
  141397. /**
  141398. * Create a new VectorSplitterBlock
  141399. * @param name defines the block name
  141400. */
  141401. constructor(name: string);
  141402. /**
  141403. * Gets the current class name
  141404. * @returns the class name
  141405. */
  141406. getClassName(): string;
  141407. /**
  141408. * Gets the xyzw component (input)
  141409. */
  141410. get xyzw(): NodeMaterialConnectionPoint;
  141411. /**
  141412. * Gets the xyz component (input)
  141413. */
  141414. get xyzIn(): NodeMaterialConnectionPoint;
  141415. /**
  141416. * Gets the xy component (input)
  141417. */
  141418. get xyIn(): NodeMaterialConnectionPoint;
  141419. /**
  141420. * Gets the xyz component (output)
  141421. */
  141422. get xyzOut(): NodeMaterialConnectionPoint;
  141423. /**
  141424. * Gets the xy component (output)
  141425. */
  141426. get xyOut(): NodeMaterialConnectionPoint;
  141427. /**
  141428. * Gets the x component (output)
  141429. */
  141430. get x(): NodeMaterialConnectionPoint;
  141431. /**
  141432. * Gets the y component (output)
  141433. */
  141434. get y(): NodeMaterialConnectionPoint;
  141435. /**
  141436. * Gets the z component (output)
  141437. */
  141438. get z(): NodeMaterialConnectionPoint;
  141439. /**
  141440. * Gets the w component (output)
  141441. */
  141442. get w(): NodeMaterialConnectionPoint;
  141443. protected _inputRename(name: string): string;
  141444. protected _outputRename(name: string): string;
  141445. protected _buildBlock(state: NodeMaterialBuildState): this;
  141446. }
  141447. }
  141448. declare module BABYLON {
  141449. /**
  141450. * Block used to lerp between 2 values
  141451. */
  141452. export class LerpBlock extends NodeMaterialBlock {
  141453. /**
  141454. * Creates a new LerpBlock
  141455. * @param name defines the block name
  141456. */
  141457. constructor(name: string);
  141458. /**
  141459. * Gets the current class name
  141460. * @returns the class name
  141461. */
  141462. getClassName(): string;
  141463. /**
  141464. * Gets the left operand input component
  141465. */
  141466. get left(): NodeMaterialConnectionPoint;
  141467. /**
  141468. * Gets the right operand input component
  141469. */
  141470. get right(): NodeMaterialConnectionPoint;
  141471. /**
  141472. * Gets the gradient operand input component
  141473. */
  141474. get gradient(): NodeMaterialConnectionPoint;
  141475. /**
  141476. * Gets the output component
  141477. */
  141478. get output(): NodeMaterialConnectionPoint;
  141479. protected _buildBlock(state: NodeMaterialBuildState): this;
  141480. }
  141481. }
  141482. declare module BABYLON {
  141483. /**
  141484. * Block used to divide 2 vectors
  141485. */
  141486. export class DivideBlock extends NodeMaterialBlock {
  141487. /**
  141488. * Creates a new DivideBlock
  141489. * @param name defines the block name
  141490. */
  141491. constructor(name: string);
  141492. /**
  141493. * Gets the current class name
  141494. * @returns the class name
  141495. */
  141496. getClassName(): string;
  141497. /**
  141498. * Gets the left operand input component
  141499. */
  141500. get left(): NodeMaterialConnectionPoint;
  141501. /**
  141502. * Gets the right operand input component
  141503. */
  141504. get right(): NodeMaterialConnectionPoint;
  141505. /**
  141506. * Gets the output component
  141507. */
  141508. get output(): NodeMaterialConnectionPoint;
  141509. protected _buildBlock(state: NodeMaterialBuildState): this;
  141510. }
  141511. }
  141512. declare module BABYLON {
  141513. /**
  141514. * Block used to subtract 2 vectors
  141515. */
  141516. export class SubtractBlock extends NodeMaterialBlock {
  141517. /**
  141518. * Creates a new SubtractBlock
  141519. * @param name defines the block name
  141520. */
  141521. constructor(name: string);
  141522. /**
  141523. * Gets the current class name
  141524. * @returns the class name
  141525. */
  141526. getClassName(): string;
  141527. /**
  141528. * Gets the left operand input component
  141529. */
  141530. get left(): NodeMaterialConnectionPoint;
  141531. /**
  141532. * Gets the right operand input component
  141533. */
  141534. get right(): NodeMaterialConnectionPoint;
  141535. /**
  141536. * Gets the output component
  141537. */
  141538. get output(): NodeMaterialConnectionPoint;
  141539. protected _buildBlock(state: NodeMaterialBuildState): this;
  141540. }
  141541. }
  141542. declare module BABYLON {
  141543. /**
  141544. * Block used to step a value
  141545. */
  141546. export class StepBlock extends NodeMaterialBlock {
  141547. /**
  141548. * Creates a new StepBlock
  141549. * @param name defines the block name
  141550. */
  141551. constructor(name: string);
  141552. /**
  141553. * Gets the current class name
  141554. * @returns the class name
  141555. */
  141556. getClassName(): string;
  141557. /**
  141558. * Gets the value operand input component
  141559. */
  141560. get value(): NodeMaterialConnectionPoint;
  141561. /**
  141562. * Gets the edge operand input component
  141563. */
  141564. get edge(): NodeMaterialConnectionPoint;
  141565. /**
  141566. * Gets the output component
  141567. */
  141568. get output(): NodeMaterialConnectionPoint;
  141569. protected _buildBlock(state: NodeMaterialBuildState): this;
  141570. }
  141571. }
  141572. declare module BABYLON {
  141573. /**
  141574. * Block used to get the opposite (1 - x) of a value
  141575. */
  141576. export class OneMinusBlock extends NodeMaterialBlock {
  141577. /**
  141578. * Creates a new OneMinusBlock
  141579. * @param name defines the block name
  141580. */
  141581. constructor(name: string);
  141582. /**
  141583. * Gets the current class name
  141584. * @returns the class name
  141585. */
  141586. getClassName(): string;
  141587. /**
  141588. * Gets the input component
  141589. */
  141590. get input(): NodeMaterialConnectionPoint;
  141591. /**
  141592. * Gets the output component
  141593. */
  141594. get output(): NodeMaterialConnectionPoint;
  141595. protected _buildBlock(state: NodeMaterialBuildState): this;
  141596. }
  141597. }
  141598. declare module BABYLON {
  141599. /**
  141600. * Block used to get the view direction
  141601. */
  141602. export class ViewDirectionBlock extends NodeMaterialBlock {
  141603. /**
  141604. * Creates a new ViewDirectionBlock
  141605. * @param name defines the block name
  141606. */
  141607. constructor(name: string);
  141608. /**
  141609. * Gets the current class name
  141610. * @returns the class name
  141611. */
  141612. getClassName(): string;
  141613. /**
  141614. * Gets the world position component
  141615. */
  141616. get worldPosition(): NodeMaterialConnectionPoint;
  141617. /**
  141618. * Gets the camera position component
  141619. */
  141620. get cameraPosition(): NodeMaterialConnectionPoint;
  141621. /**
  141622. * Gets the output component
  141623. */
  141624. get output(): NodeMaterialConnectionPoint;
  141625. autoConfigure(material: NodeMaterial): void;
  141626. protected _buildBlock(state: NodeMaterialBuildState): this;
  141627. }
  141628. }
  141629. declare module BABYLON {
  141630. /**
  141631. * Block used to compute fresnel value
  141632. */
  141633. export class FresnelBlock extends NodeMaterialBlock {
  141634. /**
  141635. * Create a new FresnelBlock
  141636. * @param name defines the block name
  141637. */
  141638. constructor(name: string);
  141639. /**
  141640. * Gets the current class name
  141641. * @returns the class name
  141642. */
  141643. getClassName(): string;
  141644. /**
  141645. * Gets the world normal input component
  141646. */
  141647. get worldNormal(): NodeMaterialConnectionPoint;
  141648. /**
  141649. * Gets the view direction input component
  141650. */
  141651. get viewDirection(): NodeMaterialConnectionPoint;
  141652. /**
  141653. * Gets the bias input component
  141654. */
  141655. get bias(): NodeMaterialConnectionPoint;
  141656. /**
  141657. * Gets the camera (or eye) position component
  141658. */
  141659. get power(): NodeMaterialConnectionPoint;
  141660. /**
  141661. * Gets the fresnel output component
  141662. */
  141663. get fresnel(): NodeMaterialConnectionPoint;
  141664. autoConfigure(material: NodeMaterial): void;
  141665. protected _buildBlock(state: NodeMaterialBuildState): this;
  141666. }
  141667. }
  141668. declare module BABYLON {
  141669. /**
  141670. * Block used to get the max of 2 values
  141671. */
  141672. export class MaxBlock extends NodeMaterialBlock {
  141673. /**
  141674. * Creates a new MaxBlock
  141675. * @param name defines the block name
  141676. */
  141677. constructor(name: string);
  141678. /**
  141679. * Gets the current class name
  141680. * @returns the class name
  141681. */
  141682. getClassName(): string;
  141683. /**
  141684. * Gets the left operand input component
  141685. */
  141686. get left(): NodeMaterialConnectionPoint;
  141687. /**
  141688. * Gets the right operand input component
  141689. */
  141690. get right(): NodeMaterialConnectionPoint;
  141691. /**
  141692. * Gets the output component
  141693. */
  141694. get output(): NodeMaterialConnectionPoint;
  141695. protected _buildBlock(state: NodeMaterialBuildState): this;
  141696. }
  141697. }
  141698. declare module BABYLON {
  141699. /**
  141700. * Block used to get the min of 2 values
  141701. */
  141702. export class MinBlock extends NodeMaterialBlock {
  141703. /**
  141704. * Creates a new MinBlock
  141705. * @param name defines the block name
  141706. */
  141707. constructor(name: string);
  141708. /**
  141709. * Gets the current class name
  141710. * @returns the class name
  141711. */
  141712. getClassName(): string;
  141713. /**
  141714. * Gets the left operand input component
  141715. */
  141716. get left(): NodeMaterialConnectionPoint;
  141717. /**
  141718. * Gets the right operand input component
  141719. */
  141720. get right(): NodeMaterialConnectionPoint;
  141721. /**
  141722. * Gets the output component
  141723. */
  141724. get output(): NodeMaterialConnectionPoint;
  141725. protected _buildBlock(state: NodeMaterialBuildState): this;
  141726. }
  141727. }
  141728. declare module BABYLON {
  141729. /**
  141730. * Block used to get the distance between 2 values
  141731. */
  141732. export class DistanceBlock extends NodeMaterialBlock {
  141733. /**
  141734. * Creates a new DistanceBlock
  141735. * @param name defines the block name
  141736. */
  141737. constructor(name: string);
  141738. /**
  141739. * Gets the current class name
  141740. * @returns the class name
  141741. */
  141742. getClassName(): string;
  141743. /**
  141744. * Gets the left operand input component
  141745. */
  141746. get left(): NodeMaterialConnectionPoint;
  141747. /**
  141748. * Gets the right operand input component
  141749. */
  141750. get right(): NodeMaterialConnectionPoint;
  141751. /**
  141752. * Gets the output component
  141753. */
  141754. get output(): NodeMaterialConnectionPoint;
  141755. protected _buildBlock(state: NodeMaterialBuildState): this;
  141756. }
  141757. }
  141758. declare module BABYLON {
  141759. /**
  141760. * Block used to get the length of a vector
  141761. */
  141762. export class LengthBlock extends NodeMaterialBlock {
  141763. /**
  141764. * Creates a new LengthBlock
  141765. * @param name defines the block name
  141766. */
  141767. constructor(name: string);
  141768. /**
  141769. * Gets the current class name
  141770. * @returns the class name
  141771. */
  141772. getClassName(): string;
  141773. /**
  141774. * Gets the value input component
  141775. */
  141776. get value(): NodeMaterialConnectionPoint;
  141777. /**
  141778. * Gets the output component
  141779. */
  141780. get output(): NodeMaterialConnectionPoint;
  141781. protected _buildBlock(state: NodeMaterialBuildState): this;
  141782. }
  141783. }
  141784. declare module BABYLON {
  141785. /**
  141786. * Block used to get negative version of a value (i.e. x * -1)
  141787. */
  141788. export class NegateBlock extends NodeMaterialBlock {
  141789. /**
  141790. * Creates a new NegateBlock
  141791. * @param name defines the block name
  141792. */
  141793. constructor(name: string);
  141794. /**
  141795. * Gets the current class name
  141796. * @returns the class name
  141797. */
  141798. getClassName(): string;
  141799. /**
  141800. * Gets the value input component
  141801. */
  141802. get value(): NodeMaterialConnectionPoint;
  141803. /**
  141804. * Gets the output component
  141805. */
  141806. get output(): NodeMaterialConnectionPoint;
  141807. protected _buildBlock(state: NodeMaterialBuildState): this;
  141808. }
  141809. }
  141810. declare module BABYLON {
  141811. /**
  141812. * Block used to get the value of the first parameter raised to the power of the second
  141813. */
  141814. export class PowBlock extends NodeMaterialBlock {
  141815. /**
  141816. * Creates a new PowBlock
  141817. * @param name defines the block name
  141818. */
  141819. constructor(name: string);
  141820. /**
  141821. * Gets the current class name
  141822. * @returns the class name
  141823. */
  141824. getClassName(): string;
  141825. /**
  141826. * Gets the value operand input component
  141827. */
  141828. get value(): NodeMaterialConnectionPoint;
  141829. /**
  141830. * Gets the power operand input component
  141831. */
  141832. get power(): NodeMaterialConnectionPoint;
  141833. /**
  141834. * Gets the output component
  141835. */
  141836. get output(): NodeMaterialConnectionPoint;
  141837. protected _buildBlock(state: NodeMaterialBuildState): this;
  141838. }
  141839. }
  141840. declare module BABYLON {
  141841. /**
  141842. * Block used to get a random number
  141843. */
  141844. export class RandomNumberBlock extends NodeMaterialBlock {
  141845. /**
  141846. * Creates a new RandomNumberBlock
  141847. * @param name defines the block name
  141848. */
  141849. constructor(name: string);
  141850. /**
  141851. * Gets the current class name
  141852. * @returns the class name
  141853. */
  141854. getClassName(): string;
  141855. /**
  141856. * Gets the seed input component
  141857. */
  141858. get seed(): NodeMaterialConnectionPoint;
  141859. /**
  141860. * Gets the output component
  141861. */
  141862. get output(): NodeMaterialConnectionPoint;
  141863. protected _buildBlock(state: NodeMaterialBuildState): this;
  141864. }
  141865. }
  141866. declare module BABYLON {
  141867. /**
  141868. * Block used to compute arc tangent of 2 values
  141869. */
  141870. export class ArcTan2Block extends NodeMaterialBlock {
  141871. /**
  141872. * Creates a new ArcTan2Block
  141873. * @param name defines the block name
  141874. */
  141875. constructor(name: string);
  141876. /**
  141877. * Gets the current class name
  141878. * @returns the class name
  141879. */
  141880. getClassName(): string;
  141881. /**
  141882. * Gets the x operand input component
  141883. */
  141884. get x(): NodeMaterialConnectionPoint;
  141885. /**
  141886. * Gets the y operand input component
  141887. */
  141888. get y(): NodeMaterialConnectionPoint;
  141889. /**
  141890. * Gets the output component
  141891. */
  141892. get output(): NodeMaterialConnectionPoint;
  141893. protected _buildBlock(state: NodeMaterialBuildState): this;
  141894. }
  141895. }
  141896. declare module BABYLON {
  141897. /**
  141898. * Block used to smooth step a value
  141899. */
  141900. export class SmoothStepBlock extends NodeMaterialBlock {
  141901. /**
  141902. * Creates a new SmoothStepBlock
  141903. * @param name defines the block name
  141904. */
  141905. constructor(name: string);
  141906. /**
  141907. * Gets the current class name
  141908. * @returns the class name
  141909. */
  141910. getClassName(): string;
  141911. /**
  141912. * Gets the value operand input component
  141913. */
  141914. get value(): NodeMaterialConnectionPoint;
  141915. /**
  141916. * Gets the first edge operand input component
  141917. */
  141918. get edge0(): NodeMaterialConnectionPoint;
  141919. /**
  141920. * Gets the second edge operand input component
  141921. */
  141922. get edge1(): NodeMaterialConnectionPoint;
  141923. /**
  141924. * Gets the output component
  141925. */
  141926. get output(): NodeMaterialConnectionPoint;
  141927. protected _buildBlock(state: NodeMaterialBuildState): this;
  141928. }
  141929. }
  141930. declare module BABYLON {
  141931. /**
  141932. * Block used to get the reciprocal (1 / x) of a value
  141933. */
  141934. export class ReciprocalBlock extends NodeMaterialBlock {
  141935. /**
  141936. * Creates a new ReciprocalBlock
  141937. * @param name defines the block name
  141938. */
  141939. constructor(name: string);
  141940. /**
  141941. * Gets the current class name
  141942. * @returns the class name
  141943. */
  141944. getClassName(): string;
  141945. /**
  141946. * Gets the input component
  141947. */
  141948. get input(): NodeMaterialConnectionPoint;
  141949. /**
  141950. * Gets the output component
  141951. */
  141952. get output(): NodeMaterialConnectionPoint;
  141953. protected _buildBlock(state: NodeMaterialBuildState): this;
  141954. }
  141955. }
  141956. declare module BABYLON {
  141957. /**
  141958. * Block used to replace a color by another one
  141959. */
  141960. export class ReplaceColorBlock extends NodeMaterialBlock {
  141961. /**
  141962. * Creates a new ReplaceColorBlock
  141963. * @param name defines the block name
  141964. */
  141965. constructor(name: string);
  141966. /**
  141967. * Gets the current class name
  141968. * @returns the class name
  141969. */
  141970. getClassName(): string;
  141971. /**
  141972. * Gets the value input component
  141973. */
  141974. get value(): NodeMaterialConnectionPoint;
  141975. /**
  141976. * Gets the reference input component
  141977. */
  141978. get reference(): NodeMaterialConnectionPoint;
  141979. /**
  141980. * Gets the distance input component
  141981. */
  141982. get distance(): NodeMaterialConnectionPoint;
  141983. /**
  141984. * Gets the replacement input component
  141985. */
  141986. get replacement(): NodeMaterialConnectionPoint;
  141987. /**
  141988. * Gets the output component
  141989. */
  141990. get output(): NodeMaterialConnectionPoint;
  141991. protected _buildBlock(state: NodeMaterialBuildState): this;
  141992. }
  141993. }
  141994. declare module BABYLON {
  141995. /**
  141996. * Block used to posterize a value
  141997. * @see https://en.wikipedia.org/wiki/Posterization
  141998. */
  141999. export class PosterizeBlock extends NodeMaterialBlock {
  142000. /**
  142001. * Creates a new PosterizeBlock
  142002. * @param name defines the block name
  142003. */
  142004. constructor(name: string);
  142005. /**
  142006. * Gets the current class name
  142007. * @returns the class name
  142008. */
  142009. getClassName(): string;
  142010. /**
  142011. * Gets the value input component
  142012. */
  142013. get value(): NodeMaterialConnectionPoint;
  142014. /**
  142015. * Gets the steps input component
  142016. */
  142017. get steps(): NodeMaterialConnectionPoint;
  142018. /**
  142019. * Gets the output component
  142020. */
  142021. get output(): NodeMaterialConnectionPoint;
  142022. protected _buildBlock(state: NodeMaterialBuildState): this;
  142023. }
  142024. }
  142025. declare module BABYLON {
  142026. /**
  142027. * Operations supported by the Wave block
  142028. */
  142029. export enum WaveBlockKind {
  142030. /** SawTooth */
  142031. SawTooth = 0,
  142032. /** Square */
  142033. Square = 1,
  142034. /** Triangle */
  142035. Triangle = 2
  142036. }
  142037. /**
  142038. * Block used to apply wave operation to floats
  142039. */
  142040. export class WaveBlock extends NodeMaterialBlock {
  142041. /**
  142042. * Gets or sets the kibnd of wave to be applied by the block
  142043. */
  142044. kind: WaveBlockKind;
  142045. /**
  142046. * Creates a new WaveBlock
  142047. * @param name defines the block name
  142048. */
  142049. constructor(name: string);
  142050. /**
  142051. * Gets the current class name
  142052. * @returns the class name
  142053. */
  142054. getClassName(): string;
  142055. /**
  142056. * Gets the input component
  142057. */
  142058. get input(): NodeMaterialConnectionPoint;
  142059. /**
  142060. * Gets the output component
  142061. */
  142062. get output(): NodeMaterialConnectionPoint;
  142063. protected _buildBlock(state: NodeMaterialBuildState): this;
  142064. serialize(): any;
  142065. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142066. }
  142067. }
  142068. declare module BABYLON {
  142069. /**
  142070. * Class used to store a color step for the GradientBlock
  142071. */
  142072. export class GradientBlockColorStep {
  142073. /**
  142074. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  142075. */
  142076. step: number;
  142077. /**
  142078. * Gets or sets the color associated with this step
  142079. */
  142080. color: Color3;
  142081. /**
  142082. * Creates a new GradientBlockColorStep
  142083. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  142084. * @param color defines the color associated with this step
  142085. */
  142086. constructor(
  142087. /**
  142088. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  142089. */
  142090. step: number,
  142091. /**
  142092. * Gets or sets the color associated with this step
  142093. */
  142094. color: Color3);
  142095. }
  142096. /**
  142097. * Block used to return a color from a gradient based on an input value between 0 and 1
  142098. */
  142099. export class GradientBlock extends NodeMaterialBlock {
  142100. /**
  142101. * Gets or sets the list of color steps
  142102. */
  142103. colorSteps: GradientBlockColorStep[];
  142104. /**
  142105. * Creates a new GradientBlock
  142106. * @param name defines the block name
  142107. */
  142108. constructor(name: string);
  142109. /**
  142110. * Gets the current class name
  142111. * @returns the class name
  142112. */
  142113. getClassName(): string;
  142114. /**
  142115. * Gets the gradient input component
  142116. */
  142117. get gradient(): NodeMaterialConnectionPoint;
  142118. /**
  142119. * Gets the output component
  142120. */
  142121. get output(): NodeMaterialConnectionPoint;
  142122. private _writeColorConstant;
  142123. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142124. serialize(): any;
  142125. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142126. protected _dumpPropertiesCode(): string;
  142127. }
  142128. }
  142129. declare module BABYLON {
  142130. /**
  142131. * Block used to normalize lerp between 2 values
  142132. */
  142133. export class NLerpBlock extends NodeMaterialBlock {
  142134. /**
  142135. * Creates a new NLerpBlock
  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 left operand input component
  142146. */
  142147. get left(): NodeMaterialConnectionPoint;
  142148. /**
  142149. * Gets the right operand input component
  142150. */
  142151. get right(): NodeMaterialConnectionPoint;
  142152. /**
  142153. * Gets the gradient operand input component
  142154. */
  142155. get gradient(): NodeMaterialConnectionPoint;
  142156. /**
  142157. * Gets the output component
  142158. */
  142159. get output(): NodeMaterialConnectionPoint;
  142160. protected _buildBlock(state: NodeMaterialBuildState): this;
  142161. }
  142162. }
  142163. declare module BABYLON {
  142164. /**
  142165. * block used to Generate a Worley Noise 3D Noise Pattern
  142166. */
  142167. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  142168. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142169. manhattanDistance: boolean;
  142170. /**
  142171. * Creates a new WorleyNoise3DBlock
  142172. * @param name defines the block name
  142173. */
  142174. constructor(name: string);
  142175. /**
  142176. * Gets the current class name
  142177. * @returns the class name
  142178. */
  142179. getClassName(): string;
  142180. /**
  142181. * Gets the seed input component
  142182. */
  142183. get seed(): NodeMaterialConnectionPoint;
  142184. /**
  142185. * Gets the jitter input component
  142186. */
  142187. get jitter(): NodeMaterialConnectionPoint;
  142188. /**
  142189. * Gets the output component
  142190. */
  142191. get output(): NodeMaterialConnectionPoint;
  142192. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142193. /**
  142194. * Exposes the properties to the UI?
  142195. */
  142196. protected _dumpPropertiesCode(): string;
  142197. /**
  142198. * Exposes the properties to the Seralize?
  142199. */
  142200. serialize(): any;
  142201. /**
  142202. * Exposes the properties to the deseralize?
  142203. */
  142204. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142205. }
  142206. }
  142207. declare module BABYLON {
  142208. /**
  142209. * block used to Generate a Simplex Perlin 3d Noise Pattern
  142210. */
  142211. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  142212. /**
  142213. * Creates a new SimplexPerlin3DBlock
  142214. * @param name defines the block name
  142215. */
  142216. constructor(name: string);
  142217. /**
  142218. * Gets the current class name
  142219. * @returns the class name
  142220. */
  142221. getClassName(): string;
  142222. /**
  142223. * Gets the seed operand input component
  142224. */
  142225. get seed(): NodeMaterialConnectionPoint;
  142226. /**
  142227. * Gets the output component
  142228. */
  142229. get output(): NodeMaterialConnectionPoint;
  142230. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142231. }
  142232. }
  142233. declare module BABYLON {
  142234. /**
  142235. * Block used to blend normals
  142236. */
  142237. export class NormalBlendBlock extends NodeMaterialBlock {
  142238. /**
  142239. * Creates a new NormalBlendBlock
  142240. * @param name defines the block name
  142241. */
  142242. constructor(name: string);
  142243. /**
  142244. * Gets the current class name
  142245. * @returns the class name
  142246. */
  142247. getClassName(): string;
  142248. /**
  142249. * Gets the first input component
  142250. */
  142251. get normalMap0(): NodeMaterialConnectionPoint;
  142252. /**
  142253. * Gets the second input component
  142254. */
  142255. get normalMap1(): NodeMaterialConnectionPoint;
  142256. /**
  142257. * Gets the output component
  142258. */
  142259. get output(): NodeMaterialConnectionPoint;
  142260. protected _buildBlock(state: NodeMaterialBuildState): this;
  142261. }
  142262. }
  142263. declare module BABYLON {
  142264. /**
  142265. * Block used to rotate a 2d vector by a given angle
  142266. */
  142267. export class Rotate2dBlock extends NodeMaterialBlock {
  142268. /**
  142269. * Creates a new Rotate2dBlock
  142270. * @param name defines the block name
  142271. */
  142272. constructor(name: string);
  142273. /**
  142274. * Gets the current class name
  142275. * @returns the class name
  142276. */
  142277. getClassName(): string;
  142278. /**
  142279. * Gets the input vector
  142280. */
  142281. get input(): NodeMaterialConnectionPoint;
  142282. /**
  142283. * Gets the input angle
  142284. */
  142285. get angle(): NodeMaterialConnectionPoint;
  142286. /**
  142287. * Gets the output component
  142288. */
  142289. get output(): NodeMaterialConnectionPoint;
  142290. autoConfigure(material: NodeMaterial): void;
  142291. protected _buildBlock(state: NodeMaterialBuildState): this;
  142292. }
  142293. }
  142294. declare module BABYLON {
  142295. /**
  142296. * Block used to get the reflected vector from a direction and a normal
  142297. */
  142298. export class ReflectBlock extends NodeMaterialBlock {
  142299. /**
  142300. * Creates a new ReflectBlock
  142301. * @param name defines the block name
  142302. */
  142303. constructor(name: string);
  142304. /**
  142305. * Gets the current class name
  142306. * @returns the class name
  142307. */
  142308. getClassName(): string;
  142309. /**
  142310. * Gets the incident component
  142311. */
  142312. get incident(): NodeMaterialConnectionPoint;
  142313. /**
  142314. * Gets the normal component
  142315. */
  142316. get normal(): NodeMaterialConnectionPoint;
  142317. /**
  142318. * Gets the output component
  142319. */
  142320. get output(): NodeMaterialConnectionPoint;
  142321. protected _buildBlock(state: NodeMaterialBuildState): this;
  142322. }
  142323. }
  142324. declare module BABYLON {
  142325. /**
  142326. * Block used to get the refracted vector from a direction and a normal
  142327. */
  142328. export class RefractBlock extends NodeMaterialBlock {
  142329. /**
  142330. * Creates a new RefractBlock
  142331. * @param name defines the block name
  142332. */
  142333. constructor(name: string);
  142334. /**
  142335. * Gets the current class name
  142336. * @returns the class name
  142337. */
  142338. getClassName(): string;
  142339. /**
  142340. * Gets the incident component
  142341. */
  142342. get incident(): NodeMaterialConnectionPoint;
  142343. /**
  142344. * Gets the normal component
  142345. */
  142346. get normal(): NodeMaterialConnectionPoint;
  142347. /**
  142348. * Gets the index of refraction component
  142349. */
  142350. get ior(): NodeMaterialConnectionPoint;
  142351. /**
  142352. * Gets the output component
  142353. */
  142354. get output(): NodeMaterialConnectionPoint;
  142355. protected _buildBlock(state: NodeMaterialBuildState): this;
  142356. }
  142357. }
  142358. declare module BABYLON {
  142359. /**
  142360. * Block used to desaturate a color
  142361. */
  142362. export class DesaturateBlock extends NodeMaterialBlock {
  142363. /**
  142364. * Creates a new DesaturateBlock
  142365. * @param name defines the block name
  142366. */
  142367. constructor(name: string);
  142368. /**
  142369. * Gets the current class name
  142370. * @returns the class name
  142371. */
  142372. getClassName(): string;
  142373. /**
  142374. * Gets the color operand input component
  142375. */
  142376. get color(): NodeMaterialConnectionPoint;
  142377. /**
  142378. * Gets the level operand input component
  142379. */
  142380. get level(): NodeMaterialConnectionPoint;
  142381. /**
  142382. * Gets the output component
  142383. */
  142384. get output(): NodeMaterialConnectionPoint;
  142385. protected _buildBlock(state: NodeMaterialBuildState): this;
  142386. }
  142387. }
  142388. declare module BABYLON {
  142389. /**
  142390. * Block used to implement the ambient occlusion module of the PBR material
  142391. */
  142392. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  142393. /**
  142394. * Create a new AmbientOcclusionBlock
  142395. * @param name defines the block name
  142396. */
  142397. constructor(name: string);
  142398. /**
  142399. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  142400. */
  142401. useAmbientInGrayScale: boolean;
  142402. /**
  142403. * Initialize the block and prepare the context for build
  142404. * @param state defines the state that will be used for the build
  142405. */
  142406. initialize(state: NodeMaterialBuildState): void;
  142407. /**
  142408. * Gets the current class name
  142409. * @returns the class name
  142410. */
  142411. getClassName(): string;
  142412. /**
  142413. * Gets the texture input component
  142414. */
  142415. get texture(): NodeMaterialConnectionPoint;
  142416. /**
  142417. * Gets the texture intensity component
  142418. */
  142419. get intensity(): NodeMaterialConnectionPoint;
  142420. /**
  142421. * Gets the direct light intensity input component
  142422. */
  142423. get directLightIntensity(): NodeMaterialConnectionPoint;
  142424. /**
  142425. * Gets the ambient occlusion object output component
  142426. */
  142427. get ambientOcclusion(): NodeMaterialConnectionPoint;
  142428. /**
  142429. * Gets the main code of the block (fragment side)
  142430. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  142431. * @returns the shader code
  142432. */
  142433. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  142434. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142435. protected _buildBlock(state: NodeMaterialBuildState): this;
  142436. protected _dumpPropertiesCode(): string;
  142437. serialize(): any;
  142438. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142439. }
  142440. }
  142441. declare module BABYLON {
  142442. /**
  142443. * Block used to implement the reflection module of the PBR material
  142444. */
  142445. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  142446. /** @hidden */
  142447. _defineLODReflectionAlpha: string;
  142448. /** @hidden */
  142449. _defineLinearSpecularReflection: string;
  142450. private _vEnvironmentIrradianceName;
  142451. /** @hidden */
  142452. _vReflectionMicrosurfaceInfosName: string;
  142453. /** @hidden */
  142454. _vReflectionInfosName: string;
  142455. /** @hidden */
  142456. _vReflectionFilteringInfoName: string;
  142457. private _scene;
  142458. /**
  142459. * The three properties below are set by the main PBR block prior to calling methods of this class.
  142460. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  142461. * It's less burden on the user side in the editor part.
  142462. */
  142463. /** @hidden */
  142464. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  142465. /** @hidden */
  142466. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  142467. /** @hidden */
  142468. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  142469. /**
  142470. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  142471. * diffuse part of the IBL.
  142472. */
  142473. useSphericalHarmonics: boolean;
  142474. /**
  142475. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  142476. */
  142477. forceIrradianceInFragment: boolean;
  142478. /**
  142479. * Create a new ReflectionBlock
  142480. * @param name defines the block name
  142481. */
  142482. constructor(name: string);
  142483. /**
  142484. * Gets the current class name
  142485. * @returns the class name
  142486. */
  142487. getClassName(): string;
  142488. /**
  142489. * Gets the position input component
  142490. */
  142491. get position(): NodeMaterialConnectionPoint;
  142492. /**
  142493. * Gets the world position input component
  142494. */
  142495. get worldPosition(): NodeMaterialConnectionPoint;
  142496. /**
  142497. * Gets the world normal input component
  142498. */
  142499. get worldNormal(): NodeMaterialConnectionPoint;
  142500. /**
  142501. * Gets the world input component
  142502. */
  142503. get world(): NodeMaterialConnectionPoint;
  142504. /**
  142505. * Gets the camera (or eye) position component
  142506. */
  142507. get cameraPosition(): NodeMaterialConnectionPoint;
  142508. /**
  142509. * Gets the view input component
  142510. */
  142511. get view(): NodeMaterialConnectionPoint;
  142512. /**
  142513. * Gets the color input component
  142514. */
  142515. get color(): NodeMaterialConnectionPoint;
  142516. /**
  142517. * Gets the reflection object output component
  142518. */
  142519. get reflection(): NodeMaterialConnectionPoint;
  142520. /**
  142521. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  142522. */
  142523. get hasTexture(): boolean;
  142524. /**
  142525. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  142526. */
  142527. get reflectionColor(): string;
  142528. protected _getTexture(): Nullable<BaseTexture>;
  142529. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142530. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142531. /**
  142532. * Gets the code to inject in the vertex shader
  142533. * @param state current state of the node material building
  142534. * @returns the shader code
  142535. */
  142536. handleVertexSide(state: NodeMaterialBuildState): string;
  142537. /**
  142538. * Gets the main code of the block (fragment side)
  142539. * @param state current state of the node material building
  142540. * @param normalVarName name of the existing variable corresponding to the normal
  142541. * @returns the shader code
  142542. */
  142543. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  142544. protected _buildBlock(state: NodeMaterialBuildState): this;
  142545. protected _dumpPropertiesCode(): string;
  142546. serialize(): any;
  142547. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142548. }
  142549. }
  142550. declare module BABYLON {
  142551. /**
  142552. * Block used to implement the sheen module of the PBR material
  142553. */
  142554. export class SheenBlock extends NodeMaterialBlock {
  142555. /**
  142556. * Create a new SheenBlock
  142557. * @param name defines the block name
  142558. */
  142559. constructor(name: string);
  142560. /**
  142561. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  142562. * It allows the strength of the sheen effect to not depend on the base color of the material,
  142563. * making it easier to setup and tweak the effect
  142564. */
  142565. albedoScaling: boolean;
  142566. /**
  142567. * Defines if the sheen is linked to the sheen color.
  142568. */
  142569. linkSheenWithAlbedo: boolean;
  142570. /**
  142571. * Initialize the block and prepare the context for build
  142572. * @param state defines the state that will be used for the build
  142573. */
  142574. initialize(state: NodeMaterialBuildState): void;
  142575. /**
  142576. * Gets the current class name
  142577. * @returns the class name
  142578. */
  142579. getClassName(): string;
  142580. /**
  142581. * Gets the intensity input component
  142582. */
  142583. get intensity(): NodeMaterialConnectionPoint;
  142584. /**
  142585. * Gets the color input component
  142586. */
  142587. get color(): NodeMaterialConnectionPoint;
  142588. /**
  142589. * Gets the roughness input component
  142590. */
  142591. get roughness(): NodeMaterialConnectionPoint;
  142592. /**
  142593. * Gets the sheen object output component
  142594. */
  142595. get sheen(): NodeMaterialConnectionPoint;
  142596. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142597. /**
  142598. * Gets the main code of the block (fragment side)
  142599. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142600. * @returns the shader code
  142601. */
  142602. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  142603. protected _buildBlock(state: NodeMaterialBuildState): this;
  142604. protected _dumpPropertiesCode(): string;
  142605. serialize(): any;
  142606. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142607. }
  142608. }
  142609. declare module BABYLON {
  142610. /**
  142611. * Block used to implement the reflectivity module of the PBR material
  142612. */
  142613. export class ReflectivityBlock extends NodeMaterialBlock {
  142614. private _metallicReflectanceColor;
  142615. private _metallicF0Factor;
  142616. /** @hidden */
  142617. _vMetallicReflectanceFactorsName: string;
  142618. /**
  142619. * The property below is set by the main PBR block prior to calling methods of this class.
  142620. */
  142621. /** @hidden */
  142622. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  142623. /**
  142624. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  142625. */
  142626. useAmbientOcclusionFromMetallicTextureRed: boolean;
  142627. /**
  142628. * Specifies if the metallic texture contains the metallness information in its blue channel.
  142629. */
  142630. useMetallnessFromMetallicTextureBlue: boolean;
  142631. /**
  142632. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  142633. */
  142634. useRoughnessFromMetallicTextureAlpha: boolean;
  142635. /**
  142636. * Specifies if the metallic texture contains the roughness information in its green channel.
  142637. */
  142638. useRoughnessFromMetallicTextureGreen: boolean;
  142639. /**
  142640. * Create a new ReflectivityBlock
  142641. * @param name defines the block name
  142642. */
  142643. constructor(name: string);
  142644. /**
  142645. * Initialize the block and prepare the context for build
  142646. * @param state defines the state that will be used for the build
  142647. */
  142648. initialize(state: NodeMaterialBuildState): void;
  142649. /**
  142650. * Gets the current class name
  142651. * @returns the class name
  142652. */
  142653. getClassName(): string;
  142654. /**
  142655. * Gets the metallic input component
  142656. */
  142657. get metallic(): NodeMaterialConnectionPoint;
  142658. /**
  142659. * Gets the roughness input component
  142660. */
  142661. get roughness(): NodeMaterialConnectionPoint;
  142662. /**
  142663. * Gets the texture input component
  142664. */
  142665. get texture(): NodeMaterialConnectionPoint;
  142666. /**
  142667. * Gets the reflectivity object output component
  142668. */
  142669. get reflectivity(): NodeMaterialConnectionPoint;
  142670. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142671. /**
  142672. * Gets the main code of the block (fragment side)
  142673. * @param state current state of the node material building
  142674. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  142675. * @returns the shader code
  142676. */
  142677. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  142678. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142679. protected _buildBlock(state: NodeMaterialBuildState): this;
  142680. protected _dumpPropertiesCode(): string;
  142681. serialize(): any;
  142682. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142683. }
  142684. }
  142685. declare module BABYLON {
  142686. /**
  142687. * Block used to implement the anisotropy module of the PBR material
  142688. */
  142689. export class AnisotropyBlock extends NodeMaterialBlock {
  142690. /**
  142691. * The two properties below are set by the main PBR block prior to calling methods of this class.
  142692. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  142693. * It's less burden on the user side in the editor part.
  142694. */
  142695. /** @hidden */
  142696. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  142697. /** @hidden */
  142698. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  142699. /**
  142700. * Create a new AnisotropyBlock
  142701. * @param name defines the block name
  142702. */
  142703. constructor(name: string);
  142704. /**
  142705. * Initialize the block and prepare the context for build
  142706. * @param state defines the state that will be used for the build
  142707. */
  142708. initialize(state: NodeMaterialBuildState): void;
  142709. /**
  142710. * Gets the current class name
  142711. * @returns the class name
  142712. */
  142713. getClassName(): string;
  142714. /**
  142715. * Gets the intensity input component
  142716. */
  142717. get intensity(): NodeMaterialConnectionPoint;
  142718. /**
  142719. * Gets the direction input component
  142720. */
  142721. get direction(): NodeMaterialConnectionPoint;
  142722. /**
  142723. * Gets the texture input component
  142724. */
  142725. get texture(): NodeMaterialConnectionPoint;
  142726. /**
  142727. * Gets the uv input component
  142728. */
  142729. get uv(): NodeMaterialConnectionPoint;
  142730. /**
  142731. * Gets the worldTangent input component
  142732. */
  142733. get worldTangent(): NodeMaterialConnectionPoint;
  142734. /**
  142735. * Gets the anisotropy object output component
  142736. */
  142737. get anisotropy(): NodeMaterialConnectionPoint;
  142738. private _generateTBNSpace;
  142739. /**
  142740. * Gets the main code of the block (fragment side)
  142741. * @param state current state of the node material building
  142742. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  142743. * @returns the shader code
  142744. */
  142745. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  142746. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142747. protected _buildBlock(state: NodeMaterialBuildState): this;
  142748. }
  142749. }
  142750. declare module BABYLON {
  142751. /**
  142752. * Block used to implement the clear coat module of the PBR material
  142753. */
  142754. export class ClearCoatBlock extends NodeMaterialBlock {
  142755. private _scene;
  142756. /**
  142757. * Create a new ClearCoatBlock
  142758. * @param name defines the block name
  142759. */
  142760. constructor(name: string);
  142761. /**
  142762. * Initialize the block and prepare the context for build
  142763. * @param state defines the state that will be used for the build
  142764. */
  142765. initialize(state: NodeMaterialBuildState): void;
  142766. /**
  142767. * Gets the current class name
  142768. * @returns the class name
  142769. */
  142770. getClassName(): string;
  142771. /**
  142772. * Gets the intensity input component
  142773. */
  142774. get intensity(): NodeMaterialConnectionPoint;
  142775. /**
  142776. * Gets the roughness input component
  142777. */
  142778. get roughness(): NodeMaterialConnectionPoint;
  142779. /**
  142780. * Gets the ior input component
  142781. */
  142782. get ior(): NodeMaterialConnectionPoint;
  142783. /**
  142784. * Gets the texture input component
  142785. */
  142786. get texture(): NodeMaterialConnectionPoint;
  142787. /**
  142788. * Gets the bump texture input component
  142789. */
  142790. get bumpTexture(): NodeMaterialConnectionPoint;
  142791. /**
  142792. * Gets the uv input component
  142793. */
  142794. get uv(): NodeMaterialConnectionPoint;
  142795. /**
  142796. * Gets the tint color input component
  142797. */
  142798. get tintColor(): NodeMaterialConnectionPoint;
  142799. /**
  142800. * Gets the tint "at distance" input component
  142801. */
  142802. get tintAtDistance(): NodeMaterialConnectionPoint;
  142803. /**
  142804. * Gets the tint thickness input component
  142805. */
  142806. get tintThickness(): NodeMaterialConnectionPoint;
  142807. /**
  142808. * Gets the world tangent input component
  142809. */
  142810. get worldTangent(): NodeMaterialConnectionPoint;
  142811. /**
  142812. * Gets the clear coat object output component
  142813. */
  142814. get clearcoat(): NodeMaterialConnectionPoint;
  142815. autoConfigure(material: NodeMaterial): void;
  142816. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142817. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142818. private _generateTBNSpace;
  142819. /**
  142820. * Gets the main code of the block (fragment side)
  142821. * @param state current state of the node material building
  142822. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  142823. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142824. * @param worldPosVarName name of the variable holding the world position
  142825. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  142826. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  142827. * @param worldNormalVarName name of the variable holding the world normal
  142828. * @returns the shader code
  142829. */
  142830. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  142831. protected _buildBlock(state: NodeMaterialBuildState): this;
  142832. }
  142833. }
  142834. declare module BABYLON {
  142835. /**
  142836. * Block used to implement the sub surface module of the PBR material
  142837. */
  142838. export class SubSurfaceBlock extends NodeMaterialBlock {
  142839. /**
  142840. * Create a new SubSurfaceBlock
  142841. * @param name defines the block name
  142842. */
  142843. constructor(name: string);
  142844. /**
  142845. * Stores the intensity of the different subsurface effects in the thickness texture.
  142846. * * the green channel is the translucency intensity.
  142847. * * the blue channel is the scattering intensity.
  142848. * * the alpha channel is the refraction intensity.
  142849. */
  142850. useMaskFromThicknessTexture: boolean;
  142851. /**
  142852. * Initialize the block and prepare the context for build
  142853. * @param state defines the state that will be used for the build
  142854. */
  142855. initialize(state: NodeMaterialBuildState): void;
  142856. /**
  142857. * Gets the current class name
  142858. * @returns the class name
  142859. */
  142860. getClassName(): string;
  142861. /**
  142862. * Gets the min thickness input component
  142863. */
  142864. get minThickness(): NodeMaterialConnectionPoint;
  142865. /**
  142866. * Gets the max thickness input component
  142867. */
  142868. get maxThickness(): NodeMaterialConnectionPoint;
  142869. /**
  142870. * Gets the thickness texture component
  142871. */
  142872. get thicknessTexture(): NodeMaterialConnectionPoint;
  142873. /**
  142874. * Gets the tint color input component
  142875. */
  142876. get tintColor(): NodeMaterialConnectionPoint;
  142877. /**
  142878. * Gets the translucency intensity input component
  142879. */
  142880. get translucencyIntensity(): NodeMaterialConnectionPoint;
  142881. /**
  142882. * Gets the translucency diffusion distance input component
  142883. */
  142884. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  142885. /**
  142886. * Gets the refraction object parameters
  142887. */
  142888. get refraction(): NodeMaterialConnectionPoint;
  142889. /**
  142890. * Gets the sub surface object output component
  142891. */
  142892. get subsurface(): NodeMaterialConnectionPoint;
  142893. autoConfigure(material: NodeMaterial): void;
  142894. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142895. /**
  142896. * Gets the main code of the block (fragment side)
  142897. * @param state current state of the node material building
  142898. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  142899. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142900. * @param worldPosVarName name of the variable holding the world position
  142901. * @returns the shader code
  142902. */
  142903. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  142904. protected _buildBlock(state: NodeMaterialBuildState): this;
  142905. }
  142906. }
  142907. declare module BABYLON {
  142908. /**
  142909. * Block used to implement the PBR metallic/roughness model
  142910. */
  142911. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  142912. /**
  142913. * Gets or sets the light associated with this block
  142914. */
  142915. light: Nullable<Light>;
  142916. private _lightId;
  142917. private _scene;
  142918. private _environmentBRDFTexture;
  142919. private _environmentBrdfSamplerName;
  142920. private _vNormalWName;
  142921. private _invertNormalName;
  142922. /**
  142923. * Create a new ReflectionBlock
  142924. * @param name defines the block name
  142925. */
  142926. constructor(name: string);
  142927. /**
  142928. * Intensity of the direct lights e.g. the four lights available in your scene.
  142929. * This impacts both the direct diffuse and specular highlights.
  142930. */
  142931. directIntensity: number;
  142932. /**
  142933. * Intensity of the environment e.g. how much the environment will light the object
  142934. * either through harmonics for rough material or through the refelction for shiny ones.
  142935. */
  142936. environmentIntensity: number;
  142937. /**
  142938. * This is a special control allowing the reduction of the specular highlights coming from the
  142939. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  142940. */
  142941. specularIntensity: number;
  142942. /**
  142943. * Defines the falloff type used in this material.
  142944. * It by default is Physical.
  142945. */
  142946. lightFalloff: number;
  142947. /**
  142948. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  142949. */
  142950. useAlphaFromAlbedoTexture: boolean;
  142951. /**
  142952. * Specifies that alpha test should be used
  142953. */
  142954. useAlphaTest: boolean;
  142955. /**
  142956. * Defines the alpha limits in alpha test mode.
  142957. */
  142958. alphaTestCutoff: number;
  142959. /**
  142960. * Specifies that alpha blending should be used
  142961. */
  142962. useAlphaBlending: boolean;
  142963. /**
  142964. * Defines if the alpha value should be determined via the rgb values.
  142965. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  142966. */
  142967. opacityRGB: boolean;
  142968. /**
  142969. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  142970. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  142971. */
  142972. useRadianceOverAlpha: boolean;
  142973. /**
  142974. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  142975. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  142976. */
  142977. useSpecularOverAlpha: boolean;
  142978. /**
  142979. * Enables specular anti aliasing in the PBR shader.
  142980. * It will both interacts on the Geometry for analytical and IBL lighting.
  142981. * It also prefilter the roughness map based on the bump values.
  142982. */
  142983. enableSpecularAntiAliasing: boolean;
  142984. /**
  142985. * Enables realtime filtering on the texture.
  142986. */
  142987. realTimeFiltering: boolean;
  142988. /**
  142989. * Quality switch for realtime filtering
  142990. */
  142991. realTimeFilteringQuality: number;
  142992. /**
  142993. * Defines if the material uses energy conservation.
  142994. */
  142995. useEnergyConservation: boolean;
  142996. /**
  142997. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  142998. * too much the area relying on ambient texture to define their ambient occlusion.
  142999. */
  143000. useRadianceOcclusion: boolean;
  143001. /**
  143002. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  143003. * makes the reflect vector face the model (under horizon).
  143004. */
  143005. useHorizonOcclusion: boolean;
  143006. /**
  143007. * If set to true, no lighting calculations will be applied.
  143008. */
  143009. unlit: boolean;
  143010. /**
  143011. * Force normal to face away from face.
  143012. */
  143013. forceNormalForward: boolean;
  143014. /**
  143015. * Defines the material debug mode.
  143016. * It helps seeing only some components of the material while troubleshooting.
  143017. */
  143018. debugMode: number;
  143019. /**
  143020. * Specify from where on screen the debug mode should start.
  143021. * The value goes from -1 (full screen) to 1 (not visible)
  143022. * It helps with side by side comparison against the final render
  143023. * This defaults to 0
  143024. */
  143025. debugLimit: number;
  143026. /**
  143027. * As the default viewing range might not be enough (if the ambient is really small for instance)
  143028. * You can use the factor to better multiply the final value.
  143029. */
  143030. debugFactor: number;
  143031. /**
  143032. * Initialize the block and prepare the context for build
  143033. * @param state defines the state that will be used for the build
  143034. */
  143035. initialize(state: NodeMaterialBuildState): void;
  143036. /**
  143037. * Gets the current class name
  143038. * @returns the class name
  143039. */
  143040. getClassName(): string;
  143041. /**
  143042. * Gets the world position input component
  143043. */
  143044. get worldPosition(): NodeMaterialConnectionPoint;
  143045. /**
  143046. * Gets the world normal input component
  143047. */
  143048. get worldNormal(): NodeMaterialConnectionPoint;
  143049. /**
  143050. * Gets the perturbed normal input component
  143051. */
  143052. get perturbedNormal(): NodeMaterialConnectionPoint;
  143053. /**
  143054. * Gets the camera position input component
  143055. */
  143056. get cameraPosition(): NodeMaterialConnectionPoint;
  143057. /**
  143058. * Gets the base color input component
  143059. */
  143060. get baseColor(): NodeMaterialConnectionPoint;
  143061. /**
  143062. * Gets the opacity texture input component
  143063. */
  143064. get opacityTexture(): NodeMaterialConnectionPoint;
  143065. /**
  143066. * Gets the ambient color input component
  143067. */
  143068. get ambientColor(): NodeMaterialConnectionPoint;
  143069. /**
  143070. * Gets the reflectivity object parameters
  143071. */
  143072. get reflectivity(): NodeMaterialConnectionPoint;
  143073. /**
  143074. * Gets the ambient occlusion object parameters
  143075. */
  143076. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143077. /**
  143078. * Gets the reflection object parameters
  143079. */
  143080. get reflection(): NodeMaterialConnectionPoint;
  143081. /**
  143082. * Gets the sheen object parameters
  143083. */
  143084. get sheen(): NodeMaterialConnectionPoint;
  143085. /**
  143086. * Gets the clear coat object parameters
  143087. */
  143088. get clearcoat(): NodeMaterialConnectionPoint;
  143089. /**
  143090. * Gets the sub surface object parameters
  143091. */
  143092. get subsurface(): NodeMaterialConnectionPoint;
  143093. /**
  143094. * Gets the anisotropy object parameters
  143095. */
  143096. get anisotropy(): NodeMaterialConnectionPoint;
  143097. /**
  143098. * Gets the ambient output component
  143099. */
  143100. get ambient(): NodeMaterialConnectionPoint;
  143101. /**
  143102. * Gets the diffuse output component
  143103. */
  143104. get diffuse(): NodeMaterialConnectionPoint;
  143105. /**
  143106. * Gets the specular output component
  143107. */
  143108. get specular(): NodeMaterialConnectionPoint;
  143109. /**
  143110. * Gets the sheen output component
  143111. */
  143112. get sheenDir(): NodeMaterialConnectionPoint;
  143113. /**
  143114. * Gets the clear coat output component
  143115. */
  143116. get clearcoatDir(): NodeMaterialConnectionPoint;
  143117. /**
  143118. * Gets the indirect diffuse output component
  143119. */
  143120. get diffuseIndirect(): NodeMaterialConnectionPoint;
  143121. /**
  143122. * Gets the indirect specular output component
  143123. */
  143124. get specularIndirect(): NodeMaterialConnectionPoint;
  143125. /**
  143126. * Gets the indirect sheen output component
  143127. */
  143128. get sheenIndirect(): NodeMaterialConnectionPoint;
  143129. /**
  143130. * Gets the indirect clear coat output component
  143131. */
  143132. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  143133. /**
  143134. * Gets the refraction output component
  143135. */
  143136. get refraction(): NodeMaterialConnectionPoint;
  143137. /**
  143138. * Gets the global lighting output component
  143139. */
  143140. get lighting(): NodeMaterialConnectionPoint;
  143141. /**
  143142. * Gets the shadow output component
  143143. */
  143144. get shadow(): NodeMaterialConnectionPoint;
  143145. /**
  143146. * Gets the alpha output component
  143147. */
  143148. get alpha(): NodeMaterialConnectionPoint;
  143149. autoConfigure(material: NodeMaterial): void;
  143150. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143151. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  143152. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143153. private _injectVertexCode;
  143154. /**
  143155. * Gets the code corresponding to the albedo/opacity module
  143156. * @returns the shader code
  143157. */
  143158. getAlbedoOpacityCode(): string;
  143159. protected _buildBlock(state: NodeMaterialBuildState): this;
  143160. protected _dumpPropertiesCode(): string;
  143161. serialize(): any;
  143162. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143163. }
  143164. }
  143165. declare module BABYLON {
  143166. /**
  143167. * Block used to compute value of one parameter modulo another
  143168. */
  143169. export class ModBlock extends NodeMaterialBlock {
  143170. /**
  143171. * Creates a new ModBlock
  143172. * @param name defines the block name
  143173. */
  143174. constructor(name: string);
  143175. /**
  143176. * Gets the current class name
  143177. * @returns the class name
  143178. */
  143179. getClassName(): string;
  143180. /**
  143181. * Gets the left operand input component
  143182. */
  143183. get left(): NodeMaterialConnectionPoint;
  143184. /**
  143185. * Gets the right operand input component
  143186. */
  143187. get right(): NodeMaterialConnectionPoint;
  143188. /**
  143189. * Gets the output component
  143190. */
  143191. get output(): NodeMaterialConnectionPoint;
  143192. protected _buildBlock(state: NodeMaterialBuildState): this;
  143193. }
  143194. }
  143195. declare module BABYLON {
  143196. /**
  143197. * Helper class to push actions to a pool of workers.
  143198. */
  143199. export class WorkerPool implements IDisposable {
  143200. private _workerInfos;
  143201. private _pendingActions;
  143202. /**
  143203. * Constructor
  143204. * @param workers Array of workers to use for actions
  143205. */
  143206. constructor(workers: Array<Worker>);
  143207. /**
  143208. * Terminates all workers and clears any pending actions.
  143209. */
  143210. dispose(): void;
  143211. /**
  143212. * Pushes an action to the worker pool. If all the workers are active, the action will be
  143213. * pended until a worker has completed its action.
  143214. * @param action The action to perform. Call onComplete when the action is complete.
  143215. */
  143216. push(action: (worker: Worker, onComplete: () => void) => void): void;
  143217. private _execute;
  143218. }
  143219. }
  143220. declare module BABYLON {
  143221. /**
  143222. * Configuration for Draco compression
  143223. */
  143224. export interface IDracoCompressionConfiguration {
  143225. /**
  143226. * Configuration for the decoder.
  143227. */
  143228. decoder: {
  143229. /**
  143230. * The url to the WebAssembly module.
  143231. */
  143232. wasmUrl?: string;
  143233. /**
  143234. * The url to the WebAssembly binary.
  143235. */
  143236. wasmBinaryUrl?: string;
  143237. /**
  143238. * The url to the fallback JavaScript module.
  143239. */
  143240. fallbackUrl?: string;
  143241. };
  143242. }
  143243. /**
  143244. * Draco compression (https://google.github.io/draco/)
  143245. *
  143246. * This class wraps the Draco module.
  143247. *
  143248. * **Encoder**
  143249. *
  143250. * The encoder is not currently implemented.
  143251. *
  143252. * **Decoder**
  143253. *
  143254. * 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.
  143255. *
  143256. * To update the configuration, use the following code:
  143257. * ```javascript
  143258. * DracoCompression.Configuration = {
  143259. * decoder: {
  143260. * wasmUrl: "<url to the WebAssembly library>",
  143261. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  143262. * fallbackUrl: "<url to the fallback JavaScript library>",
  143263. * }
  143264. * };
  143265. * ```
  143266. *
  143267. * 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.
  143268. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  143269. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  143270. *
  143271. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  143272. * ```javascript
  143273. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  143274. * ```
  143275. *
  143276. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  143277. */
  143278. export class DracoCompression implements IDisposable {
  143279. private _workerPoolPromise?;
  143280. private _decoderModulePromise?;
  143281. /**
  143282. * The configuration. Defaults to the following urls:
  143283. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  143284. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  143285. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  143286. */
  143287. static Configuration: IDracoCompressionConfiguration;
  143288. /**
  143289. * Returns true if the decoder configuration is available.
  143290. */
  143291. static get DecoderAvailable(): boolean;
  143292. /**
  143293. * Default number of workers to create when creating the draco compression object.
  143294. */
  143295. static DefaultNumWorkers: number;
  143296. private static GetDefaultNumWorkers;
  143297. private static _Default;
  143298. /**
  143299. * Default instance for the draco compression object.
  143300. */
  143301. static get Default(): DracoCompression;
  143302. /**
  143303. * Constructor
  143304. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  143305. */
  143306. constructor(numWorkers?: number);
  143307. /**
  143308. * Stop all async operations and release resources.
  143309. */
  143310. dispose(): void;
  143311. /**
  143312. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  143313. * @returns a promise that resolves when ready
  143314. */
  143315. whenReadyAsync(): Promise<void>;
  143316. /**
  143317. * Decode Draco compressed mesh data to vertex data.
  143318. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  143319. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  143320. * @returns A promise that resolves with the decoded vertex data
  143321. */
  143322. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  143323. [kind: string]: number;
  143324. }): Promise<VertexData>;
  143325. }
  143326. }
  143327. declare module BABYLON {
  143328. /**
  143329. * Class for building Constructive Solid Geometry
  143330. */
  143331. export class CSG {
  143332. private polygons;
  143333. /**
  143334. * The world matrix
  143335. */
  143336. matrix: Matrix;
  143337. /**
  143338. * Stores the position
  143339. */
  143340. position: Vector3;
  143341. /**
  143342. * Stores the rotation
  143343. */
  143344. rotation: Vector3;
  143345. /**
  143346. * Stores the rotation quaternion
  143347. */
  143348. rotationQuaternion: Nullable<Quaternion>;
  143349. /**
  143350. * Stores the scaling vector
  143351. */
  143352. scaling: Vector3;
  143353. /**
  143354. * Convert the Mesh to CSG
  143355. * @param mesh The Mesh to convert to CSG
  143356. * @returns A new CSG from the Mesh
  143357. */
  143358. static FromMesh(mesh: Mesh): CSG;
  143359. /**
  143360. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  143361. * @param polygons Polygons used to construct a CSG solid
  143362. */
  143363. private static FromPolygons;
  143364. /**
  143365. * Clones, or makes a deep copy, of the CSG
  143366. * @returns A new CSG
  143367. */
  143368. clone(): CSG;
  143369. /**
  143370. * Unions this CSG with another CSG
  143371. * @param csg The CSG to union against this CSG
  143372. * @returns The unioned CSG
  143373. */
  143374. union(csg: CSG): CSG;
  143375. /**
  143376. * Unions this CSG with another CSG in place
  143377. * @param csg The CSG to union against this CSG
  143378. */
  143379. unionInPlace(csg: CSG): void;
  143380. /**
  143381. * Subtracts this CSG with another CSG
  143382. * @param csg The CSG to subtract against this CSG
  143383. * @returns A new CSG
  143384. */
  143385. subtract(csg: CSG): CSG;
  143386. /**
  143387. * Subtracts this CSG with another CSG in place
  143388. * @param csg The CSG to subtact against this CSG
  143389. */
  143390. subtractInPlace(csg: CSG): void;
  143391. /**
  143392. * Intersect this CSG with another CSG
  143393. * @param csg The CSG to intersect against this CSG
  143394. * @returns A new CSG
  143395. */
  143396. intersect(csg: CSG): CSG;
  143397. /**
  143398. * Intersects this CSG with another CSG in place
  143399. * @param csg The CSG to intersect against this CSG
  143400. */
  143401. intersectInPlace(csg: CSG): void;
  143402. /**
  143403. * Return a new CSG solid with solid and empty space switched. This solid is
  143404. * not modified.
  143405. * @returns A new CSG solid with solid and empty space switched
  143406. */
  143407. inverse(): CSG;
  143408. /**
  143409. * Inverses the CSG in place
  143410. */
  143411. inverseInPlace(): void;
  143412. /**
  143413. * This is used to keep meshes transformations so they can be restored
  143414. * when we build back a Babylon Mesh
  143415. * NB : All CSG operations are performed in world coordinates
  143416. * @param csg The CSG to copy the transform attributes from
  143417. * @returns This CSG
  143418. */
  143419. copyTransformAttributes(csg: CSG): CSG;
  143420. /**
  143421. * Build Raw mesh from CSG
  143422. * Coordinates here are in world space
  143423. * @param name The name of the mesh geometry
  143424. * @param scene The Scene
  143425. * @param keepSubMeshes Specifies if the submeshes should be kept
  143426. * @returns A new Mesh
  143427. */
  143428. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  143429. /**
  143430. * Build Mesh from CSG taking material and transforms into account
  143431. * @param name The name of the Mesh
  143432. * @param material The material of the Mesh
  143433. * @param scene The Scene
  143434. * @param keepSubMeshes Specifies if submeshes should be kept
  143435. * @returns The new Mesh
  143436. */
  143437. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  143438. }
  143439. }
  143440. declare module BABYLON {
  143441. /**
  143442. * Class used to create a trail following a mesh
  143443. */
  143444. export class TrailMesh extends Mesh {
  143445. private _generator;
  143446. private _autoStart;
  143447. private _running;
  143448. private _diameter;
  143449. private _length;
  143450. private _sectionPolygonPointsCount;
  143451. private _sectionVectors;
  143452. private _sectionNormalVectors;
  143453. private _beforeRenderObserver;
  143454. /**
  143455. * @constructor
  143456. * @param name The value used by scene.getMeshByName() to do a lookup.
  143457. * @param generator The mesh or transform node to generate a trail.
  143458. * @param scene The scene to add this mesh to.
  143459. * @param diameter Diameter of trailing mesh. Default is 1.
  143460. * @param length Length of trailing mesh. Default is 60.
  143461. * @param autoStart Automatically start trailing mesh. Default true.
  143462. */
  143463. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  143464. /**
  143465. * "TrailMesh"
  143466. * @returns "TrailMesh"
  143467. */
  143468. getClassName(): string;
  143469. private _createMesh;
  143470. /**
  143471. * Start trailing mesh.
  143472. */
  143473. start(): void;
  143474. /**
  143475. * Stop trailing mesh.
  143476. */
  143477. stop(): void;
  143478. /**
  143479. * Update trailing mesh geometry.
  143480. */
  143481. update(): void;
  143482. /**
  143483. * Returns a new TrailMesh object.
  143484. * @param name is a string, the name given to the new mesh
  143485. * @param newGenerator use new generator object for cloned trail mesh
  143486. * @returns a new mesh
  143487. */
  143488. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  143489. /**
  143490. * Serializes this trail mesh
  143491. * @param serializationObject object to write serialization to
  143492. */
  143493. serialize(serializationObject: any): void;
  143494. /**
  143495. * Parses a serialized trail mesh
  143496. * @param parsedMesh the serialized mesh
  143497. * @param scene the scene to create the trail mesh in
  143498. * @returns the created trail mesh
  143499. */
  143500. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  143501. }
  143502. }
  143503. declare module BABYLON {
  143504. /**
  143505. * Class containing static functions to help procedurally build meshes
  143506. */
  143507. export class TiledBoxBuilder {
  143508. /**
  143509. * Creates a box mesh
  143510. * 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)
  143511. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143512. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143513. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143514. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143515. * @param name defines the name of the mesh
  143516. * @param options defines the options used to create the mesh
  143517. * @param scene defines the hosting scene
  143518. * @returns the box mesh
  143519. */
  143520. static CreateTiledBox(name: string, options: {
  143521. pattern?: number;
  143522. width?: number;
  143523. height?: number;
  143524. depth?: number;
  143525. tileSize?: number;
  143526. tileWidth?: number;
  143527. tileHeight?: number;
  143528. alignHorizontal?: number;
  143529. alignVertical?: number;
  143530. faceUV?: Vector4[];
  143531. faceColors?: Color4[];
  143532. sideOrientation?: number;
  143533. updatable?: boolean;
  143534. }, scene?: Nullable<Scene>): Mesh;
  143535. }
  143536. }
  143537. declare module BABYLON {
  143538. /**
  143539. * Class containing static functions to help procedurally build meshes
  143540. */
  143541. export class TorusKnotBuilder {
  143542. /**
  143543. * Creates a torus knot mesh
  143544. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  143545. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  143546. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  143547. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  143548. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143549. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143550. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143551. * @param name defines the name of the mesh
  143552. * @param options defines the options used to create the mesh
  143553. * @param scene defines the hosting scene
  143554. * @returns the torus knot mesh
  143555. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  143556. */
  143557. static CreateTorusKnot(name: string, options: {
  143558. radius?: number;
  143559. tube?: number;
  143560. radialSegments?: number;
  143561. tubularSegments?: number;
  143562. p?: number;
  143563. q?: number;
  143564. updatable?: boolean;
  143565. sideOrientation?: number;
  143566. frontUVs?: Vector4;
  143567. backUVs?: Vector4;
  143568. }, scene: any): Mesh;
  143569. }
  143570. }
  143571. declare module BABYLON {
  143572. /**
  143573. * Polygon
  143574. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  143575. */
  143576. export class Polygon {
  143577. /**
  143578. * Creates a rectangle
  143579. * @param xmin bottom X coord
  143580. * @param ymin bottom Y coord
  143581. * @param xmax top X coord
  143582. * @param ymax top Y coord
  143583. * @returns points that make the resulting rectation
  143584. */
  143585. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  143586. /**
  143587. * Creates a circle
  143588. * @param radius radius of circle
  143589. * @param cx scale in x
  143590. * @param cy scale in y
  143591. * @param numberOfSides number of sides that make up the circle
  143592. * @returns points that make the resulting circle
  143593. */
  143594. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  143595. /**
  143596. * Creates a polygon from input string
  143597. * @param input Input polygon data
  143598. * @returns the parsed points
  143599. */
  143600. static Parse(input: string): Vector2[];
  143601. /**
  143602. * Starts building a polygon from x and y coordinates
  143603. * @param x x coordinate
  143604. * @param y y coordinate
  143605. * @returns the started path2
  143606. */
  143607. static StartingAt(x: number, y: number): Path2;
  143608. }
  143609. /**
  143610. * Builds a polygon
  143611. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  143612. */
  143613. export class PolygonMeshBuilder {
  143614. private _points;
  143615. private _outlinepoints;
  143616. private _holes;
  143617. private _name;
  143618. private _scene;
  143619. private _epoints;
  143620. private _eholes;
  143621. private _addToepoint;
  143622. /**
  143623. * Babylon reference to the earcut plugin.
  143624. */
  143625. bjsEarcut: any;
  143626. /**
  143627. * Creates a PolygonMeshBuilder
  143628. * @param name name of the builder
  143629. * @param contours Path of the polygon
  143630. * @param scene scene to add to when creating the mesh
  143631. * @param earcutInjection can be used to inject your own earcut reference
  143632. */
  143633. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  143634. /**
  143635. * Adds a whole within the polygon
  143636. * @param hole Array of points defining the hole
  143637. * @returns this
  143638. */
  143639. addHole(hole: Vector2[]): PolygonMeshBuilder;
  143640. /**
  143641. * Creates the polygon
  143642. * @param updatable If the mesh should be updatable
  143643. * @param depth The depth of the mesh created
  143644. * @returns the created mesh
  143645. */
  143646. build(updatable?: boolean, depth?: number): Mesh;
  143647. /**
  143648. * Creates the polygon
  143649. * @param depth The depth of the mesh created
  143650. * @returns the created VertexData
  143651. */
  143652. buildVertexData(depth?: number): VertexData;
  143653. /**
  143654. * Adds a side to the polygon
  143655. * @param positions points that make the polygon
  143656. * @param normals normals of the polygon
  143657. * @param uvs uvs of the polygon
  143658. * @param indices indices of the polygon
  143659. * @param bounds bounds of the polygon
  143660. * @param points points of the polygon
  143661. * @param depth depth of the polygon
  143662. * @param flip flip of the polygon
  143663. */
  143664. private addSide;
  143665. }
  143666. }
  143667. declare module BABYLON {
  143668. /**
  143669. * Class containing static functions to help procedurally build meshes
  143670. */
  143671. export class PolygonBuilder {
  143672. /**
  143673. * Creates a polygon mesh
  143674. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  143675. * * 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
  143676. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  143677. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143678. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  143679. * * Remember you can only change the shape positions, not their number when updating a polygon
  143680. * @param name defines the name of the mesh
  143681. * @param options defines the options used to create the mesh
  143682. * @param scene defines the hosting scene
  143683. * @param earcutInjection can be used to inject your own earcut reference
  143684. * @returns the polygon mesh
  143685. */
  143686. static CreatePolygon(name: string, options: {
  143687. shape: Vector3[];
  143688. holes?: Vector3[][];
  143689. depth?: number;
  143690. faceUV?: Vector4[];
  143691. faceColors?: Color4[];
  143692. updatable?: boolean;
  143693. sideOrientation?: number;
  143694. frontUVs?: Vector4;
  143695. backUVs?: Vector4;
  143696. wrap?: boolean;
  143697. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143698. /**
  143699. * Creates an extruded polygon mesh, with depth in the Y direction.
  143700. * * 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)
  143701. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143702. * @param name defines the name of the mesh
  143703. * @param options defines the options used to create the mesh
  143704. * @param scene defines the hosting scene
  143705. * @param earcutInjection can be used to inject your own earcut reference
  143706. * @returns the polygon mesh
  143707. */
  143708. static ExtrudePolygon(name: string, options: {
  143709. shape: Vector3[];
  143710. holes?: Vector3[][];
  143711. depth?: number;
  143712. faceUV?: Vector4[];
  143713. faceColors?: Color4[];
  143714. updatable?: boolean;
  143715. sideOrientation?: number;
  143716. frontUVs?: Vector4;
  143717. backUVs?: Vector4;
  143718. wrap?: boolean;
  143719. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143720. }
  143721. }
  143722. declare module BABYLON {
  143723. /**
  143724. * Class containing static functions to help procedurally build meshes
  143725. */
  143726. export class LatheBuilder {
  143727. /**
  143728. * Creates lathe mesh.
  143729. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  143730. * * 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
  143731. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  143732. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  143733. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  143734. * * 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
  143735. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  143736. * * 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
  143737. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143738. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143739. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143740. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143741. * @param name defines the name of the mesh
  143742. * @param options defines the options used to create the mesh
  143743. * @param scene defines the hosting scene
  143744. * @returns the lathe mesh
  143745. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  143746. */
  143747. static CreateLathe(name: string, options: {
  143748. shape: Vector3[];
  143749. radius?: number;
  143750. tessellation?: number;
  143751. clip?: number;
  143752. arc?: number;
  143753. closed?: boolean;
  143754. updatable?: boolean;
  143755. sideOrientation?: number;
  143756. frontUVs?: Vector4;
  143757. backUVs?: Vector4;
  143758. cap?: number;
  143759. invertUV?: boolean;
  143760. }, scene?: Nullable<Scene>): Mesh;
  143761. }
  143762. }
  143763. declare module BABYLON {
  143764. /**
  143765. * Class containing static functions to help procedurally build meshes
  143766. */
  143767. export class TiledPlaneBuilder {
  143768. /**
  143769. * Creates a tiled plane mesh
  143770. * * The parameter `pattern` will, depending on value, do nothing or
  143771. * * * flip (reflect about central vertical) alternate tiles across and up
  143772. * * * flip every tile on alternate rows
  143773. * * * rotate (180 degs) alternate tiles across and up
  143774. * * * rotate every tile on alternate rows
  143775. * * * flip and rotate alternate tiles across and up
  143776. * * * flip and rotate every tile on alternate rows
  143777. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  143778. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  143779. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143780. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  143781. * * 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)
  143782. * * 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)
  143783. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  143784. * @param name defines the name of the mesh
  143785. * @param options defines the options used to create the mesh
  143786. * @param scene defines the hosting scene
  143787. * @returns the box mesh
  143788. */
  143789. static CreateTiledPlane(name: string, options: {
  143790. pattern?: number;
  143791. tileSize?: number;
  143792. tileWidth?: number;
  143793. tileHeight?: number;
  143794. size?: number;
  143795. width?: number;
  143796. height?: number;
  143797. alignHorizontal?: number;
  143798. alignVertical?: number;
  143799. sideOrientation?: number;
  143800. frontUVs?: Vector4;
  143801. backUVs?: Vector4;
  143802. updatable?: boolean;
  143803. }, scene?: Nullable<Scene>): Mesh;
  143804. }
  143805. }
  143806. declare module BABYLON {
  143807. /**
  143808. * Class containing static functions to help procedurally build meshes
  143809. */
  143810. export class TubeBuilder {
  143811. /**
  143812. * Creates a tube mesh.
  143813. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  143814. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  143815. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  143816. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  143817. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  143818. * * 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)
  143819. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  143820. * * 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
  143821. * * 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
  143822. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143823. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143824. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143825. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143826. * @param name defines the name of the mesh
  143827. * @param options defines the options used to create the mesh
  143828. * @param scene defines the hosting scene
  143829. * @returns the tube mesh
  143830. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  143831. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  143832. */
  143833. static CreateTube(name: string, options: {
  143834. path: Vector3[];
  143835. radius?: number;
  143836. tessellation?: number;
  143837. radiusFunction?: {
  143838. (i: number, distance: number): number;
  143839. };
  143840. cap?: number;
  143841. arc?: number;
  143842. updatable?: boolean;
  143843. sideOrientation?: number;
  143844. frontUVs?: Vector4;
  143845. backUVs?: Vector4;
  143846. instance?: Mesh;
  143847. invertUV?: boolean;
  143848. }, scene?: Nullable<Scene>): Mesh;
  143849. }
  143850. }
  143851. declare module BABYLON {
  143852. /**
  143853. * Class containing static functions to help procedurally build meshes
  143854. */
  143855. export class IcoSphereBuilder {
  143856. /**
  143857. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  143858. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  143859. * * 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`)
  143860. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  143861. * * 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
  143862. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143863. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143864. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143865. * @param name defines the name of the mesh
  143866. * @param options defines the options used to create the mesh
  143867. * @param scene defines the hosting scene
  143868. * @returns the icosahedron mesh
  143869. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  143870. */
  143871. static CreateIcoSphere(name: string, options: {
  143872. radius?: number;
  143873. radiusX?: number;
  143874. radiusY?: number;
  143875. radiusZ?: number;
  143876. flat?: boolean;
  143877. subdivisions?: number;
  143878. sideOrientation?: number;
  143879. frontUVs?: Vector4;
  143880. backUVs?: Vector4;
  143881. updatable?: boolean;
  143882. }, scene?: Nullable<Scene>): Mesh;
  143883. }
  143884. }
  143885. declare module BABYLON {
  143886. /**
  143887. * Class containing static functions to help procedurally build meshes
  143888. */
  143889. export class DecalBuilder {
  143890. /**
  143891. * Creates a decal mesh.
  143892. * 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
  143893. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  143894. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  143895. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  143896. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  143897. * @param name defines the name of the mesh
  143898. * @param sourceMesh defines the mesh where the decal must be applied
  143899. * @param options defines the options used to create the mesh
  143900. * @param scene defines the hosting scene
  143901. * @returns the decal mesh
  143902. * @see https://doc.babylonjs.com/how_to/decals
  143903. */
  143904. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  143905. position?: Vector3;
  143906. normal?: Vector3;
  143907. size?: Vector3;
  143908. angle?: number;
  143909. }): Mesh;
  143910. }
  143911. }
  143912. declare module BABYLON {
  143913. /**
  143914. * Class containing static functions to help procedurally build meshes
  143915. */
  143916. export class MeshBuilder {
  143917. /**
  143918. * Creates a box mesh
  143919. * * The parameter `size` sets the size (float) of each box side (default 1)
  143920. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  143921. * * 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)
  143922. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143923. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143924. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143925. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143926. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  143927. * @param name defines the name of the mesh
  143928. * @param options defines the options used to create the mesh
  143929. * @param scene defines the hosting scene
  143930. * @returns the box mesh
  143931. */
  143932. static CreateBox(name: string, options: {
  143933. size?: number;
  143934. width?: number;
  143935. height?: number;
  143936. depth?: number;
  143937. faceUV?: Vector4[];
  143938. faceColors?: Color4[];
  143939. sideOrientation?: number;
  143940. frontUVs?: Vector4;
  143941. backUVs?: Vector4;
  143942. wrap?: boolean;
  143943. topBaseAt?: number;
  143944. bottomBaseAt?: number;
  143945. updatable?: boolean;
  143946. }, scene?: Nullable<Scene>): Mesh;
  143947. /**
  143948. * Creates a tiled box mesh
  143949. * * faceTiles sets the pattern, tile size and number of tiles for a face
  143950. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143951. * @param name defines the name of the mesh
  143952. * @param options defines the options used to create the mesh
  143953. * @param scene defines the hosting scene
  143954. * @returns the tiled box mesh
  143955. */
  143956. static CreateTiledBox(name: string, options: {
  143957. pattern?: number;
  143958. size?: number;
  143959. width?: number;
  143960. height?: number;
  143961. depth: number;
  143962. tileSize?: number;
  143963. tileWidth?: number;
  143964. tileHeight?: number;
  143965. faceUV?: Vector4[];
  143966. faceColors?: Color4[];
  143967. alignHorizontal?: number;
  143968. alignVertical?: number;
  143969. sideOrientation?: number;
  143970. updatable?: boolean;
  143971. }, scene?: Nullable<Scene>): Mesh;
  143972. /**
  143973. * Creates a sphere mesh
  143974. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  143975. * * 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`)
  143976. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  143977. * * 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
  143978. * * 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)
  143979. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143980. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143981. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143982. * @param name defines the name of the mesh
  143983. * @param options defines the options used to create the mesh
  143984. * @param scene defines the hosting scene
  143985. * @returns the sphere mesh
  143986. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  143987. */
  143988. static CreateSphere(name: string, options: {
  143989. segments?: number;
  143990. diameter?: number;
  143991. diameterX?: number;
  143992. diameterY?: number;
  143993. diameterZ?: number;
  143994. arc?: number;
  143995. slice?: number;
  143996. sideOrientation?: number;
  143997. frontUVs?: Vector4;
  143998. backUVs?: Vector4;
  143999. updatable?: boolean;
  144000. }, scene?: Nullable<Scene>): Mesh;
  144001. /**
  144002. * Creates a plane polygonal mesh. By default, this is a disc
  144003. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  144004. * * 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
  144005. * * 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
  144006. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144007. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144008. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144009. * @param name defines the name of the mesh
  144010. * @param options defines the options used to create the mesh
  144011. * @param scene defines the hosting scene
  144012. * @returns the plane polygonal mesh
  144013. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  144014. */
  144015. static CreateDisc(name: string, options: {
  144016. radius?: number;
  144017. tessellation?: number;
  144018. arc?: number;
  144019. updatable?: boolean;
  144020. sideOrientation?: number;
  144021. frontUVs?: Vector4;
  144022. backUVs?: Vector4;
  144023. }, scene?: Nullable<Scene>): Mesh;
  144024. /**
  144025. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  144026. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  144027. * * 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`)
  144028. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  144029. * * 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
  144030. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144031. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144032. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144033. * @param name defines the name of the mesh
  144034. * @param options defines the options used to create the mesh
  144035. * @param scene defines the hosting scene
  144036. * @returns the icosahedron mesh
  144037. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  144038. */
  144039. static CreateIcoSphere(name: string, options: {
  144040. radius?: number;
  144041. radiusX?: number;
  144042. radiusY?: number;
  144043. radiusZ?: number;
  144044. flat?: boolean;
  144045. subdivisions?: number;
  144046. sideOrientation?: number;
  144047. frontUVs?: Vector4;
  144048. backUVs?: Vector4;
  144049. updatable?: boolean;
  144050. }, scene?: Nullable<Scene>): Mesh;
  144051. /**
  144052. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  144053. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  144054. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  144055. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  144056. * * 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
  144057. * * 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
  144058. * * 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
  144059. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144060. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144061. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144062. * * 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
  144063. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  144064. * * 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
  144065. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  144066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144067. * @param name defines the name of the mesh
  144068. * @param options defines the options used to create the mesh
  144069. * @param scene defines the hosting scene
  144070. * @returns the ribbon mesh
  144071. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  144072. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144073. */
  144074. static CreateRibbon(name: string, options: {
  144075. pathArray: Vector3[][];
  144076. closeArray?: boolean;
  144077. closePath?: boolean;
  144078. offset?: number;
  144079. updatable?: boolean;
  144080. sideOrientation?: number;
  144081. frontUVs?: Vector4;
  144082. backUVs?: Vector4;
  144083. instance?: Mesh;
  144084. invertUV?: boolean;
  144085. uvs?: Vector2[];
  144086. colors?: Color4[];
  144087. }, scene?: Nullable<Scene>): Mesh;
  144088. /**
  144089. * Creates a cylinder or a cone mesh
  144090. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  144091. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  144092. * * 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.
  144093. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  144094. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  144095. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  144096. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  144097. * * 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).
  144098. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  144099. * * 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).
  144100. * * 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
  144101. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  144102. * * 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
  144103. * * 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.
  144104. * * If `enclose` is false, a ring surface is one element.
  144105. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  144106. * * 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
  144107. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144108. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144109. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144110. * @param name defines the name of the mesh
  144111. * @param options defines the options used to create the mesh
  144112. * @param scene defines the hosting scene
  144113. * @returns the cylinder mesh
  144114. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  144115. */
  144116. static CreateCylinder(name: string, options: {
  144117. height?: number;
  144118. diameterTop?: number;
  144119. diameterBottom?: number;
  144120. diameter?: number;
  144121. tessellation?: number;
  144122. subdivisions?: number;
  144123. arc?: number;
  144124. faceColors?: Color4[];
  144125. faceUV?: Vector4[];
  144126. updatable?: boolean;
  144127. hasRings?: boolean;
  144128. enclose?: boolean;
  144129. cap?: number;
  144130. sideOrientation?: number;
  144131. frontUVs?: Vector4;
  144132. backUVs?: Vector4;
  144133. }, scene?: Nullable<Scene>): Mesh;
  144134. /**
  144135. * Creates a torus mesh
  144136. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  144137. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  144138. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  144139. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144140. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144141. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144142. * @param name defines the name of the mesh
  144143. * @param options defines the options used to create the mesh
  144144. * @param scene defines the hosting scene
  144145. * @returns the torus mesh
  144146. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  144147. */
  144148. static CreateTorus(name: string, options: {
  144149. diameter?: number;
  144150. thickness?: number;
  144151. tessellation?: number;
  144152. updatable?: boolean;
  144153. sideOrientation?: number;
  144154. frontUVs?: Vector4;
  144155. backUVs?: Vector4;
  144156. }, scene?: Nullable<Scene>): Mesh;
  144157. /**
  144158. * Creates a torus knot mesh
  144159. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144160. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144161. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144162. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144163. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144164. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144165. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144166. * @param name defines the name of the mesh
  144167. * @param options defines the options used to create the mesh
  144168. * @param scene defines the hosting scene
  144169. * @returns the torus knot mesh
  144170. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144171. */
  144172. static CreateTorusKnot(name: string, options: {
  144173. radius?: number;
  144174. tube?: number;
  144175. radialSegments?: number;
  144176. tubularSegments?: number;
  144177. p?: number;
  144178. q?: number;
  144179. updatable?: boolean;
  144180. sideOrientation?: number;
  144181. frontUVs?: Vector4;
  144182. backUVs?: Vector4;
  144183. }, scene?: Nullable<Scene>): Mesh;
  144184. /**
  144185. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  144186. * * 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
  144187. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  144188. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  144189. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  144190. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  144191. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  144192. * * 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
  144193. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  144194. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144195. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  144196. * @param name defines the name of the new line system
  144197. * @param options defines the options used to create the line system
  144198. * @param scene defines the hosting scene
  144199. * @returns a new line system mesh
  144200. */
  144201. static CreateLineSystem(name: string, options: {
  144202. lines: Vector3[][];
  144203. updatable?: boolean;
  144204. instance?: Nullable<LinesMesh>;
  144205. colors?: Nullable<Color4[][]>;
  144206. useVertexAlpha?: boolean;
  144207. }, scene: Nullable<Scene>): LinesMesh;
  144208. /**
  144209. * Creates a line mesh
  144210. * 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
  144211. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  144212. * * The parameter `points` is an array successive Vector3
  144213. * * 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
  144214. * * The optional parameter `colors` is an array of successive Color4, one per line point
  144215. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  144216. * * When updating an instance, remember that only point positions can change, not the number of points
  144217. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144218. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  144219. * @param name defines the name of the new line system
  144220. * @param options defines the options used to create the line system
  144221. * @param scene defines the hosting scene
  144222. * @returns a new line mesh
  144223. */
  144224. static CreateLines(name: string, options: {
  144225. points: Vector3[];
  144226. updatable?: boolean;
  144227. instance?: Nullable<LinesMesh>;
  144228. colors?: Color4[];
  144229. useVertexAlpha?: boolean;
  144230. }, scene?: Nullable<Scene>): LinesMesh;
  144231. /**
  144232. * Creates a dashed line mesh
  144233. * * 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
  144234. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  144235. * * The parameter `points` is an array successive Vector3
  144236. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  144237. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  144238. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  144239. * * 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
  144240. * * When updating an instance, remember that only point positions can change, not the number of points
  144241. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144242. * @param name defines the name of the mesh
  144243. * @param options defines the options used to create the mesh
  144244. * @param scene defines the hosting scene
  144245. * @returns the dashed line mesh
  144246. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  144247. */
  144248. static CreateDashedLines(name: string, options: {
  144249. points: Vector3[];
  144250. dashSize?: number;
  144251. gapSize?: number;
  144252. dashNb?: number;
  144253. updatable?: boolean;
  144254. instance?: LinesMesh;
  144255. }, scene?: Nullable<Scene>): LinesMesh;
  144256. /**
  144257. * 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.
  144258. * * 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.
  144259. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  144260. * * 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.
  144261. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  144262. * * 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
  144263. * * 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
  144264. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  144265. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144266. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144267. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  144268. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144269. * @param name defines the name of the mesh
  144270. * @param options defines the options used to create the mesh
  144271. * @param scene defines the hosting scene
  144272. * @returns the extruded shape mesh
  144273. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144274. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  144275. */
  144276. static ExtrudeShape(name: string, options: {
  144277. shape: Vector3[];
  144278. path: Vector3[];
  144279. scale?: number;
  144280. rotation?: number;
  144281. cap?: number;
  144282. updatable?: boolean;
  144283. sideOrientation?: number;
  144284. frontUVs?: Vector4;
  144285. backUVs?: Vector4;
  144286. instance?: Mesh;
  144287. invertUV?: boolean;
  144288. }, scene?: Nullable<Scene>): Mesh;
  144289. /**
  144290. * Creates an custom extruded shape mesh.
  144291. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  144292. * * 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.
  144293. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  144294. * * 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
  144295. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  144296. * * 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
  144297. * * It must returns a float value that will be the scale value applied to the shape on each path point
  144298. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  144299. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  144300. * * 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
  144301. * * 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
  144302. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  144303. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144304. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144305. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144306. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144307. * @param name defines the name of the mesh
  144308. * @param options defines the options used to create the mesh
  144309. * @param scene defines the hosting scene
  144310. * @returns the custom extruded shape mesh
  144311. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  144312. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144313. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  144314. */
  144315. static ExtrudeShapeCustom(name: string, options: {
  144316. shape: Vector3[];
  144317. path: Vector3[];
  144318. scaleFunction?: any;
  144319. rotationFunction?: any;
  144320. ribbonCloseArray?: boolean;
  144321. ribbonClosePath?: boolean;
  144322. cap?: number;
  144323. updatable?: boolean;
  144324. sideOrientation?: number;
  144325. frontUVs?: Vector4;
  144326. backUVs?: Vector4;
  144327. instance?: Mesh;
  144328. invertUV?: boolean;
  144329. }, scene?: Nullable<Scene>): Mesh;
  144330. /**
  144331. * Creates lathe mesh.
  144332. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  144333. * * 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
  144334. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  144335. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  144336. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  144337. * * 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
  144338. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  144339. * * 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
  144340. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144341. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144342. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144343. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144344. * @param name defines the name of the mesh
  144345. * @param options defines the options used to create the mesh
  144346. * @param scene defines the hosting scene
  144347. * @returns the lathe mesh
  144348. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  144349. */
  144350. static CreateLathe(name: string, options: {
  144351. shape: Vector3[];
  144352. radius?: number;
  144353. tessellation?: number;
  144354. clip?: number;
  144355. arc?: number;
  144356. closed?: boolean;
  144357. updatable?: boolean;
  144358. sideOrientation?: number;
  144359. frontUVs?: Vector4;
  144360. backUVs?: Vector4;
  144361. cap?: number;
  144362. invertUV?: boolean;
  144363. }, scene?: Nullable<Scene>): Mesh;
  144364. /**
  144365. * Creates a tiled plane mesh
  144366. * * You can set a limited pattern arrangement with the tiles
  144367. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144368. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144369. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144370. * @param name defines the name of the mesh
  144371. * @param options defines the options used to create the mesh
  144372. * @param scene defines the hosting scene
  144373. * @returns the plane mesh
  144374. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  144375. */
  144376. static CreateTiledPlane(name: string, options: {
  144377. pattern?: number;
  144378. tileSize?: number;
  144379. tileWidth?: number;
  144380. tileHeight?: number;
  144381. size?: number;
  144382. width?: number;
  144383. height?: number;
  144384. alignHorizontal?: number;
  144385. alignVertical?: number;
  144386. sideOrientation?: number;
  144387. frontUVs?: Vector4;
  144388. backUVs?: Vector4;
  144389. updatable?: boolean;
  144390. }, scene?: Nullable<Scene>): Mesh;
  144391. /**
  144392. * Creates a plane mesh
  144393. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  144394. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  144395. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  144396. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144397. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144398. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144399. * @param name defines the name of the mesh
  144400. * @param options defines the options used to create the mesh
  144401. * @param scene defines the hosting scene
  144402. * @returns the plane mesh
  144403. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  144404. */
  144405. static CreatePlane(name: string, options: {
  144406. size?: number;
  144407. width?: number;
  144408. height?: number;
  144409. sideOrientation?: number;
  144410. frontUVs?: Vector4;
  144411. backUVs?: Vector4;
  144412. updatable?: boolean;
  144413. sourcePlane?: Plane;
  144414. }, scene?: Nullable<Scene>): Mesh;
  144415. /**
  144416. * Creates a ground mesh
  144417. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  144418. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  144419. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144420. * @param name defines the name of the mesh
  144421. * @param options defines the options used to create the mesh
  144422. * @param scene defines the hosting scene
  144423. * @returns the ground mesh
  144424. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  144425. */
  144426. static CreateGround(name: string, options: {
  144427. width?: number;
  144428. height?: number;
  144429. subdivisions?: number;
  144430. subdivisionsX?: number;
  144431. subdivisionsY?: number;
  144432. updatable?: boolean;
  144433. }, scene?: Nullable<Scene>): Mesh;
  144434. /**
  144435. * Creates a tiled ground mesh
  144436. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  144437. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  144438. * * 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
  144439. * * 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
  144440. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144441. * @param name defines the name of the mesh
  144442. * @param options defines the options used to create the mesh
  144443. * @param scene defines the hosting scene
  144444. * @returns the tiled ground mesh
  144445. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  144446. */
  144447. static CreateTiledGround(name: string, options: {
  144448. xmin: number;
  144449. zmin: number;
  144450. xmax: number;
  144451. zmax: number;
  144452. subdivisions?: {
  144453. w: number;
  144454. h: number;
  144455. };
  144456. precision?: {
  144457. w: number;
  144458. h: number;
  144459. };
  144460. updatable?: boolean;
  144461. }, scene?: Nullable<Scene>): Mesh;
  144462. /**
  144463. * Creates a ground mesh from a height map
  144464. * * The parameter `url` sets the URL of the height map image resource.
  144465. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  144466. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  144467. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  144468. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  144469. * * 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.
  144470. * * 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).
  144471. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  144472. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144473. * @param name defines the name of the mesh
  144474. * @param url defines the url to the height map
  144475. * @param options defines the options used to create the mesh
  144476. * @param scene defines the hosting scene
  144477. * @returns the ground mesh
  144478. * @see https://doc.babylonjs.com/babylon101/height_map
  144479. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  144480. */
  144481. static CreateGroundFromHeightMap(name: string, url: string, options: {
  144482. width?: number;
  144483. height?: number;
  144484. subdivisions?: number;
  144485. minHeight?: number;
  144486. maxHeight?: number;
  144487. colorFilter?: Color3;
  144488. alphaFilter?: number;
  144489. updatable?: boolean;
  144490. onReady?: (mesh: GroundMesh) => void;
  144491. }, scene?: Nullable<Scene>): GroundMesh;
  144492. /**
  144493. * Creates a polygon mesh
  144494. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  144495. * * 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
  144496. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144497. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144498. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  144499. * * Remember you can only change the shape positions, not their number when updating a polygon
  144500. * @param name defines the name of the mesh
  144501. * @param options defines the options used to create the mesh
  144502. * @param scene defines the hosting scene
  144503. * @param earcutInjection can be used to inject your own earcut reference
  144504. * @returns the polygon mesh
  144505. */
  144506. static CreatePolygon(name: string, options: {
  144507. shape: Vector3[];
  144508. holes?: Vector3[][];
  144509. depth?: number;
  144510. faceUV?: Vector4[];
  144511. faceColors?: Color4[];
  144512. updatable?: boolean;
  144513. sideOrientation?: number;
  144514. frontUVs?: Vector4;
  144515. backUVs?: Vector4;
  144516. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144517. /**
  144518. * Creates an extruded polygon mesh, with depth in the Y direction.
  144519. * * 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)
  144520. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144521. * @param name defines the name of the mesh
  144522. * @param options defines the options used to create the mesh
  144523. * @param scene defines the hosting scene
  144524. * @param earcutInjection can be used to inject your own earcut reference
  144525. * @returns the polygon mesh
  144526. */
  144527. static ExtrudePolygon(name: string, options: {
  144528. shape: Vector3[];
  144529. holes?: Vector3[][];
  144530. depth?: number;
  144531. faceUV?: Vector4[];
  144532. faceColors?: Color4[];
  144533. updatable?: boolean;
  144534. sideOrientation?: number;
  144535. frontUVs?: Vector4;
  144536. backUVs?: Vector4;
  144537. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144538. /**
  144539. * Creates a tube mesh.
  144540. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  144541. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  144542. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  144543. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  144544. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  144545. * * 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)
  144546. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  144547. * * 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
  144548. * * 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
  144549. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144550. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144551. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144552. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144553. * @param name defines the name of the mesh
  144554. * @param options defines the options used to create the mesh
  144555. * @param scene defines the hosting scene
  144556. * @returns the tube mesh
  144557. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144558. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  144559. */
  144560. static CreateTube(name: string, options: {
  144561. path: Vector3[];
  144562. radius?: number;
  144563. tessellation?: number;
  144564. radiusFunction?: {
  144565. (i: number, distance: number): number;
  144566. };
  144567. cap?: number;
  144568. arc?: number;
  144569. updatable?: boolean;
  144570. sideOrientation?: number;
  144571. frontUVs?: Vector4;
  144572. backUVs?: Vector4;
  144573. instance?: Mesh;
  144574. invertUV?: boolean;
  144575. }, scene?: Nullable<Scene>): Mesh;
  144576. /**
  144577. * Creates a polyhedron mesh
  144578. * * 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
  144579. * * The parameter `size` (positive float, default 1) sets the polygon size
  144580. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  144581. * * 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`
  144582. * * 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
  144583. * * 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)`)
  144584. * * 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
  144585. * * 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
  144586. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144587. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144588. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144589. * @param name defines the name of the mesh
  144590. * @param options defines the options used to create the mesh
  144591. * @param scene defines the hosting scene
  144592. * @returns the polyhedron mesh
  144593. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  144594. */
  144595. static CreatePolyhedron(name: string, options: {
  144596. type?: number;
  144597. size?: number;
  144598. sizeX?: number;
  144599. sizeY?: number;
  144600. sizeZ?: number;
  144601. custom?: any;
  144602. faceUV?: Vector4[];
  144603. faceColors?: Color4[];
  144604. flat?: boolean;
  144605. updatable?: boolean;
  144606. sideOrientation?: number;
  144607. frontUVs?: Vector4;
  144608. backUVs?: Vector4;
  144609. }, scene?: Nullable<Scene>): Mesh;
  144610. /**
  144611. * Creates a decal mesh.
  144612. * 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
  144613. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  144614. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  144615. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  144616. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  144617. * @param name defines the name of the mesh
  144618. * @param sourceMesh defines the mesh where the decal must be applied
  144619. * @param options defines the options used to create the mesh
  144620. * @param scene defines the hosting scene
  144621. * @returns the decal mesh
  144622. * @see https://doc.babylonjs.com/how_to/decals
  144623. */
  144624. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  144625. position?: Vector3;
  144626. normal?: Vector3;
  144627. size?: Vector3;
  144628. angle?: number;
  144629. }): Mesh;
  144630. }
  144631. }
  144632. declare module BABYLON {
  144633. /**
  144634. * A simplifier interface for future simplification implementations
  144635. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144636. */
  144637. export interface ISimplifier {
  144638. /**
  144639. * Simplification of a given mesh according to the given settings.
  144640. * Since this requires computation, it is assumed that the function runs async.
  144641. * @param settings The settings of the simplification, including quality and distance
  144642. * @param successCallback A callback that will be called after the mesh was simplified.
  144643. * @param errorCallback in case of an error, this callback will be called. optional.
  144644. */
  144645. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  144646. }
  144647. /**
  144648. * Expected simplification settings.
  144649. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  144650. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144651. */
  144652. export interface ISimplificationSettings {
  144653. /**
  144654. * Gets or sets the expected quality
  144655. */
  144656. quality: number;
  144657. /**
  144658. * Gets or sets the distance when this optimized version should be used
  144659. */
  144660. distance: number;
  144661. /**
  144662. * Gets an already optimized mesh
  144663. */
  144664. optimizeMesh?: boolean;
  144665. }
  144666. /**
  144667. * Class used to specify simplification options
  144668. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144669. */
  144670. export class SimplificationSettings implements ISimplificationSettings {
  144671. /** expected quality */
  144672. quality: number;
  144673. /** distance when this optimized version should be used */
  144674. distance: number;
  144675. /** already optimized mesh */
  144676. optimizeMesh?: boolean | undefined;
  144677. /**
  144678. * Creates a SimplificationSettings
  144679. * @param quality expected quality
  144680. * @param distance distance when this optimized version should be used
  144681. * @param optimizeMesh already optimized mesh
  144682. */
  144683. constructor(
  144684. /** expected quality */
  144685. quality: number,
  144686. /** distance when this optimized version should be used */
  144687. distance: number,
  144688. /** already optimized mesh */
  144689. optimizeMesh?: boolean | undefined);
  144690. }
  144691. /**
  144692. * Interface used to define a simplification task
  144693. */
  144694. export interface ISimplificationTask {
  144695. /**
  144696. * Array of settings
  144697. */
  144698. settings: Array<ISimplificationSettings>;
  144699. /**
  144700. * Simplification type
  144701. */
  144702. simplificationType: SimplificationType;
  144703. /**
  144704. * Mesh to simplify
  144705. */
  144706. mesh: Mesh;
  144707. /**
  144708. * Callback called on success
  144709. */
  144710. successCallback?: () => void;
  144711. /**
  144712. * Defines if parallel processing can be used
  144713. */
  144714. parallelProcessing: boolean;
  144715. }
  144716. /**
  144717. * Queue used to order the simplification tasks
  144718. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144719. */
  144720. export class SimplificationQueue {
  144721. private _simplificationArray;
  144722. /**
  144723. * Gets a boolean indicating that the process is still running
  144724. */
  144725. running: boolean;
  144726. /**
  144727. * Creates a new queue
  144728. */
  144729. constructor();
  144730. /**
  144731. * Adds a new simplification task
  144732. * @param task defines a task to add
  144733. */
  144734. addTask(task: ISimplificationTask): void;
  144735. /**
  144736. * Execute next task
  144737. */
  144738. executeNext(): void;
  144739. /**
  144740. * Execute a simplification task
  144741. * @param task defines the task to run
  144742. */
  144743. runSimplification(task: ISimplificationTask): void;
  144744. private getSimplifier;
  144745. }
  144746. /**
  144747. * The implemented types of simplification
  144748. * At the moment only Quadratic Error Decimation is implemented
  144749. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144750. */
  144751. export enum SimplificationType {
  144752. /** Quadratic error decimation */
  144753. QUADRATIC = 0
  144754. }
  144755. /**
  144756. * An implementation of the Quadratic Error simplification algorithm.
  144757. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  144758. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  144759. * @author RaananW
  144760. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144761. */
  144762. export class QuadraticErrorSimplification implements ISimplifier {
  144763. private _mesh;
  144764. private triangles;
  144765. private vertices;
  144766. private references;
  144767. private _reconstructedMesh;
  144768. /** Gets or sets the number pf sync interations */
  144769. syncIterations: number;
  144770. /** Gets or sets the aggressiveness of the simplifier */
  144771. aggressiveness: number;
  144772. /** Gets or sets the number of allowed iterations for decimation */
  144773. decimationIterations: number;
  144774. /** Gets or sets the espilon to use for bounding box computation */
  144775. boundingBoxEpsilon: number;
  144776. /**
  144777. * Creates a new QuadraticErrorSimplification
  144778. * @param _mesh defines the target mesh
  144779. */
  144780. constructor(_mesh: Mesh);
  144781. /**
  144782. * Simplification of a given mesh according to the given settings.
  144783. * Since this requires computation, it is assumed that the function runs async.
  144784. * @param settings The settings of the simplification, including quality and distance
  144785. * @param successCallback A callback that will be called after the mesh was simplified.
  144786. */
  144787. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  144788. private runDecimation;
  144789. private initWithMesh;
  144790. private init;
  144791. private reconstructMesh;
  144792. private initDecimatedMesh;
  144793. private isFlipped;
  144794. private updateTriangles;
  144795. private identifyBorder;
  144796. private updateMesh;
  144797. private vertexError;
  144798. private calculateError;
  144799. }
  144800. }
  144801. declare module BABYLON {
  144802. interface Scene {
  144803. /** @hidden (Backing field) */
  144804. _simplificationQueue: SimplificationQueue;
  144805. /**
  144806. * Gets or sets the simplification queue attached to the scene
  144807. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144808. */
  144809. simplificationQueue: SimplificationQueue;
  144810. }
  144811. interface Mesh {
  144812. /**
  144813. * Simplify the mesh according to the given array of settings.
  144814. * Function will return immediately and will simplify async
  144815. * @param settings a collection of simplification settings
  144816. * @param parallelProcessing should all levels calculate parallel or one after the other
  144817. * @param simplificationType the type of simplification to run
  144818. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  144819. * @returns the current mesh
  144820. */
  144821. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  144822. }
  144823. /**
  144824. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  144825. * created in a scene
  144826. */
  144827. export class SimplicationQueueSceneComponent implements ISceneComponent {
  144828. /**
  144829. * The component name helpfull to identify the component in the list of scene components.
  144830. */
  144831. readonly name: string;
  144832. /**
  144833. * The scene the component belongs to.
  144834. */
  144835. scene: Scene;
  144836. /**
  144837. * Creates a new instance of the component for the given scene
  144838. * @param scene Defines the scene to register the component in
  144839. */
  144840. constructor(scene: Scene);
  144841. /**
  144842. * Registers the component in a given scene
  144843. */
  144844. register(): void;
  144845. /**
  144846. * Rebuilds the elements related to this component in case of
  144847. * context lost for instance.
  144848. */
  144849. rebuild(): void;
  144850. /**
  144851. * Disposes the component and the associated ressources
  144852. */
  144853. dispose(): void;
  144854. private _beforeCameraUpdate;
  144855. }
  144856. }
  144857. declare module BABYLON {
  144858. interface Mesh {
  144859. /**
  144860. * Creates a new thin instance
  144861. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  144862. * @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
  144863. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  144864. */
  144865. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  144866. /**
  144867. * Adds the transformation (matrix) of the current mesh as a thin instance
  144868. * @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
  144869. * @returns the thin instance index number
  144870. */
  144871. thinInstanceAddSelf(refresh: boolean): number;
  144872. /**
  144873. * Registers a custom attribute to be used with thin instances
  144874. * @param kind name of the attribute
  144875. * @param stride size in floats of the attribute
  144876. */
  144877. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  144878. /**
  144879. * Sets the matrix of a thin instance
  144880. * @param index index of the thin instance
  144881. * @param matrix matrix to set
  144882. * @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
  144883. */
  144884. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  144885. /**
  144886. * Sets the value of a custom attribute for a thin instance
  144887. * @param kind name of the attribute
  144888. * @param index index of the thin instance
  144889. * @param value value to set
  144890. * @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
  144891. */
  144892. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  144893. /**
  144894. * 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.
  144895. */
  144896. thinInstanceCount: number;
  144897. /**
  144898. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  144899. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  144900. * @param buffer buffer to set
  144901. * @param stride size in floats of each value of the buffer
  144902. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  144903. */
  144904. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  144905. /**
  144906. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  144907. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  144908. */
  144909. thinInstanceBufferUpdated(kind: string): void;
  144910. /**
  144911. * Refreshes the bounding info, taking into account all the thin instances defined
  144912. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  144913. */
  144914. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  144915. /** @hidden */
  144916. _thinInstanceInitializeUserStorage(): void;
  144917. /** @hidden */
  144918. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  144919. /** @hidden */
  144920. _userThinInstanceBuffersStorage: {
  144921. data: {
  144922. [key: string]: Float32Array;
  144923. };
  144924. sizes: {
  144925. [key: string]: number;
  144926. };
  144927. vertexBuffers: {
  144928. [key: string]: Nullable<VertexBuffer>;
  144929. };
  144930. strides: {
  144931. [key: string]: number;
  144932. };
  144933. };
  144934. }
  144935. }
  144936. declare module BABYLON {
  144937. /**
  144938. * Navigation plugin interface to add navigation constrained by a navigation mesh
  144939. */
  144940. export interface INavigationEnginePlugin {
  144941. /**
  144942. * plugin name
  144943. */
  144944. name: string;
  144945. /**
  144946. * Creates a navigation mesh
  144947. * @param meshes array of all the geometry used to compute the navigatio mesh
  144948. * @param parameters bunch of parameters used to filter geometry
  144949. */
  144950. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  144951. /**
  144952. * Create a navigation mesh debug mesh
  144953. * @param scene is where the mesh will be added
  144954. * @returns debug display mesh
  144955. */
  144956. createDebugNavMesh(scene: Scene): Mesh;
  144957. /**
  144958. * Get a navigation mesh constrained position, closest to the parameter position
  144959. * @param position world position
  144960. * @returns the closest point to position constrained by the navigation mesh
  144961. */
  144962. getClosestPoint(position: Vector3): Vector3;
  144963. /**
  144964. * Get a navigation mesh constrained position, closest to the parameter position
  144965. * @param position world position
  144966. * @param result output the closest point to position constrained by the navigation mesh
  144967. */
  144968. getClosestPointToRef(position: Vector3, result: Vector3): void;
  144969. /**
  144970. * Get a navigation mesh constrained position, within a particular radius
  144971. * @param position world position
  144972. * @param maxRadius the maximum distance to the constrained world position
  144973. * @returns the closest point to position constrained by the navigation mesh
  144974. */
  144975. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  144976. /**
  144977. * Get a navigation mesh constrained position, within a particular radius
  144978. * @param position world position
  144979. * @param maxRadius the maximum distance to the constrained world position
  144980. * @param result output the closest point to position constrained by the navigation mesh
  144981. */
  144982. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  144983. /**
  144984. * Compute the final position from a segment made of destination-position
  144985. * @param position world position
  144986. * @param destination world position
  144987. * @returns the resulting point along the navmesh
  144988. */
  144989. moveAlong(position: Vector3, destination: Vector3): Vector3;
  144990. /**
  144991. * Compute the final position from a segment made of destination-position
  144992. * @param position world position
  144993. * @param destination world position
  144994. * @param result output the resulting point along the navmesh
  144995. */
  144996. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  144997. /**
  144998. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  144999. * @param start world position
  145000. * @param end world position
  145001. * @returns array containing world position composing the path
  145002. */
  145003. computePath(start: Vector3, end: Vector3): Vector3[];
  145004. /**
  145005. * If this plugin is supported
  145006. * @returns true if plugin is supported
  145007. */
  145008. isSupported(): boolean;
  145009. /**
  145010. * Create a new Crowd so you can add agents
  145011. * @param maxAgents the maximum agent count in the crowd
  145012. * @param maxAgentRadius the maximum radius an agent can have
  145013. * @param scene to attach the crowd to
  145014. * @returns the crowd you can add agents to
  145015. */
  145016. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  145017. /**
  145018. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145019. * The queries will try to find a solution within those bounds
  145020. * default is (1,1,1)
  145021. * @param extent x,y,z value that define the extent around the queries point of reference
  145022. */
  145023. setDefaultQueryExtent(extent: Vector3): void;
  145024. /**
  145025. * Get the Bounding box extent specified by setDefaultQueryExtent
  145026. * @returns the box extent values
  145027. */
  145028. getDefaultQueryExtent(): Vector3;
  145029. /**
  145030. * build the navmesh from a previously saved state using getNavmeshData
  145031. * @param data the Uint8Array returned by getNavmeshData
  145032. */
  145033. buildFromNavmeshData(data: Uint8Array): void;
  145034. /**
  145035. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  145036. * @returns data the Uint8Array that can be saved and reused
  145037. */
  145038. getNavmeshData(): Uint8Array;
  145039. /**
  145040. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145041. * @param result output the box extent values
  145042. */
  145043. getDefaultQueryExtentToRef(result: Vector3): void;
  145044. /**
  145045. * Release all resources
  145046. */
  145047. dispose(): void;
  145048. }
  145049. /**
  145050. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  145051. */
  145052. export interface ICrowd {
  145053. /**
  145054. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  145055. * You can attach anything to that node. The node position is updated in the scene update tick.
  145056. * @param pos world position that will be constrained by the navigation mesh
  145057. * @param parameters agent parameters
  145058. * @param transform hooked to the agent that will be update by the scene
  145059. * @returns agent index
  145060. */
  145061. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  145062. /**
  145063. * Returns the agent position in world space
  145064. * @param index agent index returned by addAgent
  145065. * @returns world space position
  145066. */
  145067. getAgentPosition(index: number): Vector3;
  145068. /**
  145069. * Gets the agent position result in world space
  145070. * @param index agent index returned by addAgent
  145071. * @param result output world space position
  145072. */
  145073. getAgentPositionToRef(index: number, result: Vector3): void;
  145074. /**
  145075. * Gets the agent velocity in world space
  145076. * @param index agent index returned by addAgent
  145077. * @returns world space velocity
  145078. */
  145079. getAgentVelocity(index: number): Vector3;
  145080. /**
  145081. * Gets the agent velocity result in world space
  145082. * @param index agent index returned by addAgent
  145083. * @param result output world space velocity
  145084. */
  145085. getAgentVelocityToRef(index: number, result: Vector3): void;
  145086. /**
  145087. * remove a particular agent previously created
  145088. * @param index agent index returned by addAgent
  145089. */
  145090. removeAgent(index: number): void;
  145091. /**
  145092. * get the list of all agents attached to this crowd
  145093. * @returns list of agent indices
  145094. */
  145095. getAgents(): number[];
  145096. /**
  145097. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  145098. * @param deltaTime in seconds
  145099. */
  145100. update(deltaTime: number): void;
  145101. /**
  145102. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  145103. * @param index agent index returned by addAgent
  145104. * @param destination targeted world position
  145105. */
  145106. agentGoto(index: number, destination: Vector3): void;
  145107. /**
  145108. * Teleport the agent to a new position
  145109. * @param index agent index returned by addAgent
  145110. * @param destination targeted world position
  145111. */
  145112. agentTeleport(index: number, destination: Vector3): void;
  145113. /**
  145114. * Update agent parameters
  145115. * @param index agent index returned by addAgent
  145116. * @param parameters agent parameters
  145117. */
  145118. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  145119. /**
  145120. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145121. * The queries will try to find a solution within those bounds
  145122. * default is (1,1,1)
  145123. * @param extent x,y,z value that define the extent around the queries point of reference
  145124. */
  145125. setDefaultQueryExtent(extent: Vector3): void;
  145126. /**
  145127. * Get the Bounding box extent specified by setDefaultQueryExtent
  145128. * @returns the box extent values
  145129. */
  145130. getDefaultQueryExtent(): Vector3;
  145131. /**
  145132. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145133. * @param result output the box extent values
  145134. */
  145135. getDefaultQueryExtentToRef(result: Vector3): void;
  145136. /**
  145137. * Release all resources
  145138. */
  145139. dispose(): void;
  145140. }
  145141. /**
  145142. * Configures an agent
  145143. */
  145144. export interface IAgentParameters {
  145145. /**
  145146. * Agent radius. [Limit: >= 0]
  145147. */
  145148. radius: number;
  145149. /**
  145150. * Agent height. [Limit: > 0]
  145151. */
  145152. height: number;
  145153. /**
  145154. * Maximum allowed acceleration. [Limit: >= 0]
  145155. */
  145156. maxAcceleration: number;
  145157. /**
  145158. * Maximum allowed speed. [Limit: >= 0]
  145159. */
  145160. maxSpeed: number;
  145161. /**
  145162. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  145163. */
  145164. collisionQueryRange: number;
  145165. /**
  145166. * The path visibility optimization range. [Limit: > 0]
  145167. */
  145168. pathOptimizationRange: number;
  145169. /**
  145170. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  145171. */
  145172. separationWeight: number;
  145173. }
  145174. /**
  145175. * Configures the navigation mesh creation
  145176. */
  145177. export interface INavMeshParameters {
  145178. /**
  145179. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  145180. */
  145181. cs: number;
  145182. /**
  145183. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  145184. */
  145185. ch: number;
  145186. /**
  145187. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  145188. */
  145189. walkableSlopeAngle: number;
  145190. /**
  145191. * Minimum floor to 'ceiling' height that will still allow the floor area to
  145192. * be considered walkable. [Limit: >= 3] [Units: vx]
  145193. */
  145194. walkableHeight: number;
  145195. /**
  145196. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  145197. */
  145198. walkableClimb: number;
  145199. /**
  145200. * The distance to erode/shrink the walkable area of the heightfield away from
  145201. * obstructions. [Limit: >=0] [Units: vx]
  145202. */
  145203. walkableRadius: number;
  145204. /**
  145205. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  145206. */
  145207. maxEdgeLen: number;
  145208. /**
  145209. * The maximum distance a simplfied contour's border edges should deviate
  145210. * the original raw contour. [Limit: >=0] [Units: vx]
  145211. */
  145212. maxSimplificationError: number;
  145213. /**
  145214. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  145215. */
  145216. minRegionArea: number;
  145217. /**
  145218. * Any regions with a span count smaller than this value will, if possible,
  145219. * be merged with larger regions. [Limit: >=0] [Units: vx]
  145220. */
  145221. mergeRegionArea: number;
  145222. /**
  145223. * The maximum number of vertices allowed for polygons generated during the
  145224. * contour to polygon conversion process. [Limit: >= 3]
  145225. */
  145226. maxVertsPerPoly: number;
  145227. /**
  145228. * Sets the sampling distance to use when generating the detail mesh.
  145229. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  145230. */
  145231. detailSampleDist: number;
  145232. /**
  145233. * The maximum distance the detail mesh surface should deviate from heightfield
  145234. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  145235. */
  145236. detailSampleMaxError: number;
  145237. }
  145238. }
  145239. declare module BABYLON {
  145240. /**
  145241. * RecastJS navigation plugin
  145242. */
  145243. export class RecastJSPlugin implements INavigationEnginePlugin {
  145244. /**
  145245. * Reference to the Recast library
  145246. */
  145247. bjsRECAST: any;
  145248. /**
  145249. * plugin name
  145250. */
  145251. name: string;
  145252. /**
  145253. * the first navmesh created. We might extend this to support multiple navmeshes
  145254. */
  145255. navMesh: any;
  145256. /**
  145257. * Initializes the recastJS plugin
  145258. * @param recastInjection can be used to inject your own recast reference
  145259. */
  145260. constructor(recastInjection?: any);
  145261. /**
  145262. * Creates a navigation mesh
  145263. * @param meshes array of all the geometry used to compute the navigatio mesh
  145264. * @param parameters bunch of parameters used to filter geometry
  145265. */
  145266. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  145267. /**
  145268. * Create a navigation mesh debug mesh
  145269. * @param scene is where the mesh will be added
  145270. * @returns debug display mesh
  145271. */
  145272. createDebugNavMesh(scene: Scene): Mesh;
  145273. /**
  145274. * Get a navigation mesh constrained position, closest to the parameter position
  145275. * @param position world position
  145276. * @returns the closest point to position constrained by the navigation mesh
  145277. */
  145278. getClosestPoint(position: Vector3): Vector3;
  145279. /**
  145280. * Get a navigation mesh constrained position, closest to the parameter position
  145281. * @param position world position
  145282. * @param result output the closest point to position constrained by the navigation mesh
  145283. */
  145284. getClosestPointToRef(position: Vector3, result: Vector3): void;
  145285. /**
  145286. * Get a navigation mesh constrained position, within a particular radius
  145287. * @param position world position
  145288. * @param maxRadius the maximum distance to the constrained world position
  145289. * @returns the closest point to position constrained by the navigation mesh
  145290. */
  145291. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  145292. /**
  145293. * Get a navigation mesh constrained position, within a particular radius
  145294. * @param position world position
  145295. * @param maxRadius the maximum distance to the constrained world position
  145296. * @param result output the closest point to position constrained by the navigation mesh
  145297. */
  145298. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  145299. /**
  145300. * Compute the final position from a segment made of destination-position
  145301. * @param position world position
  145302. * @param destination world position
  145303. * @returns the resulting point along the navmesh
  145304. */
  145305. moveAlong(position: Vector3, destination: Vector3): Vector3;
  145306. /**
  145307. * Compute the final position from a segment made of destination-position
  145308. * @param position world position
  145309. * @param destination world position
  145310. * @param result output the resulting point along the navmesh
  145311. */
  145312. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  145313. /**
  145314. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  145315. * @param start world position
  145316. * @param end world position
  145317. * @returns array containing world position composing the path
  145318. */
  145319. computePath(start: Vector3, end: Vector3): Vector3[];
  145320. /**
  145321. * Create a new Crowd so you can add agents
  145322. * @param maxAgents the maximum agent count in the crowd
  145323. * @param maxAgentRadius the maximum radius an agent can have
  145324. * @param scene to attach the crowd to
  145325. * @returns the crowd you can add agents to
  145326. */
  145327. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  145328. /**
  145329. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145330. * The queries will try to find a solution within those bounds
  145331. * default is (1,1,1)
  145332. * @param extent x,y,z value that define the extent around the queries point of reference
  145333. */
  145334. setDefaultQueryExtent(extent: Vector3): void;
  145335. /**
  145336. * Get the Bounding box extent specified by setDefaultQueryExtent
  145337. * @returns the box extent values
  145338. */
  145339. getDefaultQueryExtent(): Vector3;
  145340. /**
  145341. * build the navmesh from a previously saved state using getNavmeshData
  145342. * @param data the Uint8Array returned by getNavmeshData
  145343. */
  145344. buildFromNavmeshData(data: Uint8Array): void;
  145345. /**
  145346. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  145347. * @returns data the Uint8Array that can be saved and reused
  145348. */
  145349. getNavmeshData(): Uint8Array;
  145350. /**
  145351. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145352. * @param result output the box extent values
  145353. */
  145354. getDefaultQueryExtentToRef(result: Vector3): void;
  145355. /**
  145356. * Disposes
  145357. */
  145358. dispose(): void;
  145359. /**
  145360. * If this plugin is supported
  145361. * @returns true if plugin is supported
  145362. */
  145363. isSupported(): boolean;
  145364. }
  145365. /**
  145366. * Recast detour crowd implementation
  145367. */
  145368. export class RecastJSCrowd implements ICrowd {
  145369. /**
  145370. * Recast/detour plugin
  145371. */
  145372. bjsRECASTPlugin: RecastJSPlugin;
  145373. /**
  145374. * Link to the detour crowd
  145375. */
  145376. recastCrowd: any;
  145377. /**
  145378. * One transform per agent
  145379. */
  145380. transforms: TransformNode[];
  145381. /**
  145382. * All agents created
  145383. */
  145384. agents: number[];
  145385. /**
  145386. * Link to the scene is kept to unregister the crowd from the scene
  145387. */
  145388. private _scene;
  145389. /**
  145390. * Observer for crowd updates
  145391. */
  145392. private _onBeforeAnimationsObserver;
  145393. /**
  145394. * Constructor
  145395. * @param plugin recastJS plugin
  145396. * @param maxAgents the maximum agent count in the crowd
  145397. * @param maxAgentRadius the maximum radius an agent can have
  145398. * @param scene to attach the crowd to
  145399. * @returns the crowd you can add agents to
  145400. */
  145401. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  145402. /**
  145403. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  145404. * You can attach anything to that node. The node position is updated in the scene update tick.
  145405. * @param pos world position that will be constrained by the navigation mesh
  145406. * @param parameters agent parameters
  145407. * @param transform hooked to the agent that will be update by the scene
  145408. * @returns agent index
  145409. */
  145410. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  145411. /**
  145412. * Returns the agent position in world space
  145413. * @param index agent index returned by addAgent
  145414. * @returns world space position
  145415. */
  145416. getAgentPosition(index: number): Vector3;
  145417. /**
  145418. * Returns the agent position result in world space
  145419. * @param index agent index returned by addAgent
  145420. * @param result output world space position
  145421. */
  145422. getAgentPositionToRef(index: number, result: Vector3): void;
  145423. /**
  145424. * Returns the agent velocity in world space
  145425. * @param index agent index returned by addAgent
  145426. * @returns world space velocity
  145427. */
  145428. getAgentVelocity(index: number): Vector3;
  145429. /**
  145430. * Returns the agent velocity result in world space
  145431. * @param index agent index returned by addAgent
  145432. * @param result output world space velocity
  145433. */
  145434. getAgentVelocityToRef(index: number, result: Vector3): void;
  145435. /**
  145436. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  145437. * @param index agent index returned by addAgent
  145438. * @param destination targeted world position
  145439. */
  145440. agentGoto(index: number, destination: Vector3): void;
  145441. /**
  145442. * Teleport the agent to a new position
  145443. * @param index agent index returned by addAgent
  145444. * @param destination targeted world position
  145445. */
  145446. agentTeleport(index: number, destination: Vector3): void;
  145447. /**
  145448. * Update agent parameters
  145449. * @param index agent index returned by addAgent
  145450. * @param parameters agent parameters
  145451. */
  145452. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  145453. /**
  145454. * remove a particular agent previously created
  145455. * @param index agent index returned by addAgent
  145456. */
  145457. removeAgent(index: number): void;
  145458. /**
  145459. * get the list of all agents attached to this crowd
  145460. * @returns list of agent indices
  145461. */
  145462. getAgents(): number[];
  145463. /**
  145464. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  145465. * @param deltaTime in seconds
  145466. */
  145467. update(deltaTime: number): void;
  145468. /**
  145469. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145470. * The queries will try to find a solution within those bounds
  145471. * default is (1,1,1)
  145472. * @param extent x,y,z value that define the extent around the queries point of reference
  145473. */
  145474. setDefaultQueryExtent(extent: Vector3): void;
  145475. /**
  145476. * Get the Bounding box extent specified by setDefaultQueryExtent
  145477. * @returns the box extent values
  145478. */
  145479. getDefaultQueryExtent(): Vector3;
  145480. /**
  145481. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145482. * @param result output the box extent values
  145483. */
  145484. getDefaultQueryExtentToRef(result: Vector3): void;
  145485. /**
  145486. * Release all resources
  145487. */
  145488. dispose(): void;
  145489. }
  145490. }
  145491. declare module BABYLON {
  145492. /**
  145493. * Class used to enable access to IndexedDB
  145494. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  145495. */
  145496. export class Database implements IOfflineProvider {
  145497. private _callbackManifestChecked;
  145498. private _currentSceneUrl;
  145499. private _db;
  145500. private _enableSceneOffline;
  145501. private _enableTexturesOffline;
  145502. private _manifestVersionFound;
  145503. private _mustUpdateRessources;
  145504. private _hasReachedQuota;
  145505. private _isSupported;
  145506. private _idbFactory;
  145507. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  145508. private static IsUASupportingBlobStorage;
  145509. /**
  145510. * Gets a boolean indicating if Database storate is enabled (off by default)
  145511. */
  145512. static IDBStorageEnabled: boolean;
  145513. /**
  145514. * Gets a boolean indicating if scene must be saved in the database
  145515. */
  145516. get enableSceneOffline(): boolean;
  145517. /**
  145518. * Gets a boolean indicating if textures must be saved in the database
  145519. */
  145520. get enableTexturesOffline(): boolean;
  145521. /**
  145522. * Creates a new Database
  145523. * @param urlToScene defines the url to load the scene
  145524. * @param callbackManifestChecked defines the callback to use when manifest is checked
  145525. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  145526. */
  145527. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  145528. private static _ParseURL;
  145529. private static _ReturnFullUrlLocation;
  145530. private _checkManifestFile;
  145531. /**
  145532. * Open the database and make it available
  145533. * @param successCallback defines the callback to call on success
  145534. * @param errorCallback defines the callback to call on error
  145535. */
  145536. open(successCallback: () => void, errorCallback: () => void): void;
  145537. /**
  145538. * Loads an image from the database
  145539. * @param url defines the url to load from
  145540. * @param image defines the target DOM image
  145541. */
  145542. loadImage(url: string, image: HTMLImageElement): void;
  145543. private _loadImageFromDBAsync;
  145544. private _saveImageIntoDBAsync;
  145545. private _checkVersionFromDB;
  145546. private _loadVersionFromDBAsync;
  145547. private _saveVersionIntoDBAsync;
  145548. /**
  145549. * Loads a file from database
  145550. * @param url defines the URL to load from
  145551. * @param sceneLoaded defines a callback to call on success
  145552. * @param progressCallBack defines a callback to call when progress changed
  145553. * @param errorCallback defines a callback to call on error
  145554. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  145555. */
  145556. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  145557. private _loadFileAsync;
  145558. private _saveFileAsync;
  145559. /**
  145560. * Validates if xhr data is correct
  145561. * @param xhr defines the request to validate
  145562. * @param dataType defines the expected data type
  145563. * @returns true if data is correct
  145564. */
  145565. private static _ValidateXHRData;
  145566. }
  145567. }
  145568. declare module BABYLON {
  145569. /** @hidden */
  145570. export var gpuUpdateParticlesPixelShader: {
  145571. name: string;
  145572. shader: string;
  145573. };
  145574. }
  145575. declare module BABYLON {
  145576. /** @hidden */
  145577. export var gpuUpdateParticlesVertexShader: {
  145578. name: string;
  145579. shader: string;
  145580. };
  145581. }
  145582. declare module BABYLON {
  145583. /** @hidden */
  145584. export var clipPlaneFragmentDeclaration2: {
  145585. name: string;
  145586. shader: string;
  145587. };
  145588. }
  145589. declare module BABYLON {
  145590. /** @hidden */
  145591. export var gpuRenderParticlesPixelShader: {
  145592. name: string;
  145593. shader: string;
  145594. };
  145595. }
  145596. declare module BABYLON {
  145597. /** @hidden */
  145598. export var clipPlaneVertexDeclaration2: {
  145599. name: string;
  145600. shader: string;
  145601. };
  145602. }
  145603. declare module BABYLON {
  145604. /** @hidden */
  145605. export var gpuRenderParticlesVertexShader: {
  145606. name: string;
  145607. shader: string;
  145608. };
  145609. }
  145610. declare module BABYLON {
  145611. /**
  145612. * This represents a GPU particle system in Babylon
  145613. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  145614. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  145615. */
  145616. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  145617. /**
  145618. * The layer mask we are rendering the particles through.
  145619. */
  145620. layerMask: number;
  145621. private _capacity;
  145622. private _activeCount;
  145623. private _currentActiveCount;
  145624. private _accumulatedCount;
  145625. private _renderEffect;
  145626. private _updateEffect;
  145627. private _buffer0;
  145628. private _buffer1;
  145629. private _spriteBuffer;
  145630. private _updateVAO;
  145631. private _renderVAO;
  145632. private _targetIndex;
  145633. private _sourceBuffer;
  145634. private _targetBuffer;
  145635. private _engine;
  145636. private _currentRenderId;
  145637. private _started;
  145638. private _stopped;
  145639. private _timeDelta;
  145640. private _randomTexture;
  145641. private _randomTexture2;
  145642. private _attributesStrideSize;
  145643. private _updateEffectOptions;
  145644. private _randomTextureSize;
  145645. private _actualFrame;
  145646. private _customEffect;
  145647. private readonly _rawTextureWidth;
  145648. /**
  145649. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  145650. */
  145651. static get IsSupported(): boolean;
  145652. /**
  145653. * An event triggered when the system is disposed.
  145654. */
  145655. onDisposeObservable: Observable<IParticleSystem>;
  145656. /**
  145657. * Gets the maximum number of particles active at the same time.
  145658. * @returns The max number of active particles.
  145659. */
  145660. getCapacity(): number;
  145661. /**
  145662. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  145663. * to override the particles.
  145664. */
  145665. forceDepthWrite: boolean;
  145666. /**
  145667. * Gets or set the number of active particles
  145668. */
  145669. get activeParticleCount(): number;
  145670. set activeParticleCount(value: number);
  145671. private _preWarmDone;
  145672. /**
  145673. * Specifies if the particles are updated in emitter local space or world space.
  145674. */
  145675. isLocal: boolean;
  145676. /**
  145677. * Is this system ready to be used/rendered
  145678. * @return true if the system is ready
  145679. */
  145680. isReady(): boolean;
  145681. /**
  145682. * Gets if the system has been started. (Note: this will still be true after stop is called)
  145683. * @returns True if it has been started, otherwise false.
  145684. */
  145685. isStarted(): boolean;
  145686. /**
  145687. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  145688. * @returns True if it has been stopped, otherwise false.
  145689. */
  145690. isStopped(): boolean;
  145691. /**
  145692. * Gets a boolean indicating that the system is stopping
  145693. * @returns true if the system is currently stopping
  145694. */
  145695. isStopping(): boolean;
  145696. /**
  145697. * Gets the number of particles active at the same time.
  145698. * @returns The number of active particles.
  145699. */
  145700. getActiveCount(): number;
  145701. /**
  145702. * Starts the particle system and begins to emit
  145703. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  145704. */
  145705. start(delay?: number): void;
  145706. /**
  145707. * Stops the particle system.
  145708. */
  145709. stop(): void;
  145710. /**
  145711. * Remove all active particles
  145712. */
  145713. reset(): void;
  145714. /**
  145715. * Returns the string "GPUParticleSystem"
  145716. * @returns a string containing the class name
  145717. */
  145718. getClassName(): string;
  145719. /**
  145720. * Gets the custom effect used to render the particles
  145721. * @param blendMode Blend mode for which the effect should be retrieved
  145722. * @returns The effect
  145723. */
  145724. getCustomEffect(blendMode?: number): Nullable<Effect>;
  145725. /**
  145726. * Sets the custom effect used to render the particles
  145727. * @param effect The effect to set
  145728. * @param blendMode Blend mode for which the effect should be set
  145729. */
  145730. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  145731. /** @hidden */
  145732. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  145733. /**
  145734. * Observable that will be called just before the particles are drawn
  145735. */
  145736. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  145737. /**
  145738. * Gets the name of the particle vertex shader
  145739. */
  145740. get vertexShaderName(): string;
  145741. private _colorGradientsTexture;
  145742. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  145743. /**
  145744. * Adds a new color gradient
  145745. * @param gradient defines the gradient to use (between 0 and 1)
  145746. * @param color1 defines the color to affect to the specified gradient
  145747. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  145748. * @returns the current particle system
  145749. */
  145750. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  145751. private _refreshColorGradient;
  145752. /** Force the system to rebuild all gradients that need to be resync */
  145753. forceRefreshGradients(): void;
  145754. /**
  145755. * Remove a specific color gradient
  145756. * @param gradient defines the gradient to remove
  145757. * @returns the current particle system
  145758. */
  145759. removeColorGradient(gradient: number): GPUParticleSystem;
  145760. private _angularSpeedGradientsTexture;
  145761. private _sizeGradientsTexture;
  145762. private _velocityGradientsTexture;
  145763. private _limitVelocityGradientsTexture;
  145764. private _dragGradientsTexture;
  145765. private _addFactorGradient;
  145766. /**
  145767. * Adds a new size gradient
  145768. * @param gradient defines the gradient to use (between 0 and 1)
  145769. * @param factor defines the size factor to affect to the specified gradient
  145770. * @returns the current particle system
  145771. */
  145772. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  145773. /**
  145774. * Remove a specific size gradient
  145775. * @param gradient defines the gradient to remove
  145776. * @returns the current particle system
  145777. */
  145778. removeSizeGradient(gradient: number): GPUParticleSystem;
  145779. private _refreshFactorGradient;
  145780. /**
  145781. * Adds a new angular speed gradient
  145782. * @param gradient defines the gradient to use (between 0 and 1)
  145783. * @param factor defines the angular speed to affect to the specified gradient
  145784. * @returns the current particle system
  145785. */
  145786. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  145787. /**
  145788. * Remove a specific angular speed gradient
  145789. * @param gradient defines the gradient to remove
  145790. * @returns the current particle system
  145791. */
  145792. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  145793. /**
  145794. * Adds a new velocity gradient
  145795. * @param gradient defines the gradient to use (between 0 and 1)
  145796. * @param factor defines the velocity to affect to the specified gradient
  145797. * @returns the current particle system
  145798. */
  145799. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  145800. /**
  145801. * Remove a specific velocity gradient
  145802. * @param gradient defines the gradient to remove
  145803. * @returns the current particle system
  145804. */
  145805. removeVelocityGradient(gradient: number): GPUParticleSystem;
  145806. /**
  145807. * Adds a new limit velocity gradient
  145808. * @param gradient defines the gradient to use (between 0 and 1)
  145809. * @param factor defines the limit velocity value to affect to the specified gradient
  145810. * @returns the current particle system
  145811. */
  145812. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  145813. /**
  145814. * Remove a specific limit velocity gradient
  145815. * @param gradient defines the gradient to remove
  145816. * @returns the current particle system
  145817. */
  145818. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  145819. /**
  145820. * Adds a new drag gradient
  145821. * @param gradient defines the gradient to use (between 0 and 1)
  145822. * @param factor defines the drag value to affect to the specified gradient
  145823. * @returns the current particle system
  145824. */
  145825. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  145826. /**
  145827. * Remove a specific drag gradient
  145828. * @param gradient defines the gradient to remove
  145829. * @returns the current particle system
  145830. */
  145831. removeDragGradient(gradient: number): GPUParticleSystem;
  145832. /**
  145833. * Not supported by GPUParticleSystem
  145834. * @param gradient defines the gradient to use (between 0 and 1)
  145835. * @param factor defines the emit rate value to affect to the specified gradient
  145836. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145837. * @returns the current particle system
  145838. */
  145839. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145840. /**
  145841. * Not supported by GPUParticleSystem
  145842. * @param gradient defines the gradient to remove
  145843. * @returns the current particle system
  145844. */
  145845. removeEmitRateGradient(gradient: number): IParticleSystem;
  145846. /**
  145847. * Not supported by GPUParticleSystem
  145848. * @param gradient defines the gradient to use (between 0 and 1)
  145849. * @param factor defines the start size value to affect to the specified gradient
  145850. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145851. * @returns the current particle system
  145852. */
  145853. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145854. /**
  145855. * Not supported by GPUParticleSystem
  145856. * @param gradient defines the gradient to remove
  145857. * @returns the current particle system
  145858. */
  145859. removeStartSizeGradient(gradient: number): IParticleSystem;
  145860. /**
  145861. * Not supported by GPUParticleSystem
  145862. * @param gradient defines the gradient to use (between 0 and 1)
  145863. * @param min defines the color remap minimal range
  145864. * @param max defines the color remap maximal range
  145865. * @returns the current particle system
  145866. */
  145867. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  145868. /**
  145869. * Not supported by GPUParticleSystem
  145870. * @param gradient defines the gradient to remove
  145871. * @returns the current particle system
  145872. */
  145873. removeColorRemapGradient(): IParticleSystem;
  145874. /**
  145875. * Not supported by GPUParticleSystem
  145876. * @param gradient defines the gradient to use (between 0 and 1)
  145877. * @param min defines the alpha remap minimal range
  145878. * @param max defines the alpha remap maximal range
  145879. * @returns the current particle system
  145880. */
  145881. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  145882. /**
  145883. * Not supported by GPUParticleSystem
  145884. * @param gradient defines the gradient to remove
  145885. * @returns the current particle system
  145886. */
  145887. removeAlphaRemapGradient(): IParticleSystem;
  145888. /**
  145889. * Not supported by GPUParticleSystem
  145890. * @param gradient defines the gradient to use (between 0 and 1)
  145891. * @param color defines the color to affect to the specified gradient
  145892. * @returns the current particle system
  145893. */
  145894. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  145895. /**
  145896. * Not supported by GPUParticleSystem
  145897. * @param gradient defines the gradient to remove
  145898. * @returns the current particle system
  145899. */
  145900. removeRampGradient(): IParticleSystem;
  145901. /**
  145902. * Not supported by GPUParticleSystem
  145903. * @returns the list of ramp gradients
  145904. */
  145905. getRampGradients(): Nullable<Array<Color3Gradient>>;
  145906. /**
  145907. * Not supported by GPUParticleSystem
  145908. * Gets or sets a boolean indicating that ramp gradients must be used
  145909. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  145910. */
  145911. get useRampGradients(): boolean;
  145912. set useRampGradients(value: boolean);
  145913. /**
  145914. * Not supported by GPUParticleSystem
  145915. * @param gradient defines the gradient to use (between 0 and 1)
  145916. * @param factor defines the life time factor to affect to the specified gradient
  145917. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145918. * @returns the current particle system
  145919. */
  145920. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145921. /**
  145922. * Not supported by GPUParticleSystem
  145923. * @param gradient defines the gradient to remove
  145924. * @returns the current particle system
  145925. */
  145926. removeLifeTimeGradient(gradient: number): IParticleSystem;
  145927. /**
  145928. * Instantiates a GPU particle system.
  145929. * 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.
  145930. * @param name The name of the particle system
  145931. * @param options The options used to create the system
  145932. * @param scene The scene the particle system belongs to
  145933. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  145934. * @param customEffect a custom effect used to change the way particles are rendered by default
  145935. */
  145936. constructor(name: string, options: Partial<{
  145937. capacity: number;
  145938. randomTextureSize: number;
  145939. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  145940. protected _reset(): void;
  145941. private _createUpdateVAO;
  145942. private _createRenderVAO;
  145943. private _initialize;
  145944. /** @hidden */
  145945. _recreateUpdateEffect(): void;
  145946. private _getEffect;
  145947. /**
  145948. * Fill the defines array according to the current settings of the particle system
  145949. * @param defines Array to be updated
  145950. * @param blendMode blend mode to take into account when updating the array
  145951. */
  145952. fillDefines(defines: Array<string>, blendMode?: number): void;
  145953. /**
  145954. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  145955. * @param uniforms Uniforms array to fill
  145956. * @param attributes Attributes array to fill
  145957. * @param samplers Samplers array to fill
  145958. */
  145959. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  145960. /** @hidden */
  145961. _recreateRenderEffect(): Effect;
  145962. /**
  145963. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  145964. * @param preWarm defines if we are in the pre-warmimg phase
  145965. */
  145966. animate(preWarm?: boolean): void;
  145967. private _createFactorGradientTexture;
  145968. private _createSizeGradientTexture;
  145969. private _createAngularSpeedGradientTexture;
  145970. private _createVelocityGradientTexture;
  145971. private _createLimitVelocityGradientTexture;
  145972. private _createDragGradientTexture;
  145973. private _createColorGradientTexture;
  145974. /**
  145975. * Renders the particle system in its current state
  145976. * @param preWarm defines if the system should only update the particles but not render them
  145977. * @returns the current number of particles
  145978. */
  145979. render(preWarm?: boolean): number;
  145980. /**
  145981. * Rebuilds the particle system
  145982. */
  145983. rebuild(): void;
  145984. private _releaseBuffers;
  145985. private _releaseVAOs;
  145986. /**
  145987. * Disposes the particle system and free the associated resources
  145988. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  145989. */
  145990. dispose(disposeTexture?: boolean): void;
  145991. /**
  145992. * Clones the particle system.
  145993. * @param name The name of the cloned object
  145994. * @param newEmitter The new emitter to use
  145995. * @returns the cloned particle system
  145996. */
  145997. clone(name: string, newEmitter: any): GPUParticleSystem;
  145998. /**
  145999. * Serializes the particle system to a JSON object
  146000. * @param serializeTexture defines if the texture must be serialized as well
  146001. * @returns the JSON object
  146002. */
  146003. serialize(serializeTexture?: boolean): any;
  146004. /**
  146005. * Parses a JSON object to create a GPU particle system.
  146006. * @param parsedParticleSystem The JSON object to parse
  146007. * @param scene The scene to create the particle system in
  146008. * @param rootUrl The root url to use to load external dependencies like texture
  146009. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  146010. * @returns the parsed GPU particle system
  146011. */
  146012. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  146013. }
  146014. }
  146015. declare module BABYLON {
  146016. /**
  146017. * Represents a set of particle systems working together to create a specific effect
  146018. */
  146019. export class ParticleSystemSet implements IDisposable {
  146020. /**
  146021. * Gets or sets base Assets URL
  146022. */
  146023. static BaseAssetsUrl: string;
  146024. private _emitterCreationOptions;
  146025. private _emitterNode;
  146026. /**
  146027. * Gets the particle system list
  146028. */
  146029. systems: IParticleSystem[];
  146030. /**
  146031. * Gets the emitter node used with this set
  146032. */
  146033. get emitterNode(): Nullable<TransformNode>;
  146034. /**
  146035. * Creates a new emitter mesh as a sphere
  146036. * @param options defines the options used to create the sphere
  146037. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  146038. * @param scene defines the hosting scene
  146039. */
  146040. setEmitterAsSphere(options: {
  146041. diameter: number;
  146042. segments: number;
  146043. color: Color3;
  146044. }, renderingGroupId: number, scene: Scene): void;
  146045. /**
  146046. * Starts all particle systems of the set
  146047. * @param emitter defines an optional mesh to use as emitter for the particle systems
  146048. */
  146049. start(emitter?: AbstractMesh): void;
  146050. /**
  146051. * Release all associated resources
  146052. */
  146053. dispose(): void;
  146054. /**
  146055. * Serialize the set into a JSON compatible object
  146056. * @param serializeTexture defines if the texture must be serialized as well
  146057. * @returns a JSON compatible representation of the set
  146058. */
  146059. serialize(serializeTexture?: boolean): any;
  146060. /**
  146061. * Parse a new ParticleSystemSet from a serialized source
  146062. * @param data defines a JSON compatible representation of the set
  146063. * @param scene defines the hosting scene
  146064. * @param gpu defines if we want GPU particles or CPU particles
  146065. * @returns a new ParticleSystemSet
  146066. */
  146067. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  146068. }
  146069. }
  146070. declare module BABYLON {
  146071. /**
  146072. * This class is made for on one-liner static method to help creating particle system set.
  146073. */
  146074. export class ParticleHelper {
  146075. /**
  146076. * Gets or sets base Assets URL
  146077. */
  146078. static BaseAssetsUrl: string;
  146079. /** Define the Url to load snippets */
  146080. static SnippetUrl: string;
  146081. /**
  146082. * Create a default particle system that you can tweak
  146083. * @param emitter defines the emitter to use
  146084. * @param capacity defines the system capacity (default is 500 particles)
  146085. * @param scene defines the hosting scene
  146086. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  146087. * @returns the new Particle system
  146088. */
  146089. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  146090. /**
  146091. * This is the main static method (one-liner) of this helper to create different particle systems
  146092. * @param type This string represents the type to the particle system to create
  146093. * @param scene The scene where the particle system should live
  146094. * @param gpu If the system will use gpu
  146095. * @returns the ParticleSystemSet created
  146096. */
  146097. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  146098. /**
  146099. * Static function used to export a particle system to a ParticleSystemSet variable.
  146100. * Please note that the emitter shape is not exported
  146101. * @param systems defines the particle systems to export
  146102. * @returns the created particle system set
  146103. */
  146104. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  146105. /**
  146106. * Creates a particle system from a snippet saved in a remote file
  146107. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  146108. * @param url defines the url to load from
  146109. * @param scene defines the hosting scene
  146110. * @param gpu If the system will use gpu
  146111. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  146112. * @returns a promise that will resolve to the new particle system
  146113. */
  146114. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  146115. /**
  146116. * Creates a particle system from a snippet saved by the particle system editor
  146117. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  146118. * @param scene defines the hosting scene
  146119. * @param gpu If the system will use gpu
  146120. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  146121. * @returns a promise that will resolve to the new particle system
  146122. */
  146123. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  146124. }
  146125. }
  146126. declare module BABYLON {
  146127. interface Engine {
  146128. /**
  146129. * Create an effect to use with particle systems.
  146130. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  146131. * the particle system for which you want to create a custom effect in the last parameter
  146132. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  146133. * @param uniformsNames defines a list of attribute names
  146134. * @param samplers defines an array of string used to represent textures
  146135. * @param defines defines the string containing the defines to use to compile the shaders
  146136. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  146137. * @param onCompiled defines a function to call when the effect creation is successful
  146138. * @param onError defines a function to call when the effect creation has failed
  146139. * @param particleSystem the particle system you want to create the effect for
  146140. * @returns the new Effect
  146141. */
  146142. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  146143. }
  146144. interface Mesh {
  146145. /**
  146146. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  146147. * @returns an array of IParticleSystem
  146148. */
  146149. getEmittedParticleSystems(): IParticleSystem[];
  146150. /**
  146151. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  146152. * @returns an array of IParticleSystem
  146153. */
  146154. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  146155. }
  146156. }
  146157. declare module BABYLON {
  146158. /** Defines the 4 color options */
  146159. export enum PointColor {
  146160. /** color value */
  146161. Color = 2,
  146162. /** uv value */
  146163. UV = 1,
  146164. /** random value */
  146165. Random = 0,
  146166. /** stated value */
  146167. Stated = 3
  146168. }
  146169. /**
  146170. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  146171. * 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.
  146172. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  146173. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  146174. *
  146175. * Full documentation here : TO BE ENTERED
  146176. */
  146177. export class PointsCloudSystem implements IDisposable {
  146178. /**
  146179. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  146180. * Example : var p = SPS.particles[i];
  146181. */
  146182. particles: CloudPoint[];
  146183. /**
  146184. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  146185. */
  146186. nbParticles: number;
  146187. /**
  146188. * This a counter for your own usage. It's not set by any SPS functions.
  146189. */
  146190. counter: number;
  146191. /**
  146192. * The PCS name. This name is also given to the underlying mesh.
  146193. */
  146194. name: string;
  146195. /**
  146196. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  146197. */
  146198. mesh: Mesh;
  146199. /**
  146200. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  146201. * Please read :
  146202. */
  146203. vars: any;
  146204. /**
  146205. * @hidden
  146206. */
  146207. _size: number;
  146208. private _scene;
  146209. private _promises;
  146210. private _positions;
  146211. private _indices;
  146212. private _normals;
  146213. private _colors;
  146214. private _uvs;
  146215. private _indices32;
  146216. private _positions32;
  146217. private _colors32;
  146218. private _uvs32;
  146219. private _updatable;
  146220. private _isVisibilityBoxLocked;
  146221. private _alwaysVisible;
  146222. private _groups;
  146223. private _groupCounter;
  146224. private _computeParticleColor;
  146225. private _computeParticleTexture;
  146226. private _computeParticleRotation;
  146227. private _computeBoundingBox;
  146228. private _isReady;
  146229. /**
  146230. * Creates a PCS (Points Cloud System) object
  146231. * @param name (String) is the PCS name, this will be the underlying mesh name
  146232. * @param pointSize (number) is the size for each point
  146233. * @param scene (Scene) is the scene in which the PCS is added
  146234. * @param options defines the options of the PCS e.g.
  146235. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  146236. */
  146237. constructor(name: string, pointSize: number, scene: Scene, options?: {
  146238. updatable?: boolean;
  146239. });
  146240. /**
  146241. * Builds the PCS underlying mesh. Returns a standard Mesh.
  146242. * If no points were added to the PCS, the returned mesh is just a single point.
  146243. * @returns a promise for the created mesh
  146244. */
  146245. buildMeshAsync(): Promise<Mesh>;
  146246. /**
  146247. * @hidden
  146248. */
  146249. private _buildMesh;
  146250. private _addParticle;
  146251. private _randomUnitVector;
  146252. private _getColorIndicesForCoord;
  146253. private _setPointsColorOrUV;
  146254. private _colorFromTexture;
  146255. private _calculateDensity;
  146256. /**
  146257. * Adds points to the PCS in random positions within a unit sphere
  146258. * @param nb (positive integer) the number of particles to be created from this model
  146259. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  146260. * @returns the number of groups in the system
  146261. */
  146262. addPoints(nb: number, pointFunction?: any): number;
  146263. /**
  146264. * Adds points to the PCS from the surface of the model shape
  146265. * @param mesh is any Mesh object that will be used as a surface model for the points
  146266. * @param nb (positive integer) the number of particles to be created from this model
  146267. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  146268. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  146269. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  146270. * @returns the number of groups in the system
  146271. */
  146272. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  146273. /**
  146274. * Adds points to the PCS inside the model shape
  146275. * @param mesh is any Mesh object that will be used as a surface model for the points
  146276. * @param nb (positive integer) the number of particles to be created from this model
  146277. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  146278. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  146279. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  146280. * @returns the number of groups in the system
  146281. */
  146282. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  146283. /**
  146284. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  146285. * This method calls `updateParticle()` for each particle of the SPS.
  146286. * For an animated SPS, it is usually called within the render loop.
  146287. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  146288. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  146289. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  146290. * @returns the PCS.
  146291. */
  146292. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  146293. /**
  146294. * Disposes the PCS.
  146295. */
  146296. dispose(): void;
  146297. /**
  146298. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  146299. * doc :
  146300. * @returns the PCS.
  146301. */
  146302. refreshVisibleSize(): PointsCloudSystem;
  146303. /**
  146304. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  146305. * @param size the size (float) of the visibility box
  146306. * note : this doesn't lock the PCS mesh bounding box.
  146307. * doc :
  146308. */
  146309. setVisibilityBox(size: number): void;
  146310. /**
  146311. * Gets whether the PCS is always visible or not
  146312. * doc :
  146313. */
  146314. get isAlwaysVisible(): boolean;
  146315. /**
  146316. * Sets the PCS as always visible or not
  146317. * doc :
  146318. */
  146319. set isAlwaysVisible(val: boolean);
  146320. /**
  146321. * Tells to `setParticles()` to compute the particle rotations or not
  146322. * Default value : false. The PCS is faster when it's set to false
  146323. * Note : particle rotations are only applied to parent particles
  146324. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  146325. */
  146326. set computeParticleRotation(val: boolean);
  146327. /**
  146328. * Tells to `setParticles()` to compute the particle colors or not.
  146329. * Default value : true. The PCS is faster when it's set to false.
  146330. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  146331. */
  146332. set computeParticleColor(val: boolean);
  146333. set computeParticleTexture(val: boolean);
  146334. /**
  146335. * Gets if `setParticles()` computes the particle colors or not.
  146336. * Default value : false. The PCS is faster when it's set to false.
  146337. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  146338. */
  146339. get computeParticleColor(): boolean;
  146340. /**
  146341. * Gets if `setParticles()` computes the particle textures or not.
  146342. * Default value : false. The PCS is faster when it's set to false.
  146343. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  146344. */
  146345. get computeParticleTexture(): boolean;
  146346. /**
  146347. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  146348. */
  146349. set computeBoundingBox(val: boolean);
  146350. /**
  146351. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  146352. */
  146353. get computeBoundingBox(): boolean;
  146354. /**
  146355. * This function does nothing. It may be overwritten to set all the particle first values.
  146356. * The PCS doesn't call this function, you may have to call it by your own.
  146357. * doc :
  146358. */
  146359. initParticles(): void;
  146360. /**
  146361. * This function does nothing. It may be overwritten to recycle a particle
  146362. * The PCS doesn't call this function, you can to call it
  146363. * doc :
  146364. * @param particle The particle to recycle
  146365. * @returns the recycled particle
  146366. */
  146367. recycleParticle(particle: CloudPoint): CloudPoint;
  146368. /**
  146369. * Updates a particle : this function should be overwritten by the user.
  146370. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  146371. * doc :
  146372. * @example : just set a particle position or velocity and recycle conditions
  146373. * @param particle The particle to update
  146374. * @returns the updated particle
  146375. */
  146376. updateParticle(particle: CloudPoint): CloudPoint;
  146377. /**
  146378. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  146379. * This does nothing and may be overwritten by the user.
  146380. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  146381. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  146382. * @param update the boolean update value actually passed to setParticles()
  146383. */
  146384. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  146385. /**
  146386. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  146387. * This will be passed three parameters.
  146388. * This does nothing and may be overwritten by the user.
  146389. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  146390. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  146391. * @param update the boolean update value actually passed to setParticles()
  146392. */
  146393. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  146394. }
  146395. }
  146396. declare module BABYLON {
  146397. /**
  146398. * Represents one particle of a points cloud system.
  146399. */
  146400. export class CloudPoint {
  146401. /**
  146402. * particle global index
  146403. */
  146404. idx: number;
  146405. /**
  146406. * The color of the particle
  146407. */
  146408. color: Nullable<Color4>;
  146409. /**
  146410. * The world space position of the particle.
  146411. */
  146412. position: Vector3;
  146413. /**
  146414. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  146415. */
  146416. rotation: Vector3;
  146417. /**
  146418. * The world space rotation quaternion of the particle.
  146419. */
  146420. rotationQuaternion: Nullable<Quaternion>;
  146421. /**
  146422. * The uv of the particle.
  146423. */
  146424. uv: Nullable<Vector2>;
  146425. /**
  146426. * The current speed of the particle.
  146427. */
  146428. velocity: Vector3;
  146429. /**
  146430. * The pivot point in the particle local space.
  146431. */
  146432. pivot: Vector3;
  146433. /**
  146434. * Must the particle be translated from its pivot point in its local space ?
  146435. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  146436. * Default : false
  146437. */
  146438. translateFromPivot: boolean;
  146439. /**
  146440. * Index of this particle in the global "positions" array (Internal use)
  146441. * @hidden
  146442. */
  146443. _pos: number;
  146444. /**
  146445. * @hidden Index of this particle in the global "indices" array (Internal use)
  146446. */
  146447. _ind: number;
  146448. /**
  146449. * Group this particle belongs to
  146450. */
  146451. _group: PointsGroup;
  146452. /**
  146453. * Group id of this particle
  146454. */
  146455. groupId: number;
  146456. /**
  146457. * Index of the particle in its group id (Internal use)
  146458. */
  146459. idxInGroup: number;
  146460. /**
  146461. * @hidden Particle BoundingInfo object (Internal use)
  146462. */
  146463. _boundingInfo: BoundingInfo;
  146464. /**
  146465. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  146466. */
  146467. _pcs: PointsCloudSystem;
  146468. /**
  146469. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  146470. */
  146471. _stillInvisible: boolean;
  146472. /**
  146473. * @hidden Last computed particle rotation matrix
  146474. */
  146475. _rotationMatrix: number[];
  146476. /**
  146477. * Parent particle Id, if any.
  146478. * Default null.
  146479. */
  146480. parentId: Nullable<number>;
  146481. /**
  146482. * @hidden Internal global position in the PCS.
  146483. */
  146484. _globalPosition: Vector3;
  146485. /**
  146486. * Creates a Point Cloud object.
  146487. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  146488. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  146489. * @param group (PointsGroup) is the group the particle belongs to
  146490. * @param groupId (integer) is the group identifier in the PCS.
  146491. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  146492. * @param pcs defines the PCS it is associated to
  146493. */
  146494. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  146495. /**
  146496. * get point size
  146497. */
  146498. get size(): Vector3;
  146499. /**
  146500. * Set point size
  146501. */
  146502. set size(scale: Vector3);
  146503. /**
  146504. * Legacy support, changed quaternion to rotationQuaternion
  146505. */
  146506. get quaternion(): Nullable<Quaternion>;
  146507. /**
  146508. * Legacy support, changed quaternion to rotationQuaternion
  146509. */
  146510. set quaternion(q: Nullable<Quaternion>);
  146511. /**
  146512. * Returns a boolean. True if the particle intersects a mesh, else false
  146513. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  146514. * @param target is the object (point or mesh) what the intersection is computed against
  146515. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  146516. * @returns true if it intersects
  146517. */
  146518. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  146519. /**
  146520. * get the rotation matrix of the particle
  146521. * @hidden
  146522. */
  146523. getRotationMatrix(m: Matrix): void;
  146524. }
  146525. /**
  146526. * Represents a group of points in a points cloud system
  146527. * * PCS internal tool, don't use it manually.
  146528. */
  146529. export class PointsGroup {
  146530. /**
  146531. * The group id
  146532. * @hidden
  146533. */
  146534. groupID: number;
  146535. /**
  146536. * image data for group (internal use)
  146537. * @hidden
  146538. */
  146539. _groupImageData: Nullable<ArrayBufferView>;
  146540. /**
  146541. * Image Width (internal use)
  146542. * @hidden
  146543. */
  146544. _groupImgWidth: number;
  146545. /**
  146546. * Image Height (internal use)
  146547. * @hidden
  146548. */
  146549. _groupImgHeight: number;
  146550. /**
  146551. * Custom position function (internal use)
  146552. * @hidden
  146553. */
  146554. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  146555. /**
  146556. * density per facet for surface points
  146557. * @hidden
  146558. */
  146559. _groupDensity: number[];
  146560. /**
  146561. * Only when points are colored by texture carries pointer to texture list array
  146562. * @hidden
  146563. */
  146564. _textureNb: number;
  146565. /**
  146566. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  146567. * PCS internal tool, don't use it manually.
  146568. * @hidden
  146569. */
  146570. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  146571. }
  146572. }
  146573. declare module BABYLON {
  146574. interface Scene {
  146575. /** @hidden (Backing field) */
  146576. _physicsEngine: Nullable<IPhysicsEngine>;
  146577. /** @hidden */
  146578. _physicsTimeAccumulator: number;
  146579. /**
  146580. * Gets the current physics engine
  146581. * @returns a IPhysicsEngine or null if none attached
  146582. */
  146583. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  146584. /**
  146585. * Enables physics to the current scene
  146586. * @param gravity defines the scene's gravity for the physics engine
  146587. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  146588. * @return a boolean indicating if the physics engine was initialized
  146589. */
  146590. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  146591. /**
  146592. * Disables and disposes the physics engine associated with the scene
  146593. */
  146594. disablePhysicsEngine(): void;
  146595. /**
  146596. * Gets a boolean indicating if there is an active physics engine
  146597. * @returns a boolean indicating if there is an active physics engine
  146598. */
  146599. isPhysicsEnabled(): boolean;
  146600. /**
  146601. * Deletes a physics compound impostor
  146602. * @param compound defines the compound to delete
  146603. */
  146604. deleteCompoundImpostor(compound: any): void;
  146605. /**
  146606. * An event triggered when physic simulation is about to be run
  146607. */
  146608. onBeforePhysicsObservable: Observable<Scene>;
  146609. /**
  146610. * An event triggered when physic simulation has been done
  146611. */
  146612. onAfterPhysicsObservable: Observable<Scene>;
  146613. }
  146614. interface AbstractMesh {
  146615. /** @hidden */
  146616. _physicsImpostor: Nullable<PhysicsImpostor>;
  146617. /**
  146618. * Gets or sets impostor used for physic simulation
  146619. * @see https://doc.babylonjs.com/features/physics_engine
  146620. */
  146621. physicsImpostor: Nullable<PhysicsImpostor>;
  146622. /**
  146623. * Gets the current physics impostor
  146624. * @see https://doc.babylonjs.com/features/physics_engine
  146625. * @returns a physics impostor or null
  146626. */
  146627. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  146628. /** Apply a physic impulse to the mesh
  146629. * @param force defines the force to apply
  146630. * @param contactPoint defines where to apply the force
  146631. * @returns the current mesh
  146632. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  146633. */
  146634. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  146635. /**
  146636. * Creates a physic joint between two meshes
  146637. * @param otherMesh defines the other mesh to use
  146638. * @param pivot1 defines the pivot to use on this mesh
  146639. * @param pivot2 defines the pivot to use on the other mesh
  146640. * @param options defines additional options (can be plugin dependent)
  146641. * @returns the current mesh
  146642. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  146643. */
  146644. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  146645. /** @hidden */
  146646. _disposePhysicsObserver: Nullable<Observer<Node>>;
  146647. }
  146648. /**
  146649. * Defines the physics engine scene component responsible to manage a physics engine
  146650. */
  146651. export class PhysicsEngineSceneComponent implements ISceneComponent {
  146652. /**
  146653. * The component name helpful to identify the component in the list of scene components.
  146654. */
  146655. readonly name: string;
  146656. /**
  146657. * The scene the component belongs to.
  146658. */
  146659. scene: Scene;
  146660. /**
  146661. * Creates a new instance of the component for the given scene
  146662. * @param scene Defines the scene to register the component in
  146663. */
  146664. constructor(scene: Scene);
  146665. /**
  146666. * Registers the component in a given scene
  146667. */
  146668. register(): void;
  146669. /**
  146670. * Rebuilds the elements related to this component in case of
  146671. * context lost for instance.
  146672. */
  146673. rebuild(): void;
  146674. /**
  146675. * Disposes the component and the associated ressources
  146676. */
  146677. dispose(): void;
  146678. }
  146679. }
  146680. declare module BABYLON {
  146681. /**
  146682. * A helper for physics simulations
  146683. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146684. */
  146685. export class PhysicsHelper {
  146686. private _scene;
  146687. private _physicsEngine;
  146688. /**
  146689. * Initializes the Physics helper
  146690. * @param scene Babylon.js scene
  146691. */
  146692. constructor(scene: Scene);
  146693. /**
  146694. * Applies a radial explosion impulse
  146695. * @param origin the origin of the explosion
  146696. * @param radiusOrEventOptions the radius or the options of radial explosion
  146697. * @param strength the explosion strength
  146698. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146699. * @returns A physics radial explosion event, or null
  146700. */
  146701. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  146702. /**
  146703. * Applies a radial explosion force
  146704. * @param origin the origin of the explosion
  146705. * @param radiusOrEventOptions the radius or the options of radial explosion
  146706. * @param strength the explosion strength
  146707. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146708. * @returns A physics radial explosion event, or null
  146709. */
  146710. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  146711. /**
  146712. * Creates a gravitational field
  146713. * @param origin the origin of the explosion
  146714. * @param radiusOrEventOptions the radius or the options of radial explosion
  146715. * @param strength the explosion strength
  146716. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146717. * @returns A physics gravitational field event, or null
  146718. */
  146719. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  146720. /**
  146721. * Creates a physics updraft event
  146722. * @param origin the origin of the updraft
  146723. * @param radiusOrEventOptions the radius or the options of the updraft
  146724. * @param strength the strength of the updraft
  146725. * @param height the height of the updraft
  146726. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  146727. * @returns A physics updraft event, or null
  146728. */
  146729. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  146730. /**
  146731. * Creates a physics vortex event
  146732. * @param origin the of the vortex
  146733. * @param radiusOrEventOptions the radius or the options of the vortex
  146734. * @param strength the strength of the vortex
  146735. * @param height the height of the vortex
  146736. * @returns a Physics vortex event, or null
  146737. * A physics vortex event or null
  146738. */
  146739. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  146740. }
  146741. /**
  146742. * Represents a physics radial explosion event
  146743. */
  146744. class PhysicsRadialExplosionEvent {
  146745. private _scene;
  146746. private _options;
  146747. private _sphere;
  146748. private _dataFetched;
  146749. /**
  146750. * Initializes a radial explosioin event
  146751. * @param _scene BabylonJS scene
  146752. * @param _options The options for the vortex event
  146753. */
  146754. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  146755. /**
  146756. * Returns the data related to the radial explosion event (sphere).
  146757. * @returns The radial explosion event data
  146758. */
  146759. getData(): PhysicsRadialExplosionEventData;
  146760. /**
  146761. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  146762. * @param impostor A physics imposter
  146763. * @param origin the origin of the explosion
  146764. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  146765. */
  146766. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  146767. /**
  146768. * Triggers affecterd impostors callbacks
  146769. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  146770. */
  146771. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  146772. /**
  146773. * Disposes the sphere.
  146774. * @param force Specifies if the sphere should be disposed by force
  146775. */
  146776. dispose(force?: boolean): void;
  146777. /*** Helpers ***/
  146778. private _prepareSphere;
  146779. private _intersectsWithSphere;
  146780. }
  146781. /**
  146782. * Represents a gravitational field event
  146783. */
  146784. class PhysicsGravitationalFieldEvent {
  146785. private _physicsHelper;
  146786. private _scene;
  146787. private _origin;
  146788. private _options;
  146789. private _tickCallback;
  146790. private _sphere;
  146791. private _dataFetched;
  146792. /**
  146793. * Initializes the physics gravitational field event
  146794. * @param _physicsHelper A physics helper
  146795. * @param _scene BabylonJS scene
  146796. * @param _origin The origin position of the gravitational field event
  146797. * @param _options The options for the vortex event
  146798. */
  146799. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  146800. /**
  146801. * Returns the data related to the gravitational field event (sphere).
  146802. * @returns A gravitational field event
  146803. */
  146804. getData(): PhysicsGravitationalFieldEventData;
  146805. /**
  146806. * Enables the gravitational field.
  146807. */
  146808. enable(): void;
  146809. /**
  146810. * Disables the gravitational field.
  146811. */
  146812. disable(): void;
  146813. /**
  146814. * Disposes the sphere.
  146815. * @param force The force to dispose from the gravitational field event
  146816. */
  146817. dispose(force?: boolean): void;
  146818. private _tick;
  146819. }
  146820. /**
  146821. * Represents a physics updraft event
  146822. */
  146823. class PhysicsUpdraftEvent {
  146824. private _scene;
  146825. private _origin;
  146826. private _options;
  146827. private _physicsEngine;
  146828. private _originTop;
  146829. private _originDirection;
  146830. private _tickCallback;
  146831. private _cylinder;
  146832. private _cylinderPosition;
  146833. private _dataFetched;
  146834. /**
  146835. * Initializes the physics updraft event
  146836. * @param _scene BabylonJS scene
  146837. * @param _origin The origin position of the updraft
  146838. * @param _options The options for the updraft event
  146839. */
  146840. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  146841. /**
  146842. * Returns the data related to the updraft event (cylinder).
  146843. * @returns A physics updraft event
  146844. */
  146845. getData(): PhysicsUpdraftEventData;
  146846. /**
  146847. * Enables the updraft.
  146848. */
  146849. enable(): void;
  146850. /**
  146851. * Disables the updraft.
  146852. */
  146853. disable(): void;
  146854. /**
  146855. * Disposes the cylinder.
  146856. * @param force Specifies if the updraft should be disposed by force
  146857. */
  146858. dispose(force?: boolean): void;
  146859. private getImpostorHitData;
  146860. private _tick;
  146861. /*** Helpers ***/
  146862. private _prepareCylinder;
  146863. private _intersectsWithCylinder;
  146864. }
  146865. /**
  146866. * Represents a physics vortex event
  146867. */
  146868. class PhysicsVortexEvent {
  146869. private _scene;
  146870. private _origin;
  146871. private _options;
  146872. private _physicsEngine;
  146873. private _originTop;
  146874. private _tickCallback;
  146875. private _cylinder;
  146876. private _cylinderPosition;
  146877. private _dataFetched;
  146878. /**
  146879. * Initializes the physics vortex event
  146880. * @param _scene The BabylonJS scene
  146881. * @param _origin The origin position of the vortex
  146882. * @param _options The options for the vortex event
  146883. */
  146884. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  146885. /**
  146886. * Returns the data related to the vortex event (cylinder).
  146887. * @returns The physics vortex event data
  146888. */
  146889. getData(): PhysicsVortexEventData;
  146890. /**
  146891. * Enables the vortex.
  146892. */
  146893. enable(): void;
  146894. /**
  146895. * Disables the cortex.
  146896. */
  146897. disable(): void;
  146898. /**
  146899. * Disposes the sphere.
  146900. * @param force
  146901. */
  146902. dispose(force?: boolean): void;
  146903. private getImpostorHitData;
  146904. private _tick;
  146905. /*** Helpers ***/
  146906. private _prepareCylinder;
  146907. private _intersectsWithCylinder;
  146908. }
  146909. /**
  146910. * Options fot the radial explosion event
  146911. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146912. */
  146913. export class PhysicsRadialExplosionEventOptions {
  146914. /**
  146915. * The radius of the sphere for the radial explosion.
  146916. */
  146917. radius: number;
  146918. /**
  146919. * The strenth of the explosion.
  146920. */
  146921. strength: number;
  146922. /**
  146923. * The strenght of the force in correspondence to the distance of the affected object
  146924. */
  146925. falloff: PhysicsRadialImpulseFalloff;
  146926. /**
  146927. * Sphere options for the radial explosion.
  146928. */
  146929. sphere: {
  146930. segments: number;
  146931. diameter: number;
  146932. };
  146933. /**
  146934. * Sphere options for the radial explosion.
  146935. */
  146936. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  146937. }
  146938. /**
  146939. * Options fot the updraft event
  146940. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146941. */
  146942. export class PhysicsUpdraftEventOptions {
  146943. /**
  146944. * The radius of the cylinder for the vortex
  146945. */
  146946. radius: number;
  146947. /**
  146948. * The strenth of the updraft.
  146949. */
  146950. strength: number;
  146951. /**
  146952. * The height of the cylinder for the updraft.
  146953. */
  146954. height: number;
  146955. /**
  146956. * The mode for the the updraft.
  146957. */
  146958. updraftMode: PhysicsUpdraftMode;
  146959. }
  146960. /**
  146961. * Options fot the vortex event
  146962. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146963. */
  146964. export class PhysicsVortexEventOptions {
  146965. /**
  146966. * The radius of the cylinder for the vortex
  146967. */
  146968. radius: number;
  146969. /**
  146970. * The strenth of the vortex.
  146971. */
  146972. strength: number;
  146973. /**
  146974. * The height of the cylinder for the vortex.
  146975. */
  146976. height: number;
  146977. /**
  146978. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  146979. */
  146980. centripetalForceThreshold: number;
  146981. /**
  146982. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  146983. */
  146984. centripetalForceMultiplier: number;
  146985. /**
  146986. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  146987. */
  146988. centrifugalForceMultiplier: number;
  146989. /**
  146990. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  146991. */
  146992. updraftForceMultiplier: number;
  146993. }
  146994. /**
  146995. * The strenght of the force in correspondence to the distance of the affected object
  146996. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146997. */
  146998. export enum PhysicsRadialImpulseFalloff {
  146999. /** Defines that impulse is constant in strength across it's whole radius */
  147000. Constant = 0,
  147001. /** Defines that impulse gets weaker if it's further from the origin */
  147002. Linear = 1
  147003. }
  147004. /**
  147005. * The strength of the force in correspondence to the distance of the affected object
  147006. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147007. */
  147008. export enum PhysicsUpdraftMode {
  147009. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  147010. Center = 0,
  147011. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  147012. Perpendicular = 1
  147013. }
  147014. /**
  147015. * Interface for a physics hit data
  147016. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147017. */
  147018. export interface PhysicsHitData {
  147019. /**
  147020. * The force applied at the contact point
  147021. */
  147022. force: Vector3;
  147023. /**
  147024. * The contact point
  147025. */
  147026. contactPoint: Vector3;
  147027. /**
  147028. * The distance from the origin to the contact point
  147029. */
  147030. distanceFromOrigin: number;
  147031. }
  147032. /**
  147033. * Interface for radial explosion event data
  147034. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147035. */
  147036. export interface PhysicsRadialExplosionEventData {
  147037. /**
  147038. * A sphere used for the radial explosion event
  147039. */
  147040. sphere: Mesh;
  147041. }
  147042. /**
  147043. * Interface for gravitational field event data
  147044. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147045. */
  147046. export interface PhysicsGravitationalFieldEventData {
  147047. /**
  147048. * A sphere mesh used for the gravitational field event
  147049. */
  147050. sphere: Mesh;
  147051. }
  147052. /**
  147053. * Interface for updraft event data
  147054. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147055. */
  147056. export interface PhysicsUpdraftEventData {
  147057. /**
  147058. * A cylinder used for the updraft event
  147059. */
  147060. cylinder: Mesh;
  147061. }
  147062. /**
  147063. * Interface for vortex event data
  147064. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147065. */
  147066. export interface PhysicsVortexEventData {
  147067. /**
  147068. * A cylinder used for the vortex event
  147069. */
  147070. cylinder: Mesh;
  147071. }
  147072. /**
  147073. * Interface for an affected physics impostor
  147074. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147075. */
  147076. export interface PhysicsAffectedImpostorWithData {
  147077. /**
  147078. * The impostor affected by the effect
  147079. */
  147080. impostor: PhysicsImpostor;
  147081. /**
  147082. * The data about the hit/horce from the explosion
  147083. */
  147084. hitData: PhysicsHitData;
  147085. }
  147086. }
  147087. declare module BABYLON {
  147088. /** @hidden */
  147089. export var blackAndWhitePixelShader: {
  147090. name: string;
  147091. shader: string;
  147092. };
  147093. }
  147094. declare module BABYLON {
  147095. /**
  147096. * Post process used to render in black and white
  147097. */
  147098. export class BlackAndWhitePostProcess extends PostProcess {
  147099. /**
  147100. * Linear about to convert he result to black and white (default: 1)
  147101. */
  147102. degree: number;
  147103. /**
  147104. * Creates a black and white post process
  147105. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  147106. * @param name The name of the effect.
  147107. * @param options The required width/height ratio to downsize to before computing the render pass.
  147108. * @param camera The camera to apply the render pass to.
  147109. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147110. * @param engine The engine which the post process will be applied. (default: current engine)
  147111. * @param reusable If the post process can be reused on the same frame. (default: false)
  147112. */
  147113. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147114. }
  147115. }
  147116. declare module BABYLON {
  147117. /**
  147118. * This represents a set of one or more post processes in Babylon.
  147119. * A post process can be used to apply a shader to a texture after it is rendered.
  147120. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  147121. */
  147122. export class PostProcessRenderEffect {
  147123. private _postProcesses;
  147124. private _getPostProcesses;
  147125. private _singleInstance;
  147126. private _cameras;
  147127. private _indicesForCamera;
  147128. /**
  147129. * Name of the effect
  147130. * @hidden
  147131. */
  147132. _name: string;
  147133. /**
  147134. * Instantiates a post process render effect.
  147135. * A post process can be used to apply a shader to a texture after it is rendered.
  147136. * @param engine The engine the effect is tied to
  147137. * @param name The name of the effect
  147138. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  147139. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  147140. */
  147141. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  147142. /**
  147143. * Checks if all the post processes in the effect are supported.
  147144. */
  147145. get isSupported(): boolean;
  147146. /**
  147147. * Updates the current state of the effect
  147148. * @hidden
  147149. */
  147150. _update(): void;
  147151. /**
  147152. * Attaches the effect on cameras
  147153. * @param cameras The camera to attach to.
  147154. * @hidden
  147155. */
  147156. _attachCameras(cameras: Camera): void;
  147157. /**
  147158. * Attaches the effect on cameras
  147159. * @param cameras The camera to attach to.
  147160. * @hidden
  147161. */
  147162. _attachCameras(cameras: Camera[]): void;
  147163. /**
  147164. * Detaches the effect on cameras
  147165. * @param cameras The camera to detatch from.
  147166. * @hidden
  147167. */
  147168. _detachCameras(cameras: Camera): void;
  147169. /**
  147170. * Detatches the effect on cameras
  147171. * @param cameras The camera to detatch from.
  147172. * @hidden
  147173. */
  147174. _detachCameras(cameras: Camera[]): void;
  147175. /**
  147176. * Enables the effect on given cameras
  147177. * @param cameras The camera to enable.
  147178. * @hidden
  147179. */
  147180. _enable(cameras: Camera): void;
  147181. /**
  147182. * Enables the effect on given cameras
  147183. * @param cameras The camera to enable.
  147184. * @hidden
  147185. */
  147186. _enable(cameras: Nullable<Camera[]>): void;
  147187. /**
  147188. * Disables the effect on the given cameras
  147189. * @param cameras The camera to disable.
  147190. * @hidden
  147191. */
  147192. _disable(cameras: Camera): void;
  147193. /**
  147194. * Disables the effect on the given cameras
  147195. * @param cameras The camera to disable.
  147196. * @hidden
  147197. */
  147198. _disable(cameras: Nullable<Camera[]>): void;
  147199. /**
  147200. * Gets a list of the post processes contained in the effect.
  147201. * @param camera The camera to get the post processes on.
  147202. * @returns The list of the post processes in the effect.
  147203. */
  147204. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  147205. }
  147206. }
  147207. declare module BABYLON {
  147208. /** @hidden */
  147209. export var extractHighlightsPixelShader: {
  147210. name: string;
  147211. shader: string;
  147212. };
  147213. }
  147214. declare module BABYLON {
  147215. /**
  147216. * 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.
  147217. */
  147218. export class ExtractHighlightsPostProcess extends PostProcess {
  147219. /**
  147220. * The luminance threshold, pixels below this value will be set to black.
  147221. */
  147222. threshold: number;
  147223. /** @hidden */
  147224. _exposure: number;
  147225. /**
  147226. * Post process which has the input texture to be used when performing highlight extraction
  147227. * @hidden
  147228. */
  147229. _inputPostProcess: Nullable<PostProcess>;
  147230. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147231. }
  147232. }
  147233. declare module BABYLON {
  147234. /** @hidden */
  147235. export var bloomMergePixelShader: {
  147236. name: string;
  147237. shader: string;
  147238. };
  147239. }
  147240. declare module BABYLON {
  147241. /**
  147242. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  147243. */
  147244. export class BloomMergePostProcess extends PostProcess {
  147245. /** Weight of the bloom to be added to the original input. */
  147246. weight: number;
  147247. /**
  147248. * Creates a new instance of @see BloomMergePostProcess
  147249. * @param name The name of the effect.
  147250. * @param originalFromInput Post process which's input will be used for the merge.
  147251. * @param blurred Blurred highlights post process which's output will be used.
  147252. * @param weight Weight of the bloom to be added to the original input.
  147253. * @param options The required width/height ratio to downsize to before computing the render pass.
  147254. * @param camera The camera to apply the render pass to.
  147255. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147256. * @param engine The engine which the post process will be applied. (default: current engine)
  147257. * @param reusable If the post process can be reused on the same frame. (default: false)
  147258. * @param textureType Type of textures used when performing the post process. (default: 0)
  147259. * @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)
  147260. */
  147261. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  147262. /** Weight of the bloom to be added to the original input. */
  147263. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147264. }
  147265. }
  147266. declare module BABYLON {
  147267. /**
  147268. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  147269. */
  147270. export class BloomEffect extends PostProcessRenderEffect {
  147271. private bloomScale;
  147272. /**
  147273. * @hidden Internal
  147274. */
  147275. _effects: Array<PostProcess>;
  147276. /**
  147277. * @hidden Internal
  147278. */
  147279. _downscale: ExtractHighlightsPostProcess;
  147280. private _blurX;
  147281. private _blurY;
  147282. private _merge;
  147283. /**
  147284. * The luminance threshold to find bright areas of the image to bloom.
  147285. */
  147286. get threshold(): number;
  147287. set threshold(value: number);
  147288. /**
  147289. * The strength of the bloom.
  147290. */
  147291. get weight(): number;
  147292. set weight(value: number);
  147293. /**
  147294. * Specifies the size of the bloom blur kernel, relative to the final output size
  147295. */
  147296. get kernel(): number;
  147297. set kernel(value: number);
  147298. /**
  147299. * Creates a new instance of @see BloomEffect
  147300. * @param scene The scene the effect belongs to.
  147301. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  147302. * @param bloomKernel The size of the kernel to be used when applying the blur.
  147303. * @param bloomWeight The the strength of bloom.
  147304. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  147305. * @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)
  147306. */
  147307. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  147308. /**
  147309. * Disposes each of the internal effects for a given camera.
  147310. * @param camera The camera to dispose the effect on.
  147311. */
  147312. disposeEffects(camera: Camera): void;
  147313. /**
  147314. * @hidden Internal
  147315. */
  147316. _updateEffects(): void;
  147317. /**
  147318. * Internal
  147319. * @returns if all the contained post processes are ready.
  147320. * @hidden
  147321. */
  147322. _isReady(): boolean;
  147323. }
  147324. }
  147325. declare module BABYLON {
  147326. /** @hidden */
  147327. export var chromaticAberrationPixelShader: {
  147328. name: string;
  147329. shader: string;
  147330. };
  147331. }
  147332. declare module BABYLON {
  147333. /**
  147334. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  147335. */
  147336. export class ChromaticAberrationPostProcess extends PostProcess {
  147337. /**
  147338. * The amount of seperation of rgb channels (default: 30)
  147339. */
  147340. aberrationAmount: number;
  147341. /**
  147342. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  147343. */
  147344. radialIntensity: number;
  147345. /**
  147346. * 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))
  147347. */
  147348. direction: Vector2;
  147349. /**
  147350. * 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))
  147351. */
  147352. centerPosition: Vector2;
  147353. /**
  147354. * Creates a new instance ChromaticAberrationPostProcess
  147355. * @param name The name of the effect.
  147356. * @param screenWidth The width of the screen to apply the effect on.
  147357. * @param screenHeight The height of the screen to apply the effect on.
  147358. * @param options The required width/height ratio to downsize to before computing the render pass.
  147359. * @param camera The camera to apply the render pass to.
  147360. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147361. * @param engine The engine which the post process will be applied. (default: current engine)
  147362. * @param reusable If the post process can be reused on the same frame. (default: false)
  147363. * @param textureType Type of textures used when performing the post process. (default: 0)
  147364. * @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)
  147365. */
  147366. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147367. }
  147368. }
  147369. declare module BABYLON {
  147370. /** @hidden */
  147371. export var circleOfConfusionPixelShader: {
  147372. name: string;
  147373. shader: string;
  147374. };
  147375. }
  147376. declare module BABYLON {
  147377. /**
  147378. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  147379. */
  147380. export class CircleOfConfusionPostProcess extends PostProcess {
  147381. /**
  147382. * 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.
  147383. */
  147384. lensSize: number;
  147385. /**
  147386. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  147387. */
  147388. fStop: number;
  147389. /**
  147390. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  147391. */
  147392. focusDistance: number;
  147393. /**
  147394. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  147395. */
  147396. focalLength: number;
  147397. private _depthTexture;
  147398. /**
  147399. * Creates a new instance CircleOfConfusionPostProcess
  147400. * @param name The name of the effect.
  147401. * @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.
  147402. * @param options The required width/height ratio to downsize to before computing the render pass.
  147403. * @param camera The camera to apply the render pass to.
  147404. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147405. * @param engine The engine which the post process will be applied. (default: current engine)
  147406. * @param reusable If the post process can be reused on the same frame. (default: false)
  147407. * @param textureType Type of textures used when performing the post process. (default: 0)
  147408. * @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)
  147409. */
  147410. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147411. /**
  147412. * 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.
  147413. */
  147414. set depthTexture(value: RenderTargetTexture);
  147415. }
  147416. }
  147417. declare module BABYLON {
  147418. /** @hidden */
  147419. export var colorCorrectionPixelShader: {
  147420. name: string;
  147421. shader: string;
  147422. };
  147423. }
  147424. declare module BABYLON {
  147425. /**
  147426. *
  147427. * This post-process allows the modification of rendered colors by using
  147428. * a 'look-up table' (LUT). This effect is also called Color Grading.
  147429. *
  147430. * The object needs to be provided an url to a texture containing the color
  147431. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  147432. * Use an image editing software to tweak the LUT to match your needs.
  147433. *
  147434. * For an example of a color LUT, see here:
  147435. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  147436. * For explanations on color grading, see here:
  147437. * @see http://udn.epicgames.com/Three/ColorGrading.html
  147438. *
  147439. */
  147440. export class ColorCorrectionPostProcess extends PostProcess {
  147441. private _colorTableTexture;
  147442. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147443. }
  147444. }
  147445. declare module BABYLON {
  147446. /** @hidden */
  147447. export var convolutionPixelShader: {
  147448. name: string;
  147449. shader: string;
  147450. };
  147451. }
  147452. declare module BABYLON {
  147453. /**
  147454. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  147455. * input texture to perform effects such as edge detection or sharpening
  147456. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  147457. */
  147458. export class ConvolutionPostProcess extends PostProcess {
  147459. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  147460. kernel: number[];
  147461. /**
  147462. * Creates a new instance ConvolutionPostProcess
  147463. * @param name The name of the effect.
  147464. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  147465. * @param options The required width/height ratio to downsize to before computing the render pass.
  147466. * @param camera The camera to apply the render pass to.
  147467. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147468. * @param engine The engine which the post process will be applied. (default: current engine)
  147469. * @param reusable If the post process can be reused on the same frame. (default: false)
  147470. * @param textureType Type of textures used when performing the post process. (default: 0)
  147471. */
  147472. constructor(name: string,
  147473. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  147474. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147475. /**
  147476. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147477. */
  147478. static EdgeDetect0Kernel: number[];
  147479. /**
  147480. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147481. */
  147482. static EdgeDetect1Kernel: number[];
  147483. /**
  147484. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147485. */
  147486. static EdgeDetect2Kernel: number[];
  147487. /**
  147488. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147489. */
  147490. static SharpenKernel: number[];
  147491. /**
  147492. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147493. */
  147494. static EmbossKernel: number[];
  147495. /**
  147496. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147497. */
  147498. static GaussianKernel: number[];
  147499. }
  147500. }
  147501. declare module BABYLON {
  147502. /**
  147503. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  147504. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  147505. * based on samples that have a large difference in distance than the center pixel.
  147506. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  147507. */
  147508. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  147509. direction: Vector2;
  147510. /**
  147511. * Creates a new instance CircleOfConfusionPostProcess
  147512. * @param name The name of the effect.
  147513. * @param scene The scene the effect belongs to.
  147514. * @param direction The direction the blur should be applied.
  147515. * @param kernel The size of the kernel used to blur.
  147516. * @param options The required width/height ratio to downsize to before computing the render pass.
  147517. * @param camera The camera to apply the render pass to.
  147518. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  147519. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  147520. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147521. * @param engine The engine which the post process will be applied. (default: current engine)
  147522. * @param reusable If the post process can be reused on the same frame. (default: false)
  147523. * @param textureType Type of textures used when performing the post process. (default: 0)
  147524. * @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)
  147525. */
  147526. 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);
  147527. }
  147528. }
  147529. declare module BABYLON {
  147530. /** @hidden */
  147531. export var depthOfFieldMergePixelShader: {
  147532. name: string;
  147533. shader: string;
  147534. };
  147535. }
  147536. declare module BABYLON {
  147537. /**
  147538. * Options to be set when merging outputs from the default pipeline.
  147539. */
  147540. export class DepthOfFieldMergePostProcessOptions {
  147541. /**
  147542. * The original image to merge on top of
  147543. */
  147544. originalFromInput: PostProcess;
  147545. /**
  147546. * Parameters to perform the merge of the depth of field effect
  147547. */
  147548. depthOfField?: {
  147549. circleOfConfusion: PostProcess;
  147550. blurSteps: Array<PostProcess>;
  147551. };
  147552. /**
  147553. * Parameters to perform the merge of bloom effect
  147554. */
  147555. bloom?: {
  147556. blurred: PostProcess;
  147557. weight: number;
  147558. };
  147559. }
  147560. /**
  147561. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  147562. */
  147563. export class DepthOfFieldMergePostProcess extends PostProcess {
  147564. private blurSteps;
  147565. /**
  147566. * Creates a new instance of DepthOfFieldMergePostProcess
  147567. * @param name The name of the effect.
  147568. * @param originalFromInput Post process which's input will be used for the merge.
  147569. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  147570. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  147571. * @param options The required width/height ratio to downsize to before computing the render pass.
  147572. * @param camera The camera to apply the render pass to.
  147573. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147574. * @param engine The engine which the post process will be applied. (default: current engine)
  147575. * @param reusable If the post process can be reused on the same frame. (default: false)
  147576. * @param textureType Type of textures used when performing the post process. (default: 0)
  147577. * @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)
  147578. */
  147579. 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);
  147580. /**
  147581. * Updates the effect with the current post process compile time values and recompiles the shader.
  147582. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  147583. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  147584. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  147585. * @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
  147586. * @param onCompiled Called when the shader has been compiled.
  147587. * @param onError Called if there is an error when compiling a shader.
  147588. */
  147589. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  147590. }
  147591. }
  147592. declare module BABYLON {
  147593. /**
  147594. * Specifies the level of max blur that should be applied when using the depth of field effect
  147595. */
  147596. export enum DepthOfFieldEffectBlurLevel {
  147597. /**
  147598. * Subtle blur
  147599. */
  147600. Low = 0,
  147601. /**
  147602. * Medium blur
  147603. */
  147604. Medium = 1,
  147605. /**
  147606. * Large blur
  147607. */
  147608. High = 2
  147609. }
  147610. /**
  147611. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  147612. */
  147613. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  147614. private _circleOfConfusion;
  147615. /**
  147616. * @hidden Internal, blurs from high to low
  147617. */
  147618. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  147619. private _depthOfFieldBlurY;
  147620. private _dofMerge;
  147621. /**
  147622. * @hidden Internal post processes in depth of field effect
  147623. */
  147624. _effects: Array<PostProcess>;
  147625. /**
  147626. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  147627. */
  147628. set focalLength(value: number);
  147629. get focalLength(): number;
  147630. /**
  147631. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  147632. */
  147633. set fStop(value: number);
  147634. get fStop(): number;
  147635. /**
  147636. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  147637. */
  147638. set focusDistance(value: number);
  147639. get focusDistance(): number;
  147640. /**
  147641. * 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.
  147642. */
  147643. set lensSize(value: number);
  147644. get lensSize(): number;
  147645. /**
  147646. * Creates a new instance DepthOfFieldEffect
  147647. * @param scene The scene the effect belongs to.
  147648. * @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.
  147649. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  147650. * @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)
  147651. */
  147652. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  147653. /**
  147654. * Get the current class name of the current effet
  147655. * @returns "DepthOfFieldEffect"
  147656. */
  147657. getClassName(): string;
  147658. /**
  147659. * 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.
  147660. */
  147661. set depthTexture(value: RenderTargetTexture);
  147662. /**
  147663. * Disposes each of the internal effects for a given camera.
  147664. * @param camera The camera to dispose the effect on.
  147665. */
  147666. disposeEffects(camera: Camera): void;
  147667. /**
  147668. * @hidden Internal
  147669. */
  147670. _updateEffects(): void;
  147671. /**
  147672. * Internal
  147673. * @returns if all the contained post processes are ready.
  147674. * @hidden
  147675. */
  147676. _isReady(): boolean;
  147677. }
  147678. }
  147679. declare module BABYLON {
  147680. /** @hidden */
  147681. export var displayPassPixelShader: {
  147682. name: string;
  147683. shader: string;
  147684. };
  147685. }
  147686. declare module BABYLON {
  147687. /**
  147688. * DisplayPassPostProcess which produces an output the same as it's input
  147689. */
  147690. export class DisplayPassPostProcess extends PostProcess {
  147691. /**
  147692. * Creates the DisplayPassPostProcess
  147693. * @param name The name of the effect.
  147694. * @param options The required width/height ratio to downsize to before computing the render pass.
  147695. * @param camera The camera to apply the render pass to.
  147696. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147697. * @param engine The engine which the post process will be applied. (default: current engine)
  147698. * @param reusable If the post process can be reused on the same frame. (default: false)
  147699. */
  147700. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147701. }
  147702. }
  147703. declare module BABYLON {
  147704. /** @hidden */
  147705. export var filterPixelShader: {
  147706. name: string;
  147707. shader: string;
  147708. };
  147709. }
  147710. declare module BABYLON {
  147711. /**
  147712. * Applies a kernel filter to the image
  147713. */
  147714. export class FilterPostProcess extends PostProcess {
  147715. /** The matrix to be applied to the image */
  147716. kernelMatrix: Matrix;
  147717. /**
  147718. *
  147719. * @param name The name of the effect.
  147720. * @param kernelMatrix The matrix to be applied to the image
  147721. * @param options The required width/height ratio to downsize to before computing the render pass.
  147722. * @param camera The camera to apply the render pass to.
  147723. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147724. * @param engine The engine which the post process will be applied. (default: current engine)
  147725. * @param reusable If the post process can be reused on the same frame. (default: false)
  147726. */
  147727. constructor(name: string,
  147728. /** The matrix to be applied to the image */
  147729. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147730. }
  147731. }
  147732. declare module BABYLON {
  147733. /** @hidden */
  147734. export var fxaaPixelShader: {
  147735. name: string;
  147736. shader: string;
  147737. };
  147738. }
  147739. declare module BABYLON {
  147740. /** @hidden */
  147741. export var fxaaVertexShader: {
  147742. name: string;
  147743. shader: string;
  147744. };
  147745. }
  147746. declare module BABYLON {
  147747. /**
  147748. * Fxaa post process
  147749. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  147750. */
  147751. export class FxaaPostProcess extends PostProcess {
  147752. /** @hidden */
  147753. texelWidth: number;
  147754. /** @hidden */
  147755. texelHeight: number;
  147756. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147757. private _getDefines;
  147758. }
  147759. }
  147760. declare module BABYLON {
  147761. /** @hidden */
  147762. export var grainPixelShader: {
  147763. name: string;
  147764. shader: string;
  147765. };
  147766. }
  147767. declare module BABYLON {
  147768. /**
  147769. * The GrainPostProcess adds noise to the image at mid luminance levels
  147770. */
  147771. export class GrainPostProcess extends PostProcess {
  147772. /**
  147773. * The intensity of the grain added (default: 30)
  147774. */
  147775. intensity: number;
  147776. /**
  147777. * If the grain should be randomized on every frame
  147778. */
  147779. animated: boolean;
  147780. /**
  147781. * Creates a new instance of @see GrainPostProcess
  147782. * @param name The name of the effect.
  147783. * @param options The required width/height ratio to downsize to before computing the render pass.
  147784. * @param camera The camera to apply the render pass to.
  147785. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147786. * @param engine The engine which the post process will be applied. (default: current engine)
  147787. * @param reusable If the post process can be reused on the same frame. (default: false)
  147788. * @param textureType Type of textures used when performing the post process. (default: 0)
  147789. * @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)
  147790. */
  147791. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147792. }
  147793. }
  147794. declare module BABYLON {
  147795. /** @hidden */
  147796. export var highlightsPixelShader: {
  147797. name: string;
  147798. shader: string;
  147799. };
  147800. }
  147801. declare module BABYLON {
  147802. /**
  147803. * Extracts highlights from the image
  147804. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  147805. */
  147806. export class HighlightsPostProcess extends PostProcess {
  147807. /**
  147808. * Extracts highlights from the image
  147809. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  147810. * @param name The name of the effect.
  147811. * @param options The required width/height ratio to downsize to before computing the render pass.
  147812. * @param camera The camera to apply the render pass to.
  147813. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147814. * @param engine The engine which the post process will be applied. (default: current engine)
  147815. * @param reusable If the post process can be reused on the same frame. (default: false)
  147816. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  147817. */
  147818. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147819. }
  147820. }
  147821. declare module BABYLON {
  147822. /** @hidden */
  147823. export var mrtFragmentDeclaration: {
  147824. name: string;
  147825. shader: string;
  147826. };
  147827. }
  147828. declare module BABYLON {
  147829. /** @hidden */
  147830. export var geometryPixelShader: {
  147831. name: string;
  147832. shader: string;
  147833. };
  147834. }
  147835. declare module BABYLON {
  147836. /** @hidden */
  147837. export var geometryVertexShader: {
  147838. name: string;
  147839. shader: string;
  147840. };
  147841. }
  147842. declare module BABYLON {
  147843. /** @hidden */
  147844. interface ISavedTransformationMatrix {
  147845. world: Matrix;
  147846. viewProjection: Matrix;
  147847. }
  147848. /**
  147849. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  147850. */
  147851. export class GeometryBufferRenderer {
  147852. /**
  147853. * Constant used to retrieve the position texture index in the G-Buffer textures array
  147854. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  147855. */
  147856. static readonly POSITION_TEXTURE_TYPE: number;
  147857. /**
  147858. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  147859. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  147860. */
  147861. static readonly VELOCITY_TEXTURE_TYPE: number;
  147862. /**
  147863. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  147864. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  147865. */
  147866. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  147867. /**
  147868. * Dictionary used to store the previous transformation matrices of each rendered mesh
  147869. * in order to compute objects velocities when enableVelocity is set to "true"
  147870. * @hidden
  147871. */
  147872. _previousTransformationMatrices: {
  147873. [index: number]: ISavedTransformationMatrix;
  147874. };
  147875. /**
  147876. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  147877. * in order to compute objects velocities when enableVelocity is set to "true"
  147878. * @hidden
  147879. */
  147880. _previousBonesTransformationMatrices: {
  147881. [index: number]: Float32Array;
  147882. };
  147883. /**
  147884. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  147885. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  147886. */
  147887. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  147888. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  147889. renderTransparentMeshes: boolean;
  147890. private _scene;
  147891. private _resizeObserver;
  147892. private _multiRenderTarget;
  147893. private _ratio;
  147894. private _enablePosition;
  147895. private _enableVelocity;
  147896. private _enableReflectivity;
  147897. private _positionIndex;
  147898. private _velocityIndex;
  147899. private _reflectivityIndex;
  147900. protected _effect: Effect;
  147901. protected _cachedDefines: string;
  147902. /**
  147903. * Set the render list (meshes to be rendered) used in the G buffer.
  147904. */
  147905. set renderList(meshes: Mesh[]);
  147906. /**
  147907. * Gets wether or not G buffer are supported by the running hardware.
  147908. * This requires draw buffer supports
  147909. */
  147910. get isSupported(): boolean;
  147911. /**
  147912. * Returns the index of the given texture type in the G-Buffer textures array
  147913. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  147914. * @returns the index of the given texture type in the G-Buffer textures array
  147915. */
  147916. getTextureIndex(textureType: number): number;
  147917. /**
  147918. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  147919. */
  147920. get enablePosition(): boolean;
  147921. /**
  147922. * Sets whether or not objects positions are enabled for the G buffer.
  147923. */
  147924. set enablePosition(enable: boolean);
  147925. /**
  147926. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  147927. */
  147928. get enableVelocity(): boolean;
  147929. /**
  147930. * Sets wether or not objects velocities are enabled for the G buffer.
  147931. */
  147932. set enableVelocity(enable: boolean);
  147933. /**
  147934. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  147935. */
  147936. get enableReflectivity(): boolean;
  147937. /**
  147938. * Sets wether or not objects roughness are enabled for the G buffer.
  147939. */
  147940. set enableReflectivity(enable: boolean);
  147941. /**
  147942. * Gets the scene associated with the buffer.
  147943. */
  147944. get scene(): Scene;
  147945. /**
  147946. * Gets the ratio used by the buffer during its creation.
  147947. * How big is the buffer related to the main canvas.
  147948. */
  147949. get ratio(): number;
  147950. /** @hidden */
  147951. static _SceneComponentInitialization: (scene: Scene) => void;
  147952. /**
  147953. * Creates a new G Buffer for the scene
  147954. * @param scene The scene the buffer belongs to
  147955. * @param ratio How big is the buffer related to the main canvas.
  147956. */
  147957. constructor(scene: Scene, ratio?: number);
  147958. /**
  147959. * Checks wether everything is ready to render a submesh to the G buffer.
  147960. * @param subMesh the submesh to check readiness for
  147961. * @param useInstances is the mesh drawn using instance or not
  147962. * @returns true if ready otherwise false
  147963. */
  147964. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  147965. /**
  147966. * Gets the current underlying G Buffer.
  147967. * @returns the buffer
  147968. */
  147969. getGBuffer(): MultiRenderTarget;
  147970. /**
  147971. * Gets the number of samples used to render the buffer (anti aliasing).
  147972. */
  147973. get samples(): number;
  147974. /**
  147975. * Sets the number of samples used to render the buffer (anti aliasing).
  147976. */
  147977. set samples(value: number);
  147978. /**
  147979. * Disposes the renderer and frees up associated resources.
  147980. */
  147981. dispose(): void;
  147982. protected _createRenderTargets(): void;
  147983. private _copyBonesTransformationMatrices;
  147984. }
  147985. }
  147986. declare module BABYLON {
  147987. interface Scene {
  147988. /** @hidden (Backing field) */
  147989. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  147990. /**
  147991. * Gets or Sets the current geometry buffer associated to the scene.
  147992. */
  147993. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  147994. /**
  147995. * Enables a GeometryBufferRender and associates it with the scene
  147996. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  147997. * @returns the GeometryBufferRenderer
  147998. */
  147999. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  148000. /**
  148001. * Disables the GeometryBufferRender associated with the scene
  148002. */
  148003. disableGeometryBufferRenderer(): void;
  148004. }
  148005. /**
  148006. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  148007. * in several rendering techniques.
  148008. */
  148009. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  148010. /**
  148011. * The component name helpful to identify the component in the list of scene components.
  148012. */
  148013. readonly name: string;
  148014. /**
  148015. * The scene the component belongs to.
  148016. */
  148017. scene: Scene;
  148018. /**
  148019. * Creates a new instance of the component for the given scene
  148020. * @param scene Defines the scene to register the component in
  148021. */
  148022. constructor(scene: Scene);
  148023. /**
  148024. * Registers the component in a given scene
  148025. */
  148026. register(): void;
  148027. /**
  148028. * Rebuilds the elements related to this component in case of
  148029. * context lost for instance.
  148030. */
  148031. rebuild(): void;
  148032. /**
  148033. * Disposes the component and the associated ressources
  148034. */
  148035. dispose(): void;
  148036. private _gatherRenderTargets;
  148037. }
  148038. }
  148039. declare module BABYLON {
  148040. /** @hidden */
  148041. export var motionBlurPixelShader: {
  148042. name: string;
  148043. shader: string;
  148044. };
  148045. }
  148046. declare module BABYLON {
  148047. /**
  148048. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  148049. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  148050. * As an example, all you have to do is to create the post-process:
  148051. * var mb = new BABYLON.MotionBlurPostProcess(
  148052. * 'mb', // The name of the effect.
  148053. * scene, // The scene containing the objects to blur according to their velocity.
  148054. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  148055. * camera // The camera to apply the render pass to.
  148056. * );
  148057. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  148058. */
  148059. export class MotionBlurPostProcess extends PostProcess {
  148060. /**
  148061. * Defines how much the image is blurred by the movement. Default value is equal to 1
  148062. */
  148063. motionStrength: number;
  148064. /**
  148065. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  148066. */
  148067. get motionBlurSamples(): number;
  148068. /**
  148069. * Sets the number of iterations to be used for motion blur quality
  148070. */
  148071. set motionBlurSamples(samples: number);
  148072. private _motionBlurSamples;
  148073. private _geometryBufferRenderer;
  148074. /**
  148075. * Creates a new instance MotionBlurPostProcess
  148076. * @param name The name of the effect.
  148077. * @param scene The scene containing the objects to blur according to their velocity.
  148078. * @param options The required width/height ratio to downsize to before computing the render pass.
  148079. * @param camera The camera to apply the render pass to.
  148080. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148081. * @param engine The engine which the post process will be applied. (default: current engine)
  148082. * @param reusable If the post process can be reused on the same frame. (default: false)
  148083. * @param textureType Type of textures used when performing the post process. (default: 0)
  148084. * @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)
  148085. */
  148086. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148087. /**
  148088. * Excludes the given skinned mesh from computing bones velocities.
  148089. * 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.
  148090. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  148091. */
  148092. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  148093. /**
  148094. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  148095. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  148096. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  148097. */
  148098. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  148099. /**
  148100. * Disposes the post process.
  148101. * @param camera The camera to dispose the post process on.
  148102. */
  148103. dispose(camera?: Camera): void;
  148104. }
  148105. }
  148106. declare module BABYLON {
  148107. /** @hidden */
  148108. export var refractionPixelShader: {
  148109. name: string;
  148110. shader: string;
  148111. };
  148112. }
  148113. declare module BABYLON {
  148114. /**
  148115. * Post process which applies a refractin texture
  148116. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  148117. */
  148118. export class RefractionPostProcess extends PostProcess {
  148119. /** the base color of the refraction (used to taint the rendering) */
  148120. color: Color3;
  148121. /** simulated refraction depth */
  148122. depth: number;
  148123. /** the coefficient of the base color (0 to remove base color tainting) */
  148124. colorLevel: number;
  148125. private _refTexture;
  148126. private _ownRefractionTexture;
  148127. /**
  148128. * Gets or sets the refraction texture
  148129. * Please note that you are responsible for disposing the texture if you set it manually
  148130. */
  148131. get refractionTexture(): Texture;
  148132. set refractionTexture(value: Texture);
  148133. /**
  148134. * Initializes the RefractionPostProcess
  148135. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  148136. * @param name The name of the effect.
  148137. * @param refractionTextureUrl Url of the refraction texture to use
  148138. * @param color the base color of the refraction (used to taint the rendering)
  148139. * @param depth simulated refraction depth
  148140. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  148141. * @param camera The camera to apply the render pass to.
  148142. * @param options The required width/height ratio to downsize to before computing the render pass.
  148143. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148144. * @param engine The engine which the post process will be applied. (default: current engine)
  148145. * @param reusable If the post process can be reused on the same frame. (default: false)
  148146. */
  148147. constructor(name: string, refractionTextureUrl: string,
  148148. /** the base color of the refraction (used to taint the rendering) */
  148149. color: Color3,
  148150. /** simulated refraction depth */
  148151. depth: number,
  148152. /** the coefficient of the base color (0 to remove base color tainting) */
  148153. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148154. /**
  148155. * Disposes of the post process
  148156. * @param camera Camera to dispose post process on
  148157. */
  148158. dispose(camera: Camera): void;
  148159. }
  148160. }
  148161. declare module BABYLON {
  148162. /** @hidden */
  148163. export var sharpenPixelShader: {
  148164. name: string;
  148165. shader: string;
  148166. };
  148167. }
  148168. declare module BABYLON {
  148169. /**
  148170. * The SharpenPostProcess applies a sharpen kernel to every pixel
  148171. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148172. */
  148173. export class SharpenPostProcess extends PostProcess {
  148174. /**
  148175. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  148176. */
  148177. colorAmount: number;
  148178. /**
  148179. * How much sharpness should be applied (default: 0.3)
  148180. */
  148181. edgeAmount: number;
  148182. /**
  148183. * Creates a new instance ConvolutionPostProcess
  148184. * @param name The name of the effect.
  148185. * @param options The required width/height ratio to downsize to before computing the render pass.
  148186. * @param camera The camera to apply the render pass to.
  148187. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148188. * @param engine The engine which the post process will be applied. (default: current engine)
  148189. * @param reusable If the post process can be reused on the same frame. (default: false)
  148190. * @param textureType Type of textures used when performing the post process. (default: 0)
  148191. * @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)
  148192. */
  148193. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148194. }
  148195. }
  148196. declare module BABYLON {
  148197. /**
  148198. * PostProcessRenderPipeline
  148199. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148200. */
  148201. export class PostProcessRenderPipeline {
  148202. private engine;
  148203. private _renderEffects;
  148204. private _renderEffectsForIsolatedPass;
  148205. /**
  148206. * List of inspectable custom properties (used by the Inspector)
  148207. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  148208. */
  148209. inspectableCustomProperties: IInspectable[];
  148210. /**
  148211. * @hidden
  148212. */
  148213. protected _cameras: Camera[];
  148214. /** @hidden */
  148215. _name: string;
  148216. /**
  148217. * Gets pipeline name
  148218. */
  148219. get name(): string;
  148220. /** Gets the list of attached cameras */
  148221. get cameras(): Camera[];
  148222. /**
  148223. * Initializes a PostProcessRenderPipeline
  148224. * @param engine engine to add the pipeline to
  148225. * @param name name of the pipeline
  148226. */
  148227. constructor(engine: Engine, name: string);
  148228. /**
  148229. * Gets the class name
  148230. * @returns "PostProcessRenderPipeline"
  148231. */
  148232. getClassName(): string;
  148233. /**
  148234. * If all the render effects in the pipeline are supported
  148235. */
  148236. get isSupported(): boolean;
  148237. /**
  148238. * Adds an effect to the pipeline
  148239. * @param renderEffect the effect to add
  148240. */
  148241. addEffect(renderEffect: PostProcessRenderEffect): void;
  148242. /** @hidden */
  148243. _rebuild(): void;
  148244. /** @hidden */
  148245. _enableEffect(renderEffectName: string, cameras: Camera): void;
  148246. /** @hidden */
  148247. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  148248. /** @hidden */
  148249. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  148250. /** @hidden */
  148251. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  148252. /** @hidden */
  148253. _attachCameras(cameras: Camera, unique: boolean): void;
  148254. /** @hidden */
  148255. _attachCameras(cameras: Camera[], unique: boolean): void;
  148256. /** @hidden */
  148257. _detachCameras(cameras: Camera): void;
  148258. /** @hidden */
  148259. _detachCameras(cameras: Nullable<Camera[]>): void;
  148260. /** @hidden */
  148261. _update(): void;
  148262. /** @hidden */
  148263. _reset(): void;
  148264. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  148265. /**
  148266. * Sets the required values to the prepass renderer.
  148267. * @param prePassRenderer defines the prepass renderer to setup.
  148268. * @returns true if the pre pass is needed.
  148269. */
  148270. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  148271. /**
  148272. * Disposes of the pipeline
  148273. */
  148274. dispose(): void;
  148275. }
  148276. }
  148277. declare module BABYLON {
  148278. /**
  148279. * PostProcessRenderPipelineManager class
  148280. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148281. */
  148282. export class PostProcessRenderPipelineManager {
  148283. private _renderPipelines;
  148284. /**
  148285. * Initializes a PostProcessRenderPipelineManager
  148286. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148287. */
  148288. constructor();
  148289. /**
  148290. * Gets the list of supported render pipelines
  148291. */
  148292. get supportedPipelines(): PostProcessRenderPipeline[];
  148293. /**
  148294. * Adds a pipeline to the manager
  148295. * @param renderPipeline The pipeline to add
  148296. */
  148297. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  148298. /**
  148299. * Attaches a camera to the pipeline
  148300. * @param renderPipelineName The name of the pipeline to attach to
  148301. * @param cameras the camera to attach
  148302. * @param unique if the camera can be attached multiple times to the pipeline
  148303. */
  148304. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  148305. /**
  148306. * Detaches a camera from the pipeline
  148307. * @param renderPipelineName The name of the pipeline to detach from
  148308. * @param cameras the camera to detach
  148309. */
  148310. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  148311. /**
  148312. * Enables an effect by name on a pipeline
  148313. * @param renderPipelineName the name of the pipeline to enable the effect in
  148314. * @param renderEffectName the name of the effect to enable
  148315. * @param cameras the cameras that the effect should be enabled on
  148316. */
  148317. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  148318. /**
  148319. * Disables an effect by name on a pipeline
  148320. * @param renderPipelineName the name of the pipeline to disable the effect in
  148321. * @param renderEffectName the name of the effect to disable
  148322. * @param cameras the cameras that the effect should be disabled on
  148323. */
  148324. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  148325. /**
  148326. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  148327. */
  148328. update(): void;
  148329. /** @hidden */
  148330. _rebuild(): void;
  148331. /**
  148332. * Disposes of the manager and pipelines
  148333. */
  148334. dispose(): void;
  148335. }
  148336. }
  148337. declare module BABYLON {
  148338. interface Scene {
  148339. /** @hidden (Backing field) */
  148340. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  148341. /**
  148342. * Gets the postprocess render pipeline manager
  148343. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148344. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  148345. */
  148346. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  148347. }
  148348. /**
  148349. * Defines the Render Pipeline scene component responsible to rendering pipelines
  148350. */
  148351. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  148352. /**
  148353. * The component name helpfull to identify the component in the list of scene components.
  148354. */
  148355. readonly name: string;
  148356. /**
  148357. * The scene the component belongs to.
  148358. */
  148359. scene: Scene;
  148360. /**
  148361. * Creates a new instance of the component for the given scene
  148362. * @param scene Defines the scene to register the component in
  148363. */
  148364. constructor(scene: Scene);
  148365. /**
  148366. * Registers the component in a given scene
  148367. */
  148368. register(): void;
  148369. /**
  148370. * Rebuilds the elements related to this component in case of
  148371. * context lost for instance.
  148372. */
  148373. rebuild(): void;
  148374. /**
  148375. * Disposes the component and the associated ressources
  148376. */
  148377. dispose(): void;
  148378. private _gatherRenderTargets;
  148379. }
  148380. }
  148381. declare module BABYLON {
  148382. /**
  148383. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  148384. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  148385. */
  148386. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  148387. private _scene;
  148388. private _camerasToBeAttached;
  148389. /**
  148390. * ID of the sharpen post process,
  148391. */
  148392. private readonly SharpenPostProcessId;
  148393. /**
  148394. * @ignore
  148395. * ID of the image processing post process;
  148396. */
  148397. readonly ImageProcessingPostProcessId: string;
  148398. /**
  148399. * @ignore
  148400. * ID of the Fast Approximate Anti-Aliasing post process;
  148401. */
  148402. readonly FxaaPostProcessId: string;
  148403. /**
  148404. * ID of the chromatic aberration post process,
  148405. */
  148406. private readonly ChromaticAberrationPostProcessId;
  148407. /**
  148408. * ID of the grain post process
  148409. */
  148410. private readonly GrainPostProcessId;
  148411. /**
  148412. * Sharpen post process which will apply a sharpen convolution to enhance edges
  148413. */
  148414. sharpen: SharpenPostProcess;
  148415. private _sharpenEffect;
  148416. private bloom;
  148417. /**
  148418. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  148419. */
  148420. depthOfField: DepthOfFieldEffect;
  148421. /**
  148422. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  148423. */
  148424. fxaa: FxaaPostProcess;
  148425. /**
  148426. * Image post processing pass used to perform operations such as tone mapping or color grading.
  148427. */
  148428. imageProcessing: ImageProcessingPostProcess;
  148429. /**
  148430. * Chromatic aberration post process which will shift rgb colors in the image
  148431. */
  148432. chromaticAberration: ChromaticAberrationPostProcess;
  148433. private _chromaticAberrationEffect;
  148434. /**
  148435. * Grain post process which add noise to the image
  148436. */
  148437. grain: GrainPostProcess;
  148438. private _grainEffect;
  148439. /**
  148440. * Glow post process which adds a glow to emissive areas of the image
  148441. */
  148442. private _glowLayer;
  148443. /**
  148444. * Animations which can be used to tweak settings over a period of time
  148445. */
  148446. animations: Animation[];
  148447. private _imageProcessingConfigurationObserver;
  148448. private _sharpenEnabled;
  148449. private _bloomEnabled;
  148450. private _depthOfFieldEnabled;
  148451. private _depthOfFieldBlurLevel;
  148452. private _fxaaEnabled;
  148453. private _imageProcessingEnabled;
  148454. private _defaultPipelineTextureType;
  148455. private _bloomScale;
  148456. private _chromaticAberrationEnabled;
  148457. private _grainEnabled;
  148458. private _buildAllowed;
  148459. /**
  148460. * Gets active scene
  148461. */
  148462. get scene(): Scene;
  148463. /**
  148464. * Enable or disable the sharpen process from the pipeline
  148465. */
  148466. set sharpenEnabled(enabled: boolean);
  148467. get sharpenEnabled(): boolean;
  148468. private _resizeObserver;
  148469. private _hardwareScaleLevel;
  148470. private _bloomKernel;
  148471. /**
  148472. * Specifies the size of the bloom blur kernel, relative to the final output size
  148473. */
  148474. get bloomKernel(): number;
  148475. set bloomKernel(value: number);
  148476. /**
  148477. * Specifies the weight of the bloom in the final rendering
  148478. */
  148479. private _bloomWeight;
  148480. /**
  148481. * Specifies the luma threshold for the area that will be blurred by the bloom
  148482. */
  148483. private _bloomThreshold;
  148484. private _hdr;
  148485. /**
  148486. * The strength of the bloom.
  148487. */
  148488. set bloomWeight(value: number);
  148489. get bloomWeight(): number;
  148490. /**
  148491. * The strength of the bloom.
  148492. */
  148493. set bloomThreshold(value: number);
  148494. get bloomThreshold(): number;
  148495. /**
  148496. * The scale of the bloom, lower value will provide better performance.
  148497. */
  148498. set bloomScale(value: number);
  148499. get bloomScale(): number;
  148500. /**
  148501. * Enable or disable the bloom from the pipeline
  148502. */
  148503. set bloomEnabled(enabled: boolean);
  148504. get bloomEnabled(): boolean;
  148505. private _rebuildBloom;
  148506. /**
  148507. * If the depth of field is enabled.
  148508. */
  148509. get depthOfFieldEnabled(): boolean;
  148510. set depthOfFieldEnabled(enabled: boolean);
  148511. /**
  148512. * Blur level of the depth of field effect. (Higher blur will effect performance)
  148513. */
  148514. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  148515. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  148516. /**
  148517. * If the anti aliasing is enabled.
  148518. */
  148519. set fxaaEnabled(enabled: boolean);
  148520. get fxaaEnabled(): boolean;
  148521. private _samples;
  148522. /**
  148523. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  148524. */
  148525. set samples(sampleCount: number);
  148526. get samples(): number;
  148527. /**
  148528. * If image processing is enabled.
  148529. */
  148530. set imageProcessingEnabled(enabled: boolean);
  148531. get imageProcessingEnabled(): boolean;
  148532. /**
  148533. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  148534. */
  148535. set glowLayerEnabled(enabled: boolean);
  148536. get glowLayerEnabled(): boolean;
  148537. /**
  148538. * Gets the glow layer (or null if not defined)
  148539. */
  148540. get glowLayer(): Nullable<GlowLayer>;
  148541. /**
  148542. * Enable or disable the chromaticAberration process from the pipeline
  148543. */
  148544. set chromaticAberrationEnabled(enabled: boolean);
  148545. get chromaticAberrationEnabled(): boolean;
  148546. /**
  148547. * Enable or disable the grain process from the pipeline
  148548. */
  148549. set grainEnabled(enabled: boolean);
  148550. get grainEnabled(): boolean;
  148551. /**
  148552. * @constructor
  148553. * @param name - The rendering pipeline name (default: "")
  148554. * @param hdr - If high dynamic range textures should be used (default: true)
  148555. * @param scene - The scene linked to this pipeline (default: the last created scene)
  148556. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  148557. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  148558. */
  148559. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  148560. /**
  148561. * Get the class name
  148562. * @returns "DefaultRenderingPipeline"
  148563. */
  148564. getClassName(): string;
  148565. /**
  148566. * Force the compilation of the entire pipeline.
  148567. */
  148568. prepare(): void;
  148569. private _hasCleared;
  148570. private _prevPostProcess;
  148571. private _prevPrevPostProcess;
  148572. private _setAutoClearAndTextureSharing;
  148573. private _depthOfFieldSceneObserver;
  148574. private _buildPipeline;
  148575. private _disposePostProcesses;
  148576. /**
  148577. * Adds a camera to the pipeline
  148578. * @param camera the camera to be added
  148579. */
  148580. addCamera(camera: Camera): void;
  148581. /**
  148582. * Removes a camera from the pipeline
  148583. * @param camera the camera to remove
  148584. */
  148585. removeCamera(camera: Camera): void;
  148586. /**
  148587. * Dispose of the pipeline and stop all post processes
  148588. */
  148589. dispose(): void;
  148590. /**
  148591. * Serialize the rendering pipeline (Used when exporting)
  148592. * @returns the serialized object
  148593. */
  148594. serialize(): any;
  148595. /**
  148596. * Parse the serialized pipeline
  148597. * @param source Source pipeline.
  148598. * @param scene The scene to load the pipeline to.
  148599. * @param rootUrl The URL of the serialized pipeline.
  148600. * @returns An instantiated pipeline from the serialized object.
  148601. */
  148602. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  148603. }
  148604. }
  148605. declare module BABYLON {
  148606. /** @hidden */
  148607. export var lensHighlightsPixelShader: {
  148608. name: string;
  148609. shader: string;
  148610. };
  148611. }
  148612. declare module BABYLON {
  148613. /** @hidden */
  148614. export var depthOfFieldPixelShader: {
  148615. name: string;
  148616. shader: string;
  148617. };
  148618. }
  148619. declare module BABYLON {
  148620. /**
  148621. * BABYLON.JS Chromatic Aberration GLSL Shader
  148622. * Author: Olivier Guyot
  148623. * Separates very slightly R, G and B colors on the edges of the screen
  148624. * Inspired by Francois Tarlier & Martins Upitis
  148625. */
  148626. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  148627. /**
  148628. * @ignore
  148629. * The chromatic aberration PostProcess id in the pipeline
  148630. */
  148631. LensChromaticAberrationEffect: string;
  148632. /**
  148633. * @ignore
  148634. * The highlights enhancing PostProcess id in the pipeline
  148635. */
  148636. HighlightsEnhancingEffect: string;
  148637. /**
  148638. * @ignore
  148639. * The depth-of-field PostProcess id in the pipeline
  148640. */
  148641. LensDepthOfFieldEffect: string;
  148642. private _scene;
  148643. private _depthTexture;
  148644. private _grainTexture;
  148645. private _chromaticAberrationPostProcess;
  148646. private _highlightsPostProcess;
  148647. private _depthOfFieldPostProcess;
  148648. private _edgeBlur;
  148649. private _grainAmount;
  148650. private _chromaticAberration;
  148651. private _distortion;
  148652. private _highlightsGain;
  148653. private _highlightsThreshold;
  148654. private _dofDistance;
  148655. private _dofAperture;
  148656. private _dofDarken;
  148657. private _dofPentagon;
  148658. private _blurNoise;
  148659. /**
  148660. * @constructor
  148661. *
  148662. * Effect parameters are as follow:
  148663. * {
  148664. * chromatic_aberration: number; // from 0 to x (1 for realism)
  148665. * edge_blur: number; // from 0 to x (1 for realism)
  148666. * distortion: number; // from 0 to x (1 for realism)
  148667. * grain_amount: number; // from 0 to 1
  148668. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  148669. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  148670. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  148671. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  148672. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  148673. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  148674. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  148675. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  148676. * }
  148677. * Note: if an effect parameter is unset, effect is disabled
  148678. *
  148679. * @param name The rendering pipeline name
  148680. * @param parameters - An object containing all parameters (see above)
  148681. * @param scene The scene linked to this pipeline
  148682. * @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)
  148683. * @param cameras The array of cameras that the rendering pipeline will be attached to
  148684. */
  148685. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  148686. /**
  148687. * Get the class name
  148688. * @returns "LensRenderingPipeline"
  148689. */
  148690. getClassName(): string;
  148691. /**
  148692. * Gets associated scene
  148693. */
  148694. get scene(): Scene;
  148695. /**
  148696. * Gets or sets the edge blur
  148697. */
  148698. get edgeBlur(): number;
  148699. set edgeBlur(value: number);
  148700. /**
  148701. * Gets or sets the grain amount
  148702. */
  148703. get grainAmount(): number;
  148704. set grainAmount(value: number);
  148705. /**
  148706. * Gets or sets the chromatic aberration amount
  148707. */
  148708. get chromaticAberration(): number;
  148709. set chromaticAberration(value: number);
  148710. /**
  148711. * Gets or sets the depth of field aperture
  148712. */
  148713. get dofAperture(): number;
  148714. set dofAperture(value: number);
  148715. /**
  148716. * Gets or sets the edge distortion
  148717. */
  148718. get edgeDistortion(): number;
  148719. set edgeDistortion(value: number);
  148720. /**
  148721. * Gets or sets the depth of field distortion
  148722. */
  148723. get dofDistortion(): number;
  148724. set dofDistortion(value: number);
  148725. /**
  148726. * Gets or sets the darken out of focus amount
  148727. */
  148728. get darkenOutOfFocus(): number;
  148729. set darkenOutOfFocus(value: number);
  148730. /**
  148731. * Gets or sets a boolean indicating if blur noise is enabled
  148732. */
  148733. get blurNoise(): boolean;
  148734. set blurNoise(value: boolean);
  148735. /**
  148736. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  148737. */
  148738. get pentagonBokeh(): boolean;
  148739. set pentagonBokeh(value: boolean);
  148740. /**
  148741. * Gets or sets the highlight grain amount
  148742. */
  148743. get highlightsGain(): number;
  148744. set highlightsGain(value: number);
  148745. /**
  148746. * Gets or sets the highlight threshold
  148747. */
  148748. get highlightsThreshold(): number;
  148749. set highlightsThreshold(value: number);
  148750. /**
  148751. * Sets the amount of blur at the edges
  148752. * @param amount blur amount
  148753. */
  148754. setEdgeBlur(amount: number): void;
  148755. /**
  148756. * Sets edge blur to 0
  148757. */
  148758. disableEdgeBlur(): void;
  148759. /**
  148760. * Sets the amout of grain
  148761. * @param amount Amount of grain
  148762. */
  148763. setGrainAmount(amount: number): void;
  148764. /**
  148765. * Set grain amount to 0
  148766. */
  148767. disableGrain(): void;
  148768. /**
  148769. * Sets the chromatic aberration amount
  148770. * @param amount amount of chromatic aberration
  148771. */
  148772. setChromaticAberration(amount: number): void;
  148773. /**
  148774. * Sets chromatic aberration amount to 0
  148775. */
  148776. disableChromaticAberration(): void;
  148777. /**
  148778. * Sets the EdgeDistortion amount
  148779. * @param amount amount of EdgeDistortion
  148780. */
  148781. setEdgeDistortion(amount: number): void;
  148782. /**
  148783. * Sets edge distortion to 0
  148784. */
  148785. disableEdgeDistortion(): void;
  148786. /**
  148787. * Sets the FocusDistance amount
  148788. * @param amount amount of FocusDistance
  148789. */
  148790. setFocusDistance(amount: number): void;
  148791. /**
  148792. * Disables depth of field
  148793. */
  148794. disableDepthOfField(): void;
  148795. /**
  148796. * Sets the Aperture amount
  148797. * @param amount amount of Aperture
  148798. */
  148799. setAperture(amount: number): void;
  148800. /**
  148801. * Sets the DarkenOutOfFocus amount
  148802. * @param amount amount of DarkenOutOfFocus
  148803. */
  148804. setDarkenOutOfFocus(amount: number): void;
  148805. private _pentagonBokehIsEnabled;
  148806. /**
  148807. * Creates a pentagon bokeh effect
  148808. */
  148809. enablePentagonBokeh(): void;
  148810. /**
  148811. * Disables the pentagon bokeh effect
  148812. */
  148813. disablePentagonBokeh(): void;
  148814. /**
  148815. * Enables noise blur
  148816. */
  148817. enableNoiseBlur(): void;
  148818. /**
  148819. * Disables noise blur
  148820. */
  148821. disableNoiseBlur(): void;
  148822. /**
  148823. * Sets the HighlightsGain amount
  148824. * @param amount amount of HighlightsGain
  148825. */
  148826. setHighlightsGain(amount: number): void;
  148827. /**
  148828. * Sets the HighlightsThreshold amount
  148829. * @param amount amount of HighlightsThreshold
  148830. */
  148831. setHighlightsThreshold(amount: number): void;
  148832. /**
  148833. * Disables highlights
  148834. */
  148835. disableHighlights(): void;
  148836. /**
  148837. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  148838. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  148839. */
  148840. dispose(disableDepthRender?: boolean): void;
  148841. private _createChromaticAberrationPostProcess;
  148842. private _createHighlightsPostProcess;
  148843. private _createDepthOfFieldPostProcess;
  148844. private _createGrainTexture;
  148845. }
  148846. }
  148847. declare module BABYLON {
  148848. /** @hidden */
  148849. export var ssao2PixelShader: {
  148850. name: string;
  148851. shader: string;
  148852. };
  148853. }
  148854. declare module BABYLON {
  148855. /** @hidden */
  148856. export var ssaoCombinePixelShader: {
  148857. name: string;
  148858. shader: string;
  148859. };
  148860. }
  148861. declare module BABYLON {
  148862. /**
  148863. * Render pipeline to produce ssao effect
  148864. */
  148865. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  148866. /**
  148867. * @ignore
  148868. * The PassPostProcess id in the pipeline that contains the original scene color
  148869. */
  148870. SSAOOriginalSceneColorEffect: string;
  148871. /**
  148872. * @ignore
  148873. * The SSAO PostProcess id in the pipeline
  148874. */
  148875. SSAORenderEffect: string;
  148876. /**
  148877. * @ignore
  148878. * The horizontal blur PostProcess id in the pipeline
  148879. */
  148880. SSAOBlurHRenderEffect: string;
  148881. /**
  148882. * @ignore
  148883. * The vertical blur PostProcess id in the pipeline
  148884. */
  148885. SSAOBlurVRenderEffect: string;
  148886. /**
  148887. * @ignore
  148888. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  148889. */
  148890. SSAOCombineRenderEffect: string;
  148891. /**
  148892. * The output strength of the SSAO post-process. Default value is 1.0.
  148893. */
  148894. totalStrength: number;
  148895. /**
  148896. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  148897. */
  148898. maxZ: number;
  148899. /**
  148900. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  148901. */
  148902. minZAspect: number;
  148903. private _samples;
  148904. /**
  148905. * Number of samples used for the SSAO calculations. Default value is 8
  148906. */
  148907. set samples(n: number);
  148908. get samples(): number;
  148909. private _textureSamples;
  148910. /**
  148911. * Number of samples to use for antialiasing
  148912. */
  148913. set textureSamples(n: number);
  148914. get textureSamples(): number;
  148915. /**
  148916. * Force rendering the geometry through geometry buffer
  148917. */
  148918. private _forceGeometryBuffer;
  148919. /**
  148920. * Ratio object used for SSAO ratio and blur ratio
  148921. */
  148922. private _ratio;
  148923. /**
  148924. * Dynamically generated sphere sampler.
  148925. */
  148926. private _sampleSphere;
  148927. /**
  148928. * Blur filter offsets
  148929. */
  148930. private _samplerOffsets;
  148931. private _expensiveBlur;
  148932. /**
  148933. * If bilateral blur should be used
  148934. */
  148935. set expensiveBlur(b: boolean);
  148936. get expensiveBlur(): boolean;
  148937. /**
  148938. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  148939. */
  148940. radius: number;
  148941. /**
  148942. * The base color of the SSAO post-process
  148943. * The final result is "base + ssao" between [0, 1]
  148944. */
  148945. base: number;
  148946. /**
  148947. * Support test.
  148948. */
  148949. static get IsSupported(): boolean;
  148950. private _scene;
  148951. private _randomTexture;
  148952. private _originalColorPostProcess;
  148953. private _ssaoPostProcess;
  148954. private _blurHPostProcess;
  148955. private _blurVPostProcess;
  148956. private _ssaoCombinePostProcess;
  148957. private _prePassRenderer;
  148958. /**
  148959. * Gets active scene
  148960. */
  148961. get scene(): Scene;
  148962. /**
  148963. * @constructor
  148964. * @param name The rendering pipeline name
  148965. * @param scene The scene linked to this pipeline
  148966. * @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 }
  148967. * @param cameras The array of cameras that the rendering pipeline will be attached to
  148968. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  148969. */
  148970. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  148971. /**
  148972. * Get the class name
  148973. * @returns "SSAO2RenderingPipeline"
  148974. */
  148975. getClassName(): string;
  148976. /**
  148977. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  148978. */
  148979. dispose(disableGeometryBufferRenderer?: boolean): void;
  148980. private _createBlurPostProcess;
  148981. /** @hidden */
  148982. _rebuild(): void;
  148983. private _bits;
  148984. private _radicalInverse_VdC;
  148985. private _hammersley;
  148986. private _hemisphereSample_uniform;
  148987. private _generateHemisphere;
  148988. private _getDefinesForSSAO;
  148989. private _createSSAOPostProcess;
  148990. private _createSSAOCombinePostProcess;
  148991. private _createRandomTexture;
  148992. /**
  148993. * Serialize the rendering pipeline (Used when exporting)
  148994. * @returns the serialized object
  148995. */
  148996. serialize(): any;
  148997. /**
  148998. * Parse the serialized pipeline
  148999. * @param source Source pipeline.
  149000. * @param scene The scene to load the pipeline to.
  149001. * @param rootUrl The URL of the serialized pipeline.
  149002. * @returns An instantiated pipeline from the serialized object.
  149003. */
  149004. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  149005. /**
  149006. * Sets the required values to the prepass renderer.
  149007. * @param prePassRenderer defines the prepass renderer to setup
  149008. * @returns true if the pre pass is needed.
  149009. */
  149010. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149011. }
  149012. }
  149013. declare module BABYLON {
  149014. /** @hidden */
  149015. export var ssaoPixelShader: {
  149016. name: string;
  149017. shader: string;
  149018. };
  149019. }
  149020. declare module BABYLON {
  149021. /**
  149022. * Render pipeline to produce ssao effect
  149023. */
  149024. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  149025. /**
  149026. * @ignore
  149027. * The PassPostProcess id in the pipeline that contains the original scene color
  149028. */
  149029. SSAOOriginalSceneColorEffect: string;
  149030. /**
  149031. * @ignore
  149032. * The SSAO PostProcess id in the pipeline
  149033. */
  149034. SSAORenderEffect: string;
  149035. /**
  149036. * @ignore
  149037. * The horizontal blur PostProcess id in the pipeline
  149038. */
  149039. SSAOBlurHRenderEffect: string;
  149040. /**
  149041. * @ignore
  149042. * The vertical blur PostProcess id in the pipeline
  149043. */
  149044. SSAOBlurVRenderEffect: string;
  149045. /**
  149046. * @ignore
  149047. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  149048. */
  149049. SSAOCombineRenderEffect: string;
  149050. /**
  149051. * The output strength of the SSAO post-process. Default value is 1.0.
  149052. */
  149053. totalStrength: number;
  149054. /**
  149055. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  149056. */
  149057. radius: number;
  149058. /**
  149059. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  149060. * Must not be equal to fallOff and superior to fallOff.
  149061. * Default value is 0.0075
  149062. */
  149063. area: number;
  149064. /**
  149065. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  149066. * Must not be equal to area and inferior to area.
  149067. * Default value is 0.000001
  149068. */
  149069. fallOff: number;
  149070. /**
  149071. * The base color of the SSAO post-process
  149072. * The final result is "base + ssao" between [0, 1]
  149073. */
  149074. base: number;
  149075. private _scene;
  149076. private _depthTexture;
  149077. private _randomTexture;
  149078. private _originalColorPostProcess;
  149079. private _ssaoPostProcess;
  149080. private _blurHPostProcess;
  149081. private _blurVPostProcess;
  149082. private _ssaoCombinePostProcess;
  149083. private _firstUpdate;
  149084. /**
  149085. * Gets active scene
  149086. */
  149087. get scene(): Scene;
  149088. /**
  149089. * @constructor
  149090. * @param name - The rendering pipeline name
  149091. * @param scene - The scene linked to this pipeline
  149092. * @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 }
  149093. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  149094. */
  149095. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  149096. /**
  149097. * Get the class name
  149098. * @returns "SSAORenderingPipeline"
  149099. */
  149100. getClassName(): string;
  149101. /**
  149102. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  149103. */
  149104. dispose(disableDepthRender?: boolean): void;
  149105. private _createBlurPostProcess;
  149106. /** @hidden */
  149107. _rebuild(): void;
  149108. private _createSSAOPostProcess;
  149109. private _createSSAOCombinePostProcess;
  149110. private _createRandomTexture;
  149111. }
  149112. }
  149113. declare module BABYLON {
  149114. /** @hidden */
  149115. export var screenSpaceReflectionPixelShader: {
  149116. name: string;
  149117. shader: string;
  149118. };
  149119. }
  149120. declare module BABYLON {
  149121. /**
  149122. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  149123. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  149124. */
  149125. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  149126. /**
  149127. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  149128. */
  149129. threshold: number;
  149130. /**
  149131. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  149132. */
  149133. strength: number;
  149134. /**
  149135. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  149136. */
  149137. reflectionSpecularFalloffExponent: number;
  149138. /**
  149139. * 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]
  149140. */
  149141. step: number;
  149142. /**
  149143. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  149144. */
  149145. roughnessFactor: number;
  149146. private _geometryBufferRenderer;
  149147. private _enableSmoothReflections;
  149148. private _reflectionSamples;
  149149. private _smoothSteps;
  149150. /**
  149151. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  149152. * @param name The name of the effect.
  149153. * @param scene The scene containing the objects to calculate reflections.
  149154. * @param options The required width/height ratio to downsize to before computing the render pass.
  149155. * @param camera The camera to apply the render pass to.
  149156. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149157. * @param engine The engine which the post process will be applied. (default: current engine)
  149158. * @param reusable If the post process can be reused on the same frame. (default: false)
  149159. * @param textureType Type of textures used when performing the post process. (default: 0)
  149160. * @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)
  149161. */
  149162. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149163. /**
  149164. * Gets wether or not smoothing reflections is enabled.
  149165. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  149166. */
  149167. get enableSmoothReflections(): boolean;
  149168. /**
  149169. * Sets wether or not smoothing reflections is enabled.
  149170. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  149171. */
  149172. set enableSmoothReflections(enabled: boolean);
  149173. /**
  149174. * Gets the number of samples taken while computing reflections. More samples count is high,
  149175. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  149176. */
  149177. get reflectionSamples(): number;
  149178. /**
  149179. * Sets the number of samples taken while computing reflections. More samples count is high,
  149180. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  149181. */
  149182. set reflectionSamples(samples: number);
  149183. /**
  149184. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  149185. * more the post-process will require GPU power and can generate a drop in FPS.
  149186. * Default value (5.0) work pretty well in all cases but can be adjusted.
  149187. */
  149188. get smoothSteps(): number;
  149189. set smoothSteps(steps: number);
  149190. private _updateEffectDefines;
  149191. }
  149192. }
  149193. declare module BABYLON {
  149194. /** @hidden */
  149195. export var standardPixelShader: {
  149196. name: string;
  149197. shader: string;
  149198. };
  149199. }
  149200. declare module BABYLON {
  149201. /**
  149202. * Standard rendering pipeline
  149203. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  149204. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  149205. */
  149206. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149207. /**
  149208. * Public members
  149209. */
  149210. /**
  149211. * Post-process which contains the original scene color before the pipeline applies all the effects
  149212. */
  149213. originalPostProcess: Nullable<PostProcess>;
  149214. /**
  149215. * Post-process used to down scale an image x4
  149216. */
  149217. downSampleX4PostProcess: Nullable<PostProcess>;
  149218. /**
  149219. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  149220. */
  149221. brightPassPostProcess: Nullable<PostProcess>;
  149222. /**
  149223. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  149224. */
  149225. blurHPostProcesses: PostProcess[];
  149226. /**
  149227. * Post-process array storing all the vertical blur post-processes used by the pipeline
  149228. */
  149229. blurVPostProcesses: PostProcess[];
  149230. /**
  149231. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  149232. */
  149233. textureAdderPostProcess: Nullable<PostProcess>;
  149234. /**
  149235. * Post-process used to create volumetric lighting effect
  149236. */
  149237. volumetricLightPostProcess: Nullable<PostProcess>;
  149238. /**
  149239. * Post-process used to smooth the previous volumetric light post-process on the X axis
  149240. */
  149241. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  149242. /**
  149243. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  149244. */
  149245. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  149246. /**
  149247. * Post-process used to merge the volumetric light effect and the real scene color
  149248. */
  149249. volumetricLightMergePostProces: Nullable<PostProcess>;
  149250. /**
  149251. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  149252. */
  149253. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  149254. /**
  149255. * Base post-process used to calculate the average luminance of the final image for HDR
  149256. */
  149257. luminancePostProcess: Nullable<PostProcess>;
  149258. /**
  149259. * Post-processes used to create down sample post-processes in order to get
  149260. * the average luminance of the final image for HDR
  149261. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  149262. */
  149263. luminanceDownSamplePostProcesses: PostProcess[];
  149264. /**
  149265. * Post-process used to create a HDR effect (light adaptation)
  149266. */
  149267. hdrPostProcess: Nullable<PostProcess>;
  149268. /**
  149269. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  149270. */
  149271. textureAdderFinalPostProcess: Nullable<PostProcess>;
  149272. /**
  149273. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  149274. */
  149275. lensFlareFinalPostProcess: Nullable<PostProcess>;
  149276. /**
  149277. * Post-process used to merge the final HDR post-process and the real scene color
  149278. */
  149279. hdrFinalPostProcess: Nullable<PostProcess>;
  149280. /**
  149281. * Post-process used to create a lens flare effect
  149282. */
  149283. lensFlarePostProcess: Nullable<PostProcess>;
  149284. /**
  149285. * Post-process that merges the result of the lens flare post-process and the real scene color
  149286. */
  149287. lensFlareComposePostProcess: Nullable<PostProcess>;
  149288. /**
  149289. * Post-process used to create a motion blur effect
  149290. */
  149291. motionBlurPostProcess: Nullable<PostProcess>;
  149292. /**
  149293. * Post-process used to create a depth of field effect
  149294. */
  149295. depthOfFieldPostProcess: Nullable<PostProcess>;
  149296. /**
  149297. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149298. */
  149299. fxaaPostProcess: Nullable<FxaaPostProcess>;
  149300. /**
  149301. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  149302. */
  149303. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  149304. /**
  149305. * Represents the brightness threshold in order to configure the illuminated surfaces
  149306. */
  149307. brightThreshold: number;
  149308. /**
  149309. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  149310. */
  149311. blurWidth: number;
  149312. /**
  149313. * Sets if the blur for highlighted surfaces must be only horizontal
  149314. */
  149315. horizontalBlur: boolean;
  149316. /**
  149317. * Gets the overall exposure used by the pipeline
  149318. */
  149319. get exposure(): number;
  149320. /**
  149321. * Sets the overall exposure used by the pipeline
  149322. */
  149323. set exposure(value: number);
  149324. /**
  149325. * Texture used typically to simulate "dirty" on camera lens
  149326. */
  149327. lensTexture: Nullable<Texture>;
  149328. /**
  149329. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  149330. */
  149331. volumetricLightCoefficient: number;
  149332. /**
  149333. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  149334. */
  149335. volumetricLightPower: number;
  149336. /**
  149337. * Used the set the blur intensity to smooth the volumetric lights
  149338. */
  149339. volumetricLightBlurScale: number;
  149340. /**
  149341. * Light (spot or directional) used to generate the volumetric lights rays
  149342. * The source light must have a shadow generate so the pipeline can get its
  149343. * depth map
  149344. */
  149345. sourceLight: Nullable<SpotLight | DirectionalLight>;
  149346. /**
  149347. * For eye adaptation, represents the minimum luminance the eye can see
  149348. */
  149349. hdrMinimumLuminance: number;
  149350. /**
  149351. * For eye adaptation, represents the decrease luminance speed
  149352. */
  149353. hdrDecreaseRate: number;
  149354. /**
  149355. * For eye adaptation, represents the increase luminance speed
  149356. */
  149357. hdrIncreaseRate: number;
  149358. /**
  149359. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  149360. */
  149361. get hdrAutoExposure(): boolean;
  149362. /**
  149363. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  149364. */
  149365. set hdrAutoExposure(value: boolean);
  149366. /**
  149367. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  149368. */
  149369. lensColorTexture: Nullable<Texture>;
  149370. /**
  149371. * The overall strengh for the lens flare effect
  149372. */
  149373. lensFlareStrength: number;
  149374. /**
  149375. * Dispersion coefficient for lens flare ghosts
  149376. */
  149377. lensFlareGhostDispersal: number;
  149378. /**
  149379. * Main lens flare halo width
  149380. */
  149381. lensFlareHaloWidth: number;
  149382. /**
  149383. * Based on the lens distortion effect, defines how much the lens flare result
  149384. * is distorted
  149385. */
  149386. lensFlareDistortionStrength: number;
  149387. /**
  149388. * Configures the blur intensity used for for lens flare (halo)
  149389. */
  149390. lensFlareBlurWidth: number;
  149391. /**
  149392. * Lens star texture must be used to simulate rays on the flares and is available
  149393. * in the documentation
  149394. */
  149395. lensStarTexture: Nullable<Texture>;
  149396. /**
  149397. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  149398. * flare effect by taking account of the dirt texture
  149399. */
  149400. lensFlareDirtTexture: Nullable<Texture>;
  149401. /**
  149402. * Represents the focal length for the depth of field effect
  149403. */
  149404. depthOfFieldDistance: number;
  149405. /**
  149406. * Represents the blur intensity for the blurred part of the depth of field effect
  149407. */
  149408. depthOfFieldBlurWidth: number;
  149409. /**
  149410. * Gets how much the image is blurred by the movement while using the motion blur post-process
  149411. */
  149412. get motionStrength(): number;
  149413. /**
  149414. * Sets how much the image is blurred by the movement while using the motion blur post-process
  149415. */
  149416. set motionStrength(strength: number);
  149417. /**
  149418. * Gets wether or not the motion blur post-process is object based or screen based.
  149419. */
  149420. get objectBasedMotionBlur(): boolean;
  149421. /**
  149422. * Sets wether or not the motion blur post-process should be object based or screen based
  149423. */
  149424. set objectBasedMotionBlur(value: boolean);
  149425. /**
  149426. * List of animations for the pipeline (IAnimatable implementation)
  149427. */
  149428. animations: Animation[];
  149429. /**
  149430. * Private members
  149431. */
  149432. private _scene;
  149433. private _currentDepthOfFieldSource;
  149434. private _basePostProcess;
  149435. private _fixedExposure;
  149436. private _currentExposure;
  149437. private _hdrAutoExposure;
  149438. private _hdrCurrentLuminance;
  149439. private _motionStrength;
  149440. private _isObjectBasedMotionBlur;
  149441. private _floatTextureType;
  149442. private _camerasToBeAttached;
  149443. private _ratio;
  149444. private _bloomEnabled;
  149445. private _depthOfFieldEnabled;
  149446. private _vlsEnabled;
  149447. private _lensFlareEnabled;
  149448. private _hdrEnabled;
  149449. private _motionBlurEnabled;
  149450. private _fxaaEnabled;
  149451. private _screenSpaceReflectionsEnabled;
  149452. private _motionBlurSamples;
  149453. private _volumetricLightStepsCount;
  149454. private _samples;
  149455. /**
  149456. * @ignore
  149457. * Specifies if the bloom pipeline is enabled
  149458. */
  149459. get BloomEnabled(): boolean;
  149460. set BloomEnabled(enabled: boolean);
  149461. /**
  149462. * @ignore
  149463. * Specifies if the depth of field pipeline is enabed
  149464. */
  149465. get DepthOfFieldEnabled(): boolean;
  149466. set DepthOfFieldEnabled(enabled: boolean);
  149467. /**
  149468. * @ignore
  149469. * Specifies if the lens flare pipeline is enabed
  149470. */
  149471. get LensFlareEnabled(): boolean;
  149472. set LensFlareEnabled(enabled: boolean);
  149473. /**
  149474. * @ignore
  149475. * Specifies if the HDR pipeline is enabled
  149476. */
  149477. get HDREnabled(): boolean;
  149478. set HDREnabled(enabled: boolean);
  149479. /**
  149480. * @ignore
  149481. * Specifies if the volumetric lights scattering effect is enabled
  149482. */
  149483. get VLSEnabled(): boolean;
  149484. set VLSEnabled(enabled: boolean);
  149485. /**
  149486. * @ignore
  149487. * Specifies if the motion blur effect is enabled
  149488. */
  149489. get MotionBlurEnabled(): boolean;
  149490. set MotionBlurEnabled(enabled: boolean);
  149491. /**
  149492. * Specifies if anti-aliasing is enabled
  149493. */
  149494. get fxaaEnabled(): boolean;
  149495. set fxaaEnabled(enabled: boolean);
  149496. /**
  149497. * Specifies if screen space reflections are enabled.
  149498. */
  149499. get screenSpaceReflectionsEnabled(): boolean;
  149500. set screenSpaceReflectionsEnabled(enabled: boolean);
  149501. /**
  149502. * Specifies the number of steps used to calculate the volumetric lights
  149503. * Typically in interval [50, 200]
  149504. */
  149505. get volumetricLightStepsCount(): number;
  149506. set volumetricLightStepsCount(count: number);
  149507. /**
  149508. * Specifies the number of samples used for the motion blur effect
  149509. * Typically in interval [16, 64]
  149510. */
  149511. get motionBlurSamples(): number;
  149512. set motionBlurSamples(samples: number);
  149513. /**
  149514. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149515. */
  149516. get samples(): number;
  149517. set samples(sampleCount: number);
  149518. /**
  149519. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  149520. * @constructor
  149521. * @param name The rendering pipeline name
  149522. * @param scene The scene linked to this pipeline
  149523. * @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)
  149524. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  149525. * @param cameras The array of cameras that the rendering pipeline will be attached to
  149526. */
  149527. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  149528. private _buildPipeline;
  149529. private _createDownSampleX4PostProcess;
  149530. private _createBrightPassPostProcess;
  149531. private _createBlurPostProcesses;
  149532. private _createTextureAdderPostProcess;
  149533. private _createVolumetricLightPostProcess;
  149534. private _createLuminancePostProcesses;
  149535. private _createHdrPostProcess;
  149536. private _createLensFlarePostProcess;
  149537. private _createDepthOfFieldPostProcess;
  149538. private _createMotionBlurPostProcess;
  149539. private _getDepthTexture;
  149540. private _disposePostProcesses;
  149541. /**
  149542. * Dispose of the pipeline and stop all post processes
  149543. */
  149544. dispose(): void;
  149545. /**
  149546. * Serialize the rendering pipeline (Used when exporting)
  149547. * @returns the serialized object
  149548. */
  149549. serialize(): any;
  149550. /**
  149551. * Parse the serialized pipeline
  149552. * @param source Source pipeline.
  149553. * @param scene The scene to load the pipeline to.
  149554. * @param rootUrl The URL of the serialized pipeline.
  149555. * @returns An instantiated pipeline from the serialized object.
  149556. */
  149557. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  149558. /**
  149559. * Luminance steps
  149560. */
  149561. static LuminanceSteps: number;
  149562. }
  149563. }
  149564. declare module BABYLON {
  149565. /** @hidden */
  149566. export var stereoscopicInterlacePixelShader: {
  149567. name: string;
  149568. shader: string;
  149569. };
  149570. }
  149571. declare module BABYLON {
  149572. /**
  149573. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  149574. */
  149575. export class StereoscopicInterlacePostProcessI extends PostProcess {
  149576. private _stepSize;
  149577. private _passedProcess;
  149578. /**
  149579. * Initializes a StereoscopicInterlacePostProcessI
  149580. * @param name The name of the effect.
  149581. * @param rigCameras The rig cameras to be appled to the post process
  149582. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  149583. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  149584. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149585. * @param engine The engine which the post process will be applied. (default: current engine)
  149586. * @param reusable If the post process can be reused on the same frame. (default: false)
  149587. */
  149588. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149589. }
  149590. /**
  149591. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  149592. */
  149593. export class StereoscopicInterlacePostProcess extends PostProcess {
  149594. private _stepSize;
  149595. private _passedProcess;
  149596. /**
  149597. * Initializes a StereoscopicInterlacePostProcess
  149598. * @param name The name of the effect.
  149599. * @param rigCameras The rig cameras to be appled to the post process
  149600. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  149601. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149602. * @param engine The engine which the post process will be applied. (default: current engine)
  149603. * @param reusable If the post process can be reused on the same frame. (default: false)
  149604. */
  149605. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149606. }
  149607. }
  149608. declare module BABYLON {
  149609. /** @hidden */
  149610. export var tonemapPixelShader: {
  149611. name: string;
  149612. shader: string;
  149613. };
  149614. }
  149615. declare module BABYLON {
  149616. /** Defines operator used for tonemapping */
  149617. export enum TonemappingOperator {
  149618. /** Hable */
  149619. Hable = 0,
  149620. /** Reinhard */
  149621. Reinhard = 1,
  149622. /** HejiDawson */
  149623. HejiDawson = 2,
  149624. /** Photographic */
  149625. Photographic = 3
  149626. }
  149627. /**
  149628. * Defines a post process to apply tone mapping
  149629. */
  149630. export class TonemapPostProcess extends PostProcess {
  149631. private _operator;
  149632. /** Defines the required exposure adjustement */
  149633. exposureAdjustment: number;
  149634. /**
  149635. * Creates a new TonemapPostProcess
  149636. * @param name defines the name of the postprocess
  149637. * @param _operator defines the operator to use
  149638. * @param exposureAdjustment defines the required exposure adjustement
  149639. * @param camera defines the camera to use (can be null)
  149640. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  149641. * @param engine defines the hosting engine (can be ignore if camera is set)
  149642. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  149643. */
  149644. constructor(name: string, _operator: TonemappingOperator,
  149645. /** Defines the required exposure adjustement */
  149646. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  149647. }
  149648. }
  149649. declare module BABYLON {
  149650. /** @hidden */
  149651. export var volumetricLightScatteringPixelShader: {
  149652. name: string;
  149653. shader: string;
  149654. };
  149655. }
  149656. declare module BABYLON {
  149657. /** @hidden */
  149658. export var volumetricLightScatteringPassVertexShader: {
  149659. name: string;
  149660. shader: string;
  149661. };
  149662. }
  149663. declare module BABYLON {
  149664. /** @hidden */
  149665. export var volumetricLightScatteringPassPixelShader: {
  149666. name: string;
  149667. shader: string;
  149668. };
  149669. }
  149670. declare module BABYLON {
  149671. /**
  149672. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  149673. */
  149674. export class VolumetricLightScatteringPostProcess extends PostProcess {
  149675. private _volumetricLightScatteringPass;
  149676. private _volumetricLightScatteringRTT;
  149677. private _viewPort;
  149678. private _screenCoordinates;
  149679. private _cachedDefines;
  149680. /**
  149681. * If not undefined, the mesh position is computed from the attached node position
  149682. */
  149683. attachedNode: {
  149684. position: Vector3;
  149685. };
  149686. /**
  149687. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  149688. */
  149689. customMeshPosition: Vector3;
  149690. /**
  149691. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  149692. */
  149693. useCustomMeshPosition: boolean;
  149694. /**
  149695. * If the post-process should inverse the light scattering direction
  149696. */
  149697. invert: boolean;
  149698. /**
  149699. * The internal mesh used by the post-process
  149700. */
  149701. mesh: Mesh;
  149702. /**
  149703. * @hidden
  149704. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  149705. */
  149706. get useDiffuseColor(): boolean;
  149707. set useDiffuseColor(useDiffuseColor: boolean);
  149708. /**
  149709. * Array containing the excluded meshes not rendered in the internal pass
  149710. */
  149711. excludedMeshes: AbstractMesh[];
  149712. /**
  149713. * Controls the overall intensity of the post-process
  149714. */
  149715. exposure: number;
  149716. /**
  149717. * Dissipates each sample's contribution in range [0, 1]
  149718. */
  149719. decay: number;
  149720. /**
  149721. * Controls the overall intensity of each sample
  149722. */
  149723. weight: number;
  149724. /**
  149725. * Controls the density of each sample
  149726. */
  149727. density: number;
  149728. /**
  149729. * @constructor
  149730. * @param name The post-process name
  149731. * @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)
  149732. * @param camera The camera that the post-process will be attached to
  149733. * @param mesh The mesh used to create the light scattering
  149734. * @param samples The post-process quality, default 100
  149735. * @param samplingModeThe post-process filtering mode
  149736. * @param engine The babylon engine
  149737. * @param reusable If the post-process is reusable
  149738. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  149739. */
  149740. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  149741. /**
  149742. * Returns the string "VolumetricLightScatteringPostProcess"
  149743. * @returns "VolumetricLightScatteringPostProcess"
  149744. */
  149745. getClassName(): string;
  149746. private _isReady;
  149747. /**
  149748. * Sets the new light position for light scattering effect
  149749. * @param position The new custom light position
  149750. */
  149751. setCustomMeshPosition(position: Vector3): void;
  149752. /**
  149753. * Returns the light position for light scattering effect
  149754. * @return Vector3 The custom light position
  149755. */
  149756. getCustomMeshPosition(): Vector3;
  149757. /**
  149758. * Disposes the internal assets and detaches the post-process from the camera
  149759. */
  149760. dispose(camera: Camera): void;
  149761. /**
  149762. * Returns the render target texture used by the post-process
  149763. * @return the render target texture used by the post-process
  149764. */
  149765. getPass(): RenderTargetTexture;
  149766. private _meshExcluded;
  149767. private _createPass;
  149768. private _updateMeshScreenCoordinates;
  149769. /**
  149770. * Creates a default mesh for the Volumeric Light Scattering post-process
  149771. * @param name The mesh name
  149772. * @param scene The scene where to create the mesh
  149773. * @return the default mesh
  149774. */
  149775. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  149776. }
  149777. }
  149778. declare module BABYLON {
  149779. /** @hidden */
  149780. export var screenSpaceCurvaturePixelShader: {
  149781. name: string;
  149782. shader: string;
  149783. };
  149784. }
  149785. declare module BABYLON {
  149786. /**
  149787. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  149788. */
  149789. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  149790. /**
  149791. * Defines how much ridge the curvature effect displays.
  149792. */
  149793. ridge: number;
  149794. /**
  149795. * Defines how much valley the curvature effect displays.
  149796. */
  149797. valley: number;
  149798. private _geometryBufferRenderer;
  149799. /**
  149800. * Creates a new instance ScreenSpaceCurvaturePostProcess
  149801. * @param name The name of the effect.
  149802. * @param scene The scene containing the objects to blur according to their velocity.
  149803. * @param options The required width/height ratio to downsize to before computing the render pass.
  149804. * @param camera The camera to apply the render pass to.
  149805. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149806. * @param engine The engine which the post process will be applied. (default: current engine)
  149807. * @param reusable If the post process can be reused on the same frame. (default: false)
  149808. * @param textureType Type of textures used when performing the post process. (default: 0)
  149809. * @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)
  149810. */
  149811. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149812. /**
  149813. * Support test.
  149814. */
  149815. static get IsSupported(): boolean;
  149816. }
  149817. }
  149818. declare module BABYLON {
  149819. interface Scene {
  149820. /** @hidden (Backing field) */
  149821. _boundingBoxRenderer: BoundingBoxRenderer;
  149822. /** @hidden (Backing field) */
  149823. _forceShowBoundingBoxes: boolean;
  149824. /**
  149825. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  149826. */
  149827. forceShowBoundingBoxes: boolean;
  149828. /**
  149829. * Gets the bounding box renderer associated with the scene
  149830. * @returns a BoundingBoxRenderer
  149831. */
  149832. getBoundingBoxRenderer(): BoundingBoxRenderer;
  149833. }
  149834. interface AbstractMesh {
  149835. /** @hidden (Backing field) */
  149836. _showBoundingBox: boolean;
  149837. /**
  149838. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  149839. */
  149840. showBoundingBox: boolean;
  149841. }
  149842. /**
  149843. * Component responsible of rendering the bounding box of the meshes in a scene.
  149844. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  149845. */
  149846. export class BoundingBoxRenderer implements ISceneComponent {
  149847. /**
  149848. * The component name helpfull to identify the component in the list of scene components.
  149849. */
  149850. readonly name: string;
  149851. /**
  149852. * The scene the component belongs to.
  149853. */
  149854. scene: Scene;
  149855. /**
  149856. * Color of the bounding box lines placed in front of an object
  149857. */
  149858. frontColor: Color3;
  149859. /**
  149860. * Color of the bounding box lines placed behind an object
  149861. */
  149862. backColor: Color3;
  149863. /**
  149864. * Defines if the renderer should show the back lines or not
  149865. */
  149866. showBackLines: boolean;
  149867. /**
  149868. * Observable raised before rendering a bounding box
  149869. */
  149870. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  149871. /**
  149872. * Observable raised after rendering a bounding box
  149873. */
  149874. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  149875. /**
  149876. * @hidden
  149877. */
  149878. renderList: SmartArray<BoundingBox>;
  149879. private _colorShader;
  149880. private _vertexBuffers;
  149881. private _indexBuffer;
  149882. private _fillIndexBuffer;
  149883. private _fillIndexData;
  149884. /**
  149885. * Instantiates a new bounding box renderer in a scene.
  149886. * @param scene the scene the renderer renders in
  149887. */
  149888. constructor(scene: Scene);
  149889. /**
  149890. * Registers the component in a given scene
  149891. */
  149892. register(): void;
  149893. private _evaluateSubMesh;
  149894. private _activeMesh;
  149895. private _prepareRessources;
  149896. private _createIndexBuffer;
  149897. /**
  149898. * Rebuilds the elements related to this component in case of
  149899. * context lost for instance.
  149900. */
  149901. rebuild(): void;
  149902. /**
  149903. * @hidden
  149904. */
  149905. reset(): void;
  149906. /**
  149907. * Render the bounding boxes of a specific rendering group
  149908. * @param renderingGroupId defines the rendering group to render
  149909. */
  149910. render(renderingGroupId: number): void;
  149911. /**
  149912. * In case of occlusion queries, we can render the occlusion bounding box through this method
  149913. * @param mesh Define the mesh to render the occlusion bounding box for
  149914. */
  149915. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  149916. /**
  149917. * Dispose and release the resources attached to this renderer.
  149918. */
  149919. dispose(): void;
  149920. }
  149921. }
  149922. declare module BABYLON {
  149923. interface Scene {
  149924. /** @hidden (Backing field) */
  149925. _depthRenderer: {
  149926. [id: string]: DepthRenderer;
  149927. };
  149928. /**
  149929. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  149930. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  149931. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  149932. * @returns the created depth renderer
  149933. */
  149934. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  149935. /**
  149936. * Disables a depth renderer for a given camera
  149937. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  149938. */
  149939. disableDepthRenderer(camera?: Nullable<Camera>): void;
  149940. }
  149941. /**
  149942. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  149943. * in several rendering techniques.
  149944. */
  149945. export class DepthRendererSceneComponent implements ISceneComponent {
  149946. /**
  149947. * The component name helpfull to identify the component in the list of scene components.
  149948. */
  149949. readonly name: string;
  149950. /**
  149951. * The scene the component belongs to.
  149952. */
  149953. scene: Scene;
  149954. /**
  149955. * Creates a new instance of the component for the given scene
  149956. * @param scene Defines the scene to register the component in
  149957. */
  149958. constructor(scene: Scene);
  149959. /**
  149960. * Registers the component in a given scene
  149961. */
  149962. register(): void;
  149963. /**
  149964. * Rebuilds the elements related to this component in case of
  149965. * context lost for instance.
  149966. */
  149967. rebuild(): void;
  149968. /**
  149969. * Disposes the component and the associated ressources
  149970. */
  149971. dispose(): void;
  149972. private _gatherRenderTargets;
  149973. private _gatherActiveCameraRenderTargets;
  149974. }
  149975. }
  149976. declare module BABYLON {
  149977. interface AbstractScene {
  149978. /** @hidden (Backing field) */
  149979. _prePassRenderer: Nullable<PrePassRenderer>;
  149980. /**
  149981. * Gets or Sets the current prepass renderer associated to the scene.
  149982. */
  149983. prePassRenderer: Nullable<PrePassRenderer>;
  149984. /**
  149985. * Enables the prepass and associates it with the scene
  149986. * @returns the PrePassRenderer
  149987. */
  149988. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  149989. /**
  149990. * Disables the prepass associated with the scene
  149991. */
  149992. disablePrePassRenderer(): void;
  149993. }
  149994. /**
  149995. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149996. * in several rendering techniques.
  149997. */
  149998. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  149999. /**
  150000. * The component name helpful to identify the component in the list of scene components.
  150001. */
  150002. readonly name: string;
  150003. /**
  150004. * The scene the component belongs to.
  150005. */
  150006. scene: Scene;
  150007. /**
  150008. * Creates a new instance of the component for the given scene
  150009. * @param scene Defines the scene to register the component in
  150010. */
  150011. constructor(scene: Scene);
  150012. /**
  150013. * Registers the component in a given scene
  150014. */
  150015. register(): void;
  150016. private _beforeCameraDraw;
  150017. private _afterCameraDraw;
  150018. private _beforeClearStage;
  150019. /**
  150020. * Serializes the component data to the specified json object
  150021. * @param serializationObject The object to serialize to
  150022. */
  150023. serialize(serializationObject: any): void;
  150024. /**
  150025. * Adds all the elements from the container to the scene
  150026. * @param container the container holding the elements
  150027. */
  150028. addFromContainer(container: AbstractScene): void;
  150029. /**
  150030. * Removes all the elements in the container from the scene
  150031. * @param container contains the elements to remove
  150032. * @param dispose if the removed element should be disposed (default: false)
  150033. */
  150034. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  150035. /**
  150036. * Rebuilds the elements related to this component in case of
  150037. * context lost for instance.
  150038. */
  150039. rebuild(): void;
  150040. /**
  150041. * Disposes the component and the associated ressources
  150042. */
  150043. dispose(): void;
  150044. }
  150045. }
  150046. declare module BABYLON {
  150047. /** @hidden */
  150048. export var outlinePixelShader: {
  150049. name: string;
  150050. shader: string;
  150051. };
  150052. }
  150053. declare module BABYLON {
  150054. /** @hidden */
  150055. export var outlineVertexShader: {
  150056. name: string;
  150057. shader: string;
  150058. };
  150059. }
  150060. declare module BABYLON {
  150061. interface Scene {
  150062. /** @hidden */
  150063. _outlineRenderer: OutlineRenderer;
  150064. /**
  150065. * Gets the outline renderer associated with the scene
  150066. * @returns a OutlineRenderer
  150067. */
  150068. getOutlineRenderer(): OutlineRenderer;
  150069. }
  150070. interface AbstractMesh {
  150071. /** @hidden (Backing field) */
  150072. _renderOutline: boolean;
  150073. /**
  150074. * Gets or sets a boolean indicating if the outline must be rendered as well
  150075. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  150076. */
  150077. renderOutline: boolean;
  150078. /** @hidden (Backing field) */
  150079. _renderOverlay: boolean;
  150080. /**
  150081. * Gets or sets a boolean indicating if the overlay must be rendered as well
  150082. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  150083. */
  150084. renderOverlay: boolean;
  150085. }
  150086. /**
  150087. * This class is responsible to draw bothe outline/overlay of meshes.
  150088. * It should not be used directly but through the available method on mesh.
  150089. */
  150090. export class OutlineRenderer implements ISceneComponent {
  150091. /**
  150092. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  150093. */
  150094. private static _StencilReference;
  150095. /**
  150096. * The name of the component. Each component must have a unique name.
  150097. */
  150098. name: string;
  150099. /**
  150100. * The scene the component belongs to.
  150101. */
  150102. scene: Scene;
  150103. /**
  150104. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  150105. */
  150106. zOffset: number;
  150107. private _engine;
  150108. private _effect;
  150109. private _cachedDefines;
  150110. private _savedDepthWrite;
  150111. /**
  150112. * Instantiates a new outline renderer. (There could be only one per scene).
  150113. * @param scene Defines the scene it belongs to
  150114. */
  150115. constructor(scene: Scene);
  150116. /**
  150117. * Register the component to one instance of a scene.
  150118. */
  150119. register(): void;
  150120. /**
  150121. * Rebuilds the elements related to this component in case of
  150122. * context lost for instance.
  150123. */
  150124. rebuild(): void;
  150125. /**
  150126. * Disposes the component and the associated ressources.
  150127. */
  150128. dispose(): void;
  150129. /**
  150130. * Renders the outline in the canvas.
  150131. * @param subMesh Defines the sumesh to render
  150132. * @param batch Defines the batch of meshes in case of instances
  150133. * @param useOverlay Defines if the rendering is for the overlay or the outline
  150134. */
  150135. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  150136. /**
  150137. * Returns whether or not the outline renderer is ready for a given submesh.
  150138. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  150139. * @param subMesh Defines the submesh to check readyness for
  150140. * @param useInstances Defines wheter wee are trying to render instances or not
  150141. * @returns true if ready otherwise false
  150142. */
  150143. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  150144. private _beforeRenderingMesh;
  150145. private _afterRenderingMesh;
  150146. }
  150147. }
  150148. declare module BABYLON {
  150149. /**
  150150. * Defines the basic options interface of a Sprite Frame Source Size.
  150151. */
  150152. export interface ISpriteJSONSpriteSourceSize {
  150153. /**
  150154. * number of the original width of the Frame
  150155. */
  150156. w: number;
  150157. /**
  150158. * number of the original height of the Frame
  150159. */
  150160. h: number;
  150161. }
  150162. /**
  150163. * Defines the basic options interface of a Sprite Frame Data.
  150164. */
  150165. export interface ISpriteJSONSpriteFrameData {
  150166. /**
  150167. * number of the x offset of the Frame
  150168. */
  150169. x: number;
  150170. /**
  150171. * number of the y offset of the Frame
  150172. */
  150173. y: number;
  150174. /**
  150175. * number of the width of the Frame
  150176. */
  150177. w: number;
  150178. /**
  150179. * number of the height of the Frame
  150180. */
  150181. h: number;
  150182. }
  150183. /**
  150184. * Defines the basic options interface of a JSON Sprite.
  150185. */
  150186. export interface ISpriteJSONSprite {
  150187. /**
  150188. * string name of the Frame
  150189. */
  150190. filename: string;
  150191. /**
  150192. * ISpriteJSONSpriteFrame basic object of the frame data
  150193. */
  150194. frame: ISpriteJSONSpriteFrameData;
  150195. /**
  150196. * boolean to flag is the frame was rotated.
  150197. */
  150198. rotated: boolean;
  150199. /**
  150200. * boolean to flag is the frame was trimmed.
  150201. */
  150202. trimmed: boolean;
  150203. /**
  150204. * ISpriteJSONSpriteFrame basic object of the source data
  150205. */
  150206. spriteSourceSize: ISpriteJSONSpriteFrameData;
  150207. /**
  150208. * ISpriteJSONSpriteFrame basic object of the source data
  150209. */
  150210. sourceSize: ISpriteJSONSpriteSourceSize;
  150211. }
  150212. /**
  150213. * Defines the basic options interface of a JSON atlas.
  150214. */
  150215. export interface ISpriteJSONAtlas {
  150216. /**
  150217. * Array of objects that contain the frame data.
  150218. */
  150219. frames: Array<ISpriteJSONSprite>;
  150220. /**
  150221. * object basic object containing the sprite meta data.
  150222. */
  150223. meta?: object;
  150224. }
  150225. }
  150226. declare module BABYLON {
  150227. /** @hidden */
  150228. export var spriteMapPixelShader: {
  150229. name: string;
  150230. shader: string;
  150231. };
  150232. }
  150233. declare module BABYLON {
  150234. /** @hidden */
  150235. export var spriteMapVertexShader: {
  150236. name: string;
  150237. shader: string;
  150238. };
  150239. }
  150240. declare module BABYLON {
  150241. /**
  150242. * Defines the basic options interface of a SpriteMap
  150243. */
  150244. export interface ISpriteMapOptions {
  150245. /**
  150246. * Vector2 of the number of cells in the grid.
  150247. */
  150248. stageSize?: Vector2;
  150249. /**
  150250. * Vector2 of the size of the output plane in World Units.
  150251. */
  150252. outputSize?: Vector2;
  150253. /**
  150254. * Vector3 of the position of the output plane in World Units.
  150255. */
  150256. outputPosition?: Vector3;
  150257. /**
  150258. * Vector3 of the rotation of the output plane.
  150259. */
  150260. outputRotation?: Vector3;
  150261. /**
  150262. * number of layers that the system will reserve in resources.
  150263. */
  150264. layerCount?: number;
  150265. /**
  150266. * number of max animation frames a single cell will reserve in resources.
  150267. */
  150268. maxAnimationFrames?: number;
  150269. /**
  150270. * number cell index of the base tile when the system compiles.
  150271. */
  150272. baseTile?: number;
  150273. /**
  150274. * boolean flip the sprite after its been repositioned by the framing data.
  150275. */
  150276. flipU?: boolean;
  150277. /**
  150278. * Vector3 scalar of the global RGB values of the SpriteMap.
  150279. */
  150280. colorMultiply?: Vector3;
  150281. }
  150282. /**
  150283. * Defines the IDisposable interface in order to be cleanable from resources.
  150284. */
  150285. export interface ISpriteMap extends IDisposable {
  150286. /**
  150287. * String name of the SpriteMap.
  150288. */
  150289. name: string;
  150290. /**
  150291. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  150292. */
  150293. atlasJSON: ISpriteJSONAtlas;
  150294. /**
  150295. * Texture of the SpriteMap.
  150296. */
  150297. spriteSheet: Texture;
  150298. /**
  150299. * The parameters to initialize the SpriteMap with.
  150300. */
  150301. options: ISpriteMapOptions;
  150302. }
  150303. /**
  150304. * Class used to manage a grid restricted sprite deployment on an Output plane.
  150305. */
  150306. export class SpriteMap implements ISpriteMap {
  150307. /** The Name of the spriteMap */
  150308. name: string;
  150309. /** The JSON file with the frame and meta data */
  150310. atlasJSON: ISpriteJSONAtlas;
  150311. /** The systems Sprite Sheet Texture */
  150312. spriteSheet: Texture;
  150313. /** Arguments passed with the Constructor */
  150314. options: ISpriteMapOptions;
  150315. /** Public Sprite Storage array, parsed from atlasJSON */
  150316. sprites: Array<ISpriteJSONSprite>;
  150317. /** Returns the Number of Sprites in the System */
  150318. get spriteCount(): number;
  150319. /** Returns the Position of Output Plane*/
  150320. get position(): Vector3;
  150321. /** Returns the Position of Output Plane*/
  150322. set position(v: Vector3);
  150323. /** Returns the Rotation of Output Plane*/
  150324. get rotation(): Vector3;
  150325. /** Returns the Rotation of Output Plane*/
  150326. set rotation(v: Vector3);
  150327. /** Sets the AnimationMap*/
  150328. get animationMap(): RawTexture;
  150329. /** Sets the AnimationMap*/
  150330. set animationMap(v: RawTexture);
  150331. /** Scene that the SpriteMap was created in */
  150332. private _scene;
  150333. /** Texture Buffer of Float32 that holds tile frame data*/
  150334. private _frameMap;
  150335. /** Texture Buffers of Float32 that holds tileMap data*/
  150336. private _tileMaps;
  150337. /** Texture Buffer of Float32 that holds Animation Data*/
  150338. private _animationMap;
  150339. /** Custom ShaderMaterial Central to the System*/
  150340. private _material;
  150341. /** Custom ShaderMaterial Central to the System*/
  150342. private _output;
  150343. /** Systems Time Ticker*/
  150344. private _time;
  150345. /**
  150346. * Creates a new SpriteMap
  150347. * @param name defines the SpriteMaps Name
  150348. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  150349. * @param spriteSheet is the Texture that the Sprites are on.
  150350. * @param options a basic deployment configuration
  150351. * @param scene The Scene that the map is deployed on
  150352. */
  150353. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  150354. /**
  150355. * Returns tileID location
  150356. * @returns Vector2 the cell position ID
  150357. */
  150358. getTileID(): Vector2;
  150359. /**
  150360. * Gets the UV location of the mouse over the SpriteMap.
  150361. * @returns Vector2 the UV position of the mouse interaction
  150362. */
  150363. getMousePosition(): Vector2;
  150364. /**
  150365. * Creates the "frame" texture Buffer
  150366. * -------------------------------------
  150367. * Structure of frames
  150368. * "filename": "Falling-Water-2.png",
  150369. * "frame": {"x":69,"y":103,"w":24,"h":32},
  150370. * "rotated": true,
  150371. * "trimmed": true,
  150372. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  150373. * "sourceSize": {"w":32,"h":32}
  150374. * @returns RawTexture of the frameMap
  150375. */
  150376. private _createFrameBuffer;
  150377. /**
  150378. * Creates the tileMap texture Buffer
  150379. * @param buffer normally and array of numbers, or a false to generate from scratch
  150380. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  150381. * @returns RawTexture of the tileMap
  150382. */
  150383. private _createTileBuffer;
  150384. /**
  150385. * Modifies the data of the tileMaps
  150386. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  150387. * @param pos is the iVector2 Coordinates of the Tile
  150388. * @param tile The SpriteIndex of the new Tile
  150389. */
  150390. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  150391. /**
  150392. * Creates the animationMap texture Buffer
  150393. * @param buffer normally and array of numbers, or a false to generate from scratch
  150394. * @returns RawTexture of the animationMap
  150395. */
  150396. private _createTileAnimationBuffer;
  150397. /**
  150398. * Modifies the data of the animationMap
  150399. * @param cellID is the Index of the Sprite
  150400. * @param _frame is the target Animation frame
  150401. * @param toCell is the Target Index of the next frame of the animation
  150402. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  150403. * @param speed is a global scalar of the time variable on the map.
  150404. */
  150405. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  150406. /**
  150407. * Exports the .tilemaps file
  150408. */
  150409. saveTileMaps(): void;
  150410. /**
  150411. * Imports the .tilemaps file
  150412. * @param url of the .tilemaps file
  150413. */
  150414. loadTileMaps(url: string): void;
  150415. /**
  150416. * Release associated resources
  150417. */
  150418. dispose(): void;
  150419. }
  150420. }
  150421. declare module BABYLON {
  150422. /**
  150423. * Class used to manage multiple sprites of different sizes on the same spritesheet
  150424. * @see https://doc.babylonjs.com/babylon101/sprites
  150425. */
  150426. export class SpritePackedManager extends SpriteManager {
  150427. /** defines the packed manager's name */
  150428. name: string;
  150429. /**
  150430. * Creates a new sprite manager from a packed sprite sheet
  150431. * @param name defines the manager's name
  150432. * @param imgUrl defines the sprite sheet url
  150433. * @param capacity defines the maximum allowed number of sprites
  150434. * @param scene defines the hosting scene
  150435. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  150436. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  150437. * @param samplingMode defines the smapling mode to use with spritesheet
  150438. * @param fromPacked set to true; do not alter
  150439. */
  150440. constructor(
  150441. /** defines the packed manager's name */
  150442. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  150443. }
  150444. }
  150445. declare module BABYLON {
  150446. /**
  150447. * Defines the list of states available for a task inside a AssetsManager
  150448. */
  150449. export enum AssetTaskState {
  150450. /**
  150451. * Initialization
  150452. */
  150453. INIT = 0,
  150454. /**
  150455. * Running
  150456. */
  150457. RUNNING = 1,
  150458. /**
  150459. * Done
  150460. */
  150461. DONE = 2,
  150462. /**
  150463. * Error
  150464. */
  150465. ERROR = 3
  150466. }
  150467. /**
  150468. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  150469. */
  150470. export abstract class AbstractAssetTask {
  150471. /**
  150472. * Task name
  150473. */ name: string;
  150474. /**
  150475. * Callback called when the task is successful
  150476. */
  150477. onSuccess: (task: any) => void;
  150478. /**
  150479. * Callback called when the task is not successful
  150480. */
  150481. onError: (task: any, message?: string, exception?: any) => void;
  150482. /**
  150483. * Creates a new AssetsManager
  150484. * @param name defines the name of the task
  150485. */
  150486. constructor(
  150487. /**
  150488. * Task name
  150489. */ name: string);
  150490. private _isCompleted;
  150491. private _taskState;
  150492. private _errorObject;
  150493. /**
  150494. * Get if the task is completed
  150495. */
  150496. get isCompleted(): boolean;
  150497. /**
  150498. * Gets the current state of the task
  150499. */
  150500. get taskState(): AssetTaskState;
  150501. /**
  150502. * Gets the current error object (if task is in error)
  150503. */
  150504. get errorObject(): {
  150505. message?: string;
  150506. exception?: any;
  150507. };
  150508. /**
  150509. * Internal only
  150510. * @hidden
  150511. */
  150512. _setErrorObject(message?: string, exception?: any): void;
  150513. /**
  150514. * Execute the current task
  150515. * @param scene defines the scene where you want your assets to be loaded
  150516. * @param onSuccess is a callback called when the task is successfully executed
  150517. * @param onError is a callback called if an error occurs
  150518. */
  150519. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150520. /**
  150521. * Execute the current task
  150522. * @param scene defines the scene where you want your assets to be loaded
  150523. * @param onSuccess is a callback called when the task is successfully executed
  150524. * @param onError is a callback called if an error occurs
  150525. */
  150526. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150527. /**
  150528. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  150529. * This can be used with failed tasks that have the reason for failure fixed.
  150530. */
  150531. reset(): void;
  150532. private onErrorCallback;
  150533. private onDoneCallback;
  150534. }
  150535. /**
  150536. * Define the interface used by progress events raised during assets loading
  150537. */
  150538. export interface IAssetsProgressEvent {
  150539. /**
  150540. * Defines the number of remaining tasks to process
  150541. */
  150542. remainingCount: number;
  150543. /**
  150544. * Defines the total number of tasks
  150545. */
  150546. totalCount: number;
  150547. /**
  150548. * Defines the task that was just processed
  150549. */
  150550. task: AbstractAssetTask;
  150551. }
  150552. /**
  150553. * Class used to share progress information about assets loading
  150554. */
  150555. export class AssetsProgressEvent implements IAssetsProgressEvent {
  150556. /**
  150557. * Defines the number of remaining tasks to process
  150558. */
  150559. remainingCount: number;
  150560. /**
  150561. * Defines the total number of tasks
  150562. */
  150563. totalCount: number;
  150564. /**
  150565. * Defines the task that was just processed
  150566. */
  150567. task: AbstractAssetTask;
  150568. /**
  150569. * Creates a AssetsProgressEvent
  150570. * @param remainingCount defines the number of remaining tasks to process
  150571. * @param totalCount defines the total number of tasks
  150572. * @param task defines the task that was just processed
  150573. */
  150574. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  150575. }
  150576. /**
  150577. * Define a task used by AssetsManager to load meshes
  150578. */
  150579. export class MeshAssetTask extends AbstractAssetTask {
  150580. /**
  150581. * Defines the name of the task
  150582. */
  150583. name: string;
  150584. /**
  150585. * Defines the list of mesh's names you want to load
  150586. */
  150587. meshesNames: any;
  150588. /**
  150589. * Defines the root url to use as a base to load your meshes and associated resources
  150590. */
  150591. rootUrl: string;
  150592. /**
  150593. * Defines the filename or File of the scene to load from
  150594. */
  150595. sceneFilename: string | File;
  150596. /**
  150597. * Gets the list of loaded meshes
  150598. */
  150599. loadedMeshes: Array<AbstractMesh>;
  150600. /**
  150601. * Gets the list of loaded particle systems
  150602. */
  150603. loadedParticleSystems: Array<IParticleSystem>;
  150604. /**
  150605. * Gets the list of loaded skeletons
  150606. */
  150607. loadedSkeletons: Array<Skeleton>;
  150608. /**
  150609. * Gets the list of loaded animation groups
  150610. */
  150611. loadedAnimationGroups: Array<AnimationGroup>;
  150612. /**
  150613. * Callback called when the task is successful
  150614. */
  150615. onSuccess: (task: MeshAssetTask) => void;
  150616. /**
  150617. * Callback called when the task is successful
  150618. */
  150619. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  150620. /**
  150621. * Creates a new MeshAssetTask
  150622. * @param name defines the name of the task
  150623. * @param meshesNames defines the list of mesh's names you want to load
  150624. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  150625. * @param sceneFilename defines the filename or File of the scene to load from
  150626. */
  150627. constructor(
  150628. /**
  150629. * Defines the name of the task
  150630. */
  150631. name: string,
  150632. /**
  150633. * Defines the list of mesh's names you want to load
  150634. */
  150635. meshesNames: any,
  150636. /**
  150637. * Defines the root url to use as a base to load your meshes and associated resources
  150638. */
  150639. rootUrl: string,
  150640. /**
  150641. * Defines the filename or File of the scene to load from
  150642. */
  150643. sceneFilename: string | File);
  150644. /**
  150645. * Execute the current task
  150646. * @param scene defines the scene where you want your assets to be loaded
  150647. * @param onSuccess is a callback called when the task is successfully executed
  150648. * @param onError is a callback called if an error occurs
  150649. */
  150650. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150651. }
  150652. /**
  150653. * Define a task used by AssetsManager to load text content
  150654. */
  150655. export class TextFileAssetTask extends AbstractAssetTask {
  150656. /**
  150657. * Defines the name of the task
  150658. */
  150659. name: string;
  150660. /**
  150661. * Defines the location of the file to load
  150662. */
  150663. url: string;
  150664. /**
  150665. * Gets the loaded text string
  150666. */
  150667. text: string;
  150668. /**
  150669. * Callback called when the task is successful
  150670. */
  150671. onSuccess: (task: TextFileAssetTask) => void;
  150672. /**
  150673. * Callback called when the task is successful
  150674. */
  150675. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  150676. /**
  150677. * Creates a new TextFileAssetTask object
  150678. * @param name defines the name of the task
  150679. * @param url defines the location of the file to load
  150680. */
  150681. constructor(
  150682. /**
  150683. * Defines the name of the task
  150684. */
  150685. name: string,
  150686. /**
  150687. * Defines the location of the file to load
  150688. */
  150689. url: string);
  150690. /**
  150691. * Execute the current task
  150692. * @param scene defines the scene where you want your assets to be loaded
  150693. * @param onSuccess is a callback called when the task is successfully executed
  150694. * @param onError is a callback called if an error occurs
  150695. */
  150696. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150697. }
  150698. /**
  150699. * Define a task used by AssetsManager to load binary data
  150700. */
  150701. export class BinaryFileAssetTask extends AbstractAssetTask {
  150702. /**
  150703. * Defines the name of the task
  150704. */
  150705. name: string;
  150706. /**
  150707. * Defines the location of the file to load
  150708. */
  150709. url: string;
  150710. /**
  150711. * Gets the lodaded data (as an array buffer)
  150712. */
  150713. data: ArrayBuffer;
  150714. /**
  150715. * Callback called when the task is successful
  150716. */
  150717. onSuccess: (task: BinaryFileAssetTask) => void;
  150718. /**
  150719. * Callback called when the task is successful
  150720. */
  150721. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  150722. /**
  150723. * Creates a new BinaryFileAssetTask object
  150724. * @param name defines the name of the new task
  150725. * @param url defines the location of the file to load
  150726. */
  150727. constructor(
  150728. /**
  150729. * Defines the name of the task
  150730. */
  150731. name: string,
  150732. /**
  150733. * Defines the location of the file to load
  150734. */
  150735. url: string);
  150736. /**
  150737. * Execute the current task
  150738. * @param scene defines the scene where you want your assets to be loaded
  150739. * @param onSuccess is a callback called when the task is successfully executed
  150740. * @param onError is a callback called if an error occurs
  150741. */
  150742. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150743. }
  150744. /**
  150745. * Define a task used by AssetsManager to load images
  150746. */
  150747. export class ImageAssetTask extends AbstractAssetTask {
  150748. /**
  150749. * Defines the name of the task
  150750. */
  150751. name: string;
  150752. /**
  150753. * Defines the location of the image to load
  150754. */
  150755. url: string;
  150756. /**
  150757. * Gets the loaded images
  150758. */
  150759. image: HTMLImageElement;
  150760. /**
  150761. * Callback called when the task is successful
  150762. */
  150763. onSuccess: (task: ImageAssetTask) => void;
  150764. /**
  150765. * Callback called when the task is successful
  150766. */
  150767. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  150768. /**
  150769. * Creates a new ImageAssetTask
  150770. * @param name defines the name of the task
  150771. * @param url defines the location of the image to load
  150772. */
  150773. constructor(
  150774. /**
  150775. * Defines the name of the task
  150776. */
  150777. name: string,
  150778. /**
  150779. * Defines the location of the image to load
  150780. */
  150781. url: string);
  150782. /**
  150783. * Execute the current task
  150784. * @param scene defines the scene where you want your assets to be loaded
  150785. * @param onSuccess is a callback called when the task is successfully executed
  150786. * @param onError is a callback called if an error occurs
  150787. */
  150788. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150789. }
  150790. /**
  150791. * Defines the interface used by texture loading tasks
  150792. */
  150793. export interface ITextureAssetTask<TEX extends BaseTexture> {
  150794. /**
  150795. * Gets the loaded texture
  150796. */
  150797. texture: TEX;
  150798. }
  150799. /**
  150800. * Define a task used by AssetsManager to load 2D textures
  150801. */
  150802. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  150803. /**
  150804. * Defines the name of the task
  150805. */
  150806. name: string;
  150807. /**
  150808. * Defines the location of the file to load
  150809. */
  150810. url: string;
  150811. /**
  150812. * Defines if mipmap should not be generated (default is false)
  150813. */
  150814. noMipmap?: boolean | undefined;
  150815. /**
  150816. * Defines if texture must be inverted on Y axis (default is true)
  150817. */
  150818. invertY: boolean;
  150819. /**
  150820. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150821. */
  150822. samplingMode: number;
  150823. /**
  150824. * Gets the loaded texture
  150825. */
  150826. texture: Texture;
  150827. /**
  150828. * Callback called when the task is successful
  150829. */
  150830. onSuccess: (task: TextureAssetTask) => void;
  150831. /**
  150832. * Callback called when the task is successful
  150833. */
  150834. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  150835. /**
  150836. * Creates a new TextureAssetTask object
  150837. * @param name defines the name of the task
  150838. * @param url defines the location of the file to load
  150839. * @param noMipmap defines if mipmap should not be generated (default is false)
  150840. * @param invertY defines if texture must be inverted on Y axis (default is true)
  150841. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150842. */
  150843. constructor(
  150844. /**
  150845. * Defines the name of the task
  150846. */
  150847. name: string,
  150848. /**
  150849. * Defines the location of the file to load
  150850. */
  150851. url: string,
  150852. /**
  150853. * Defines if mipmap should not be generated (default is false)
  150854. */
  150855. noMipmap?: boolean | undefined,
  150856. /**
  150857. * Defines if texture must be inverted on Y axis (default is true)
  150858. */
  150859. invertY?: boolean,
  150860. /**
  150861. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150862. */
  150863. samplingMode?: number);
  150864. /**
  150865. * Execute the current task
  150866. * @param scene defines the scene where you want your assets to be loaded
  150867. * @param onSuccess is a callback called when the task is successfully executed
  150868. * @param onError is a callback called if an error occurs
  150869. */
  150870. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150871. }
  150872. /**
  150873. * Define a task used by AssetsManager to load cube textures
  150874. */
  150875. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  150876. /**
  150877. * Defines the name of the task
  150878. */
  150879. name: string;
  150880. /**
  150881. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150882. */
  150883. url: string;
  150884. /**
  150885. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150886. */
  150887. extensions?: string[] | undefined;
  150888. /**
  150889. * Defines if mipmaps should not be generated (default is false)
  150890. */
  150891. noMipmap?: boolean | undefined;
  150892. /**
  150893. * Defines the explicit list of files (undefined by default)
  150894. */
  150895. files?: string[] | undefined;
  150896. /**
  150897. * Gets the loaded texture
  150898. */
  150899. texture: CubeTexture;
  150900. /**
  150901. * Callback called when the task is successful
  150902. */
  150903. onSuccess: (task: CubeTextureAssetTask) => void;
  150904. /**
  150905. * Callback called when the task is successful
  150906. */
  150907. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  150908. /**
  150909. * Creates a new CubeTextureAssetTask
  150910. * @param name defines the name of the task
  150911. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150912. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150913. * @param noMipmap defines if mipmaps should not be generated (default is false)
  150914. * @param files defines the explicit list of files (undefined by default)
  150915. */
  150916. constructor(
  150917. /**
  150918. * Defines the name of the task
  150919. */
  150920. name: string,
  150921. /**
  150922. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150923. */
  150924. url: string,
  150925. /**
  150926. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150927. */
  150928. extensions?: string[] | undefined,
  150929. /**
  150930. * Defines if mipmaps should not be generated (default is false)
  150931. */
  150932. noMipmap?: boolean | undefined,
  150933. /**
  150934. * Defines the explicit list of files (undefined by default)
  150935. */
  150936. files?: string[] | undefined);
  150937. /**
  150938. * Execute the current task
  150939. * @param scene defines the scene where you want your assets to be loaded
  150940. * @param onSuccess is a callback called when the task is successfully executed
  150941. * @param onError is a callback called if an error occurs
  150942. */
  150943. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150944. }
  150945. /**
  150946. * Define a task used by AssetsManager to load HDR cube textures
  150947. */
  150948. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  150949. /**
  150950. * Defines the name of the task
  150951. */
  150952. name: string;
  150953. /**
  150954. * Defines the location of the file to load
  150955. */
  150956. url: string;
  150957. /**
  150958. * Defines the desired size (the more it increases the longer the generation will be)
  150959. */
  150960. size: number;
  150961. /**
  150962. * Defines if mipmaps should not be generated (default is false)
  150963. */
  150964. noMipmap: boolean;
  150965. /**
  150966. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  150967. */
  150968. generateHarmonics: boolean;
  150969. /**
  150970. * 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)
  150971. */
  150972. gammaSpace: boolean;
  150973. /**
  150974. * Internal Use Only
  150975. */
  150976. reserved: boolean;
  150977. /**
  150978. * Gets the loaded texture
  150979. */
  150980. texture: HDRCubeTexture;
  150981. /**
  150982. * Callback called when the task is successful
  150983. */
  150984. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  150985. /**
  150986. * Callback called when the task is successful
  150987. */
  150988. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  150989. /**
  150990. * Creates a new HDRCubeTextureAssetTask object
  150991. * @param name defines the name of the task
  150992. * @param url defines the location of the file to load
  150993. * @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.
  150994. * @param noMipmap defines if mipmaps should not be generated (default is false)
  150995. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  150996. * @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)
  150997. * @param reserved Internal use only
  150998. */
  150999. constructor(
  151000. /**
  151001. * Defines the name of the task
  151002. */
  151003. name: string,
  151004. /**
  151005. * Defines the location of the file to load
  151006. */
  151007. url: string,
  151008. /**
  151009. * Defines the desired size (the more it increases the longer the generation will be)
  151010. */
  151011. size: number,
  151012. /**
  151013. * Defines if mipmaps should not be generated (default is false)
  151014. */
  151015. noMipmap?: boolean,
  151016. /**
  151017. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  151018. */
  151019. generateHarmonics?: boolean,
  151020. /**
  151021. * 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)
  151022. */
  151023. gammaSpace?: boolean,
  151024. /**
  151025. * Internal Use Only
  151026. */
  151027. reserved?: boolean);
  151028. /**
  151029. * Execute the current task
  151030. * @param scene defines the scene where you want your assets to be loaded
  151031. * @param onSuccess is a callback called when the task is successfully executed
  151032. * @param onError is a callback called if an error occurs
  151033. */
  151034. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151035. }
  151036. /**
  151037. * Define a task used by AssetsManager to load Equirectangular cube textures
  151038. */
  151039. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  151040. /**
  151041. * Defines the name of the task
  151042. */
  151043. name: string;
  151044. /**
  151045. * Defines the location of the file to load
  151046. */
  151047. url: string;
  151048. /**
  151049. * Defines the desired size (the more it increases the longer the generation will be)
  151050. */
  151051. size: number;
  151052. /**
  151053. * Defines if mipmaps should not be generated (default is false)
  151054. */
  151055. noMipmap: boolean;
  151056. /**
  151057. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  151058. * but the standard material would require them in Gamma space) (default is true)
  151059. */
  151060. gammaSpace: boolean;
  151061. /**
  151062. * Gets the loaded texture
  151063. */
  151064. texture: EquiRectangularCubeTexture;
  151065. /**
  151066. * Callback called when the task is successful
  151067. */
  151068. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  151069. /**
  151070. * Callback called when the task is successful
  151071. */
  151072. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  151073. /**
  151074. * Creates a new EquiRectangularCubeTextureAssetTask object
  151075. * @param name defines the name of the task
  151076. * @param url defines the location of the file to load
  151077. * @param size defines the desired size (the more it increases the longer the generation will be)
  151078. * If the size is omitted this implies you are using a preprocessed cubemap.
  151079. * @param noMipmap defines if mipmaps should not be generated (default is false)
  151080. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  151081. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  151082. * (default is true)
  151083. */
  151084. constructor(
  151085. /**
  151086. * Defines the name of the task
  151087. */
  151088. name: string,
  151089. /**
  151090. * Defines the location of the file to load
  151091. */
  151092. url: string,
  151093. /**
  151094. * Defines the desired size (the more it increases the longer the generation will be)
  151095. */
  151096. size: number,
  151097. /**
  151098. * Defines if mipmaps should not be generated (default is false)
  151099. */
  151100. noMipmap?: boolean,
  151101. /**
  151102. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  151103. * but the standard material would require them in Gamma space) (default is true)
  151104. */
  151105. gammaSpace?: boolean);
  151106. /**
  151107. * Execute the current task
  151108. * @param scene defines the scene where you want your assets to be loaded
  151109. * @param onSuccess is a callback called when the task is successfully executed
  151110. * @param onError is a callback called if an error occurs
  151111. */
  151112. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151113. }
  151114. /**
  151115. * This class can be used to easily import assets into a scene
  151116. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  151117. */
  151118. export class AssetsManager {
  151119. private _scene;
  151120. private _isLoading;
  151121. protected _tasks: AbstractAssetTask[];
  151122. protected _waitingTasksCount: number;
  151123. protected _totalTasksCount: number;
  151124. /**
  151125. * Callback called when all tasks are processed
  151126. */
  151127. onFinish: (tasks: AbstractAssetTask[]) => void;
  151128. /**
  151129. * Callback called when a task is successful
  151130. */
  151131. onTaskSuccess: (task: AbstractAssetTask) => void;
  151132. /**
  151133. * Callback called when a task had an error
  151134. */
  151135. onTaskError: (task: AbstractAssetTask) => void;
  151136. /**
  151137. * Callback called when a task is done (whatever the result is)
  151138. */
  151139. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  151140. /**
  151141. * Observable called when all tasks are processed
  151142. */
  151143. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  151144. /**
  151145. * Observable called when a task had an error
  151146. */
  151147. onTaskErrorObservable: Observable<AbstractAssetTask>;
  151148. /**
  151149. * Observable called when all tasks were executed
  151150. */
  151151. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  151152. /**
  151153. * Observable called when a task is done (whatever the result is)
  151154. */
  151155. onProgressObservable: Observable<IAssetsProgressEvent>;
  151156. /**
  151157. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  151158. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  151159. */
  151160. useDefaultLoadingScreen: boolean;
  151161. /**
  151162. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  151163. * when all assets have been downloaded.
  151164. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  151165. */
  151166. autoHideLoadingUI: boolean;
  151167. /**
  151168. * Creates a new AssetsManager
  151169. * @param scene defines the scene to work on
  151170. */
  151171. constructor(scene: Scene);
  151172. /**
  151173. * Add a MeshAssetTask to the list of active tasks
  151174. * @param taskName defines the name of the new task
  151175. * @param meshesNames defines the name of meshes to load
  151176. * @param rootUrl defines the root url to use to locate files
  151177. * @param sceneFilename defines the filename of the scene file
  151178. * @returns a new MeshAssetTask object
  151179. */
  151180. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  151181. /**
  151182. * Add a TextFileAssetTask to the list of active tasks
  151183. * @param taskName defines the name of the new task
  151184. * @param url defines the url of the file to load
  151185. * @returns a new TextFileAssetTask object
  151186. */
  151187. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  151188. /**
  151189. * Add a BinaryFileAssetTask to the list of active tasks
  151190. * @param taskName defines the name of the new task
  151191. * @param url defines the url of the file to load
  151192. * @returns a new BinaryFileAssetTask object
  151193. */
  151194. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  151195. /**
  151196. * Add a ImageAssetTask to the list of active tasks
  151197. * @param taskName defines the name of the new task
  151198. * @param url defines the url of the file to load
  151199. * @returns a new ImageAssetTask object
  151200. */
  151201. addImageTask(taskName: string, url: string): ImageAssetTask;
  151202. /**
  151203. * Add a TextureAssetTask to the list of active tasks
  151204. * @param taskName defines the name of the new task
  151205. * @param url defines the url of the file to load
  151206. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  151207. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  151208. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  151209. * @returns a new TextureAssetTask object
  151210. */
  151211. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  151212. /**
  151213. * Add a CubeTextureAssetTask to the list of active tasks
  151214. * @param taskName defines the name of the new task
  151215. * @param url defines the url of the file to load
  151216. * @param extensions defines the extension to use to load the cube map (can be null)
  151217. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  151218. * @param files defines the list of files to load (can be null)
  151219. * @returns a new CubeTextureAssetTask object
  151220. */
  151221. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  151222. /**
  151223. *
  151224. * Add a HDRCubeTextureAssetTask to the list of active tasks
  151225. * @param taskName defines the name of the new task
  151226. * @param url defines the url of the file to load
  151227. * @param size defines the size you want for the cubemap (can be null)
  151228. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  151229. * @param generateHarmonics defines if you want to automatically generate (true by default)
  151230. * @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)
  151231. * @param reserved Internal use only
  151232. * @returns a new HDRCubeTextureAssetTask object
  151233. */
  151234. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  151235. /**
  151236. *
  151237. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  151238. * @param taskName defines the name of the new task
  151239. * @param url defines the url of the file to load
  151240. * @param size defines the size you want for the cubemap (can be null)
  151241. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  151242. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  151243. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  151244. * @returns a new EquiRectangularCubeTextureAssetTask object
  151245. */
  151246. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  151247. /**
  151248. * Remove a task from the assets manager.
  151249. * @param task the task to remove
  151250. */
  151251. removeTask(task: AbstractAssetTask): void;
  151252. private _decreaseWaitingTasksCount;
  151253. private _runTask;
  151254. /**
  151255. * Reset the AssetsManager and remove all tasks
  151256. * @return the current instance of the AssetsManager
  151257. */
  151258. reset(): AssetsManager;
  151259. /**
  151260. * Start the loading process
  151261. * @return the current instance of the AssetsManager
  151262. */
  151263. load(): AssetsManager;
  151264. /**
  151265. * Start the loading process as an async operation
  151266. * @return a promise returning the list of failed tasks
  151267. */
  151268. loadAsync(): Promise<void>;
  151269. }
  151270. }
  151271. declare module BABYLON {
  151272. /**
  151273. * Wrapper class for promise with external resolve and reject.
  151274. */
  151275. export class Deferred<T> {
  151276. /**
  151277. * The promise associated with this deferred object.
  151278. */
  151279. readonly promise: Promise<T>;
  151280. private _resolve;
  151281. private _reject;
  151282. /**
  151283. * The resolve method of the promise associated with this deferred object.
  151284. */
  151285. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  151286. /**
  151287. * The reject method of the promise associated with this deferred object.
  151288. */
  151289. get reject(): (reason?: any) => void;
  151290. /**
  151291. * Constructor for this deferred object.
  151292. */
  151293. constructor();
  151294. }
  151295. }
  151296. declare module BABYLON {
  151297. /**
  151298. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  151299. */
  151300. export class MeshExploder {
  151301. private _centerMesh;
  151302. private _meshes;
  151303. private _meshesOrigins;
  151304. private _toCenterVectors;
  151305. private _scaledDirection;
  151306. private _newPosition;
  151307. private _centerPosition;
  151308. /**
  151309. * Explodes meshes from a center mesh.
  151310. * @param meshes The meshes to explode.
  151311. * @param centerMesh The mesh to be center of explosion.
  151312. */
  151313. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  151314. private _setCenterMesh;
  151315. /**
  151316. * Get class name
  151317. * @returns "MeshExploder"
  151318. */
  151319. getClassName(): string;
  151320. /**
  151321. * "Exploded meshes"
  151322. * @returns Array of meshes with the centerMesh at index 0.
  151323. */
  151324. getMeshes(): Array<Mesh>;
  151325. /**
  151326. * Explodes meshes giving a specific direction
  151327. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  151328. */
  151329. explode(direction?: number): void;
  151330. }
  151331. }
  151332. declare module BABYLON {
  151333. /**
  151334. * Class used to help managing file picking and drag'n'drop
  151335. */
  151336. export class FilesInput {
  151337. /**
  151338. * List of files ready to be loaded
  151339. */
  151340. static get FilesToLoad(): {
  151341. [key: string]: File;
  151342. };
  151343. /**
  151344. * Callback called when a file is processed
  151345. */
  151346. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  151347. private _engine;
  151348. private _currentScene;
  151349. private _sceneLoadedCallback;
  151350. private _progressCallback;
  151351. private _additionalRenderLoopLogicCallback;
  151352. private _textureLoadingCallback;
  151353. private _startingProcessingFilesCallback;
  151354. private _onReloadCallback;
  151355. private _errorCallback;
  151356. private _elementToMonitor;
  151357. private _sceneFileToLoad;
  151358. private _filesToLoad;
  151359. /**
  151360. * Creates a new FilesInput
  151361. * @param engine defines the rendering engine
  151362. * @param scene defines the hosting scene
  151363. * @param sceneLoadedCallback callback called when scene is loaded
  151364. * @param progressCallback callback called to track progress
  151365. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  151366. * @param textureLoadingCallback callback called when a texture is loading
  151367. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  151368. * @param onReloadCallback callback called when a reload is requested
  151369. * @param errorCallback callback call if an error occurs
  151370. */
  151371. 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>);
  151372. private _dragEnterHandler;
  151373. private _dragOverHandler;
  151374. private _dropHandler;
  151375. /**
  151376. * Calls this function to listen to drag'n'drop events on a specific DOM element
  151377. * @param elementToMonitor defines the DOM element to track
  151378. */
  151379. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  151380. /** Gets the current list of files to load */
  151381. get filesToLoad(): File[];
  151382. /**
  151383. * Release all associated resources
  151384. */
  151385. dispose(): void;
  151386. private renderFunction;
  151387. private drag;
  151388. private drop;
  151389. private _traverseFolder;
  151390. private _processFiles;
  151391. /**
  151392. * Load files from a drop event
  151393. * @param event defines the drop event to use as source
  151394. */
  151395. loadFiles(event: any): void;
  151396. private _processReload;
  151397. /**
  151398. * Reload the current scene from the loaded files
  151399. */
  151400. reload(): void;
  151401. }
  151402. }
  151403. declare module BABYLON {
  151404. /**
  151405. * Defines the root class used to create scene optimization to use with SceneOptimizer
  151406. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151407. */
  151408. export class SceneOptimization {
  151409. /**
  151410. * Defines the priority of this optimization (0 by default which means first in the list)
  151411. */
  151412. priority: number;
  151413. /**
  151414. * Gets a string describing the action executed by the current optimization
  151415. * @returns description string
  151416. */
  151417. getDescription(): string;
  151418. /**
  151419. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151420. * @param scene defines the current scene where to apply this optimization
  151421. * @param optimizer defines the current optimizer
  151422. * @returns true if everything that can be done was applied
  151423. */
  151424. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151425. /**
  151426. * Creates the SceneOptimization object
  151427. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151428. * @param desc defines the description associated with the optimization
  151429. */
  151430. constructor(
  151431. /**
  151432. * Defines the priority of this optimization (0 by default which means first in the list)
  151433. */
  151434. priority?: number);
  151435. }
  151436. /**
  151437. * Defines an optimization used to reduce the size of render target textures
  151438. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151439. */
  151440. export class TextureOptimization extends SceneOptimization {
  151441. /**
  151442. * Defines the priority of this optimization (0 by default which means first in the list)
  151443. */
  151444. priority: number;
  151445. /**
  151446. * 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
  151447. */
  151448. maximumSize: number;
  151449. /**
  151450. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151451. */
  151452. step: number;
  151453. /**
  151454. * Gets a string describing the action executed by the current optimization
  151455. * @returns description string
  151456. */
  151457. getDescription(): string;
  151458. /**
  151459. * Creates the TextureOptimization object
  151460. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151461. * @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
  151462. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151463. */
  151464. constructor(
  151465. /**
  151466. * Defines the priority of this optimization (0 by default which means first in the list)
  151467. */
  151468. priority?: number,
  151469. /**
  151470. * 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
  151471. */
  151472. maximumSize?: number,
  151473. /**
  151474. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151475. */
  151476. step?: number);
  151477. /**
  151478. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151479. * @param scene defines the current scene where to apply this optimization
  151480. * @param optimizer defines the current optimizer
  151481. * @returns true if everything that can be done was applied
  151482. */
  151483. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151484. }
  151485. /**
  151486. * Defines an optimization used to increase or decrease the rendering resolution
  151487. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151488. */
  151489. export class HardwareScalingOptimization extends SceneOptimization {
  151490. /**
  151491. * Defines the priority of this optimization (0 by default which means first in the list)
  151492. */
  151493. priority: number;
  151494. /**
  151495. * Defines the maximum scale to use (2 by default)
  151496. */
  151497. maximumScale: number;
  151498. /**
  151499. * Defines the step to use between two passes (0.5 by default)
  151500. */
  151501. step: number;
  151502. private _currentScale;
  151503. private _directionOffset;
  151504. /**
  151505. * Gets a string describing the action executed by the current optimization
  151506. * @return description string
  151507. */
  151508. getDescription(): string;
  151509. /**
  151510. * Creates the HardwareScalingOptimization object
  151511. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151512. * @param maximumScale defines the maximum scale to use (2 by default)
  151513. * @param step defines the step to use between two passes (0.5 by default)
  151514. */
  151515. constructor(
  151516. /**
  151517. * Defines the priority of this optimization (0 by default which means first in the list)
  151518. */
  151519. priority?: number,
  151520. /**
  151521. * Defines the maximum scale to use (2 by default)
  151522. */
  151523. maximumScale?: number,
  151524. /**
  151525. * Defines the step to use between two passes (0.5 by default)
  151526. */
  151527. step?: number);
  151528. /**
  151529. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151530. * @param scene defines the current scene where to apply this optimization
  151531. * @param optimizer defines the current optimizer
  151532. * @returns true if everything that can be done was applied
  151533. */
  151534. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151535. }
  151536. /**
  151537. * Defines an optimization used to remove shadows
  151538. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151539. */
  151540. export class ShadowsOptimization extends SceneOptimization {
  151541. /**
  151542. * Gets a string describing the action executed by the current optimization
  151543. * @return description string
  151544. */
  151545. getDescription(): string;
  151546. /**
  151547. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151548. * @param scene defines the current scene where to apply this optimization
  151549. * @param optimizer defines the current optimizer
  151550. * @returns true if everything that can be done was applied
  151551. */
  151552. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151553. }
  151554. /**
  151555. * Defines an optimization used to turn post-processes off
  151556. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151557. */
  151558. export class PostProcessesOptimization extends SceneOptimization {
  151559. /**
  151560. * Gets a string describing the action executed by the current optimization
  151561. * @return description string
  151562. */
  151563. getDescription(): string;
  151564. /**
  151565. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151566. * @param scene defines the current scene where to apply this optimization
  151567. * @param optimizer defines the current optimizer
  151568. * @returns true if everything that can be done was applied
  151569. */
  151570. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151571. }
  151572. /**
  151573. * Defines an optimization used to turn lens flares off
  151574. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151575. */
  151576. export class LensFlaresOptimization extends SceneOptimization {
  151577. /**
  151578. * Gets a string describing the action executed by the current optimization
  151579. * @return description string
  151580. */
  151581. getDescription(): string;
  151582. /**
  151583. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151584. * @param scene defines the current scene where to apply this optimization
  151585. * @param optimizer defines the current optimizer
  151586. * @returns true if everything that can be done was applied
  151587. */
  151588. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151589. }
  151590. /**
  151591. * Defines an optimization based on user defined callback.
  151592. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151593. */
  151594. export class CustomOptimization extends SceneOptimization {
  151595. /**
  151596. * Callback called to apply the custom optimization.
  151597. */
  151598. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  151599. /**
  151600. * Callback called to get custom description
  151601. */
  151602. onGetDescription: () => string;
  151603. /**
  151604. * Gets a string describing the action executed by the current optimization
  151605. * @returns description string
  151606. */
  151607. getDescription(): string;
  151608. /**
  151609. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151610. * @param scene defines the current scene where to apply this optimization
  151611. * @param optimizer defines the current optimizer
  151612. * @returns true if everything that can be done was applied
  151613. */
  151614. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151615. }
  151616. /**
  151617. * Defines an optimization used to turn particles off
  151618. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151619. */
  151620. export class ParticlesOptimization extends SceneOptimization {
  151621. /**
  151622. * Gets a string describing the action executed by the current optimization
  151623. * @return description string
  151624. */
  151625. getDescription(): string;
  151626. /**
  151627. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151628. * @param scene defines the current scene where to apply this optimization
  151629. * @param optimizer defines the current optimizer
  151630. * @returns true if everything that can be done was applied
  151631. */
  151632. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151633. }
  151634. /**
  151635. * Defines an optimization used to turn render targets off
  151636. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151637. */
  151638. export class RenderTargetsOptimization extends SceneOptimization {
  151639. /**
  151640. * Gets a string describing the action executed by the current optimization
  151641. * @return description string
  151642. */
  151643. getDescription(): string;
  151644. /**
  151645. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151646. * @param scene defines the current scene where to apply this optimization
  151647. * @param optimizer defines the current optimizer
  151648. * @returns true if everything that can be done was applied
  151649. */
  151650. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151651. }
  151652. /**
  151653. * Defines an optimization used to merge meshes with compatible materials
  151654. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151655. */
  151656. export class MergeMeshesOptimization extends SceneOptimization {
  151657. private static _UpdateSelectionTree;
  151658. /**
  151659. * Gets or sets a boolean which defines if optimization octree has to be updated
  151660. */
  151661. static get UpdateSelectionTree(): boolean;
  151662. /**
  151663. * Gets or sets a boolean which defines if optimization octree has to be updated
  151664. */
  151665. static set UpdateSelectionTree(value: boolean);
  151666. /**
  151667. * Gets a string describing the action executed by the current optimization
  151668. * @return description string
  151669. */
  151670. getDescription(): string;
  151671. private _canBeMerged;
  151672. /**
  151673. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151674. * @param scene defines the current scene where to apply this optimization
  151675. * @param optimizer defines the current optimizer
  151676. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  151677. * @returns true if everything that can be done was applied
  151678. */
  151679. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  151680. }
  151681. /**
  151682. * Defines a list of options used by SceneOptimizer
  151683. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151684. */
  151685. export class SceneOptimizerOptions {
  151686. /**
  151687. * Defines the target frame rate to reach (60 by default)
  151688. */
  151689. targetFrameRate: number;
  151690. /**
  151691. * Defines the interval between two checkes (2000ms by default)
  151692. */
  151693. trackerDuration: number;
  151694. /**
  151695. * Gets the list of optimizations to apply
  151696. */
  151697. optimizations: SceneOptimization[];
  151698. /**
  151699. * Creates a new list of options used by SceneOptimizer
  151700. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  151701. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  151702. */
  151703. constructor(
  151704. /**
  151705. * Defines the target frame rate to reach (60 by default)
  151706. */
  151707. targetFrameRate?: number,
  151708. /**
  151709. * Defines the interval between two checkes (2000ms by default)
  151710. */
  151711. trackerDuration?: number);
  151712. /**
  151713. * Add a new optimization
  151714. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  151715. * @returns the current SceneOptimizerOptions
  151716. */
  151717. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  151718. /**
  151719. * Add a new custom optimization
  151720. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  151721. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  151722. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151723. * @returns the current SceneOptimizerOptions
  151724. */
  151725. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  151726. /**
  151727. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  151728. * @param targetFrameRate defines the target frame rate (60 by default)
  151729. * @returns a SceneOptimizerOptions object
  151730. */
  151731. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151732. /**
  151733. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  151734. * @param targetFrameRate defines the target frame rate (60 by default)
  151735. * @returns a SceneOptimizerOptions object
  151736. */
  151737. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151738. /**
  151739. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  151740. * @param targetFrameRate defines the target frame rate (60 by default)
  151741. * @returns a SceneOptimizerOptions object
  151742. */
  151743. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151744. }
  151745. /**
  151746. * Class used to run optimizations in order to reach a target frame rate
  151747. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151748. */
  151749. export class SceneOptimizer implements IDisposable {
  151750. private _isRunning;
  151751. private _options;
  151752. private _scene;
  151753. private _currentPriorityLevel;
  151754. private _targetFrameRate;
  151755. private _trackerDuration;
  151756. private _currentFrameRate;
  151757. private _sceneDisposeObserver;
  151758. private _improvementMode;
  151759. /**
  151760. * Defines an observable called when the optimizer reaches the target frame rate
  151761. */
  151762. onSuccessObservable: Observable<SceneOptimizer>;
  151763. /**
  151764. * Defines an observable called when the optimizer enables an optimization
  151765. */
  151766. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  151767. /**
  151768. * Defines an observable called when the optimizer is not able to reach the target frame rate
  151769. */
  151770. onFailureObservable: Observable<SceneOptimizer>;
  151771. /**
  151772. * Gets a boolean indicating if the optimizer is in improvement mode
  151773. */
  151774. get isInImprovementMode(): boolean;
  151775. /**
  151776. * Gets the current priority level (0 at start)
  151777. */
  151778. get currentPriorityLevel(): number;
  151779. /**
  151780. * Gets the current frame rate checked by the SceneOptimizer
  151781. */
  151782. get currentFrameRate(): number;
  151783. /**
  151784. * Gets or sets the current target frame rate (60 by default)
  151785. */
  151786. get targetFrameRate(): number;
  151787. /**
  151788. * Gets or sets the current target frame rate (60 by default)
  151789. */
  151790. set targetFrameRate(value: number);
  151791. /**
  151792. * Gets or sets the current interval between two checks (every 2000ms by default)
  151793. */
  151794. get trackerDuration(): number;
  151795. /**
  151796. * Gets or sets the current interval between two checks (every 2000ms by default)
  151797. */
  151798. set trackerDuration(value: number);
  151799. /**
  151800. * Gets the list of active optimizations
  151801. */
  151802. get optimizations(): SceneOptimization[];
  151803. /**
  151804. * Creates a new SceneOptimizer
  151805. * @param scene defines the scene to work on
  151806. * @param options defines the options to use with the SceneOptimizer
  151807. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  151808. * @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)
  151809. */
  151810. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  151811. /**
  151812. * Stops the current optimizer
  151813. */
  151814. stop(): void;
  151815. /**
  151816. * Reset the optimizer to initial step (current priority level = 0)
  151817. */
  151818. reset(): void;
  151819. /**
  151820. * Start the optimizer. By default it will try to reach a specific framerate
  151821. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  151822. */
  151823. start(): void;
  151824. private _checkCurrentState;
  151825. /**
  151826. * Release all resources
  151827. */
  151828. dispose(): void;
  151829. /**
  151830. * Helper function to create a SceneOptimizer with one single line of code
  151831. * @param scene defines the scene to work on
  151832. * @param options defines the options to use with the SceneOptimizer
  151833. * @param onSuccess defines a callback to call on success
  151834. * @param onFailure defines a callback to call on failure
  151835. * @returns the new SceneOptimizer object
  151836. */
  151837. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  151838. }
  151839. }
  151840. declare module BABYLON {
  151841. /**
  151842. * Class used to serialize a scene into a string
  151843. */
  151844. export class SceneSerializer {
  151845. /**
  151846. * Clear cache used by a previous serialization
  151847. */
  151848. static ClearCache(): void;
  151849. /**
  151850. * Serialize a scene into a JSON compatible object
  151851. * @param scene defines the scene to serialize
  151852. * @returns a JSON compatible object
  151853. */
  151854. static Serialize(scene: Scene): any;
  151855. /**
  151856. * Serialize a mesh into a JSON compatible object
  151857. * @param toSerialize defines the mesh to serialize
  151858. * @param withParents defines if parents must be serialized as well
  151859. * @param withChildren defines if children must be serialized as well
  151860. * @returns a JSON compatible object
  151861. */
  151862. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  151863. }
  151864. }
  151865. declare module BABYLON {
  151866. /**
  151867. * Class used to host texture specific utilities
  151868. */
  151869. export class TextureTools {
  151870. /**
  151871. * Uses the GPU to create a copy texture rescaled at a given size
  151872. * @param texture Texture to copy from
  151873. * @param width defines the desired width
  151874. * @param height defines the desired height
  151875. * @param useBilinearMode defines if bilinear mode has to be used
  151876. * @return the generated texture
  151877. */
  151878. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  151879. }
  151880. }
  151881. declare module BABYLON {
  151882. /**
  151883. * This represents the different options available for the video capture.
  151884. */
  151885. export interface VideoRecorderOptions {
  151886. /** Defines the mime type of the video. */
  151887. mimeType: string;
  151888. /** Defines the FPS the video should be recorded at. */
  151889. fps: number;
  151890. /** Defines the chunk size for the recording data. */
  151891. recordChunckSize: number;
  151892. /** The audio tracks to attach to the recording. */
  151893. audioTracks?: MediaStreamTrack[];
  151894. }
  151895. /**
  151896. * This can help with recording videos from BabylonJS.
  151897. * This is based on the available WebRTC functionalities of the browser.
  151898. *
  151899. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  151900. */
  151901. export class VideoRecorder {
  151902. private static readonly _defaultOptions;
  151903. /**
  151904. * Returns whether or not the VideoRecorder is available in your browser.
  151905. * @param engine Defines the Babylon Engine.
  151906. * @returns true if supported otherwise false.
  151907. */
  151908. static IsSupported(engine: Engine): boolean;
  151909. private readonly _options;
  151910. private _canvas;
  151911. private _mediaRecorder;
  151912. private _recordedChunks;
  151913. private _fileName;
  151914. private _resolve;
  151915. private _reject;
  151916. /**
  151917. * True when a recording is already in progress.
  151918. */
  151919. get isRecording(): boolean;
  151920. /**
  151921. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  151922. * @param engine Defines the BabylonJS Engine you wish to record.
  151923. * @param options Defines options that can be used to customize the capture.
  151924. */
  151925. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  151926. /**
  151927. * Stops the current recording before the default capture timeout passed in the startRecording function.
  151928. */
  151929. stopRecording(): void;
  151930. /**
  151931. * Starts recording the canvas for a max duration specified in parameters.
  151932. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  151933. * If null no automatic download will start and you can rely on the promise to get the data back.
  151934. * @param maxDuration Defines the maximum recording time in seconds.
  151935. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  151936. * @return A promise callback at the end of the recording with the video data in Blob.
  151937. */
  151938. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  151939. /**
  151940. * Releases internal resources used during the recording.
  151941. */
  151942. dispose(): void;
  151943. private _handleDataAvailable;
  151944. private _handleError;
  151945. private _handleStop;
  151946. }
  151947. }
  151948. declare module BABYLON {
  151949. /**
  151950. * Class containing a set of static utilities functions for screenshots
  151951. */
  151952. export class ScreenshotTools {
  151953. /**
  151954. * Captures a screenshot of the current rendering
  151955. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151956. * @param engine defines the rendering engine
  151957. * @param camera defines the source camera
  151958. * @param size This parameter can be set to a single number or to an object with the
  151959. * following (optional) properties: precision, width, height. If a single number is passed,
  151960. * it will be used for both width and height. If an object is passed, the screenshot size
  151961. * will be derived from the parameters. The precision property is a multiplier allowing
  151962. * rendering at a higher or lower resolution
  151963. * @param successCallback defines the callback receives a single parameter which contains the
  151964. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  151965. * src parameter of an <img> to display it
  151966. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  151967. * Check your browser for supported MIME types
  151968. */
  151969. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  151970. /**
  151971. * Captures a screenshot of the current rendering
  151972. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151973. * @param engine defines the rendering engine
  151974. * @param camera defines the source camera
  151975. * @param size This parameter can be set to a single number or to an object with the
  151976. * following (optional) properties: precision, width, height. If a single number is passed,
  151977. * it will be used for both width and height. If an object is passed, the screenshot size
  151978. * will be derived from the parameters. The precision property is a multiplier allowing
  151979. * rendering at a higher or lower resolution
  151980. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  151981. * Check your browser for supported MIME types
  151982. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  151983. * to the src parameter of an <img> to display it
  151984. */
  151985. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  151986. /**
  151987. * Generates an image screenshot from the specified camera.
  151988. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151989. * @param engine The engine to use for rendering
  151990. * @param camera The camera to use for rendering
  151991. * @param size This parameter can be set to a single number or to an object with the
  151992. * following (optional) properties: precision, width, height. If a single number is passed,
  151993. * it will be used for both width and height. If an object is passed, the screenshot size
  151994. * will be derived from the parameters. The precision property is a multiplier allowing
  151995. * rendering at a higher or lower resolution
  151996. * @param successCallback The callback receives a single parameter which contains the
  151997. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  151998. * src parameter of an <img> to display it
  151999. * @param mimeType The MIME type of the screenshot image (default: image/png).
  152000. * Check your browser for supported MIME types
  152001. * @param samples Texture samples (default: 1)
  152002. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  152003. * @param fileName A name for for the downloaded file.
  152004. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  152005. */
  152006. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  152007. /**
  152008. * Generates an image screenshot from the specified camera.
  152009. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  152010. * @param engine The engine to use for rendering
  152011. * @param camera The camera to use for rendering
  152012. * @param size This parameter can be set to a single number or to an object with the
  152013. * following (optional) properties: precision, width, height. If a single number is passed,
  152014. * it will be used for both width and height. If an object is passed, the screenshot size
  152015. * will be derived from the parameters. The precision property is a multiplier allowing
  152016. * rendering at a higher or lower resolution
  152017. * @param mimeType The MIME type of the screenshot image (default: image/png).
  152018. * Check your browser for supported MIME types
  152019. * @param samples Texture samples (default: 1)
  152020. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  152021. * @param fileName A name for for the downloaded file.
  152022. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  152023. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  152024. * to the src parameter of an <img> to display it
  152025. */
  152026. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  152027. /**
  152028. * Gets height and width for screenshot size
  152029. * @private
  152030. */
  152031. private static _getScreenshotSize;
  152032. }
  152033. }
  152034. declare module BABYLON {
  152035. /**
  152036. * Interface for a data buffer
  152037. */
  152038. export interface IDataBuffer {
  152039. /**
  152040. * Reads bytes from the data buffer.
  152041. * @param byteOffset The byte offset to read
  152042. * @param byteLength The byte length to read
  152043. * @returns A promise that resolves when the bytes are read
  152044. */
  152045. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  152046. /**
  152047. * The byte length of the buffer.
  152048. */
  152049. readonly byteLength: number;
  152050. }
  152051. /**
  152052. * Utility class for reading from a data buffer
  152053. */
  152054. export class DataReader {
  152055. /**
  152056. * The data buffer associated with this data reader.
  152057. */
  152058. readonly buffer: IDataBuffer;
  152059. /**
  152060. * The current byte offset from the beginning of the data buffer.
  152061. */
  152062. byteOffset: number;
  152063. private _dataView;
  152064. private _dataByteOffset;
  152065. /**
  152066. * Constructor
  152067. * @param buffer The buffer to read
  152068. */
  152069. constructor(buffer: IDataBuffer);
  152070. /**
  152071. * Loads the given byte length.
  152072. * @param byteLength The byte length to load
  152073. * @returns A promise that resolves when the load is complete
  152074. */
  152075. loadAsync(byteLength: number): Promise<void>;
  152076. /**
  152077. * Read a unsigned 32-bit integer from the currently loaded data range.
  152078. * @returns The 32-bit integer read
  152079. */
  152080. readUint32(): number;
  152081. /**
  152082. * Read a byte array from the currently loaded data range.
  152083. * @param byteLength The byte length to read
  152084. * @returns The byte array read
  152085. */
  152086. readUint8Array(byteLength: number): Uint8Array;
  152087. /**
  152088. * Read a string from the currently loaded data range.
  152089. * @param byteLength The byte length to read
  152090. * @returns The string read
  152091. */
  152092. readString(byteLength: number): string;
  152093. /**
  152094. * Skips the given byte length the currently loaded data range.
  152095. * @param byteLength The byte length to skip
  152096. */
  152097. skipBytes(byteLength: number): void;
  152098. }
  152099. }
  152100. declare module BABYLON {
  152101. /**
  152102. * Class for storing data to local storage if available or in-memory storage otherwise
  152103. */
  152104. export class DataStorage {
  152105. private static _Storage;
  152106. private static _GetStorage;
  152107. /**
  152108. * Reads a string from the data storage
  152109. * @param key The key to read
  152110. * @param defaultValue The value if the key doesn't exist
  152111. * @returns The string value
  152112. */
  152113. static ReadString(key: string, defaultValue: string): string;
  152114. /**
  152115. * Writes a string to the data storage
  152116. * @param key The key to write
  152117. * @param value The value to write
  152118. */
  152119. static WriteString(key: string, value: string): void;
  152120. /**
  152121. * Reads a boolean from the data storage
  152122. * @param key The key to read
  152123. * @param defaultValue The value if the key doesn't exist
  152124. * @returns The boolean value
  152125. */
  152126. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  152127. /**
  152128. * Writes a boolean to the data storage
  152129. * @param key The key to write
  152130. * @param value The value to write
  152131. */
  152132. static WriteBoolean(key: string, value: boolean): void;
  152133. /**
  152134. * Reads a number from the data storage
  152135. * @param key The key to read
  152136. * @param defaultValue The value if the key doesn't exist
  152137. * @returns The number value
  152138. */
  152139. static ReadNumber(key: string, defaultValue: number): number;
  152140. /**
  152141. * Writes a number to the data storage
  152142. * @param key The key to write
  152143. * @param value The value to write
  152144. */
  152145. static WriteNumber(key: string, value: number): void;
  152146. }
  152147. }
  152148. declare module BABYLON {
  152149. /**
  152150. * Class used to record delta files between 2 scene states
  152151. */
  152152. export class SceneRecorder {
  152153. private _trackedScene;
  152154. private _savedJSON;
  152155. /**
  152156. * Track a given scene. This means the current scene state will be considered the original state
  152157. * @param scene defines the scene to track
  152158. */
  152159. track(scene: Scene): void;
  152160. /**
  152161. * Get the delta between current state and original state
  152162. * @returns a string containing the delta
  152163. */
  152164. getDelta(): any;
  152165. private _compareArray;
  152166. private _compareObjects;
  152167. private _compareCollections;
  152168. /**
  152169. * Apply a given delta to a given scene
  152170. * @param deltaJSON defines the JSON containing the delta
  152171. * @param scene defines the scene to apply the delta to
  152172. */
  152173. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  152174. private static _ApplyPropertiesToEntity;
  152175. private static _ApplyDeltaForEntity;
  152176. }
  152177. }
  152178. declare module BABYLON {
  152179. /**
  152180. * An interface for all Hit test features
  152181. */
  152182. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  152183. /**
  152184. * Triggered when new babylon (transformed) hit test results are available
  152185. */
  152186. onHitTestResultObservable: Observable<T[]>;
  152187. }
  152188. /**
  152189. * Options used for hit testing
  152190. */
  152191. export interface IWebXRLegacyHitTestOptions {
  152192. /**
  152193. * Only test when user interacted with the scene. Default - hit test every frame
  152194. */
  152195. testOnPointerDownOnly?: boolean;
  152196. /**
  152197. * The node to use to transform the local results to world coordinates
  152198. */
  152199. worldParentNode?: TransformNode;
  152200. }
  152201. /**
  152202. * Interface defining the babylon result of raycasting/hit-test
  152203. */
  152204. export interface IWebXRLegacyHitResult {
  152205. /**
  152206. * Transformation matrix that can be applied to a node that will put it in the hit point location
  152207. */
  152208. transformationMatrix: Matrix;
  152209. /**
  152210. * The native hit test result
  152211. */
  152212. xrHitResult: XRHitResult | XRHitTestResult;
  152213. }
  152214. /**
  152215. * The currently-working hit-test module.
  152216. * Hit test (or Ray-casting) is used to interact with the real world.
  152217. * For further information read here - https://github.com/immersive-web/hit-test
  152218. */
  152219. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  152220. /**
  152221. * options to use when constructing this feature
  152222. */
  152223. readonly options: IWebXRLegacyHitTestOptions;
  152224. private _direction;
  152225. private _mat;
  152226. private _onSelectEnabled;
  152227. private _origin;
  152228. /**
  152229. * The module's name
  152230. */
  152231. static readonly Name: string;
  152232. /**
  152233. * The (Babylon) version of this module.
  152234. * This is an integer representing the implementation version.
  152235. * This number does not correspond to the WebXR specs version
  152236. */
  152237. static readonly Version: number;
  152238. /**
  152239. * Populated with the last native XR Hit Results
  152240. */
  152241. lastNativeXRHitResults: XRHitResult[];
  152242. /**
  152243. * Triggered when new babylon (transformed) hit test results are available
  152244. */
  152245. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  152246. /**
  152247. * Creates a new instance of the (legacy version) hit test feature
  152248. * @param _xrSessionManager an instance of WebXRSessionManager
  152249. * @param options options to use when constructing this feature
  152250. */
  152251. constructor(_xrSessionManager: WebXRSessionManager,
  152252. /**
  152253. * options to use when constructing this feature
  152254. */
  152255. options?: IWebXRLegacyHitTestOptions);
  152256. /**
  152257. * execute a hit test with an XR Ray
  152258. *
  152259. * @param xrSession a native xrSession that will execute this hit test
  152260. * @param xrRay the ray (position and direction) to use for ray-casting
  152261. * @param referenceSpace native XR reference space to use for the hit-test
  152262. * @param filter filter function that will filter the results
  152263. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  152264. */
  152265. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  152266. /**
  152267. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  152268. * @param event the (select) event to use to select with
  152269. * @param referenceSpace the reference space to use for this hit test
  152270. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  152271. */
  152272. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  152273. /**
  152274. * attach this feature
  152275. * Will usually be called by the features manager
  152276. *
  152277. * @returns true if successful.
  152278. */
  152279. attach(): boolean;
  152280. /**
  152281. * detach this feature.
  152282. * Will usually be called by the features manager
  152283. *
  152284. * @returns true if successful.
  152285. */
  152286. detach(): boolean;
  152287. /**
  152288. * Dispose this feature and all of the resources attached
  152289. */
  152290. dispose(): void;
  152291. protected _onXRFrame(frame: XRFrame): void;
  152292. private _onHitTestResults;
  152293. private _onSelect;
  152294. }
  152295. }
  152296. declare module BABYLON {
  152297. /**
  152298. * Options used for hit testing (version 2)
  152299. */
  152300. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  152301. /**
  152302. * Do not create a permanent hit test. Will usually be used when only
  152303. * transient inputs are needed.
  152304. */
  152305. disablePermanentHitTest?: boolean;
  152306. /**
  152307. * Enable transient (for example touch-based) hit test inspections
  152308. */
  152309. enableTransientHitTest?: boolean;
  152310. /**
  152311. * Offset ray for the permanent hit test
  152312. */
  152313. offsetRay?: Vector3;
  152314. /**
  152315. * Offset ray for the transient hit test
  152316. */
  152317. transientOffsetRay?: Vector3;
  152318. /**
  152319. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  152320. */
  152321. useReferenceSpace?: boolean;
  152322. }
  152323. /**
  152324. * Interface defining the babylon result of hit-test
  152325. */
  152326. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  152327. /**
  152328. * The input source that generated this hit test (if transient)
  152329. */
  152330. inputSource?: XRInputSource;
  152331. /**
  152332. * Is this a transient hit test
  152333. */
  152334. isTransient?: boolean;
  152335. /**
  152336. * Position of the hit test result
  152337. */
  152338. position: Vector3;
  152339. /**
  152340. * Rotation of the hit test result
  152341. */
  152342. rotationQuaternion: Quaternion;
  152343. /**
  152344. * The native hit test result
  152345. */
  152346. xrHitResult: XRHitTestResult;
  152347. }
  152348. /**
  152349. * The currently-working hit-test module.
  152350. * Hit test (or Ray-casting) is used to interact with the real world.
  152351. * For further information read here - https://github.com/immersive-web/hit-test
  152352. *
  152353. * Tested on chrome (mobile) 80.
  152354. */
  152355. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  152356. /**
  152357. * options to use when constructing this feature
  152358. */
  152359. readonly options: IWebXRHitTestOptions;
  152360. private _tmpMat;
  152361. private _tmpPos;
  152362. private _tmpQuat;
  152363. private _transientXrHitTestSource;
  152364. private _xrHitTestSource;
  152365. private initHitTestSource;
  152366. /**
  152367. * The module's name
  152368. */
  152369. static readonly Name: string;
  152370. /**
  152371. * The (Babylon) version of this module.
  152372. * This is an integer representing the implementation version.
  152373. * This number does not correspond to the WebXR specs version
  152374. */
  152375. static readonly Version: number;
  152376. /**
  152377. * When set to true, each hit test will have its own position/rotation objects
  152378. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  152379. * the developers will clone them or copy them as they see fit.
  152380. */
  152381. autoCloneTransformation: boolean;
  152382. /**
  152383. * Triggered when new babylon (transformed) hit test results are available
  152384. */
  152385. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  152386. /**
  152387. * Use this to temporarily pause hit test checks.
  152388. */
  152389. paused: boolean;
  152390. /**
  152391. * Creates a new instance of the hit test feature
  152392. * @param _xrSessionManager an instance of WebXRSessionManager
  152393. * @param options options to use when constructing this feature
  152394. */
  152395. constructor(_xrSessionManager: WebXRSessionManager,
  152396. /**
  152397. * options to use when constructing this feature
  152398. */
  152399. options?: IWebXRHitTestOptions);
  152400. /**
  152401. * attach this feature
  152402. * Will usually be called by the features manager
  152403. *
  152404. * @returns true if successful.
  152405. */
  152406. attach(): boolean;
  152407. /**
  152408. * detach this feature.
  152409. * Will usually be called by the features manager
  152410. *
  152411. * @returns true if successful.
  152412. */
  152413. detach(): boolean;
  152414. /**
  152415. * Dispose this feature and all of the resources attached
  152416. */
  152417. dispose(): void;
  152418. protected _onXRFrame(frame: XRFrame): void;
  152419. private _processWebXRHitTestResult;
  152420. }
  152421. }
  152422. declare module BABYLON {
  152423. /**
  152424. * Configuration options of the anchor system
  152425. */
  152426. export interface IWebXRAnchorSystemOptions {
  152427. /**
  152428. * a node that will be used to convert local to world coordinates
  152429. */
  152430. worldParentNode?: TransformNode;
  152431. /**
  152432. * If set to true a reference of the created anchors will be kept until the next session starts
  152433. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  152434. */
  152435. doNotRemoveAnchorsOnSessionEnded?: boolean;
  152436. }
  152437. /**
  152438. * A babylon container for an XR Anchor
  152439. */
  152440. export interface IWebXRAnchor {
  152441. /**
  152442. * A babylon-assigned ID for this anchor
  152443. */
  152444. id: number;
  152445. /**
  152446. * Transformation matrix to apply to an object attached to this anchor
  152447. */
  152448. transformationMatrix: Matrix;
  152449. /**
  152450. * The native anchor object
  152451. */
  152452. xrAnchor: XRAnchor;
  152453. /**
  152454. * if defined, this object will be constantly updated by the anchor's position and rotation
  152455. */
  152456. attachedNode?: TransformNode;
  152457. }
  152458. /**
  152459. * An implementation of the anchor system for WebXR.
  152460. * For further information see https://github.com/immersive-web/anchors/
  152461. */
  152462. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  152463. private _options;
  152464. private _lastFrameDetected;
  152465. private _trackedAnchors;
  152466. private _referenceSpaceForFrameAnchors;
  152467. private _futureAnchors;
  152468. /**
  152469. * The module's name
  152470. */
  152471. static readonly Name: string;
  152472. /**
  152473. * The (Babylon) version of this module.
  152474. * This is an integer representing the implementation version.
  152475. * This number does not correspond to the WebXR specs version
  152476. */
  152477. static readonly Version: number;
  152478. /**
  152479. * Observers registered here will be executed when a new anchor was added to the session
  152480. */
  152481. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  152482. /**
  152483. * Observers registered here will be executed when an anchor was removed from the session
  152484. */
  152485. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  152486. /**
  152487. * Observers registered here will be executed when an existing anchor updates
  152488. * This can execute N times every frame
  152489. */
  152490. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  152491. /**
  152492. * Set the reference space to use for anchor creation, when not using a hit test.
  152493. * Will default to the session's reference space if not defined
  152494. */
  152495. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  152496. /**
  152497. * constructs a new anchor system
  152498. * @param _xrSessionManager an instance of WebXRSessionManager
  152499. * @param _options configuration object for this feature
  152500. */
  152501. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  152502. private _tmpVector;
  152503. private _tmpQuaternion;
  152504. private _populateTmpTransformation;
  152505. /**
  152506. * Create a new anchor point using a hit test result at a specific point in the scene
  152507. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  152508. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  152509. *
  152510. * @param hitTestResult The hit test result to use for this anchor creation
  152511. * @param position an optional position offset for this anchor
  152512. * @param rotationQuaternion an optional rotation offset for this anchor
  152513. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  152514. */
  152515. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  152516. /**
  152517. * Add a new anchor at a specific position and rotation
  152518. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  152519. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  152520. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  152521. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  152522. *
  152523. * @param position the position in which to add an anchor
  152524. * @param rotationQuaternion an optional rotation for the anchor transformation
  152525. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  152526. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  152527. */
  152528. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  152529. /**
  152530. * detach this feature.
  152531. * Will usually be called by the features manager
  152532. *
  152533. * @returns true if successful.
  152534. */
  152535. detach(): boolean;
  152536. /**
  152537. * Dispose this feature and all of the resources attached
  152538. */
  152539. dispose(): void;
  152540. protected _onXRFrame(frame: XRFrame): void;
  152541. /**
  152542. * avoiding using Array.find for global support.
  152543. * @param xrAnchor the plane to find in the array
  152544. */
  152545. private _findIndexInAnchorArray;
  152546. private _updateAnchorWithXRFrame;
  152547. private _createAnchorAtTransformation;
  152548. }
  152549. }
  152550. declare module BABYLON {
  152551. /**
  152552. * Options used in the plane detector module
  152553. */
  152554. export interface IWebXRPlaneDetectorOptions {
  152555. /**
  152556. * The node to use to transform the local results to world coordinates
  152557. */
  152558. worldParentNode?: TransformNode;
  152559. /**
  152560. * If set to true a reference of the created planes will be kept until the next session starts
  152561. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  152562. */
  152563. doNotRemovePlanesOnSessionEnded?: boolean;
  152564. }
  152565. /**
  152566. * A babylon interface for a WebXR plane.
  152567. * A Plane is actually a polygon, built from N points in space
  152568. *
  152569. * Supported in chrome 79, not supported in canary 81 ATM
  152570. */
  152571. export interface IWebXRPlane {
  152572. /**
  152573. * a babylon-assigned ID for this polygon
  152574. */
  152575. id: number;
  152576. /**
  152577. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  152578. */
  152579. polygonDefinition: Array<Vector3>;
  152580. /**
  152581. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  152582. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  152583. */
  152584. transformationMatrix: Matrix;
  152585. /**
  152586. * the native xr-plane object
  152587. */
  152588. xrPlane: XRPlane;
  152589. }
  152590. /**
  152591. * The plane detector is used to detect planes in the real world when in AR
  152592. * For more information see https://github.com/immersive-web/real-world-geometry/
  152593. */
  152594. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  152595. private _options;
  152596. private _detectedPlanes;
  152597. private _enabled;
  152598. private _lastFrameDetected;
  152599. /**
  152600. * The module's name
  152601. */
  152602. static readonly Name: string;
  152603. /**
  152604. * The (Babylon) version of this module.
  152605. * This is an integer representing the implementation version.
  152606. * This number does not correspond to the WebXR specs version
  152607. */
  152608. static readonly Version: number;
  152609. /**
  152610. * Observers registered here will be executed when a new plane was added to the session
  152611. */
  152612. onPlaneAddedObservable: Observable<IWebXRPlane>;
  152613. /**
  152614. * Observers registered here will be executed when a plane is no longer detected in the session
  152615. */
  152616. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  152617. /**
  152618. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  152619. * This can execute N times every frame
  152620. */
  152621. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  152622. /**
  152623. * construct a new Plane Detector
  152624. * @param _xrSessionManager an instance of xr Session manager
  152625. * @param _options configuration to use when constructing this feature
  152626. */
  152627. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  152628. /**
  152629. * detach this feature.
  152630. * Will usually be called by the features manager
  152631. *
  152632. * @returns true if successful.
  152633. */
  152634. detach(): boolean;
  152635. /**
  152636. * Dispose this feature and all of the resources attached
  152637. */
  152638. dispose(): void;
  152639. protected _onXRFrame(frame: XRFrame): void;
  152640. private _init;
  152641. private _updatePlaneWithXRPlane;
  152642. /**
  152643. * avoiding using Array.find for global support.
  152644. * @param xrPlane the plane to find in the array
  152645. */
  152646. private findIndexInPlaneArray;
  152647. }
  152648. }
  152649. declare module BABYLON {
  152650. /**
  152651. * Options interface for the background remover plugin
  152652. */
  152653. export interface IWebXRBackgroundRemoverOptions {
  152654. /**
  152655. * Further background meshes to disable when entering AR
  152656. */
  152657. backgroundMeshes?: AbstractMesh[];
  152658. /**
  152659. * flags to configure the removal of the environment helper.
  152660. * If not set, the entire background will be removed. If set, flags should be set as well.
  152661. */
  152662. environmentHelperRemovalFlags?: {
  152663. /**
  152664. * Should the skybox be removed (default false)
  152665. */
  152666. skyBox?: boolean;
  152667. /**
  152668. * Should the ground be removed (default false)
  152669. */
  152670. ground?: boolean;
  152671. };
  152672. /**
  152673. * don't disable the environment helper
  152674. */
  152675. ignoreEnvironmentHelper?: boolean;
  152676. }
  152677. /**
  152678. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  152679. */
  152680. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  152681. /**
  152682. * read-only options to be used in this module
  152683. */
  152684. readonly options: IWebXRBackgroundRemoverOptions;
  152685. /**
  152686. * The module's name
  152687. */
  152688. static readonly Name: string;
  152689. /**
  152690. * The (Babylon) version of this module.
  152691. * This is an integer representing the implementation version.
  152692. * This number does not correspond to the WebXR specs version
  152693. */
  152694. static readonly Version: number;
  152695. /**
  152696. * registered observers will be triggered when the background state changes
  152697. */
  152698. onBackgroundStateChangedObservable: Observable<boolean>;
  152699. /**
  152700. * constructs a new background remover module
  152701. * @param _xrSessionManager the session manager for this module
  152702. * @param options read-only options to be used in this module
  152703. */
  152704. constructor(_xrSessionManager: WebXRSessionManager,
  152705. /**
  152706. * read-only options to be used in this module
  152707. */
  152708. options?: IWebXRBackgroundRemoverOptions);
  152709. /**
  152710. * attach this feature
  152711. * Will usually be called by the features manager
  152712. *
  152713. * @returns true if successful.
  152714. */
  152715. attach(): boolean;
  152716. /**
  152717. * detach this feature.
  152718. * Will usually be called by the features manager
  152719. *
  152720. * @returns true if successful.
  152721. */
  152722. detach(): boolean;
  152723. /**
  152724. * Dispose this feature and all of the resources attached
  152725. */
  152726. dispose(): void;
  152727. protected _onXRFrame(_xrFrame: XRFrame): void;
  152728. private _setBackgroundState;
  152729. }
  152730. }
  152731. declare module BABYLON {
  152732. /**
  152733. * Options for the controller physics feature
  152734. */
  152735. export class IWebXRControllerPhysicsOptions {
  152736. /**
  152737. * Should the headset get its own impostor
  152738. */
  152739. enableHeadsetImpostor?: boolean;
  152740. /**
  152741. * Optional parameters for the headset impostor
  152742. */
  152743. headsetImpostorParams?: {
  152744. /**
  152745. * The type of impostor to create. Default is sphere
  152746. */
  152747. impostorType: number;
  152748. /**
  152749. * the size of the impostor. Defaults to 10cm
  152750. */
  152751. impostorSize?: number | {
  152752. width: number;
  152753. height: number;
  152754. depth: number;
  152755. };
  152756. /**
  152757. * Friction definitions
  152758. */
  152759. friction?: number;
  152760. /**
  152761. * Restitution
  152762. */
  152763. restitution?: number;
  152764. };
  152765. /**
  152766. * The physics properties of the future impostors
  152767. */
  152768. physicsProperties?: {
  152769. /**
  152770. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  152771. * Note that this requires a physics engine that supports mesh impostors!
  152772. */
  152773. useControllerMesh?: boolean;
  152774. /**
  152775. * The type of impostor to create. Default is sphere
  152776. */
  152777. impostorType?: number;
  152778. /**
  152779. * the size of the impostor. Defaults to 10cm
  152780. */
  152781. impostorSize?: number | {
  152782. width: number;
  152783. height: number;
  152784. depth: number;
  152785. };
  152786. /**
  152787. * Friction definitions
  152788. */
  152789. friction?: number;
  152790. /**
  152791. * Restitution
  152792. */
  152793. restitution?: number;
  152794. };
  152795. /**
  152796. * the xr input to use with this pointer selection
  152797. */
  152798. xrInput: WebXRInput;
  152799. }
  152800. /**
  152801. * Add physics impostor to your webxr controllers,
  152802. * including naive calculation of their linear and angular velocity
  152803. */
  152804. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  152805. private readonly _options;
  152806. private _attachController;
  152807. private _controllers;
  152808. private _debugMode;
  152809. private _delta;
  152810. private _headsetImpostor?;
  152811. private _headsetMesh?;
  152812. private _lastTimestamp;
  152813. private _tmpQuaternion;
  152814. private _tmpVector;
  152815. /**
  152816. * The module's name
  152817. */
  152818. static readonly Name: string;
  152819. /**
  152820. * The (Babylon) version of this module.
  152821. * This is an integer representing the implementation version.
  152822. * This number does not correspond to the webxr specs version
  152823. */
  152824. static readonly Version: number;
  152825. /**
  152826. * Construct a new Controller Physics Feature
  152827. * @param _xrSessionManager the corresponding xr session manager
  152828. * @param _options options to create this feature with
  152829. */
  152830. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  152831. /**
  152832. * @hidden
  152833. * enable debugging - will show console outputs and the impostor mesh
  152834. */
  152835. _enablePhysicsDebug(): void;
  152836. /**
  152837. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  152838. * @param xrController the controller to add
  152839. */
  152840. addController(xrController: WebXRInputSource): void;
  152841. /**
  152842. * attach this feature
  152843. * Will usually be called by the features manager
  152844. *
  152845. * @returns true if successful.
  152846. */
  152847. attach(): boolean;
  152848. /**
  152849. * detach this feature.
  152850. * Will usually be called by the features manager
  152851. *
  152852. * @returns true if successful.
  152853. */
  152854. detach(): boolean;
  152855. /**
  152856. * Get the headset impostor, if enabled
  152857. * @returns the impostor
  152858. */
  152859. getHeadsetImpostor(): PhysicsImpostor | undefined;
  152860. /**
  152861. * Get the physics impostor of a specific controller.
  152862. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  152863. * @param controller the controller or the controller id of which to get the impostor
  152864. * @returns the impostor or null
  152865. */
  152866. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  152867. /**
  152868. * Update the physics properties provided in the constructor
  152869. * @param newProperties the new properties object
  152870. */
  152871. setPhysicsProperties(newProperties: {
  152872. impostorType?: number;
  152873. impostorSize?: number | {
  152874. width: number;
  152875. height: number;
  152876. depth: number;
  152877. };
  152878. friction?: number;
  152879. restitution?: number;
  152880. }): void;
  152881. protected _onXRFrame(_xrFrame: any): void;
  152882. private _detachController;
  152883. }
  152884. }
  152885. declare module BABYLON {
  152886. /**
  152887. * The motion controller class for all microsoft mixed reality controllers
  152888. */
  152889. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  152890. protected readonly _mapping: {
  152891. defaultButton: {
  152892. valueNodeName: string;
  152893. unpressedNodeName: string;
  152894. pressedNodeName: string;
  152895. };
  152896. defaultAxis: {
  152897. valueNodeName: string;
  152898. minNodeName: string;
  152899. maxNodeName: string;
  152900. };
  152901. buttons: {
  152902. "xr-standard-trigger": {
  152903. rootNodeName: string;
  152904. componentProperty: string;
  152905. states: string[];
  152906. };
  152907. "xr-standard-squeeze": {
  152908. rootNodeName: string;
  152909. componentProperty: string;
  152910. states: string[];
  152911. };
  152912. "xr-standard-touchpad": {
  152913. rootNodeName: string;
  152914. labelAnchorNodeName: string;
  152915. touchPointNodeName: string;
  152916. };
  152917. "xr-standard-thumbstick": {
  152918. rootNodeName: string;
  152919. componentProperty: string;
  152920. states: string[];
  152921. };
  152922. };
  152923. axes: {
  152924. "xr-standard-touchpad": {
  152925. "x-axis": {
  152926. rootNodeName: string;
  152927. };
  152928. "y-axis": {
  152929. rootNodeName: string;
  152930. };
  152931. };
  152932. "xr-standard-thumbstick": {
  152933. "x-axis": {
  152934. rootNodeName: string;
  152935. };
  152936. "y-axis": {
  152937. rootNodeName: string;
  152938. };
  152939. };
  152940. };
  152941. };
  152942. /**
  152943. * The base url used to load the left and right controller models
  152944. */
  152945. static MODEL_BASE_URL: string;
  152946. /**
  152947. * The name of the left controller model file
  152948. */
  152949. static MODEL_LEFT_FILENAME: string;
  152950. /**
  152951. * The name of the right controller model file
  152952. */
  152953. static MODEL_RIGHT_FILENAME: string;
  152954. profileId: string;
  152955. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  152956. protected _getFilenameAndPath(): {
  152957. filename: string;
  152958. path: string;
  152959. };
  152960. protected _getModelLoadingConstraints(): boolean;
  152961. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  152962. protected _setRootMesh(meshes: AbstractMesh[]): void;
  152963. protected _updateModel(): void;
  152964. }
  152965. }
  152966. declare module BABYLON {
  152967. /**
  152968. * The motion controller class for oculus touch (quest, rift).
  152969. * This class supports legacy mapping as well the standard xr mapping
  152970. */
  152971. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  152972. private _forceLegacyControllers;
  152973. private _modelRootNode;
  152974. /**
  152975. * The base url used to load the left and right controller models
  152976. */
  152977. static MODEL_BASE_URL: string;
  152978. /**
  152979. * The name of the left controller model file
  152980. */
  152981. static MODEL_LEFT_FILENAME: string;
  152982. /**
  152983. * The name of the right controller model file
  152984. */
  152985. static MODEL_RIGHT_FILENAME: string;
  152986. /**
  152987. * Base Url for the Quest controller model.
  152988. */
  152989. static QUEST_MODEL_BASE_URL: string;
  152990. profileId: string;
  152991. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  152992. protected _getFilenameAndPath(): {
  152993. filename: string;
  152994. path: string;
  152995. };
  152996. protected _getModelLoadingConstraints(): boolean;
  152997. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  152998. protected _setRootMesh(meshes: AbstractMesh[]): void;
  152999. protected _updateModel(): void;
  153000. /**
  153001. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  153002. * between the touch and touch 2.
  153003. */
  153004. private _isQuest;
  153005. }
  153006. }
  153007. declare module BABYLON {
  153008. /**
  153009. * The motion controller class for the standard HTC-Vive controllers
  153010. */
  153011. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  153012. private _modelRootNode;
  153013. /**
  153014. * The base url used to load the left and right controller models
  153015. */
  153016. static MODEL_BASE_URL: string;
  153017. /**
  153018. * File name for the controller model.
  153019. */
  153020. static MODEL_FILENAME: string;
  153021. profileId: string;
  153022. /**
  153023. * Create a new Vive motion controller object
  153024. * @param scene the scene to use to create this controller
  153025. * @param gamepadObject the corresponding gamepad object
  153026. * @param handedness the handedness of the controller
  153027. */
  153028. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  153029. protected _getFilenameAndPath(): {
  153030. filename: string;
  153031. path: string;
  153032. };
  153033. protected _getModelLoadingConstraints(): boolean;
  153034. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  153035. protected _setRootMesh(meshes: AbstractMesh[]): void;
  153036. protected _updateModel(): void;
  153037. }
  153038. }
  153039. declare module BABYLON {
  153040. /**
  153041. * A cursor which tracks a point on a path
  153042. */
  153043. export class PathCursor {
  153044. private path;
  153045. /**
  153046. * Stores path cursor callbacks for when an onchange event is triggered
  153047. */
  153048. private _onchange;
  153049. /**
  153050. * The value of the path cursor
  153051. */
  153052. value: number;
  153053. /**
  153054. * The animation array of the path cursor
  153055. */
  153056. animations: Animation[];
  153057. /**
  153058. * Initializes the path cursor
  153059. * @param path The path to track
  153060. */
  153061. constructor(path: Path2);
  153062. /**
  153063. * Gets the cursor point on the path
  153064. * @returns A point on the path cursor at the cursor location
  153065. */
  153066. getPoint(): Vector3;
  153067. /**
  153068. * Moves the cursor ahead by the step amount
  153069. * @param step The amount to move the cursor forward
  153070. * @returns This path cursor
  153071. */
  153072. moveAhead(step?: number): PathCursor;
  153073. /**
  153074. * Moves the cursor behind by the step amount
  153075. * @param step The amount to move the cursor back
  153076. * @returns This path cursor
  153077. */
  153078. moveBack(step?: number): PathCursor;
  153079. /**
  153080. * Moves the cursor by the step amount
  153081. * If the step amount is greater than one, an exception is thrown
  153082. * @param step The amount to move the cursor
  153083. * @returns This path cursor
  153084. */
  153085. move(step: number): PathCursor;
  153086. /**
  153087. * Ensures that the value is limited between zero and one
  153088. * @returns This path cursor
  153089. */
  153090. private ensureLimits;
  153091. /**
  153092. * Runs onchange callbacks on change (used by the animation engine)
  153093. * @returns This path cursor
  153094. */
  153095. private raiseOnChange;
  153096. /**
  153097. * Executes a function on change
  153098. * @param f A path cursor onchange callback
  153099. * @returns This path cursor
  153100. */
  153101. onchange(f: (cursor: PathCursor) => void): PathCursor;
  153102. }
  153103. }
  153104. declare module BABYLON {
  153105. /** @hidden */
  153106. export var blurPixelShader: {
  153107. name: string;
  153108. shader: string;
  153109. };
  153110. }
  153111. declare module BABYLON {
  153112. /** @hidden */
  153113. export var pointCloudVertexDeclaration: {
  153114. name: string;
  153115. shader: string;
  153116. };
  153117. }
  153118. // Mixins
  153119. interface Window {
  153120. mozIndexedDB: IDBFactory;
  153121. webkitIndexedDB: IDBFactory;
  153122. msIndexedDB: IDBFactory;
  153123. webkitURL: typeof URL;
  153124. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  153125. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  153126. WebGLRenderingContext: WebGLRenderingContext;
  153127. MSGesture: MSGesture;
  153128. CANNON: any;
  153129. AudioContext: AudioContext;
  153130. webkitAudioContext: AudioContext;
  153131. PointerEvent: any;
  153132. Math: Math;
  153133. Uint8Array: Uint8ArrayConstructor;
  153134. Float32Array: Float32ArrayConstructor;
  153135. mozURL: typeof URL;
  153136. msURL: typeof URL;
  153137. VRFrameData: any; // WebVR, from specs 1.1
  153138. DracoDecoderModule: any;
  153139. setImmediate(handler: (...args: any[]) => void): number;
  153140. }
  153141. interface HTMLCanvasElement {
  153142. requestPointerLock(): void;
  153143. msRequestPointerLock?(): void;
  153144. mozRequestPointerLock?(): void;
  153145. webkitRequestPointerLock?(): void;
  153146. /** Track wether a record is in progress */
  153147. isRecording: boolean;
  153148. /** Capture Stream method defined by some browsers */
  153149. captureStream(fps?: number): MediaStream;
  153150. }
  153151. interface CanvasRenderingContext2D {
  153152. msImageSmoothingEnabled: boolean;
  153153. }
  153154. interface MouseEvent {
  153155. mozMovementX: number;
  153156. mozMovementY: number;
  153157. webkitMovementX: number;
  153158. webkitMovementY: number;
  153159. msMovementX: number;
  153160. msMovementY: number;
  153161. }
  153162. interface Navigator {
  153163. mozGetVRDevices: (any: any) => any;
  153164. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  153165. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  153166. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  153167. webkitGetGamepads(): Gamepad[];
  153168. msGetGamepads(): Gamepad[];
  153169. webkitGamepads(): Gamepad[];
  153170. }
  153171. interface HTMLVideoElement {
  153172. mozSrcObject: any;
  153173. }
  153174. interface Math {
  153175. fround(x: number): number;
  153176. imul(a: number, b: number): number;
  153177. }
  153178. interface WebGLRenderingContext {
  153179. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  153180. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  153181. vertexAttribDivisor(index: number, divisor: number): void;
  153182. createVertexArray(): any;
  153183. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  153184. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  153185. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  153186. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  153187. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  153188. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  153189. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  153190. // Queries
  153191. createQuery(): WebGLQuery;
  153192. deleteQuery(query: WebGLQuery): void;
  153193. beginQuery(target: number, query: WebGLQuery): void;
  153194. endQuery(target: number): void;
  153195. getQueryParameter(query: WebGLQuery, pname: number): any;
  153196. getQuery(target: number, pname: number): any;
  153197. MAX_SAMPLES: number;
  153198. RGBA8: number;
  153199. READ_FRAMEBUFFER: number;
  153200. DRAW_FRAMEBUFFER: number;
  153201. UNIFORM_BUFFER: number;
  153202. HALF_FLOAT_OES: number;
  153203. RGBA16F: number;
  153204. RGBA32F: number;
  153205. R32F: number;
  153206. RG32F: number;
  153207. RGB32F: number;
  153208. R16F: number;
  153209. RG16F: number;
  153210. RGB16F: number;
  153211. RED: number;
  153212. RG: number;
  153213. R8: number;
  153214. RG8: number;
  153215. UNSIGNED_INT_24_8: number;
  153216. DEPTH24_STENCIL8: number;
  153217. MIN: number;
  153218. MAX: number;
  153219. /* Multiple Render Targets */
  153220. drawBuffers(buffers: number[]): void;
  153221. readBuffer(src: number): void;
  153222. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  153223. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  153224. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  153225. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  153226. // Occlusion Query
  153227. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  153228. ANY_SAMPLES_PASSED: number;
  153229. QUERY_RESULT_AVAILABLE: number;
  153230. QUERY_RESULT: number;
  153231. }
  153232. interface WebGLProgram {
  153233. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  153234. }
  153235. interface EXT_disjoint_timer_query {
  153236. QUERY_COUNTER_BITS_EXT: number;
  153237. TIME_ELAPSED_EXT: number;
  153238. TIMESTAMP_EXT: number;
  153239. GPU_DISJOINT_EXT: number;
  153240. QUERY_RESULT_EXT: number;
  153241. QUERY_RESULT_AVAILABLE_EXT: number;
  153242. queryCounterEXT(query: WebGLQuery, target: number): void;
  153243. createQueryEXT(): WebGLQuery;
  153244. beginQueryEXT(target: number, query: WebGLQuery): void;
  153245. endQueryEXT(target: number): void;
  153246. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  153247. deleteQueryEXT(query: WebGLQuery): void;
  153248. }
  153249. interface WebGLUniformLocation {
  153250. _currentState: any;
  153251. }
  153252. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  153253. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  153254. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  153255. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  153256. interface WebGLRenderingContext {
  153257. readonly RASTERIZER_DISCARD: number;
  153258. readonly DEPTH_COMPONENT24: number;
  153259. readonly TEXTURE_3D: number;
  153260. readonly TEXTURE_2D_ARRAY: number;
  153261. readonly TEXTURE_COMPARE_FUNC: number;
  153262. readonly TEXTURE_COMPARE_MODE: number;
  153263. readonly COMPARE_REF_TO_TEXTURE: number;
  153264. readonly TEXTURE_WRAP_R: number;
  153265. readonly HALF_FLOAT: number;
  153266. readonly RGB8: number;
  153267. readonly RED_INTEGER: number;
  153268. readonly RG_INTEGER: number;
  153269. readonly RGB_INTEGER: number;
  153270. readonly RGBA_INTEGER: number;
  153271. readonly R8_SNORM: number;
  153272. readonly RG8_SNORM: number;
  153273. readonly RGB8_SNORM: number;
  153274. readonly RGBA8_SNORM: number;
  153275. readonly R8I: number;
  153276. readonly RG8I: number;
  153277. readonly RGB8I: number;
  153278. readonly RGBA8I: number;
  153279. readonly R8UI: number;
  153280. readonly RG8UI: number;
  153281. readonly RGB8UI: number;
  153282. readonly RGBA8UI: number;
  153283. readonly R16I: number;
  153284. readonly RG16I: number;
  153285. readonly RGB16I: number;
  153286. readonly RGBA16I: number;
  153287. readonly R16UI: number;
  153288. readonly RG16UI: number;
  153289. readonly RGB16UI: number;
  153290. readonly RGBA16UI: number;
  153291. readonly R32I: number;
  153292. readonly RG32I: number;
  153293. readonly RGB32I: number;
  153294. readonly RGBA32I: number;
  153295. readonly R32UI: number;
  153296. readonly RG32UI: number;
  153297. readonly RGB32UI: number;
  153298. readonly RGBA32UI: number;
  153299. readonly RGB10_A2UI: number;
  153300. readonly R11F_G11F_B10F: number;
  153301. readonly RGB9_E5: number;
  153302. readonly RGB10_A2: number;
  153303. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  153304. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  153305. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  153306. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  153307. readonly DEPTH_COMPONENT32F: number;
  153308. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  153309. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  153310. 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;
  153311. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  153312. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  153313. readonly TRANSFORM_FEEDBACK: number;
  153314. readonly INTERLEAVED_ATTRIBS: number;
  153315. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  153316. createTransformFeedback(): WebGLTransformFeedback;
  153317. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  153318. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  153319. beginTransformFeedback(primitiveMode: number): void;
  153320. endTransformFeedback(): void;
  153321. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  153322. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153323. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153324. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153325. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  153326. }
  153327. interface ImageBitmap {
  153328. readonly width: number;
  153329. readonly height: number;
  153330. close(): void;
  153331. }
  153332. interface WebGLQuery extends WebGLObject {
  153333. }
  153334. declare var WebGLQuery: {
  153335. prototype: WebGLQuery;
  153336. new(): WebGLQuery;
  153337. };
  153338. interface WebGLSampler extends WebGLObject {
  153339. }
  153340. declare var WebGLSampler: {
  153341. prototype: WebGLSampler;
  153342. new(): WebGLSampler;
  153343. };
  153344. interface WebGLSync extends WebGLObject {
  153345. }
  153346. declare var WebGLSync: {
  153347. prototype: WebGLSync;
  153348. new(): WebGLSync;
  153349. };
  153350. interface WebGLTransformFeedback extends WebGLObject {
  153351. }
  153352. declare var WebGLTransformFeedback: {
  153353. prototype: WebGLTransformFeedback;
  153354. new(): WebGLTransformFeedback;
  153355. };
  153356. interface WebGLVertexArrayObject extends WebGLObject {
  153357. }
  153358. declare var WebGLVertexArrayObject: {
  153359. prototype: WebGLVertexArrayObject;
  153360. new(): WebGLVertexArrayObject;
  153361. };
  153362. // Type definitions for WebVR API
  153363. // Project: https://w3c.github.io/webvr/
  153364. // Definitions by: six a <https://github.com/lostfictions>
  153365. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  153366. interface VRDisplay extends EventTarget {
  153367. /**
  153368. * Dictionary of capabilities describing the VRDisplay.
  153369. */
  153370. readonly capabilities: VRDisplayCapabilities;
  153371. /**
  153372. * z-depth defining the far plane of the eye view frustum
  153373. * enables mapping of values in the render target depth
  153374. * attachment to scene coordinates. Initially set to 10000.0.
  153375. */
  153376. depthFar: number;
  153377. /**
  153378. * z-depth defining the near plane of the eye view frustum
  153379. * enables mapping of values in the render target depth
  153380. * attachment to scene coordinates. Initially set to 0.01.
  153381. */
  153382. depthNear: number;
  153383. /**
  153384. * An identifier for this distinct VRDisplay. Used as an
  153385. * association point in the Gamepad API.
  153386. */
  153387. readonly displayId: number;
  153388. /**
  153389. * A display name, a user-readable name identifying it.
  153390. */
  153391. readonly displayName: string;
  153392. readonly isConnected: boolean;
  153393. readonly isPresenting: boolean;
  153394. /**
  153395. * If this VRDisplay supports room-scale experiences, the optional
  153396. * stage attribute contains details on the room-scale parameters.
  153397. */
  153398. readonly stageParameters: VRStageParameters | null;
  153399. /**
  153400. * Passing the value returned by `requestAnimationFrame` to
  153401. * `cancelAnimationFrame` will unregister the callback.
  153402. * @param handle Define the hanle of the request to cancel
  153403. */
  153404. cancelAnimationFrame(handle: number): void;
  153405. /**
  153406. * Stops presenting to the VRDisplay.
  153407. * @returns a promise to know when it stopped
  153408. */
  153409. exitPresent(): Promise<void>;
  153410. /**
  153411. * Return the current VREyeParameters for the given eye.
  153412. * @param whichEye Define the eye we want the parameter for
  153413. * @returns the eye parameters
  153414. */
  153415. getEyeParameters(whichEye: string): VREyeParameters;
  153416. /**
  153417. * Populates the passed VRFrameData with the information required to render
  153418. * the current frame.
  153419. * @param frameData Define the data structure to populate
  153420. * @returns true if ok otherwise false
  153421. */
  153422. getFrameData(frameData: VRFrameData): boolean;
  153423. /**
  153424. * Get the layers currently being presented.
  153425. * @returns the list of VR layers
  153426. */
  153427. getLayers(): VRLayer[];
  153428. /**
  153429. * Return a VRPose containing the future predicted pose of the VRDisplay
  153430. * when the current frame will be presented. The value returned will not
  153431. * change until JavaScript has returned control to the browser.
  153432. *
  153433. * The VRPose will contain the position, orientation, velocity,
  153434. * and acceleration of each of these properties.
  153435. * @returns the pose object
  153436. */
  153437. getPose(): VRPose;
  153438. /**
  153439. * Return the current instantaneous pose of the VRDisplay, with no
  153440. * prediction applied.
  153441. * @returns the current instantaneous pose
  153442. */
  153443. getImmediatePose(): VRPose;
  153444. /**
  153445. * The callback passed to `requestAnimationFrame` will be called
  153446. * any time a new frame should be rendered. When the VRDisplay is
  153447. * presenting the callback will be called at the native refresh
  153448. * rate of the HMD. When not presenting this function acts
  153449. * identically to how window.requestAnimationFrame acts. Content should
  153450. * make no assumptions of frame rate or vsync behavior as the HMD runs
  153451. * asynchronously from other displays and at differing refresh rates.
  153452. * @param callback Define the eaction to run next frame
  153453. * @returns the request handle it
  153454. */
  153455. requestAnimationFrame(callback: FrameRequestCallback): number;
  153456. /**
  153457. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  153458. * Repeat calls while already presenting will update the VRLayers being displayed.
  153459. * @param layers Define the list of layer to present
  153460. * @returns a promise to know when the request has been fulfilled
  153461. */
  153462. requestPresent(layers: VRLayer[]): Promise<void>;
  153463. /**
  153464. * Reset the pose for this display, treating its current position and
  153465. * orientation as the "origin/zero" values. VRPose.position,
  153466. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  153467. * updated when calling resetPose(). This should be called in only
  153468. * sitting-space experiences.
  153469. */
  153470. resetPose(): void;
  153471. /**
  153472. * The VRLayer provided to the VRDisplay will be captured and presented
  153473. * in the HMD. Calling this function has the same effect on the source
  153474. * canvas as any other operation that uses its source image, and canvases
  153475. * created without preserveDrawingBuffer set to true will be cleared.
  153476. * @param pose Define the pose to submit
  153477. */
  153478. submitFrame(pose?: VRPose): void;
  153479. }
  153480. declare var VRDisplay: {
  153481. prototype: VRDisplay;
  153482. new(): VRDisplay;
  153483. };
  153484. interface VRLayer {
  153485. leftBounds?: number[] | Float32Array | null;
  153486. rightBounds?: number[] | Float32Array | null;
  153487. source?: HTMLCanvasElement | null;
  153488. }
  153489. interface VRDisplayCapabilities {
  153490. readonly canPresent: boolean;
  153491. readonly hasExternalDisplay: boolean;
  153492. readonly hasOrientation: boolean;
  153493. readonly hasPosition: boolean;
  153494. readonly maxLayers: number;
  153495. }
  153496. interface VREyeParameters {
  153497. /** @deprecated */
  153498. readonly fieldOfView: VRFieldOfView;
  153499. readonly offset: Float32Array;
  153500. readonly renderHeight: number;
  153501. readonly renderWidth: number;
  153502. }
  153503. interface VRFieldOfView {
  153504. readonly downDegrees: number;
  153505. readonly leftDegrees: number;
  153506. readonly rightDegrees: number;
  153507. readonly upDegrees: number;
  153508. }
  153509. interface VRFrameData {
  153510. readonly leftProjectionMatrix: Float32Array;
  153511. readonly leftViewMatrix: Float32Array;
  153512. readonly pose: VRPose;
  153513. readonly rightProjectionMatrix: Float32Array;
  153514. readonly rightViewMatrix: Float32Array;
  153515. readonly timestamp: number;
  153516. }
  153517. interface VRPose {
  153518. readonly angularAcceleration: Float32Array | null;
  153519. readonly angularVelocity: Float32Array | null;
  153520. readonly linearAcceleration: Float32Array | null;
  153521. readonly linearVelocity: Float32Array | null;
  153522. readonly orientation: Float32Array | null;
  153523. readonly position: Float32Array | null;
  153524. readonly timestamp: number;
  153525. }
  153526. interface VRStageParameters {
  153527. sittingToStandingTransform?: Float32Array;
  153528. sizeX?: number;
  153529. sizeY?: number;
  153530. }
  153531. interface Navigator {
  153532. getVRDisplays(): Promise<VRDisplay[]>;
  153533. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  153534. }
  153535. interface Window {
  153536. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  153537. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  153538. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  153539. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  153540. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  153541. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  153542. }
  153543. interface Gamepad {
  153544. readonly displayId: number;
  153545. }
  153546. type XRSessionMode =
  153547. | "inline"
  153548. | "immersive-vr"
  153549. | "immersive-ar";
  153550. type XRReferenceSpaceType =
  153551. | "viewer"
  153552. | "local"
  153553. | "local-floor"
  153554. | "bounded-floor"
  153555. | "unbounded";
  153556. type XREnvironmentBlendMode =
  153557. | "opaque"
  153558. | "additive"
  153559. | "alpha-blend";
  153560. type XRVisibilityState =
  153561. | "visible"
  153562. | "visible-blurred"
  153563. | "hidden";
  153564. type XRHandedness =
  153565. | "none"
  153566. | "left"
  153567. | "right";
  153568. type XRTargetRayMode =
  153569. | "gaze"
  153570. | "tracked-pointer"
  153571. | "screen";
  153572. type XREye =
  153573. | "none"
  153574. | "left"
  153575. | "right";
  153576. type XREventType =
  153577. | "devicechange"
  153578. | "visibilitychange"
  153579. | "end"
  153580. | "inputsourceschange"
  153581. | "select"
  153582. | "selectstart"
  153583. | "selectend"
  153584. | "squeeze"
  153585. | "squeezestart"
  153586. | "squeezeend"
  153587. | "reset";
  153588. interface XRSpace extends EventTarget {
  153589. }
  153590. interface XRRenderState {
  153591. depthNear?: number;
  153592. depthFar?: number;
  153593. inlineVerticalFieldOfView?: number;
  153594. baseLayer?: XRWebGLLayer;
  153595. }
  153596. interface XRInputSource {
  153597. handedness: XRHandedness;
  153598. targetRayMode: XRTargetRayMode;
  153599. targetRaySpace: XRSpace;
  153600. gripSpace: XRSpace | undefined;
  153601. gamepad: Gamepad | undefined;
  153602. profiles: Array<string>;
  153603. }
  153604. interface XRSessionInit {
  153605. optionalFeatures?: string[];
  153606. requiredFeatures?: string[];
  153607. }
  153608. interface XRSession {
  153609. addEventListener: Function;
  153610. removeEventListener: Function;
  153611. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  153612. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  153613. requestAnimationFrame: Function;
  153614. end(): Promise<void>;
  153615. renderState: XRRenderState;
  153616. inputSources: Array<XRInputSource>;
  153617. // hit test
  153618. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  153619. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  153620. // legacy AR hit test
  153621. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153622. // legacy plane detection
  153623. updateWorldTrackingState(options: {
  153624. planeDetectionState?: { enabled: boolean; }
  153625. }): void;
  153626. }
  153627. interface XRReferenceSpace extends XRSpace {
  153628. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  153629. onreset: any;
  153630. }
  153631. type XRPlaneSet = Set<XRPlane>;
  153632. type XRAnchorSet = Set<XRAnchor>;
  153633. interface XRFrame {
  153634. session: XRSession;
  153635. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  153636. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  153637. // AR
  153638. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult> ;
  153639. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  153640. // Anchors
  153641. trackedAnchors?: XRAnchorSet;
  153642. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  153643. // Planes
  153644. worldInformation: {
  153645. detectedPlanes?: XRPlaneSet;
  153646. };
  153647. }
  153648. interface XRViewerPose extends XRPose {
  153649. views: Array<XRView>;
  153650. }
  153651. interface XRPose {
  153652. transform: XRRigidTransform;
  153653. emulatedPosition: boolean;
  153654. }
  153655. interface XRWebGLLayerOptions {
  153656. antialias?: boolean;
  153657. depth?: boolean;
  153658. stencil?: boolean;
  153659. alpha?: boolean;
  153660. multiview?: boolean;
  153661. framebufferScaleFactor?: number;
  153662. }
  153663. declare var XRWebGLLayer: {
  153664. prototype: XRWebGLLayer;
  153665. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  153666. };
  153667. interface XRWebGLLayer {
  153668. framebuffer: WebGLFramebuffer;
  153669. framebufferWidth: number;
  153670. framebufferHeight: number;
  153671. getViewport: Function;
  153672. }
  153673. declare class XRRigidTransform {
  153674. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  153675. position: DOMPointReadOnly;
  153676. orientation: DOMPointReadOnly;
  153677. matrix: Float32Array;
  153678. inverse: XRRigidTransform;
  153679. }
  153680. interface XRView {
  153681. eye: XREye;
  153682. projectionMatrix: Float32Array;
  153683. transform: XRRigidTransform;
  153684. }
  153685. interface XRInputSourceChangeEvent {
  153686. session: XRSession;
  153687. removed: Array<XRInputSource>;
  153688. added: Array<XRInputSource>;
  153689. }
  153690. interface XRInputSourceEvent extends Event {
  153691. readonly frame: XRFrame;
  153692. readonly inputSource: XRInputSource;
  153693. }
  153694. // Experimental(er) features
  153695. declare class XRRay {
  153696. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  153697. origin: DOMPointReadOnly;
  153698. direction: DOMPointReadOnly;
  153699. matrix: Float32Array;
  153700. }
  153701. declare enum XRHitTestTrackableType {
  153702. "point",
  153703. "plane"
  153704. }
  153705. interface XRHitResult {
  153706. hitMatrix: Float32Array;
  153707. }
  153708. interface XRTransientInputHitTestResult {
  153709. readonly inputSource: XRInputSource;
  153710. readonly results: Array<XRHitTestResult>;
  153711. }
  153712. interface XRHitTestResult {
  153713. getPose(baseSpace: XRSpace): XRPose | undefined;
  153714. // When anchor system is enabled
  153715. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  153716. }
  153717. interface XRHitTestSource {
  153718. cancel(): void;
  153719. }
  153720. interface XRTransientInputHitTestSource {
  153721. cancel(): void;
  153722. }
  153723. interface XRHitTestOptionsInit {
  153724. space: XRSpace;
  153725. entityTypes?: Array<XRHitTestTrackableType>;
  153726. offsetRay?: XRRay;
  153727. }
  153728. interface XRTransientInputHitTestOptionsInit {
  153729. profile: string;
  153730. entityTypes?: Array<XRHitTestTrackableType>;
  153731. offsetRay?: XRRay;
  153732. }
  153733. interface XRAnchor {
  153734. anchorSpace: XRSpace;
  153735. delete(): void;
  153736. }
  153737. interface XRPlane {
  153738. orientation: "Horizontal" | "Vertical";
  153739. planeSpace: XRSpace;
  153740. polygon: Array<DOMPointReadOnly>;
  153741. lastChangedTime: number;
  153742. }